Document (engine/view)

@ckeditor/ckeditor5-engine/src/view/document

class

Hierarchy

Observable
- Emitter
  - Document

Document class creates an abstract layer over the content editable area, contains a tree of view elements and view selection associated with this document.

Filtering

Public
Inherited
Internal
Protected
Private
Deprecated

Properties

observable
isComposing : boolean

See source
True if composition is in progress inside the document.

This property is updated by the CompositionObserver. If the CompositionObserver is disabled this property will not change.
observable
isFocused : boolean

See source
True if document is focused.

This property is updated by the FocusObserver. If the FocusObserver is disabled this property will not change.
observable
isReadOnly : boolean

See source
Defines whether document is in read-only mode.

When document is read-ony then all roots are read-only as well and caret placed inside this root is hidden.
observable
isSelecting : boolean

See source
true while the user is making a selection in the document (e.g. holding the mouse button and moving the cursor). When they stop selecting, the property goes back to false.

This property is updated by the SelectionObserver.
readonly
roots : Collection<RootEditableElement>

See source
Roots of the view tree. Collection of the view elements.

View roots are created as a result of binding between roots and roots and this is handled by EditingController, so to create view root we need to create model root using createRoot.
readonly
selection : DocumentSelection

See source
Selection done on this document.
readonly
stylesProcessor : StylesProcessor

See source
The styles processor instance used by this document when normalizing styles.
private readonly
_postFixers : Set<ViewDocumentPostFixer>

See source
Post-fixer callbacks registered to the view document.

Methods

constructor( stylesProcessor )

See source
Creates a Document instance.

Parameters

stylesProcessor : StylesProcessor

The styles processor instance.
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' | 'selection' | 'isReadOnly' | 'isFocused' | 'roots' | 'stylesProcessor' | 'isSelecting' | 'isComposing' | 'getRoot' | 'registerPostFixer' | '_callPostFixers'>

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

Returns

MultiBindChain

The bind chain with the to() and toMany() methods.
inherited
bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Document[ K1 ], K2, Document[ 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, Document[ K1 ], K2, Document[ K2 ]>

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

The bind chain with the to() and toMany() methods.
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' | 'selection' | 'isReadOnly' | 'isFocused' | 'roots' | 'stylesProcessor' | 'isSelecting' | 'isComposing' | 'getRoot' | 'registerPostFixer' | '_callPostFixers'

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

See source
Destroys this instance. Makes sure that all observers are destroyed and listeners removed.

Returns

void
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).
getRoot( name ) → null | RootEditableElement

See source
Gets a view root element with the specified name. If the name is not specific "main" root is returned.

Parameters

name : string

Name of the root.

Defaults to 'main'

Returns

null | RootEditableElement

The view root element with the specified name or null when there is no root of given name.
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
registerPostFixer( postFixer ) → void
See source
Allows registering post-fixer callbacks. A post-fixers mechanism allows to update the view tree just before it is rendered to the DOM.

Post-fixers are executed right after all changes from the outermost change block were applied but before the render event is fired. If a post-fixer callback made a change, it should return true. When this happens, all post-fixers are fired again to check if something else should not be fixed in the new document tree state.

View post-fixers are useful when you want to apply some fixes whenever the view structure changes. Keep in mind that changes executed in a view post-fixer should not break model-view mapping.

The types of changes which should be safe:
- adding or removing attribute from elements,
- changes inside of UI elements,
- marking some of the model elements to be re-converted.
Try to avoid changes which touch view structure:
- you should not add or remove nor wrap or unwrap any view elements,
- you should not change the editor data model in a view post-fixer.
As a parameter, a post-fixer callback receives a downcast writer.

Typically, a post-fixer will look like this:
```
editor.editing.view.document.registerPostFixer( writer => {
	if ( checkSomeCondition() ) {
		writer.doSomething();

		// Let other post-fixers know that something changed.
		return true;
	}

	return false;
} );
```
Note that nothing happens right after you register a post-fixer (e.g. execute such a code in the console). That is because adding a post-fixer does not execute it. The post-fixer will be executed as soon as any change in the document needs to cause its rendering. If you want to re-render the editor's view after registering the post-fixer then you should do it manually by calling view.forceRender().

