CKBoxCommand (ckbox)

@ckeditor/ckeditor5-ckbox/src/ckboxcommand

class

The CKBox command. It is used by the CKBox editing feature to open the CKBox file manager. The file manager allows inserting an image or a link to a file into the editor content.

editor.execute( 'ckbox' );

Note: This command uses other features to perform the following tasks:

To insert images it uses the 'insertImage' command from the Image feature.
To insert links to other files it uses the 'link' command from the Link feature.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

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.

Parameters

affectsData : boolean
readonly inherited
editor : Editor

See source
The editor on which this command will be used.
inherited observable
isEnabled : boolean

See source
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.
observable
value : boolean

See source
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.
internal readonly
_chosenAssets : Set<CKBoxAssetDefinition>

See source
A set of all chosen assets. They are stored temporarily and they are automatically removed 1 second after being chosen. Chosen assets have to be "remembered" for a while to be able to map the given asset with the element inserted into the model. This association map is then used to set the ID on the model element.

All chosen assets are automatically removed after the timeout, because (theoretically) it may happen that they will never be inserted into the model, even if the 'link' command or the 'insertImage' command is enabled. Such a case may arise when another plugin blocks the command execution. Then, in order not to keep the chosen (but not inserted) assets forever, we delete them automatically to prevent memory leakage. The 1 second timeout is enough to insert the asset into the model and extract the ID from the chosen asset.

The assets are stored only if the config.ckbox.ignoreDataId option is set to false (by default).
protected inherited
_isEnabledBasedOnSelection : boolean

See source
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.
private
_wrapper : null | Element

See source
The DOM element that acts as a mounting point for the CKBox dialog.

Methods

constructor( editor )

See source

Parameters

editor : Editor
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CKBoxCommand[ K1 ], K2, CKBoxCommand[ K2 ]>
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 );
```
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

DualBindChain<K1, CKBoxCommand[ K1 ], K2, CKBoxCommand[ K2 ]>

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperties ) → MultiBindChain
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 : Array<'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'value' | 'execute' | 'isEnabled' | 'affectsData' | 'refresh' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | '_chosenAssets'>

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

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty ) → SingleBindChain<K, CKBoxCommand[ K ]>
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 );
```
Type parameters

K

Parameters

bindProperty : K

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

Returns

SingleBindChain<K, CKBoxCommand[ K ]>

The bind chain with the to() and toMany() methods.
inherited
clearForceDisabled( id ) → void

See source
Clears forced disable previously set through forceDisabled. See forceDisabled.

Parameters

id : string

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

Returns

