EditableElement (engine/view)

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

class

Editable element which can be a root or nested editable area in the editor.

Editable is automatically read-only when its Document is read-only.

The constructor of this class shouldn't be used directly. To create new EditableElement use the downcastWriter#createEditableElement() method.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

childCount : Number

readonly inherited

Number of element's children.

See source
document : Document

readonly inherited

The document instance to which this node belongs.

See source
index : Number | null

readonly inherited

Index of the node in the parent element or null if the node has no parent.

See source

Accessing this property throws an error if this node's parent element does not contain it. This means that view tree got broken.
isEmpty : Boolean

readonly inherited

Is true if there are no nodes inside this element, false otherwise.

See source
isFocused : Boolean

readonly observable

Whether the editable is focused.

See source

This property updates when document.isFocused or view selection is changed.
isReadOnly : Boolean

observable

Whether the editable is in read-write or read-only mode.

See source
name : String

readonly inherited

Name of the element.

See source
nextSibling : Node | null

readonly inherited

Node's next sibling, or null if it is the last child.

See source
parent : Element | DocumentFragment | null

readonly inherited

Parent element. Null by default. Set by _insertChild.

See source
previousSibling : Node | null

readonly inherited

Node's previous sibling, or null if it is the first child.

See source
root : Node | DocumentFragment

readonly inherited

Top-most ancestor of the node. If the node has no parent it is the root itself.

See source
_attrs : Map

protected inherited

Map of attributes, where attributes names are keys and attributes values are values.

See source
_children : Array.<Node>

protected inherited

Array of child nodes.

See source
_classes : Set

protected inherited

Set of classes associated with element instance.

See source
_customProperties : Map

protected inherited

Map of custom properties. Custom properties can be added to element instance, will be cloned but not rendered into DOM.

See source
_styles : StylesMap

protected inherited

Normalized styles.

See source
_unsafeAttributesToRender : Array.<String>

private readonly inherited

A list of attribute names that should be rendered in the editing pipeline even though filtering mechanisms implemented in the DomConverter (for instance, shouldRenderAttribute) would filter them out.

See source

These attributes can be specified as an option when the element is created by the DowncastWriter. To check whether an unsafe an attribute should be permitted, use the shouldRenderUnsafeAttribute method.

Methods

constructor()

protected
Creates an editable element.

See source
Related:
- DowncastWriter#createEditableElement
bind( bindProperties ) → Object

mixed
Binds observable properties to other objects implementing the Observable interface.

See source
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.
decorate( methodName )

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

See source
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.
delegate( events ) → EmitterMixinDelegateChain

mixed
Delegates selected events to another Emitter. For instance:

