| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798 |
- /**
- * @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/tableproperties/commands/tablepropertycommand
- */
- import Command from '@ckeditor/ckeditor5-core/src/command';
- /**
- * The table cell attribute command.
- *
- * This command is a base command for other table property commands.
- *
- * @extends module:core/command~Command
- */
- export default class TablePropertyCommand extends Command {
- /**
- * Creates a new `TablePropertyCommand` 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 selection = editor.model.document.selection;
- const table = selection.getFirstPosition().findAncestor( 'table' );
- this.isEnabled = !!table;
- this.value = this._getValue( table );
- }
- /**
- * Executes the command.
- *
- * @fires execute
- * @param {Object} [options]
- * @param {*} [options.value] If set, the command will set the attribute on the selected table.
- * If not set, the command will remove the attribute from the selected table.
- * @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 model = this.editor.model;
- const selection = model.document.selection;
- const { value, batch } = options;
- const table = selection.getFirstPosition().findAncestor( 'table' );
- const valueToSet = this._getValueToSet( value );
- model.enqueueChange( batch || 'default', writer => {
- if ( valueToSet ) {
- writer.setAttribute( this.attributeName, valueToSet, table );
- } else {
- writer.removeAttribute( this.attributeName, table );
- }
- } );
- }
- /**
- * Returns the attribute value for a table.
- *
- * @param {module:engine/model/element~Element} table
- * @returns {String|undefined}
- * @private
- */
- _getValue( table ) {
- if ( !table ) {
- return;
- }
- return table.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;
- }
- }
|