| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110 |
- /**
- * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
- /**
- * @module table/tablecellproperties/commands/tablecellpropertycommand
- */
- import Command from '@ckeditor/ckeditor5-core/src/command';
- import { getSelectionAffectedTableCells } from '../../utils/selection';
- /**
- * The table cell attribute command.
- *
- * The command is a base command for other table cell property commands.
- *
- * @extends module:core/command~Command
- */
- export default class TableCellPropertyCommand extends Command {
- /**
- * Creates a new `TableCellPropertyCommand` instance.
- *
- * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
- * @param {String} attributeName Table cell attribute name.
- */
- constructor( editor, attributeName ) {
- super( editor );
- this.attributeName = attributeName;
- }
- /**
- * @inheritDoc
- */
- refresh() {
- const editor = this.editor;
- const selectedTableCells = getSelectionAffectedTableCells( editor.model.document.selection );
- this.isEnabled = !!selectedTableCells.length;
- this.value = this._getSingleValue( selectedTableCells );
- }
- /**
- * Executes the command.
- *
- * @fires execute
- * @param {Object} [options]
- * @param {*} [options.value] If set, the command will set the attribute on selected table cells.
- * If it is not set, the command will remove the attribute from the selected table cells.
- * @param {module:engine/model/batch~Batch} [options.batch] Pass the model batch instance to the command to aggregate changes,
- * for example to allow a single undo step for multiple executions.
- */
- execute( options = {} ) {
- const { value, batch } = options;
- const model = this.editor.model;
- const tableCells = getSelectionAffectedTableCells( model.document.selection );
- const valueToSet = this._getValueToSet( value );
- model.enqueueChange( batch || 'default', writer => {
- if ( valueToSet ) {
- tableCells.forEach( tableCell => writer.setAttribute( this.attributeName, valueToSet, tableCell ) );
- } else {
- tableCells.forEach( tableCell => writer.removeAttribute( this.attributeName, tableCell ) );
- }
- } );
- }
- /**
- * Returns the attribute value for a table cell.
- *
- * @param {module:engine/model/element~Element} tableCell
- * @returns {String|undefined}
- * @private
- */
- _getAttribute( tableCell ) {
- if ( !tableCell ) {
- return;
- }
- return tableCell.getAttribute( this.attributeName );
- }
- /**
- * Returns the proper model value. It can be used to add a default unit to numeric values.
- *
- * @private
- * @param {*} value
- * @returns {*}
- */
- _getValueToSet( value ) {
- return value;
- }
- /**
- * Returns a single value for all selected table cells. If the value is the same for all cells,
- * it will be returned (`undefined` otherwise).
- *
- * @param {Array.<module:engine/model/element~Element>} tableCell
- * @returns {*}
- * @private
- */
- _getSingleValue( tableCell ) {
- const firstCellValue = this._getAttribute( tableCell[ 0 ] );
- const everyCellHasAttribute = tableCell.every( tableCell => this._getAttribute( tableCell ) === firstCellValue );
- return everyCellHasAttribute ? firstCellValue : undefined;
- }
- }
|