See source
```
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
findAncestor( patterns ) → Element | null

inherited
Returns ancestor element that match specified pattern. Provided patterns should be compatible with Matcher as it is used internally.

See source
Parameters

patterns : Object | String | RegExp | function

Patterns used to match correct ancestor. See Matcher.

Returns

Element | null

Found element or null if no matching ancestor was found.

Related:
- Matcher
fire( eventOrInfo, [ args ] ) → *

mixed

Fires an event, executing all callbacks registered for it.

See source

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).
getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array

inherited

Returns ancestors array of this node.

See source

Parameters

options : Object

Options object.

Properties

[ options.includeSelf ] : Boolean

When set to true this node will be also included in parent's array.

Defaults to false

[ options.parentFirst ] : Boolean

When set to true, array will be sorted from node's parent to root element, otherwise root element will be the first item in the array.

Defaults to false

Returns

Array

Array with ancestors.
getAttribute( key ) → String | undefined

inherited

Gets attribute by key. If attribute is not present - returns undefined.

See source

Parameters

key : String

Attribute key.

Returns

String | undefined

Attribute value.
getAttributeKeys() → Iterable.<String>

inherited

Returns an iterator that contains the keys for attributes. Order of inserting attributes is not preserved.

See source

Returns

Iterable.<String>

Keys for attributes.
getAttributes() → Iterable.<*>

inherited

Returns iterator that iterates over this element's attributes.

See source

Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value. This format is accepted by native Map object and also can be passed in Node constructor.

Returns

Iterable.<*>
getChild( index ) → Node

inherited

Gets child at the given index.

See source

Parameters

index : Number

Index of child.

Returns

Node

Child node.
getChildIndex( node ) → Number

inherited

Gets index of the given child node. Returns -1 if child node is not found.

See source

Parameters

node : Node

Child node.

Returns

Number

Index of the child node.
getChildren() → Iterable.<Node>

inherited

Gets child nodes iterator.

See source

Returns

Iterable.<Node>

Child nodes iterator.
getClassNames() → Iterable.<String>

inherited

Returns iterator that contains all class names.

See source

Returns

Iterable.<String>
getCommonAncestor( node, options = { [options.includeSelf] } ) → Element | DocumentFragment | null

inherited

Returns a Element or DocumentFragment which is a common ancestor of both nodes.

See source

Parameters

node : Node

The second node.

options : Object

Options object.

Properties

[ options.includeSelf ] : Boolean

When set to true both nodes will be considered "ancestors" too. Which means that if e.g. node A is inside B, then their common ancestor will be B.

Defaults to false

Returns

Element | DocumentFragment | null
getCustomProperties() → Iterable.<*>

inherited

Returns an iterator which iterates over this element's custom properties. Iterator provides [ key, value ] pairs for each stored property.

See source

Returns

Iterable.<*>
getCustomProperty( key ) → *

inherited

Returns the custom property value for the given key.

See source

Parameters

key : String | Symbol

Returns

*
getFillerOffset()

inherited

Returns block filler offset or null if block filler is not needed.

See source
getIdentity() → String

inherited
Returns identity string based on element's name, styles, classes and other attributes. Two elements that are similar will have same identity string. It has the following format:

See source
```
'name class="class1,class2" style="style1:value1;style2:value2" attr1="val1" attr2="val2"'
```
For example:
```
const element = writer.createContainerElement( 'foo', {
	banana: '10',
	apple: '20',
	style: 'color: red; border-color: white;',
	class: 'baz'
} );

// returns 'foo class="baz" style="border-color:white;color:red" apple="20" banana="10"'
element.getIdentity();
```
Note: Classes, styles and other attributes are sorted alphabetically.

Returns

String
getNormalizedStyle( property ) → Object | String | undefined

inherited
Returns a normalized style object or single style value.

See source
For an element with style set to: margin:1px 2px 3em;
```
element.getNormalizedStyle( 'margin' ) );
```
will return:
```
{
	top: '1px',
	right: '2px',
	bottom: '3em',
	left: '2px'    // a normalized value from margin shorthand
}
```
and reading for single style value:
```
styles.getNormalizedStyle( 'margin-left' );
```
Will return a 2px string.

Note: This method will return normalized values only if a particular style processor rule is enabled. See StylesMap#getNormalized() for details.

Parameters

property : String

Name of CSS property

Returns

Object | String | undefined

`getPath() → Array.<Number>`

inherited

Gets a path to the node. The path is an array containing indices of consecutive ancestors of this node, beginning from root, down to this node's index.

See source

const abc = downcastWriter.createText( 'abc' );
const foo = downcastWriter.createText( 'foo' );
const h1 = downcastWriter.createElement( 'h1', null, downcastWriter.createText( 'header' ) );
const p = downcastWriter.createElement( 'p', null, [ abc, foo ] );
const div = downcastWriter.createElement( 'div', null, [ h1, p ] );
foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
h1.getPath(); // Returns [ 0 ].
div.getPath(); // Returns [].

Returns

Array.<Number>: The path.

getStyle( property ) → String | undefined

inherited
Returns style value for the given property mae. If the style does not exist undefined is returned.

See source
Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#getAsString() for details.

For an element with style set to 'margin:1px':
```
// Enable 'margin' shorthand processing:
editor.data.addStyleProcessorRules( addMarginRules );

const element = view.change( writer => {
	const element = writer.createElement();
	writer.setStyle( 'margin', '1px' );
	writer.setStyle( 'margin-bottom', '3em' );

	return element;
} );

