CKEDITOR.dom.elementPath

Properties

• readonly

  block : elementCKEDITOR.dom.elementPath#block

  See source

  First non-empty block element which:

  • is not a CKEDITOR.dtd.$blockLimit,
  • or is a div which does not contain block elements and is not a root.

  This means a first, splittable block in elements path.

• readonly

  blockLimit : elementCKEDITOR.dom.elementPath#blockLimit

  See source

  See the CKEDITOR.dtd.$blockLimit description.

• readonly

  elements : element[]CKEDITOR.dom.elementPath#elements

  See source

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

• readonly

  lastElement : elementCKEDITOR.dom.elementPath#lastElement

  See source

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

• readonly

  root : elementCKEDITOR.dom.elementPath#root

  See source

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

Methods

• constructor( startNode, root ) → elementPathCKEDITOR.dom.elementPath#constructor

  See source

  Creates an element path class instance.

  Parameters

  startNode : element

  From which the path should start.

  root : element

  To which element the path should stop, defaults to the body element.

  Returns

  elementPath

• compare( otherPath ) → BooleanCKEDITOR.dom.elementPath#compare

  See source

  Compares this element path with another one.

  Parameters

  otherPath : elementPath

  The elementPath object to be compared with this one.

  Returns

  Boolean

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

• contains( query, [ excludeRoot ], [ fromTop ] ) → elementCKEDITOR.dom.elementPath#contains

  See source

  Search the path elements that meets the specified criteria.

  Parameters

  query : String | Array | Function | Object | 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

  Not taking path root element into consideration.

  [ fromTop ] : Boolean

  Search start from the topmost element instead of bottom.

  Returns

  element

  The first matched dom element or null.

• direction() → 'ltr' | 'rtl'CKEDITOR.dom.elementPath#direction

  See source

  Retrieve the text direction for this elements path.

  Returns

  'ltr' | 'rtl'

• isContextFor( tag ) → BooleanCKEDITOR.dom.elementPath#isContextFor

  See source

  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