If you need to register a callback which is executed when DOM elements are already updated, use render event.

Parameters

postFixer : ViewDocumentPostFixer

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 : Document[ 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' | 'selection' | 'isReadOnly' | 'isFocused' | 'roots' | 'stylesProcessor' | 'isSelecting' | 'isComposing' | 'getRoot' | 'registerPostFixer' | '_callPostFixers'>

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

Returns

void
internal
_callPostFixers( writer ) → void

See source
Performs post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model.

Parameters

writer : DowncastWriter

Returns

void

Events

arrowKey( eventInfo, data )

See source
Event fired when the user presses an arrow keys.

Introduced by ArrowKeysObserver.

Note that because ArrowKeysObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : KeyEventData
beforeinput( eventInfo, data )
See source
Fired before the web browser inputs, deletes, or formats some data.

This event is introduced by InputObserver and available by default in all editor instances (attached by View).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : InputEventData

Event data containing detailed information about the event.

Related:
- InputObserver
blur( eventInfo, data )
See source
Fired when one of the editables loses focus.

Introduced by FocusObserver.

Note that because FocusObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<FocusEvent>

Event data.

Related:
- FocusObserver
change:isComposing( eventInfo, name, value, oldValue )

See source
Fired when the isComposing property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isComposing).

value : boolean

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

oldValue : boolean

Old value of the isComposing property with given key or null, if property was not set before.
change:isFocused( eventInfo, name, value, oldValue )

See source
Fired when the isFocused property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isFocused).

value : boolean

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

oldValue : boolean

Old value of the isFocused property with given key or null, if property was not set before.
change:isReadOnly( eventInfo, name, value, oldValue )

See source
Fired when the isReadOnly property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isReadOnly).

value : boolean

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

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
change:isSelecting( eventInfo, name, value, oldValue )

See source
Fired when the isSelecting property changed value.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

name : string

Name of the changed property (isSelecting).

value : boolean

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

oldValue : boolean

Old value of the isSelecting 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.
click( eventInfo, data )
See source
Fired when one of the editables has been clicked.

Introduced by ClickObserver.

Note that this event is not available by default. To make it available ClickObserver needs to be added to View by a addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

Event data.

Related:
- ClickObserver
clipboardInput( eventInfo, data )
See source
Fired as a continuation of the event-paste and event-drop events.

It is a part of the clipboard input pipeline.

This event carries a dataTransfer object which comes from the clipboard and whose content should be processed and inserted into the editor.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- ClipboardObserver
- Clipboard
clipboardOutput( eventInfo, data )
See source
Fired on event-copy and event-cut with a copy of the selected content. The content can be processed before it ends up in the clipboard.

It is a part of the clipboard output pipeline.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : ViewDocumentClipboardOutputEventData

The event data.

Related:
- ClipboardObserver
- ClipboardPipeline
compositionend( eventInfo, data )
See source
Fired when composition ends inside one of the editables.

Introduced by CompositionObserver.

Note that because CompositionObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : CompositionEventData

Event data.

Related:
- CompositionObserver
compositionstart( eventInfo, data )
See source
Fired when composition starts inside one of the editables.

Introduced by CompositionObserver.

Note that because CompositionObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : CompositionEventData

Event data.

Related:
- CompositionObserver
compositionupdate( eventInfo, data )
See source
Fired when composition is updated inside one of the editables.

Introduced by CompositionObserver.

Note that because CompositionObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : CompositionEventData

Event data.

Related:
- CompositionObserver
copy( eventInfo, data )
See source
Fired when the user copied the content from one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- ClipboardObserver
cut( eventInfo, data )
See source
Fired when the user cut the content from one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- ClipboardObserver
delete( eventInfo, data )

