Report an issue
Class

RootEditableElement (engine/view)

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

class

Class representing a single root in the data view. A root can be either editable or read-only, but in both cases it is called "an editable". Roots can contain other editable elements making them "nested editables".

Filtering

Properties

  • childCount : Number

    readonly inherited

    Number of element's children.

  • document : Document

    inherited

    The Document which is an owner of this root. Can only by set once. Throws CKEditorError view-editableelement-document-already-set when document is already set.

  • index : Number | null

    readonly inherited

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

    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.

  • isFocused : Boolean

    readonly inherited observable

    Whether the editable is focused.

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

  • isReadOnly : Boolean

    inherited observable

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

  • name : String

    readonly inherited

    Name of the element.

  • nextSibling : Node | null

    readonly inherited

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

  • parent : Element | DocumentFragment | null

    readonly inherited

    Parent element. Null by default. Set by _insertChild.

  • previousSibling : Node | null

    readonly inherited

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

  • root : Node | DocumentFragment

    readonly inherited

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

  • rootName : String

    readonly

    Name of this root inside Document that is an owner of this root. If no other name is set, main name is used.

  • _attrs : Map

    protected inherited

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

  • _children : Array.<Node>

    protected inherited

    Array of child nodes.

  • _classes : Set

    protected inherited

    Set of classes associated with element instance.

  • _customProperties

    protected inherited

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

  • _document

    protected inherited

    Sets document of this editable element.

  • _name

    protected

    Overrides old element name and sets new one. This is needed because view roots are created before they are attached to the DOM. The name of the root element is temporary at this stage. It has to be changed when the view root element is attached to the DOM element.

  • _styles : Set

    protected inherited

    Map of styles.