element.getStyle( 'margin' ); // -> 'margin: 1px 1px 3em;'
```
Parameters

property : String

Returns

String | undefined
getStyleNames( [ expand ] ) → Iterable.<String>

inherited

Returns iterator that contains all style names.

See source

Parameters

[ expand ] : Boolean

Expand shorthand style properties and return all equivalent style representations.

Defaults to false

Returns

Iterable.<String>
hasAttribute( key ) → Boolean

inherited

Returns a boolean indicating whether an attribute with the specified key exists in the element.

See source

Parameters

key : String

Attribute key.

Returns

Boolean

true if attribute with the specified key exists in the element, false otherwise.
hasClass( className )

inherited
Returns true if class is present. If more then one class is provided - returns true only when all classes are present.

See source
```
element.hasClass( 'foo' ); // Returns true if 'foo' class is present.
element.hasClass( 'foo', 'bar' ); // Returns true if 'foo' and 'bar' classes are both present.
```
Parameters

className : String
hasStyle( property )

inherited
Returns true if style keys are present. If more then one style property is provided - returns true only when all properties are present.

See source
```
element.hasStyle( 'color' ); // Returns true if 'border-top' style is present.
element.hasStyle( 'color', 'border-top' ); // Returns true if 'color' and 'border-top' styles are both present.
```
Parameters

property : String
is( type ) → Boolean

inherited
Checks whether this object is of the given type.

See source
This method is useful when processing view objects that are of unknown type. For example, a function may return a DocumentFragment or a Node that can be either a text node or an element. This method can be used to check what kind of object is returned.
```
someObject.is( 'element' ); // -> true if this is an element
someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
someObject.is( 'documentFragment' ); // -> true if this is a document fragment
```
Since this method is also available on a range of model objects, you can prefix the type of the object with model: or view: to check, for example, if this is the model's or view's element:
```
viewElement.is( 'view:element' ); // -> true
viewElement.is( 'model:element' ); // -> false
```
By using this method it is also possible to check a name of an element:
```
imgElement.is( 'element', 'img' ); // -> true
imgElement.is( 'view:element', 'img' ); // -> same as above, but more precise
```
The list of view objects which implement the is() method:
Parameters

type : String

Type to check.

Returns

Boolean
isAfter( node ) → Boolean

inherited

Returns whether this node is after given node. false is returned if nodes are in different trees (for example, in different DocumentFragments).

See source

Parameters

node : Node

Node to compare with.

Returns

Boolean
isAttached() → Boolean

inherited

Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).

See source

Returns

Boolean
isBefore( node ) → Boolean

inherited

Returns whether this node is before given node. false is returned if nodes are in different trees (for example, in different DocumentFragments).

See source

Parameters

node : Node

Node to compare with.

Returns

Boolean
isSimilar() → Boolean

inherited

Checks if provided node is similar to this node.

See source

Returns

Boolean

True if nodes are similar.
listenTo( emitter, event, callback, [ options ] = { [options.priority] } )

mixed
Registers a callback function to be executed when an event is fired in a specific (emitter) object.

See source
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 {}
off( event, callback )

mixed

Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
on( event, callback, [ options ] = { [options.priority] } )

mixed

Registers a callback function to be executed when an event is fired.

See source

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 {}
once( event, callback, [ options ] = { [options.priority] } )

mixed

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.

See source

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 {}
set( name, [ value ] )

mixed

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

See source

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).
shouldRenderUnsafeAttribute( attributeName ) → Boolean

inherited

Decides whether an unsafe attribute is whitelisted and should be rendered in the editing pipeline even though filtering mechanisms like shouldRenderAttribute say it should not.

See source

Unsafe attribute names can be specified when creating an element via DowncastWriter.

Parameters

attributeName : String

The name of the attribute to be checked.

Returns

Boolean
stopDelegating( [ event ], [ emitter ] )

mixed
Stops delegating events. It can be used at different levels:

See source
- 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.
stopListening( [ emitter ], [ event ], [ callback ] )

mixed
Stops listening for events. It can be used at different levels:

See source
- 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.
toJSON() → Object

inherited

Custom toJSON method to solve child-parent circular dependencies.

See source

Returns

Object

Clone of this object with the parent property removed.
unbind( [ unbindProperties ] )

mixed
Removes the binding created with bind.

See source
```
// 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.
_addClass( className )