See source
Event fired when the user tries to delete content (e.g. presses Delete or Backspace).

Note: This event is fired by the delete observer (usually registered by the delete feature).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DeleteEventData

The event data.
dragend( eventInfo, data )
See source
Fired when the user ended dragging the content.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
dragenter( eventInfo, data )
See source
Fired when the user drags the content into one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
dragging( eventInfo, data )
See source
Fired as a continuation of the event-dragover event.

It is a part of the clipboard input pipeline.

This event carries a dataTransfer object which comes from the clipboard and whose content should be processed and inserted into the editor.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- ClipboardObserver
- Clipboard
dragleave( eventInfo, data )
See source
Fired when the user drags the content out of one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
dragover( eventInfo, data )
See source
Fired when the user drags the content over one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
dragstart( eventInfo, data )
See source
Fired when the user starts dragging the content in one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
drop( eventInfo, data )
See source
Fired when the user dropped the content into one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
enter( eventInfo, <anonymous> )

See source
Fired when the user presses the Enter key.

Note: This event is fired by the observer (usually registered by the Enter feature and ShiftEnter feature).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : EnterEventData
focus( eventInfo, data )
See source
Fired when one of the editables gets focus.

Introduced by FocusObserver.

Note that because FocusObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<FocusEvent>

Event data.

Related:
- FocusObserver
imageLoaded( eventInfo, data )
See source
Fired when an DOM element has been loaded in the DOM root.

Introduced by ImageLoadObserver.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : Event

Event data.

Related:
- ImageLoadObserver
insertText( eventInfo, data )

See source
Event fired when the user types text, for instance presses A or ? in the editing view document.

Note: This event will not fire for keystrokes such as Delete or Enter. They have dedicated events, see event-delete and event-enter to learn more.

Note: This event is fired by the input feature.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : InsertTextEventData

The event data.
keydown( eventInfo, data )
See source
Fired when a key has been pressed.

Introduced by KeyObserver.

Note that because KeyObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : KeyEventData

Related:
- KeyObserver
keyup( eventInfo, data )
See source
Fired when a key has been released.

Introduced by KeyObserver.

Note that because KeyObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : KeyEventData

Related:
- KeyObserver
layoutChanged( eventInfo )

See source
Event fired whenever document content layout changes. It is fired whenever content is rendered, but should be also fired by observers in case of other actions which may change layout, for instance when image loads.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
mousedown( eventInfo, data )
See source
Fired when the mouse button is pressed down on one of the editing roots of the editor.

Introduced by MouseObserver.

Note that this event is not available by default. To make it available, MouseObserver needs to be added to View by the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

The event data.

Related:
- MouseObserver
mouseleave( eventInfo, data )
See source
Fired when the mouse is moved out of one of the editables.

Introduced by MouseEventsObserver.

Note that this event is not available by default. To make it available, MouseEventsObserver needs to be added to View using the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

Event data.

Related:
- MouseEventsObserver
mousemove( eventInfo, data )
See source
Fired when the mouse is moved over one of the editables.

Introduced by MouseEventsObserver.

Note that this event is not available by default. To make it available, MouseEventsObserver needs to be added to View using the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

Event data.

Related:
- MouseEventsObserver
mouseout( eventInfo, data )
See source
Fired when the mouse is moved out of the one of the editing roots of the editor.

Introduced by MouseObserver.

Note that this event is not available by default. To make it available, MouseObserver needs to be added to View by the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

The event data.

Related:
- MouseObserver
mouseover( eventInfo, data )
See source
Fired when the mouse is over one of the editing roots of the editor.

Introduced by MouseObserver.

Note that this event is not available by default. To make it available, MouseObserver needs to be added to View by the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

The event data.

Related:
- MouseObserver
mouseup( eventInfo, data )
See source
Fired when the mouse button is released over one of the editing roots of the editor.

Introduced by MouseObserver.

Note that this event is not available by default. To make it available, MouseObserver needs to be added to View by the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<MouseEvent>

