CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

TableCellWidthCommand (table/tablecellproperties/commands)

@ckeditor/ckeditor5-table/src/tablecellproperties/commands/tablecellwidthcommand

class
See source

The table cell width command.

The command is registered by the TableCellWidthEditing as the 'tableCellWidth' editor command.

To change the width of selected cells, execute the command:

editor.execute( 'tableCellWidth', {
	value: '50px'
} );

Note: This command adds a default 'px' unit to numeric values. Executing:

editor.execute( 'tableCellWidth', {
	value: '50'
} );

will set the width attribute to '50px' in the model.

Filtering

Properties

  • readonly inherited

    affectsData : Boolean

    See source

    A flag indicating whether a command execution changes the editor data or not.

    Commands with affectsData set to false will not be automatically disabled in the read-only mode and other editor modes with restricted user write permissions.

    Note: You do not have to set it for your every command. It is true by default.

    Defaults to true

  • readonly inherited

    attributeName : String

    See source

    The attribute that will be set by the command.

  • readonly inherited

    editor : Editor

    See source

    The editor on which this command will be used.

  • readonly inherited observable

    isEnabled : Boolean

    See source

    Flag indicating whether a command is enabled or disabled. A disabled command will do nothing when executed.

    A concrete command class should control this value by overriding the refresh() method.

    It is possible to disable a command from "outside". For instance, in your integration you may want to disable a certain set of commands for the time being. To do that, you can use the fact that isEnabled is observable and it fires the set:isEnabled event every time anyone tries to modify its value:

    function disableCommand( cmd ) {
	cmd.on( 'set:isEnabled', forceDisable, { priority: 'highest' } );

	cmd.isEnabled = false;

	// Make it possible to enable the command again.
	return () => {
		cmd.off( 'set:isEnabled', forceDisable );
		cmd.refresh();
	};

	function forceDisable( evt ) {
		evt.return = false;
		evt.stop();
	}
}

// Usage:

// Disabling the command.
const enableBold = disableCommand( editor.commands.get( 'bold' ) );

// Enabling the command again.
enableBold();

  • readonly inherited observable

    value

    See source

    The value of the command. A concrete command class should define what it represents for it.

    For example, the 'bold' command's value indicates whether the selection starts in a bolded text. And the value of the 'link' command may be an object with links details.

    It is possible for a command to have no value (e.g. for stateless actions such as 'uploadImage').

    A concrete command class should control this value by overriding the refresh() method.

  • protected readonly inherited

    _defaultValue : String

    See source

    The default value for the attribute.

  • private inherited

    _disableStack : Set.<String>

    See source

    Holds identifiers for forceDisabled mechanism.

Methods

  • constructor( editor, defaultValue )

    See source

    Creates a new TableCellWidthCommand instance.

    Parameters

    editor : Editor

    An editor in which this command will be used.

    defaultValue : String

    The default value of the attribute.

  • mixed

    bind( bindProperties ) → Object

    See source

    Binds observable properties to other objects implementing the Observable interface.

    Read more in the dedicated guide covering the topic of property bindings with some additional examples.

    Consider two objects: a button and an associated command (both Observable).

    A simple property binding could be as follows:

    button.bind( 'isEnabled' ).to( command, 'isEnabled' );

    or even shorter:

    button.bind( 'isEnabled' ).to( command );

    which works in the following way:

    • button.isEnabled instantly equals command.isEnabled,
    • whenever command.isEnabled changes, button.isEnabled will immediately reflect its value.

    Note: To release the binding, use unbind.

    You can also "rename" the property in the binding by specifying the new name in the to() chain:

    button.bind( 'isEnabled' ).to( command, 'isWorking' );

    It is possible to bind more than one property at a time to shorten the code:

    button.bind( 'isEnabled', 'value' ).to( command );

    which corresponds to:

    button.bind( 'isEnabled' ).to( command );
button.bind( 'value' ).to( command );

    The binding can include more than one observable, combining multiple data sources in a custom callback:

    button.bind( 'isEnabled' ).to( command, 'isEnabled', ui, 'isVisible',
	( isCommandEnabled, isUIVisible ) => isCommandEnabled && isUIVisible );

    Using a custom callback allows processing the value before passing it to the target property:

    button.bind( 'isEnabled' ).to( command, 'value', value => value === 'heading1' );

    It is also possible to bind to the same property in an array of observables. To bind a button to multiple commands (also Observables) so that each and every one of them must be enabled for the button to become enabled, use the following code:

    button.bind( 'isEnabled' ).toMany( [ commandA, commandB, commandC ], 'isEnabled',
	( isAEnabled, isBEnabled, isCEnabled ) => isAEnabled && isBEnabled && isCEnabled );

    Parameters

    bindProperties : String

    Observable properties that will be bound to other observable(s).

    Returns

    Object

    The bind chain with the to() and toMany() methods.

  • inherited

    clearForceDisabled( id )

    See source

    Clears forced disable previously set through forceDisabled. See forceDisabled.

    Parameters

    id : String

    Unique identifier, equal to the one passed in forceDisabled call.

  • mixed

    decorate( methodName )

    See source

    Turns the given methods of this object into event-based ones. This means that the new method will fire an event (named after the method) and the original action will be plugged as a listener to that event.

    Read more in the dedicated guide covering the topic of decorating methods with some additional examples.

    Decorating the method does not change its behavior (it only adds an event), but it allows to modify it later on by listening to the method's event.

    For example, to cancel the method execution the event can be stopped:

    class Foo {
	constructor() {
		this.decorate( 'method' );
	}

	method() {
		console.log( 'called!' );
	}
}