protected inherited
Adds specified class.

See source
```
element._addClass( 'foo' ); // Adds 'foo' class.
element._addClass( [ 'foo', 'bar' ] ); // Adds 'foo' and 'bar' classes.
```
Parameters

className : Array.<String> | String

Fires
- change
Related:
- DowncastWriter#addClass
_addEventListener( event, callback, [ options ] = { [options.priority] } )

protected mixed

Adds callback to emitter for given event.

See source

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 {}
_appendChild( items ) → Number

protected inherited
Insert a child node or a list of child nodes at the end of this node and sets the parent of these nodes to this element.

See source
Parameters

items : Item | Iterable.<Item>

Items to be inserted.

Returns

Number

Number of appended nodes.

Fires
- change
Related:
- DowncastWriter#insert
_clone() → Node

protected inherited

Clones this node.

See source

Returns

Node

Clone of this node.
_fireChange( type, node )

protected inherited
Parameters

type : ChangeType

Type of the change.

node : Node

Changed node.

Fires
- change
_insertChild( index, items ) → Number

protected inherited
Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to this element.

See source
Parameters

index : Number

Position where nodes should be inserted.

items : Item | Iterable.<Item>

Items to be inserted.

Returns

Number

Number of inserted nodes.

Fires
- change
Related:
- DowncastWriter#insert
_remove()

protected inherited

Removes node from parent.

See source
_removeAttribute( key ) → Boolean

protected inherited
Removes attribute from the element.

See source
Parameters

key : String

Attribute key.

Returns

Boolean

Returns true if an attribute existed and has been removed.

Fires
- change
Related:
- DowncastWriter#removeAttribute
_removeChildren( index, [ howMany ] ) → Array.<Node>

protected inherited
Removes number of child nodes starting at the given index and set the parent of these nodes to null.

See source
Parameters

index : Number

Number of the first node to remove.

[ howMany ] : Number

Number of nodes to remove.

Defaults to 1

Returns

Array.<Node>

The array of removed nodes.

Fires
- change
Related:
- DowncastWriter#remove
_removeClass( className )

protected inherited
Removes specified class.

See source
```
element._removeClass( 'foo' );  // Removes 'foo' class.
element._removeClass( [ 'foo', 'bar' ] ); // Removes both 'foo' and 'bar' classes.
```
Parameters

className : Array.<String> | String

Fires
- change
Related:
- DowncastWriter#removeClass
_removeCustomProperty( key ) → Boolean

protected inherited
Removes the custom property stored under the given key.

See source
Parameters

key : String | Symbol

Returns

Boolean

Returns true if property was removed.

Related:
- DowncastWriter#removeCustomProperty
_removeEventListener( event, callback )

protected mixed

Removes callback from emitter for given event.

See source

Parameters

event : String

The name of the event.

callback : function

The function to stop being called.
_removeStyle( property )

protected inherited
Removes specified style.

See source
```
element._removeStyle( 'color' );  // Removes 'color' style.
element._removeStyle( [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles.
```
Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#remove() for details.

Parameters

property : Array.<String> | String

Fires
- change
Related:
- DowncastWriter#removeStyle
_setAttribute( key, value )

protected inherited
Adds or overwrite attribute with a specified key and value.

See source
Parameters

key : String

Attribute key.

value : String

Attribute value.

Fires
- change
Related:
- DowncastWriter#setAttribute
_setCustomProperty( key, value )

protected inherited
Sets a custom property. Unlike attributes, custom properties are not rendered to the DOM, so they can be used to add special data to elements.

See source
Parameters

key : String | Symbol

value : *

Related:
- DowncastWriter#setCustomProperty
_setStyle( property, [ value ] )

