CKEditor 4 Documentation

CKEDITOR.dom.elementPath

Files

Retrieve the list of nodes walked from the start node up to the editable element of the editor.

Defined By

Properties

CKEDITOR.dom.elementPath
view source
: CKEDITOR.dom.elementreadonly
First non-empty block element which: is not a CKEDITOR.dtd.$blockLimit, or is a div which does not contain block el...

First non-empty block element which:

This means a first, splittable block in elements path.

CKEDITOR.dom.elementPath
view source
: CKEDITOR.dom.elementreadonly

See the CKEDITOR.dtd.$blockLimit description.

See the CKEDITOR.dtd.$blockLimit description.

CKEDITOR.dom.elementPath
view source
: CKEDITOR.dom.element[]readonly

An array of elements (from startNode to root) in the path.

An array of elements (from startNode to root) in the path.

CKEDITOR.dom.elementPath
view source
: CKEDITOR.dom.elementreadonly

The last element of the elements path - startNode or its parent.

The last element of the elements path - startNode or its parent.

CKEDITOR.dom.elementPath
view source
: CKEDITOR.dom.elementreadonly

The root of the elements path - root argument passed to class constructor or a body element.

The root of the elements path - root argument passed to class constructor or a body element.

Defined By

Methods

CKEDITOR.dom.elementPath
view source
new( startNode, root ) : CKEDITOR.dom.elementPath
Creates an element path class instance. ...

Creates an element path class instance.

Parameters

Returns

CKEDITOR.dom.elementPath
view source
( otherPath ) : Boolean
Compares this element path with another one. ...

Compares this element path with another one.

Parameters

Returns

  • Boolean

    true if the paths are equal, containing the same number of elements and the same elements in the same order.

CKEDITOR.dom.elementPath
view source
( query, [excludeRoot], [fromTop] ) : CKEDITOR.dom.element
Search the path elements that meets the specified criteria. ...

Search the path elements that meets the specified criteria.

Parameters

  • query : String/Array/Function/Object/CKEDITOR.dom.element

    The criteria that can be either a tag name, list (array and object) of tag names, element or an node evaluator function.

  • excludeRoot : Boolean (optional)

    Not taking path root element into consideration.

  • fromTop : Boolean (optional)

    Search start from the topmost element instead of bottom.

Returns

CKEDITOR.dom.elementPath
view source
( ) : 'ltr'/'rtl'
Retrieve the text direction for this elements path. ...

Retrieve the text direction for this elements path.

Returns

  • 'ltr'/'rtl'
CKEDITOR.dom.elementPath
view source
( tag ) : Boolean
Check whether the elements path is the proper context for the specified tag name in the DTD. ...

Check whether the elements path is the proper context for the specified tag name in the DTD.

Parameters

  • tag : String

    The tag name.

Returns

  • Boolean