const foo = new Foo();
foo.on( 'method', ( evt ) => {
	evt.stop();
}, { priority: 'high' } );

foo.method(); // Nothing is logged.

    Note: The high priority listener has been used to execute this particular callback before the one which calls the original method (which uses the "normal" priority).

    It is also possible to change the returned value:

    foo.on( 'method', ( evt ) => {
	evt.return = 'Foo!';
} );

foo.method(); // -> 'Foo'

    Finally, it is possible to access and modify the arguments the method is called with:

    method( a, b ) {
	console.log( `${ a }, ${ b }`  );
}

// ...

foo.on( 'method', ( evt, args ) => {
	args[ 0 ] = 3;

	console.log( args[ 1 ] ); // -> 2
}, { priority: 'high' } );

foo.method( 1, 2 ); // -> '3, 2'

    Parameters

    methodName : String

    Name of the method to decorate.

  • mixed

    delegate( events ) → EmitterMixinDelegateChain

    See source

    Delegates selected events to another Emitter. For instance:

    emitterA.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

    then eventX is delegated (fired by) emitterB and emitterC along with data:

    emitterA.fire( 'eventX', data );

    and eventY is delegated (fired by) emitterC along with data:

    emitterA.fire( 'eventY', data );

    Parameters

    events : String

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain

  • inherited

    destroy()

    See source

    Destroys the command.

  • inherited

    execute( [ options ] = { [options.value], [options.batch] } )

    See source

    Executes the command.

    Parameters

    [ options ] : Object
    Properties
    [ 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.

    [ options.batch ] : Batch

    Pass the model batch instance to the command to aggregate changes, for example to allow a single undo step for multiple executions.

    Fires

  • mixed

    fire( eventOrInfo, [ args ] ) → *

    See source

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    Parameters

    eventOrInfo : String | EventInfo

    The name of the event or EventInfo object if event is delegated.

    [ args ] : *

    Additional arguments to be passed to the callbacks.

    Returns

    *

    By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

  • inherited

    forceDisabled( id )

    See source

    Disables the command.

    Command may be disabled by multiple features or algorithms (at once). When disabling a command, unique id should be passed (e.g. feature name). The same identifier should be used when enabling back the command. The command becomes enabled only after all features enabled it back.

    Disabling and enabling a command:

    command.isEnabled; // -> true
command.forceDisabled( 'MyFeature' );
command.isEnabled; // -> false
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> true

    Command disabled by multiple features:

    command.forceDisabled( 'MyFeature' );
command.forceDisabled( 'OtherFeature' );
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> false
command.clearForceDisabled( 'OtherFeature' );
command.isEnabled; // -> true

    Multiple disabling with the same identifier is redundant:

    command.forceDisabled( 'MyFeature' );
command.forceDisabled( 'MyFeature' );
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> true

    Note: some commands or algorithms may have more complex logic when it comes to enabling or disabling certain commands, so the command might be still disabled after clearForceDisabled was used.

    Parameters

    id : String

    Unique identifier for disabling. Use the same id when enabling back the command.

  • mixed

    listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

    See source

    Registers a callback function to be executed when an event is fired in a specific (emitter) object.

    Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

    // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
myEmitter.on( 'myGroup', genericCallback );
myEmitter.on( 'myGroup:myEvent', specificCallback );

// genericCallback is fired.
myEmitter.fire( 'myGroup' );
// both genericCallback and specificCallback are fired.
myEmitter.fire( 'myGroup:myEvent' );
// genericCallback is fired even though there are no callbacks for "foo".
myEmitter.fire( 'myGroup:foo' );

    An event callback can stop the event and set the return value of the fire method.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • mixed

    off( event, callback )

    See source

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to stop being called.

  • mixed

    on( event, callback, [ options ] = { [options.priority] } )

    See source

    Registers a callback function to be executed when an event is fired.

    Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • mixed

    once( event, callback, [ options ] = { [options.priority] } )

    See source

    Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • inherited

    refresh()

    See source

    Refreshes the command. The command should update its isEnabled and value properties in this method.

    This method is automatically called when any changes are applied to the document.

  • mixed

    set( name, [ value ] )

    See source

    Creates and sets the value of an observable property of this object. Such a property becomes a part of the state and is observable.

    It accepts also a single object literal containing key/value pairs with properties to be set.

    This method throws the observable-set-cannot-override error if the observable instance already has a property with the given property name. This prevents from mistakenly overriding existing properties and methods, but means that foo.set( 'bar', 1 ) may be slightly slower than foo.bar = 1.

    Parameters

    name : String | Object

    The property's name or object with name=>value pairs.

    [ value ] : *

    The property's value (if name was passed in the first parameter).

  • mixed

    stopDelegating( [ event ], [ emitter ] )

    See source

    Stops delegating events. It can be used at different levels:

    • To stop delegating all events.
    • To stop delegating a specific event to all emitters.
    • To stop delegating a specific event to a specific emitter.

    Parameters

    [ event ] : String

    The name of the event to stop delegating. If omitted, stops it all delegations.

    [ emitter ] : Emitter

    (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

  • mixed

    stopListening( [ emitter ], [ event ], [ callback ] )

    See source

    Stops listening for events. It can be used at different levels:

    • To stop listening to a specific callback.
    • To stop listening to a specific event.
    • To stop listening to all events fired by a specific object.
    • To stop listening to all events fired by all objects.

    Parameters

    [ emitter ] : Emitter

    The object to stop listening to. If omitted, stops it for all objects.

    [ event ] : String

    (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

    [ callback ] : function

    (Requires the event) The function to be removed from the call list for the given event.

  • mixed

    unbind( [ unbindProperties ] )

    See source

    Removes the binding created with bind.

    // Removes the binding for the 'a' property.
A.unbind( 'a' );

// Removes bindings for all properties.
A.unbind();

    Parameters

    [ unbindProperties ] : String

    Observable properties to be unbound. All the bindings will be released if no properties are provided.

  • protected mixed

    _addEventListener( event, callback, [ options ] = { [options.priority] } )

    See source

    Adds callback to emitter for given event.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to be called on event.

    [ options ] : Object

    Additional options.

    Properties
    [ options.priority ] : PriorityString | Number

    The priority of this event callback. The higher the priority value the sooner the callback will be fired. Events having the same priority are called in the order they were added.

    Defaults to 'normal'

    Defaults to {}

  • protected mixed

    _removeEventListener( event, callback )

    See source

    Removes callback from emitter for given event.

    Parameters

    event : String

    The name of the event.

    callback : function

    The function to stop being called.

  • private inherited

    _getAttribute( tableCell ) → String | undefined

    See source

    Returns the attribute value for a table cell.

    Parameters

    tableCell : Element

    Returns

    String | undefined

  • private inherited

    _getSingleValue( tableCell ) → *

    See source

    Returns a single value for all selected table cells. If the value is the same for all cells, it will be returned (undefined otherwise).

    Parameters

    tableCell : Array.<Element>

    Returns

    *

  • private inherited

    _getValueToSet( value ) → *

    See source

    Returns the proper model value. It can be used to add a default unit to numeric values.

    Parameters

    value : *

    Returns

    *

Events

  • inherited

    change:isEnabled( eventInfo, name, value, oldValue )

    See source

    Fired when the isEnabled property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (isEnabled).

    value : Boolean

    New value of the isEnabled property with given key or null, if operation should remove property.

    oldValue : Boolean

    Old value of the isEnabled property with given key or null, if property was not set before.

  • inherited

    change:value( eventInfo, name, value, oldValue )

    See source

    Fired when the value property changed value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    Name of the changed property (value).

    value : *

    New value of the value property with given key or null, if operation should remove property.

    oldValue : *

    Old value of the value property with given key or null, if property was not set before.

  • mixed

    change:{property}( eventInfo, name, value, oldValue )

    See source

    Fired when a property changed value.

    observable.set( 'prop', 1 );

observable.on( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `${ propertyName } has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'prop has changed from 1 to 2'

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    The property name.

    value : *

    The new property value.

    oldValue : *

    The previous property value.

  • inherited

    execute( eventInfo )

    See source

    Event fired by the execute method. The command action is a listener to this event so it's possible to change/cancel the behavior of the command by listening to this event.

    See decorate for more information and samples.

    Note: This event is fired even if command is disabled. However, it is automatically blocked by a high priority listener in order to prevent command execution.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • mixed

    set:{property}( eventInfo, name, value, oldValue )

    See source

    Fired when a property value is going to be set but is not set yet (before the change event is fired).

    You can control the final value of the property by using the event's return property.

    observable.set( 'prop', 1 );

observable.on( 'set:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value is going to be changed from ${ oldValue } to ${ newValue }` );
	console.log( `Current property value is ${ observable[ propertyName ] }` );

	// Let's override the value.
	evt.return = 3;
} );

observable.on( 'change:prop', ( evt, propertyName, newValue, oldValue ) => {
	console.log( `Value has changed from ${ oldValue } to ${ newValue }` );
} );

observable.prop = 2; // -> 'Value is going to be changed from 1 to 2'
                     // -> 'Current property value is 1'
                     // -> 'Value has changed from 1 to 3'

    Note: The event is fired even when the new value is the same as the old value.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    name : String

    The property name.

    value : *

    The new property value.

    oldValue : *

    The previous property value.