protected inherited
Adds style to the element.

See source
```
element._setStyle( 'color', 'red' );
element._setStyle( {
	color: 'red',
	position: 'fixed'
} );
```
Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#set() for details.

Parameters

property : String | Object

Property name or object with key - value pairs.

[ value ] : String

Value to set. This parameter is ignored if object is provided as the first parameter.

Fires
- change
Related:
- DowncastWriter#setStyle

Events

change( eventInfo )

inherited

Parameters

eventInfo : EventInfo

An object containing information about the fired event.
change:attributes( eventInfo, changedNode )

inherited

Fired when list of elements attributes changes.

See source

Change event is bubbled – it is fired on all ancestors.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : Node
change:children( eventInfo, changedNode )

inherited

Fired when list of elements children changes.

See source

Change event is bubbled – it is fired on all ancestors.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : Node
change:isFocused( eventInfo, name, value, oldValue )

Fired when the isFocused property changed value.

See source

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 )

Fired when the isReadOnly property changed value.

See source

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:text( eventInfo, changedNode )

inherited

Fired when text nodes data changes.

See source

Change event is bubbled – it is fired on all ancestors.

Parameters

eventInfo : EventInfo

An object containing information about the fired event.

changedNode : Node
change:{property}( eventInfo, name, value, oldValue )

mixed
Fired when a property changed value.