Methods

  • constructor( name )

    Creates root editable element.

    Parameters

    name : String

    Node name.

  • _fireChange( type, node )

    inherited

    Parameters

    type : ChangeType

    Type of the change.

    node : Node

    Changed node.

    Fires

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

    inherited

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

    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

  • _removeClass( className )

    inherited

    Removes specified class.

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

    Parameters

    className : Array.<String> | String

    Fires

  • bind( bindProperties ) → Object

    mixed

    Binds observable properties to another objects implementing Observable interface (like Model).

    Once bound, the observable will immediately share the current state of properties of the observable it is bound to and react to the changes to these properties in the future.

    Note: To release the binding use unbind.

    Using bind().to() chain:

    A.bind( 'a' ).to( B );
    A.bind( 'a' ).to( B, 'b' );
    A.bind( 'a', 'b' ).to( B, 'c', 'd' );
    A.bind( 'a' ).to( B, 'b', C, 'd', ( b, d ) => b + d );

    It is also possible to bind to the same property in a observables collection using bind().toMany() chain:

    A.bind( 'a' ).toMany( [ B, C, D ], 'x', ( a, b, c ) => a + b + c );
    A.bind( 'a' ).toMany( [ B, C, D ], 'x', ( ...x ) => x.every( x => x ) );

    Parameters

    bindProperties : String

    Observable properties that will be bound to another 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.

    This is a very simplified method decoration. Itself it doesn't change the behavior of a method (expect adding the event), but it allows to modify it later on by listening to the method's event.

    For example, in order to cancel the method execution one can stop the event:

    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: we used a high priority listener here to execute this callback before the one which calls the original method (which used the default priority).

    It's also possible to change the return value:

    foo.on( 'method', ( evt ) => {
        evt.return = 'Foo!';
    } );
    
    foo.method(); // -> 'Foo'

    Finally, it's possible to access and modify the parameters:

    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:

    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.

    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.

  • fire( eventOrInfo, [ args ] ) → *

    mixed

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    Parameters

    eventOrInfo : String | EventInfo

    The name of the event or EventInfo object if event is delegated.

    [ args ] : *

    Additional arguments to be passed to the callbacks.

    Returns

    *

    By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

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

    inherited

    Returns ancestors array of this node.

    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.

    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.

    Returns

    Iterable.<String>

    Keys for attributes.

  • getAttributes() → Iterable.<*>

    inherited

    Returns iterator that iterates over this element's attributes.

    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.

    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.

    Parameters

    node : Node

    Child node.

    Returns

    Number

    Index of the child node.

  • getChildren() → Iterable.<Node>

    inherited

    Gets child nodes iterator.

    Returns

    Iterable.<Node>

    Child nodes iterator.

  • getClassNames() → Iterable.<String>

    inherited

    Returns iterator that contains all class names.

    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.

    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.

    Returns

    Iterable.<*>
  • getCustomProperty( key ) → *

    inherited

    Returns the custom property value for the given key.

    Parameters

    key : String | Symbol

    Returns

    *
  • getFillerOffset() → Number | null

    inherited

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

    Returns

    Number | null

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

  • 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:

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

    const abc = new Text( 'abc' );
    const foo = new Text( 'foo' );
    const h1 = new Element( 'h1', null, new Text( 'header' ) );
    const p = new Element( 'p', null, [ abc, foo ] );
    const div = new Element( '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 given property. Undefined is returned if style does not exist.

    Parameters

    property : String

    Returns

    String | undefined
  • getStyleNames() → Iterable.<String>

    inherited

    Returns iterator that contains all style names.

    Returns

    Iterable.<String>
  • hasAttribute( key ) → Boolean

    inherited

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

    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.

    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.

    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, [ name ] ) → Boolean

    inherited

    Checks whether given view tree object is of given type.

    Read more in is.

    Parameters

    type : String
    [ name ] : String

    Element name.

    Returns

    Boolean
    Overrides: EditableElement#is
  • 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).

    Parameters

    node : Node

    Node to compare with.

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

    Parameters

    node : Node

    Node to compare with.

    Returns

    Boolean
  • isSimilar( otherElement ) → Boolean

    inherited

    Checks if this element is similar to other element. Both elements should have the same name and attributes to be considered as similar. Two similar elements can contain different set of children nodes.

    Parameters

    otherElement : Element

    Returns

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

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

    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.

    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.

    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 an property becomes a part of the state and is be observable.

    It accepts also a single object literal containing key/value pairs with properties to be set.

    This method throws the observable-set-cannot-override error if the observable instance already have 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).

  • stopDelegating( [ event ], [ emitter ] )

    mixed

    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.

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

    mixed

    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.

  • toJSON() → Object

    inherited

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    Object

    Clone of this object with the parent property removed.

  • unbind( [ unbindProperties ] )

    mixed

    Removes the binding created with bind.

    A.unbind( 'a' );
    A.unbind();

    Parameters

    [ unbindProperties ] : String

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

  • _addClass( className )

    protected inherited

    Adds specified class.

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

    Parameters

    className : Array.<String> | String

    Fires

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

    Parameters

    items : Item | Iterable.<Item>

    Items to be inserted.

    Returns

    Number

    Number of appended nodes.

    Fires

  • _clone( [ deep ] ) → Element

    protected inherited

    Clones provided element.

    Parameters

    [ deep ] : Boolean

    If set to true clones element and all its children recursively. When set to false, element will be cloned without any children.

    Defaults to false

    Returns

    Element

    Clone of this element.

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

    Parameters

    index : Number

    Position where nodes should be inserted.

    items : Item | Iterable.<Item>

    Items to be inserted.

    Returns

    Number

    Number of inserted nodes.

    Fires

  • _remove()

    protected inherited

    Removes node from parent.

  • _removeAttribute( key ) → Boolean

    protected inherited

    Removes attribute from the element.

    Parameters

    key : String

    Attribute key.

    Returns

    Boolean

    Returns true if an attribute existed and has been removed.

    Fires

  • _removeCustomProperty( key ) → Boolean

    protected inherited

    Removes the custom property stored under the given key.

    Parameters

    key : String | Symbol

    Returns

    Boolean

    Returns true if property was removed.

  • _removeStyle( property )

    protected inherited

    Removes specified style.

    element._removeStyle( 'color' );  // Removes 'color' style.
    element._removeStyle( [ 'color', 'border-top' ] ); // Removes both 'color' and 'border-top' styles.

    Parameters

    property : Array.<String> | String

    Fires

  • _setAttribute( key, value )

    protected inherited

    Adds or overwrite attribute with a specified key and value.

    Parameters

    key : String

    Attribute key.

    value : String

    Attribute value.

    Fires

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

    Parameters

    key : String | Symbol
    value : *
  • _setStyle( property, [ value ] )

    protected inherited

    Adds style to the element.

    element._setStyle( 'color', 'red' );
    element._setStyle( {
        color: 'red',
        position: 'fixed'
    } );

    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

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.

    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.

    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 )

    inherited

    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 )

    inherited

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

    inherited

    Fired when text nodes data changes.

    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.

    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.