void
inherited
decorate( methodName ) → void
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 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:
```
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 : 'off' | 'on' | 'once' | 'listenTo' | 'stopListening' | 'fire' | 'delegate' | 'stopDelegating' | 'set' | 'bind' | 'unbind' | 'decorate' | 'destroy' | 'value' | 'execute' | 'isEnabled' | 'affectsData' | 'refresh' | 'editor' | 'forceDisabled' | 'clearForceDisabled' | '_chosenAssets'

Name of the method to decorate.

Returns

void
inherited
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 : Array<string>

Event names that will be delegated to another emitter.

Returns

EmitterMixinDelegateChain
inherited
destroy() → void

See source
Destroys the command.

Returns

void
execute() → void
See source
Executes the command.

A command may accept parameters. They will be passed from editor.execute() to the command.

The execute() method will automatically abort when the command is disabled (isEnabled is false). This behavior is implemented by a high priority listener to the event-execute event.

In order to see how to disable a command from "outside" see the isEnabled documentation.

This method may return a value, which would be forwarded all the way down to the editor.execute().

Returns

void

Fires
- execute
inherited
fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]

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.

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).
inherited
forceDisabled( id ) → void
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. 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.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.

Returns

void
inherited
listenTo( emitter, event, callback, [ options ] ) → void
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.

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
inherited
off( event, callback ) → void

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.

Returns

void
inherited
on( event, callback, [ options ] ) → void

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

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
inherited
once( event, callback, [ options ] ) → void

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.

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
refresh() → void

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.

Returns

void
inherited
set( values ) → void
See source
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
inherited
set( name, value ) → void
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.

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 : CKBoxCommand[ K ]

The property's value.

Returns

void
inherited
stopDelegating( [ event ], [ emitter ] ) → void
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.

Returns

void
inherited
stopListening( [ emitter ], [ event ], [ callback ] ) → void
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.

Returns

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

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

Returns

void
private
_checkEnabled() → boolean

See source
Checks whether the command can be enabled in the current context.

Returns

boolean
private
_getValue() → boolean

See source
Indicates if the CKBox dialog is already opened.

Returns

boolean
private
_initListeners() → void

See source
Initializes various event listeners for the ckbox:* events, because all functionality of the ckbox command is event-based.

Returns

void
private
_insertAsset( asset, isLastAsset, writer, isSingleAsset ) → void

See source
Inserts the asset into the model.

Parameters

asset : CKBoxAssetDefinition

The asset to be inserted.

isLastAsset : boolean

Indicates if the current asset is the last one from the chosen set.

writer : Writer

An instance of the model writer.

isSingleAsset : boolean

It's true when only one asset is processed.

Returns

void
private
_insertImage( asset ) → void

See source
Inserts the image by calling the insertImage command.

Parameters

asset : CKBoxAssetImageDefinition

The asset to be inserted.

Returns

void
private
_insertLink( asset, writer, isSingleAsset ) → void

See source
Inserts the link to the asset by calling the link command.

Parameters

asset : CKBoxAssetLinkDefinition

The asset to be inserted.

writer : Writer

An instance of the model writer.

isSingleAsset : boolean

It's true when only one asset is processed.

Returns

void
private
_prepareOptions() → object
See source
Creates the options object for the CKBox dialog.

Returns
object
The object with properties:

theme The theme for CKBox dialog.

language The language for CKBox dialog.

tokenUrl The token endpoint URL.

serviceOrigin The base URL of the API service.

forceDemoLabel Whether to force "Powered by CKBox" link.

assets.onChoose The callback function invoked after choosing the assets.

dialog.onClose The callback function invoked after closing the CKBox dialog.

dialog.width The dialog width in pixels.

dialog.height The dialog height in pixels.

categories.icons Allows setting custom icons for categories.

view.openLastView Sets if the last view visited by the user will be reopened on the next startup.

view.startupFolderId Sets the ID of the folder that will be opened on startup.

view.startupCategoryId Sets the ID of the category that will be opened on startup.

view.hideMaximizeButton Sets whether to hide the ‘Maximize’ button.

view.componentsHideTimeout Sets timeout after which upload components are hidden after completed upload.

view.dialogMinimizeTimeout Sets timeout after which upload dialog is minimized after completed upload.

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.
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 : boolean

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

oldValue : boolean

Old value of the value property with given key or null, if property was not set before.
inherited
change:{property}( eventInfo, name, value, oldValue )
See source
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.
inherited
execute( eventInfo, <anonymous> )

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.

<anonymous> : Parameters<TObservable[ TName ]>
inherited
set:isEnabled( eventInfo, name, value, oldValue )

See source
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.
set:value( eventInfo, name, value, oldValue )

See source
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 : boolean

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

oldValue : boolean

Old value of the value property with given key or null, if property was not set before.
inherited
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<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.

Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.

With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.

CKBoxCommand (ckbox)

Filtering

Properties

inherited affectsData : booleanmodule:ckbox/ckboxcommand~CKBoxCommand#affectsData

Parameters

readonly inherited editor : Editormodule:ckbox/ckboxcommand~CKBoxCommand#editor

inherited observable isEnabled : booleanmodule:ckbox/ckboxcommand~CKBoxCommand#isEnabled

observable value : booleanmodule:ckbox/ckboxcommand~CKBoxCommand#value

internal readonly _chosenAssets : Set<CKBoxAssetDefinition>module:ckbox/ckboxcommand~CKBoxCommand#_chosenAssets

protected inherited _isEnabledBasedOnSelection : booleanmodule:ckbox/ckboxcommand~CKBoxCommand#_isEnabledBasedOnSelection

private _wrapper : null | Elementmodule:ckbox/ckboxcommand~CKBoxCommand#_wrapper

Methods

constructor( editor )module:ckbox/ckboxcommand~CKBoxCommand#constructor

Parameters

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CKBoxCommand[ K1 ], K2, CKBoxCommand[ K2 ]>module:ckbox/ckboxcommand~CKBoxCommand#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperties ) → MultiBindChainmodule:ckbox/ckboxcommand~CKBoxCommand#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, CKBoxCommand[ K ]>module:ckbox/ckboxcommand~CKBoxCommand#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited clearForceDisabled( id ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#clearForceDisabled

Parameters

Returns

inherited decorate( methodName ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:ckbox/ckboxcommand~CKBoxCommand#delegate

Parameters

Returns

inherited destroy() → voidmodule:ckbox/ckboxcommand~CKBoxCommand#destroy

Returns

execute() → voidmodule:ckbox/ckboxcommand~CKBoxCommand#execute

Returns

Fires

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:ckbox/ckboxcommand~CKBoxCommand#fire

Type parameters

Parameters

Returns

inherited forceDisabled( id ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#forceDisabled

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#listenTo:BASE_EMITTER

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#off

Parameters

Returns

inherited on( event, callback, [ options ] ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#on

Type parameters

Parameters

Returns

inherited once( event, callback, [ options ] ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#once

Type parameters

Parameters

Returns

refresh() → voidmodule:ckbox/ckboxcommand~CKBoxCommand#refresh

Returns

inherited set( values ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#set:OBJECT

Parameters

Returns

inherited set( name, value ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#set:KEY_VALUE

Type parameters

Parameters

Returns

inherited stopDelegating( [ event ], [ emitter ] ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#stopDelegating

Parameters

Returns

inherited stopListening( [ emitter ], [ event ], [ callback ] ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#stopListening:BASE_STOP

Parameters

Returns

inherited unbind( unbindProperties ) → voidmodule:ckbox/ckboxcommand~CKBoxCommand#unbind

Parameters

Returns

private _checkEnabled() → booleanmodule:ckbox/ckboxcommand~CKBoxCommand#_checkEnabled

inherited
`affectsData : boolean`

readonly inherited
`editor : Editor`

inherited observable
`isEnabled : boolean`

observable
`value : boolean`

internal readonly
`_chosenAssets : Set<CKBoxAssetDefinition>`

protected inherited
`_isEnabledBasedOnSelection : boolean`

private
`_wrapper : null | Element`

`constructor( editor )`

inherited
`bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, CKBoxCommand[ K1 ], K2, CKBoxCommand[ K2 ]>`

inherited
`bind( bindProperties ) → MultiBindChain`

inherited
`bind( bindProperty ) → SingleBindChain<K, CKBoxCommand[ K ]>`

inherited
`clearForceDisabled( id ) → void`

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

inherited
`destroy() → void`

`execute() → void`

inherited
`fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]`

inherited
`forceDisabled( id ) → void`

inherited
`listenTo( emitter, event, callback, [ options ] ) → void`

inherited
`off( event, callback ) → void`

inherited
`on( event, callback, [ options ] ) → void`

inherited
`once( event, callback, [ options ] ) → void`

`refresh() → void`

inherited
`set( values ) → void`

inherited
`set( name, value ) → void`

inherited
`stopDelegating( [ event ], [ emitter ] ) → void`

inherited
`stopListening( [ emitter ], [ event ], [ callback ] ) → void`

inherited
`unbind( unbindProperties ) → void`

private
`_checkEnabled() → boolean`

private
`_getValue() → boolean`

private
`_initListeners() → void`

private
`_insertAsset( asset, isLastAsset, writer, isSingleAsset ) → void`

private
`_insertImage( asset ) → void`

private
`_insertLink( asset, writer, isSingleAsset ) → void`

private
`_prepareOptions() → object`

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

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

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

inherited
`execute( eventInfo, <anonymous> )`

inherited
`set:isEnabled( eventInfo, name, value, oldValue )`

`set:value( eventInfo, name, value, oldValue )`

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