ManualDecorator (link)

@ckeditor/ckeditor5-link/src/utils

class

Helper class that stores manual decorators with observable value to support integration with the UI state. An instance of this class is a model with the state of individual manual decorators. These decorators are kept as collections in manualDecorators.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

attributes : Object

See source
A set of attributes added to downcasted data when the decorator is activated for a specific link. Attributes should be added in a form of attributes defined in ElementDefinition.
classes : Object

See source
A set of classes added to downcasted data when the decorator is activated for a specific link. Classes should be added in a form of classes defined in ElementDefinition.
defaultValue : Boolean

See source
The default value of manual decorator.
id : String

See source
An ID of a manual decorator which is the name of the attribute in the model, for example: 'linkManualDecorator0'.
label : String

See source
The label used in the user interface to toggle the manual decorator.
styles : Object

See source
A set of styles added to downcasted data when the decorator is activated for a specific link. Styles should be added in a form of styles defined in ElementDefinition.
observable
value : Boolean

See source
The value of the current manual decorator. It reflects its state from the UI.

Methods

constructor( config = { config.id, config.label, config.attributes, [config.defaultValue] } )

See source
Creates a new instance of ManualDecorator.

Parameters

config : Object

Properties

config.id : String

The name of the attribute used in the model that represents a given manual decorator. For example: 'linkIsExternal'.

config.label : String

The label used in the user interface to toggle the manual decorator.

config.attributes : Object

A set of attributes added to output data when the decorator is active for a specific link. Attributes should keep the format of attributes defined in ElementDefinition.

[ config.defaultValue ] : Boolean

Controls whether the decorator is "on" by default.
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.
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
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).
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 {}
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
_createPattern() → MatcherPattern

See source
Returns MatcherPattern with decorator attributes.

Returns

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

Events

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

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.

ManualDecorator (link)

Filtering

Properties

attributes : Objectmodule:link/utils~ManualDecorator#attributes

classes : Objectmodule:link/utils~ManualDecorator#classes

defaultValue : Booleanmodule:link/utils~ManualDecorator#defaultValue

id : Stringmodule:link/utils~ManualDecorator#id

label : Stringmodule:link/utils~ManualDecorator#label

styles : Objectmodule:link/utils~ManualDecorator#styles

observable value : Booleanmodule:link/utils~ManualDecorator#value

Methods

constructor( config = { config.id, config.label, config.attributes, [config.defaultValue] } )module:link/utils~ManualDecorator#constructor

Parameters

mixed bind( bindProperties ) → Objectmodule:link/utils~ManualDecorator#bind

Parameters

Returns

mixed decorate( methodName )module:link/utils~ManualDecorator#decorate

Parameters

mixed delegate( events ) → EmitterMixinDelegateChainmodule:link/utils~ManualDecorator#delegate

Parameters

Returns

mixed fire( eventOrInfo, [ args ] ) → *module:link/utils~ManualDecorator#fire

Parameters

Returns

mixed listenTo( emitter, event, callback, [ options ] = { [options.priority] } )module:link/utils~ManualDecorator#listenTo

Parameters

mixed off( event, callback )module:link/utils~ManualDecorator#off

Parameters

mixed on( event, callback, [ options ] = { [options.priority] } )module:link/utils~ManualDecorator#on

Parameters

mixed once( event, callback, [ options ] = { [options.priority] } )module:link/utils~ManualDecorator#once

Parameters

mixed set( name, [ value ] )module:link/utils~ManualDecorator#set

Parameters

mixed stopDelegating( [ event ], [ emitter ] )module:link/utils~ManualDecorator#stopDelegating

Parameters

mixed stopListening( [ emitter ], [ event ], [ callback ] )module:link/utils~ManualDecorator#stopListening

Parameters

mixed unbind( [ unbindProperties ] )module:link/utils~ManualDecorator#unbind

Parameters

protected mixed _addEventListener( event, callback, [ options ] = { [options.priority] } )module:link/utils~ManualDecorator#_addEventListener

Parameters

protected _createPattern() → MatcherPatternmodule:link/utils~ManualDecorator#_createPattern

Returns

protected mixed _removeEventListener( event, callback )module:link/utils~ManualDecorator#_removeEventListener

Parameters

Events

change:value( eventInfo, name, value, oldValue )module:link/utils~ManualDecorator#event:change:value

Parameters

mixed change:{property}( eventInfo, name, value, oldValue )module:link/utils~ManualDecorator#event:change:{property}

Parameters

mixed set:{property}( eventInfo, name, value, oldValue )module:link/utils~ManualDecorator#event:set:{property}

Parameters

`attributes : Object`

`classes : Object`

`defaultValue : Boolean`

`id : String`

`label : String`

`styles : Object`

observable
`value : Boolean`

`constructor( config = { config.id, config.label, config.attributes, [config.defaultValue] } )`

mixed
`bind( bindProperties ) → Object`

mixed
`decorate( methodName )`

mixed
`delegate( events ) → EmitterMixinDelegateChain`

mixed
`fire( eventOrInfo, [ args ] ) → *`

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

mixed
`off( event, callback )`

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

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

mixed
`set( name, [ value ] )`

mixed
`stopDelegating( [ event ], [ emitter ] )`

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

mixed
`unbind( [ unbindProperties ] )`

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

protected
`_createPattern() → MatcherPattern`

protected mixed
`_removeEventListener( event, callback )`

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

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

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