Creates a Document instance.
The styles processor instance.
ReadonlyisTrue if composition is in progress inside the document.
This property is updated by the module:engine/view/observer/compositionobserver~CompositionObserver. If the module:engine/view/observer/compositionobserver~CompositionObserver is disabled this property will not change.
ReadonlyisTrue if document is focused.
This property is updated by the module:engine/view/observer/focusobserver~FocusObserver. If the module:engine/view/observer/focusobserver~FocusObserver is disabled this property will not change.
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.
Readonlyistrue 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 module:engine/view/observer/selectionobserver~SelectionObserver.
ReadonlyrootsRoots of the view tree. Collection of the module:engine/view/element~ViewElement view elements.
View roots are created as a result of binding between module:engine/view/document~ViewDocument#roots and module:engine/model/document~ModelDocument#roots and this is handled by module:engine/controller/editingcontroller~EditingController, so to create view root we need to create model root using module:engine/model/document~ModelDocument#createRoot.
ReadonlyselectionSelection done on this document.
ReadonlystylesThe styles processor instance used by this document when normalizing styles.
InternalPerforms post-fixer loops. Executes post-fixer callbacks as long as none of them has done any changes to the model.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings 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,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#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 );
Observable property that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings 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,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#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 );
The bind chain with the to() and toMany() methods.
Binds #set observable properties to other objects implementing the module:utils/observablemixin~Observable interface.
Read more in the {@glink framework/deep-dive/observables#property-bindings 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,command.isEnabled changes, button.isEnabled will immediately reflect its value.Note: To release the binding, use module:utils/observablemixin~Observable#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 );
Observable properties that will be bound to other observable(s).
The bind chain with the to() and toMany() methods.
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 {@glink framework/deep-dive/observables#decorating-object-methods 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 module:utils/eventinfo~EventInfo#stop 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 module:utils/priorities~PriorityString 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'
Name of the method to decorate.
Delegates selected events to another module:utils/emittermixin~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 );
Event names that will be delegated to another emitter.
Destroys this instance. Makes sure that all observers are destroyed and listeners removed.
Fires an event, executing all callbacks registered for it.
The first parameter passed to callbacks is an module:utils/eventinfo~EventInfo object,
followed by the optional args provided in the fire() method call.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The name of the event or EventInfo object if event is delegated.
Additional arguments to be passed to the callbacks.
By default the method returns undefined. However, the return value can be changed by listeners
through modification of the module:utils/eventinfo~EventInfo#return evt.return's property (the event info
is the first param of every callback).
Gets a module:engine/view/document~ViewDocument#roots view root element with the specified name. If the name is not specific "main" root is returned.
Optionalname: stringName of the root.
The view root element with the specified name or null when there is no root of given name.
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 module:utils/eventinfo~EventInfo#stop stop the event and set the module:utils/eventinfo~EventInfo#return return value of the #fire method.
The type describing the event. See module:utils/emittermixin~BaseEvent.
The object that fires the event.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
Stops executing the callback on the given event.
Shorthand for #stopListening this.stopListening( this, event, callback ).
The name of the event.
The function to stop being called.
Registers a callback function to be executed when an event is fired.
Shorthand for #listenTo this.listenTo( this, event, callback, options ) (it makes the emitter
listen on itself).
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
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.
The type descibing the event. See module:utils/emittermixin~BaseEvent.
The name of the event.
The function to be called on event.
Optionaloptions: GetCallbackOptions<TEvent>Additional options.
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 module:engine/view/view~EditingView#event:render 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:
Try to avoid changes which touch view structure:
As a parameter, a post-fixer callback receives a module:engine/view/downcastwriter~ViewDowncastWriter 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
module:engine/view/view~EditingView#forceRender view.forceRender().
If you need to register a callback which is executed when DOM elements are already updated, use module:engine/view/view~EditingView#event:render render event.
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 );
}
The property's name.
The property's value.
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'
} );
}
An object with name=>value pairs.
Optional_callPostFixers?: unknownOptionalbind?: unknownOptionaldecorate?: unknownOptionaldelegate?: unknownOptionaldestroy?: unknownOptionalfire?: unknownOptionalgetRoot?: unknownOptional ReadonlyisComposing?: unknownTrue if composition is in progress inside the document.
This property is updated by the module:engine/view/observer/compositionobserver~CompositionObserver. If the module:engine/view/observer/compositionobserver~CompositionObserver is disabled this property will not change.
Optional ReadonlyisFocused?: unknownTrue if document is focused.
This property is updated by the module:engine/view/observer/focusobserver~FocusObserver. If the module:engine/view/observer/focusobserver~FocusObserver is disabled this property will not change.
Optional ReadonlyisReadOnly?: unknownDefines 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.
Optional ReadonlyisSelecting?: unknowntrue 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 module:engine/view/observer/selectionobserver~SelectionObserver.
OptionallistenTo?: unknownOptionaloff?: unknownOptionalon?: unknownOptionalonce?: unknownOptionalregisterPostFixer?: unknownOptional Readonlyroots?: unknownRoots of the view tree. Collection of the module:engine/view/element~ViewElement view elements.
View roots are created as a result of binding between module:engine/view/document~ViewDocument#roots and module:engine/model/document~ModelDocument#roots and this is handled by module:engine/controller/editingcontroller~EditingController, so to create view root we need to create model root using module:engine/model/document~ModelDocument#createRoot.
Optional Readonlyselection?: unknownSelection done on this document.
Optionalset?: unknownOptionalstopDelegating?: unknownOptionalstopListening?: unknownOptional ReadonlystylesProcessor?: unknownThe styles processor instance used by this document when normalizing styles.
Optionalunbind?: unknownStops delegating events. It can be used at different levels:
Optionalevent: stringThe name of the event to stop delegating. If omitted, stops it all delegations.
Optionalemitter: Emitter(requires event) The object to stop delegating a particular event to.
If omitted, stops delegation of event to all emitters.
Stops listening for events. It can be used at different levels:
Optionalemitter: EmitterThe object to stop listening to. If omitted, stops it for all objects.
Optionalevent: string(Requires the emitter) The name of the event to stop listening to. If omitted, stops it
for all events from emitter.
Optionalcallback: Function(Requires the event) The function to be removed from the call list for the given
event.
Removes the binding created with #bind.
// Removes the binding for the 'a' property.
A.unbind( 'a' );
// Removes bindings for all properties.
A.unbind();
Observable properties to be unbound. All the bindings will be released if no properties are provided.
Document class creates an abstract layer over the content editable area, contains a tree of view elements and module:engine/view/documentselection~ViewDocumentSelection view selection associated with this document.