TableBorderWidthCommand

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.

Parameters

affectsData : boolean

The attribute that will be set by the command.

The editor on which this command will be used.

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

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

It is possible to disable a command "from outside" using forceDisabled method.

The value of the command. A given 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 link details.

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

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

The default value for the attribute.

A flag indicating whether a command's isEnabled state should be changed depending on where the document selection is placed.

By default, it is set to true. If the document selection is placed in a non-editable place (such as non-editable root), the command becomes disabled.

The flag should be changed to false in a concrete command's constructor if the command should not change its isEnabled accordingly to the document selection.

Creates a new TableBorderWidthCommand instance.

Parameters

editor : Editor

An editor in which this command will be used.

defaultValue : string

The default value of the attribute.

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, 'isEnabled' );

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, 'isEnabled' );

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

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

which corresponds to:

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

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

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

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

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

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' ).to( command, 'isEnabled' );

Type parameters

K1

K2

Parameters

bindProperty1 : K1

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

bindProperty2 : K2

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

Returns

ObservableDualBindChain<K1, TableBorderWidthCommand[ K1 ], K2, TableBorderWidthCommand[ K2 ]>

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

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, 'isEnabled' );

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, 'isEnabled' );

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

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

which corresponds to:

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

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

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

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

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

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' ).to( command, 'isEnabled' );

Parameters

bindProperties : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'value' | 'affectsData' | 'attributeName' | 'refresh' | 'execute' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>

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

Returns

ObservableMultiBindChain

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

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, 'isEnabled' );

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, 'isEnabled' );

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

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

which corresponds to:

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

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

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

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

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

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' ).to( command, 'isEnabled' );

Type parameters

K

Parameters

bindProperty : K

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

Returns

ObservableSingleBindChain<K, TableBorderWidthCommand[ K ]>

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

Clears forced disable previously set through forceDisabled. See forceDisabled.

Parameters

id : string

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

Returns

void

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 extends ObservableMixin() {
	constructor() {
		super();
		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:

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

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

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

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

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

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

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

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

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

Parameters

methodName : 'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'value' | 'affectsData' | 'attributeName' | 'refresh' | 'execute' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled'

Name of the method to decorate.

Returns

void

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.delegate( 'eventX' ).to( emitterB );
emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );

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

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

Parameters

events : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain

Destroys the command.

Returns

void

Executes the command.

Parameters

options : TablePropertyCommandExecuteOptions

Defaults to {}

Returns

void

Fires

• execute

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.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

eventOrInfo : GetNameOrEventInfo<TEvent>

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

args : TEvent[ 'args' ]

Additional arguments to be passed to the callbacks.

Returns

GetEventInfo<TEvent>[ 'return' ]

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).

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. the 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.isEnabled; // -> true
command.forceDisabled( 'MyFeature' );
command.isEnabled; // -> false
command.clearForceDisabled( 'MyFeature' );
command.isEnabled; // -> true

Multiple disabling with the same identifier is redundant:

command.isEnabled; // -> true
command.forceDisabled( 'MyFeature' );
command.isEnabled; // -> false
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.

Returns

void

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.

Type parameters

TEvent : extends BaseEvent

The type describing the event. See BaseEvent.

Parameters

emitter : Emitter

The object that fires the event.

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

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.

Returns

void

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).

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

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.

Type parameters

TEvent : extends BaseEvent

The type descibing the event. See BaseEvent.

Parameters

event : TEvent[ 'name' ]

The name of the event.

callback : GetCallback<TEvent>

The function to be called on event.

[ options ] : GetCallbackOptions<TEvent>

Additional options.

Returns

void

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.

Returns

void

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

It accepts 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.

In TypeScript, those properties should be declared in class using declare keyword. In example:

public declare myProp1: number;
public declare myProp2: string;

constructor() {
	this.set( {
		'myProp1: 2,
		'myProp2: 'foo'
	} );
}

Parameters

values : object

An object with name=>value pairs.

Returns

void

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

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.

In TypeScript, those properties should be declared in class using declare keyword. In example:

public declare myProp: number;

constructor() {
	this.set( 'myProp', 2 );
}

Type parameters

K

Parameters

name : K

The property's name.

value : TableBorderWidthCommand[ K ]

The property's value.

Returns

void

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.

Returns

void

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.

Returns

void

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 : Array<'off' | 'set' | 'bind' | 'unbind' | 'decorate' | 'stopListening' | 'on' | 'once' | 'listenTo' | 'fire' | 'delegate' | 'stopDelegating' | 'destroy' | 'value' | 'affectsData' | 'attributeName' | 'refresh' | 'execute' | 'isEnabled' | 'editor' | 'forceDisabled' | 'clearForceDisabled'>

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

Returns

void

Returns the attribute value for a table.

Parameters

table : ModelElement

Returns

undefined | string

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

Parameters

value : undefined | string | number

Returns

unknown

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.

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 : unknown

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

oldValue : unknown

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

Fired when a property changed value.

observable.set( 'prop', 1 );

observable.on<ObservableChangeEvent<number>>( '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 : TValue

The new property value.

oldValue : TValue

The previous property value.

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.

<anonymous> : Parameters<TObservable[ TName ]>

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

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.

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

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (value).

value : unknown

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

oldValue : unknown

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

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<ObservableSetEvent<number>>( '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<ObservableChangeEvent<number>>( '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 : TValue

The new property value.

oldValue : TValue

The previous property value.