The event data.

Related:
- MouseObserver
mutations( eventInfo, data )

See source
Event fired on DOM mutations detected.

This event is introduced by MutationObserver and available by default in all editor instances (attached by View).

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : MutationsEventData

Event data containing detailed information about the event.
paste( eventInfo, data )
See source
Fired when the user pasted the content into one of the editing roots of the editor.

Introduced by ClipboardObserver.

Note: This event is not available by default. To make it available, ClipboardObserver needs to be added to the Document by using the addObserver method. This is usually done by the Clipboard plugin, but if for some reason it is not loaded, the observer must be added manually.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : object

The event data.

Related:
- Document#event:clipboardInput
selectionChange( eventInfo, <anonymous> )
See source
Fired when a selection has changed. This event is fired only when the selection change was the only change that happened in the document, and the old selection is different then the new selection.

Introduced by SelectionObserver.

Note that because SelectionObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : ViewDocumentSelectionEventData

Related:
- SelectionObserver
selectionChangeDone( eventInfo, <anonymous> )
See source
Fired when selection stops changing.

Introduced by SelectionObserver.

Note that because SelectionObserver is attached by the View this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

<anonymous> : ViewDocumentSelectionEventData

Related:
- SelectionObserver
set:isComposing( eventInfo, name, value, oldValue )

See source
Fired when the isComposing 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 (isComposing).

value : boolean

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

oldValue : boolean

Old value of the isComposing property with given key or null, if property was not set before.
set:isFocused( eventInfo, name, value, oldValue )

See source
Fired when the isFocused 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 (isFocused).

value : boolean

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

oldValue : boolean

Old value of the isFocused property with given key or null, if property was not set before.
set:isReadOnly( eventInfo, name, value, oldValue )

See source
Fired when the isReadOnly 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 (isReadOnly).

value : boolean

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

oldValue : boolean

Old value of the isReadOnly property with given key or null, if property was not set before.
set:isSelecting( eventInfo, name, value, oldValue )

See source
Fired when the isSelecting 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 (isSelecting).

value : boolean

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

oldValue : boolean

Old value of the isSelecting 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.
tab( eventInfo, data )

See source
Event fired when the user presses a tab key.

Introduced by TabObserver.

Note that because TabObserver is attached by the View, this event is available by default.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : KeyEventData
todoCheckboxChange( eventInfo, data )
See source
Fired when the to-do list checkbox is toggled.

Introduced by TodoCheckboxChangeObserver.

Note that this event is not available by default. To make it available, TodoCheckboxChangeObserver needs to be added to View by the addObserver method.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

data : DomEventData<Event>

The event data.

Related:
- TodoCheckboxChangeObserver

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.

Document (engine/view)

Filtering

Properties

observable isComposing : booleanmodule:engine/view/document~Document#isComposing

observable isFocused : booleanmodule:engine/view/document~Document#isFocused

observable isReadOnly : booleanmodule:engine/view/document~Document#isReadOnly

observable isSelecting : booleanmodule:engine/view/document~Document#isSelecting

readonly roots : Collection<RootEditableElement>module:engine/view/document~Document#roots

readonly selection : DocumentSelectionmodule:engine/view/document~Document#selection

readonly stylesProcessor : StylesProcessormodule:engine/view/document~Document#stylesProcessor

private readonly _postFixers : Set<ViewDocumentPostFixer>module:engine/view/document~Document#_postFixers

Methods

constructor( stylesProcessor )module:engine/view/document~Document#constructor

Parameters

inherited bind( bindProperties ) → MultiBindChainmodule:engine/view/document~Document#bind:MANY_BIND

Parameters

Returns

inherited bind( bindProperty1, bindProperty2 ) → DualBindChain<K1, Document[ K1 ], K2, Document[ K2 ]>module:engine/view/document~Document#bind:DUAL_BIND

Type parameters

Parameters

Returns