See source
```
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.

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

mixed

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

See source

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 an outdated information? Is something missing? Please report it via our issue tracker.

EditableElement (engine/view)

Filtering

Properties

childCount : Numbermodule:engine/view/editableelement~EditableElement#childCount

document : Documentmodule:engine/view/editableelement~EditableElement#document

index : Number | nullmodule:engine/view/editableelement~EditableElement#index

isEmpty : Booleanmodule:engine/view/editableelement~EditableElement#isEmpty

isFocused : Booleanmodule:engine/view/editableelement~EditableElement#isFocused

isReadOnly : Booleanmodule:engine/view/editableelement~EditableElement#isReadOnly

name : Stringmodule:engine/view/editableelement~EditableElement#name

nextSibling : Node | nullmodule:engine/view/editableelement~EditableElement#nextSibling

parent : Element | DocumentFragment | nullmodule:engine/view/editableelement~EditableElement#parent

previousSibling : Node | nullmodule:engine/view/editableelement~EditableElement#previousSibling

root : Node | DocumentFragmentmodule:engine/view/editableelement~EditableElement#root

_attrs : Mapmodule:engine/view/editableelement~EditableElement#_attrs

_children : Array.<Node>module:engine/view/editableelement~EditableElement#_children

_classes : Setmodule:engine/view/editableelement~EditableElement#_classes

_customProperties : Mapmodule:engine/view/editableelement~EditableElement#_customProperties

_styles : StylesMapmodule:engine/view/editableelement~EditableElement#_styles

_unsafeAttributesToRender : Array.<String>module:engine/view/editableelement~EditableElement#_unsafeAttributesToRender

Methods

constructor()module:engine/view/editableelement~EditableElement#constructor

Related:

bind( bindProperties ) → Objectmodule:engine/view/editableelement~EditableElement#bind

Parameters

Returns

decorate( methodName )module:engine/view/editableelement~EditableElement#decorate

Parameters

delegate( events ) → EmitterMixinDelegateChainmodule:engine/view/editableelement~EditableElement#delegate

Parameters

Returns

findAncestor( patterns ) → Element | nullmodule:engine/view/editableelement~EditableElement#findAncestor

Parameters

Returns

Related:

fire( eventOrInfo, [ args ] ) → *module:engine/view/editableelement~EditableElement#fire

Parameters

Returns

getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Arraymodule:engine/view/editableelement~EditableElement#getAncestors

Parameters

Returns

getAttribute( key ) → String | undefinedmodule:engine/view/editableelement~EditableElement#getAttribute

Parameters

Returns

getAttributeKeys() → Iterable.<String>module:engine/view/editableelement~EditableElement#getAttributeKeys

Returns

getAttributes() → Iterable.<*>module:engine/view/editableelement~EditableElement#getAttributes

Returns

getChild( index ) → Nodemodule:engine/view/editableelement~EditableElement#getChild

Parameters

Returns

getChildIndex( node ) → Numbermodule:engine/view/editableelement~EditableElement#getChildIndex

Parameters

Returns

getChildren() → Iterable.<Node>module:engine/view/editableelement~EditableElement#getChildren

Returns

getClassNames() → Iterable.<String>module:engine/view/editableelement~EditableElement#getClassNames

Returns

getCommonAncestor( node, options = { [options.includeSelf] } ) → Element | DocumentFragment | nullmodule:engine/view/editableelement~EditableElement#getCommonAncestor

Parameters

Returns

getCustomProperties() → Iterable.<*>module:engine/view/editableelement~EditableElement#getCustomProperties

Returns

getCustomProperty( key ) → *module:engine/view/editableelement~EditableElement#getCustomProperty

Parameters

Returns

getFillerOffset()module:engine/view/editableelement~EditableElement#getFillerOffset

getIdentity() → Stringmodule:engine/view/editableelement~EditableElement#getIdentity

Returns

getNormalizedStyle( property ) → Object | String | undefinedmodule:engine/view/editableelement~EditableElement#getNormalizedStyle

Parameters

Returns

getPath() → Array.<Number>module:engine/view/editableelement~EditableElement#getPath

Returns

getStyle( property ) → String | undefinedmodule:engine/view/editableelement~EditableElement#getStyle

Parameters

Returns

getStyleNames( [ expand ] ) → Iterable.<String>module:engine/view/editableelement~EditableElement#getStyleNames

Parameters

Returns

`childCount : Number`

`document : Document`

`index : Number | null`

`isEmpty : Boolean`

`isFocused : Boolean`

`isReadOnly : Boolean`

`name : String`

`nextSibling : Node | null`

`parent : Element | DocumentFragment | null`

`previousSibling : Node | null`

`root : Node | DocumentFragment`

`_attrs : Map`

`_children : Array.<Node>`

`_classes : Set`

`_customProperties : Map`

`_styles : StylesMap`

`_unsafeAttributesToRender : Array.<String>`

`constructor()`

`bind( bindProperties ) → Object`

`decorate( methodName )`

`delegate( events ) → EmitterMixinDelegateChain`

`findAncestor( patterns ) → Element | null`

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

`getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array`

`getAttribute( key ) → String | undefined`

`getAttributeKeys() → Iterable.<String>`

`getAttributes() → Iterable.<*>`

`getChild( index ) → Node`

`getChildIndex( node ) → Number`

`getChildren() → Iterable.<Node>`

`getClassNames() → Iterable.<String>`

`getCommonAncestor( node, options = { [options.includeSelf] } ) → Element | DocumentFragment | null`

`getCustomProperties() → Iterable.<*>`

`getCustomProperty( key ) → *`

`getFillerOffset()`

`getIdentity() → String`

`getNormalizedStyle( property ) → Object | String | undefined`

`getPath() → Array.<Number>`

`getStyle( property ) → String | undefined`

`getStyleNames( [ expand ] ) → Iterable.<String>`

`hasAttribute( key ) → Boolean`

`hasClass( className )`

`hasStyle( property )`

`is( type ) → Boolean`

`isAfter( node ) → Boolean`

`isAttached() → Boolean`

`isBefore( node ) → Boolean`

`isSimilar() → Boolean`

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

`off( event, callback )`

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

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

`set( name, [ value ] )`

`shouldRenderUnsafeAttribute( attributeName ) → Boolean`

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

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

`toJSON() → Object`

`unbind( [ unbindProperties ] )`

`_addClass( className )`

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

`_appendChild( items ) → Number`

`_clone() → Node`

`_fireChange( type, node )`

`_insertChild( index, items ) → Number`

`_remove()`

`_removeAttribute( key ) → Boolean`

`_removeChildren( index, [ howMany ] ) → Array.<Node>`