inherited bind( bindProperty ) → SingleBindChain<K, Document[ K ]>module:engine/view/document~Document#bind:SINGLE_BIND

Type parameters

Parameters

Returns

inherited decorate( methodName ) → voidmodule:engine/view/document~Document#decorate

Parameters

Returns

inherited delegate( events ) → EmitterMixinDelegateChainmodule:engine/view/document~Document#delegate

Parameters

Returns

destroy() → voidmodule:engine/view/document~Document#destroy

Returns

inherited fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]module:engine/view/document~Document#fire

Type parameters

Parameters

Returns

getRoot( name ) → null | RootEditableElementmodule:engine/view/document~Document#getRoot

Parameters

Returns

inherited listenTo( emitter, event, callback, [ options ] ) → voidmodule:engine/view/document~Document#listenTo:BASE_EMITTER

Type parameters

Parameters

Returns

inherited off( event, callback ) → voidmodule:engine/view/document~Document#off

Parameters

Returns

inherited on( event, callback, [ options ] ) → voidmodule:engine/view/document~Document#on

Type parameters

Parameters

Returns

inherited once( event, callback, [ options ] ) → voidmodule:engine/view/document~Document#once

Type parameters

Parameters

Returns

registerPostFixer( postFixer ) → voidmodule:engine/view/document~Document#registerPostFixer

Parameters

Returns

inherited set( values ) → voidmodule:engine/view/document~Document#set:OBJECT

Parameters

Returns

inherited set( name, value ) → voidmodule:engine/view/document~Document#set:KEY_VALUE

Type parameters

Parameters

Returns

inherited stopDelegating( [ event ], [ emitter ] ) → voidmodule:engine/view/document~Document#stopDelegating

Parameters

Returns

inherited stopListening( [ emitter ], [ event ], [ callback ] ) → voidmodule:engine/view/document~Document#stopListening:BASE_STOP

Parameters

Returns

inherited unbind( unbindProperties ) → voidmodule:engine/view/document~Document#unbind

Parameters

Returns

internal _callPostFixers( writer ) → voidmodule:engine/view/document~Document#_callPostFixers

Parameters

Returns

Events

arrowKey( eventInfo, data )module:engine/view/document~Document#event:arrowKey

Parameters

observable
`isComposing : boolean`

observable
`isFocused : boolean`

observable
`isReadOnly : boolean`

observable
`isSelecting : boolean`

readonly
`roots : Collection<RootEditableElement>`

readonly
`selection : DocumentSelection`

readonly
`stylesProcessor : StylesProcessor`

private readonly
`_postFixers : Set<ViewDocumentPostFixer>`

`constructor( stylesProcessor )`

inherited
`bind( bindProperties ) → MultiBindChain`

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

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

inherited
`decorate( methodName ) → void`

inherited
`delegate( events ) → EmitterMixinDelegateChain`

`destroy() → void`

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

`getRoot( name ) → null | RootEditableElement`

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

inherited
`off( event, callback ) → void`

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

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

`registerPostFixer( postFixer ) → 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`

internal
`_callPostFixers( writer ) → void`

`arrowKey( eventInfo, data )`

`beforeinput( eventInfo, data )`

`blur( eventInfo, data )`

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

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

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

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

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

`click( eventInfo, data )`

`clipboardInput( eventInfo, data )`

`clipboardOutput( eventInfo, data )`

`compositionend( eventInfo, data )`

`compositionstart( eventInfo, data )`

`compositionupdate( eventInfo, data )`

`copy( eventInfo, data )`

`cut( eventInfo, data )`

`delete( eventInfo, data )`

`dragend( eventInfo, data )`

`dragenter( eventInfo, data )`

`dragging( eventInfo, data )`

`dragleave( eventInfo, data )`

`dragover( eventInfo, data )`

`dragstart( eventInfo, data )`

`drop( eventInfo, data )`

`enter( eventInfo, <anonymous> )`

`focus( eventInfo, data )`

`imageLoaded( eventInfo, data )`