CKEDITOR.htmlParser.element

Properties

• attributes : ObjectCKEDITOR.htmlParser.element#attributes

  Stores the attributes defined for this element.

  See source

• children : ArrayCKEDITOR.htmlParser.element#children

  The nodes that are direct children of this element.

  See source

  Defaults to []

• name : StringCKEDITOR.htmlParser.element#name

  The element name.

  See source

• type : NumberCKEDITOR.htmlParser.element#type

  readonly

  The node type. This is a constant value set to CKEDITOR.NODE_ELEMENT.

  See source

  Defaults to CKEDITOR.NODE_ELEMENT

• _ : ObjectCKEDITOR.htmlParser.element#_

  private

  See source

Methods

• constructor() → nodeCKEDITOR.htmlParser.element#constructor

  inherited

  Creates a node class instance.

  See source

  Returns

  node

• add( node, [ index ] )CKEDITOR.htmlParser.element#add

  Adds a node to the element children list.

  See source

  Parameters

  node : node

  The node to be added.

  [ index ] : Number

  From where the insertion happens.

• addClass( className )CKEDITOR.htmlParser.element#addClass

  since 4.4.0

  Adds a class name to the list of classes.

  See source

  Parameters

  className : String

  The class name to be added.

• clone() → elementCKEDITOR.htmlParser.element#clone

  Clones this element.

  See source

  Returns

  element

  The element clone.

• filter( filter ) → BooleanCKEDITOR.htmlParser.element#filter

  since 4.1.0

  Filters this element and its children with the given filter.

  See source

  Parameters

  filter : filter

  Returns

  Boolean

  The method returns false when this element has been removed or replaced with another. This information means that filterChildren has to repeat the filter on the current position in parent's children array.

• filterChildren( filter )CKEDITOR.htmlParser.element#filterChildren

  Filters this element's children with the given filter.

  See source

  Element's children may only be filtered once by one instance of the filter.

  Parameters

  filter : filter

• find( criteria, [ recursive ] ) → node[]CKEDITOR.htmlParser.element#find

  Searches through the current node children to find nodes matching the criteria.

  See source

  Parameters

  criteria : String | Function

  Tag name or evaluator function.

  [ recursive ] : Boolean

  Defaults to false

  Returns

  node[]

• findOne( criteria, [ recursive ] ) → node | nullCKEDITOR.htmlParser.element#findOne

  Searches through the children of the current element to find the first child matching the criteria.

  See source

  element.findOne( function( child ) {
      return child.name === 'span' || child.name === 'strong';
  } ); // Will return the first child which is a <span> or a <strong> element.
  

  Parameters

  criteria : String | Function

  Tag name or evaluator function.

  [ recursive ] : Boolean

  If set to true, it will iterate over all descendants. Otherwise the method will only iterate over direct children.

  Defaults to false

  Returns

  node | null

  The first matched child, null otherwise.

• forEach( callback, [ type ], [ skipRoot ] )CKEDITOR.htmlParser.element#forEach

  since 4.1.0

  Executes a callback on each node (of the given type) in this element.

  See source

  // Create a <p> element with foo<b>bar</b>bom as its content.
  var elP = CKEDITOR.htmlParser.fragment.fromHtml( 'foo<b>bar</b>bom', 'p' );
  elP.forEach( function( node ) {
      console.log( node );
  } );
  // Will log:
  // 1. document fragment,
  // 2. <p> element,
  // 3. "foo" text node,
  // 4. <b> element,
  // 5. "bar" text node,
  // 6. "bom" text node.
  

  Parameters

  callback : Function

  Function to be executed on every node. Since 4.3: If callback returned false, the descendants of the current node will be ignored.

  Properties

  node : node

  Node passed as an argument.

  [ type ] : Number

  Whether the specified callback will be executed only on nodes of this type.

  [ skipRoot ] : Boolean

  Do not execute callback on this element.

• getAscendant( condition ) → elementCKEDITOR.htmlParser.element#getAscendant

  since 4.3.0 inherited

  Gets the closest ancestor element of this element which satisfies given condition

  See source

  Parameters

  condition : String | Object | Function

  Name of an ancestor, hash of names or validator function.

  Returns

  element

  The closest ancestor which satisfies given condition or null.

• getFirst( condition ) → nodeCKEDITOR.htmlParser.element#getFirst

  since 4.3.0

  Gets this element's first child. If condition is given, this method returns the first child which satisfies that condition.

  See source

  Parameters

  condition : String | Object | Function

  Name of a child, a hash of names, or a validator function.

  Returns

  node

• getHtml() → StringCKEDITOR.htmlParser.element#getHtml

  since 4.3.0

  Gets this element's inner HTML.

  See source

  Returns

  String

• getIndex() → NumberCKEDITOR.htmlParser.element#getIndex

  since 4.3.0 inherited

  Gets this node's index in its parent's children array.

  See source

  Returns

  Number

• getOuterHtml() → StringCKEDITOR.htmlParser.element#getOuterHtml

  since 4.3.0

  Gets this element's outer HTML.

  See source

  Returns

  String

• hasClass( className ) → BooleanCKEDITOR.htmlParser.element#hasClass

  since 4.3.0

  Checkes whether this element has a class name.

  See source

  Parameters

  className : String

  The class name to be checked.

  Returns

  Boolean

  Whether this element has a className.

• insertAfter( node )CKEDITOR.htmlParser.element#insertAfter

  since 4.1.0 inherited

  Insert this node after given one.

  See source

  Parameters

  node : node

  The node that will precede this element.

• insertBefore( node )CKEDITOR.htmlParser.element#insertBefore

  since 4.1.0 inherited

  Insert this node before given one.

  See source

  Parameters

  node : node

  The node that will follow this element.

• remove()CKEDITOR.htmlParser.element#remove

  since 4.1.0 inherited

  Remove this node from a tree.

  See source

• removeClass( className )CKEDITOR.htmlParser.element#removeClass

  since 4.3.0

  Removes a class name from the list of classes.

  See source

  Parameters

  className : String

  The class name to be removed.

• replaceWith( node )CKEDITOR.htmlParser.element#replaceWith

  since 4.1.0 inherited

  Replace this node with given one.

  See source

  Parameters

  node : node

  The node that will replace this one.

• replaceWithChildren()CKEDITOR.htmlParser.element#replaceWithChildren

  since 4.1.0

  Replaces this element with its children.

  See source

• setHtml( html )CKEDITOR.htmlParser.element#setHtml

  since 4.3.0

  Sets this element's inner HTML.

  See source

  Parameters

  html : String

• split( index ) → elementCKEDITOR.htmlParser.element#split

  since 4.3.0

  Splits this element at the given index.

  See source

  Parameters

  index : Number

  Index at which the element will be split — 0 means the beginning, 1 after the first child node, etc.

  Returns

  element

  The new element following this one.

• wrapWith( wrapper ) → elementCKEDITOR.htmlParser.element#wrapWith

  since 4.3.0 inherited

  Wraps this element with given wrapper.

  See source

  Parameters

  wrapper : element

  The element which will be this element's new parent.

  Returns

  element

  Wrapper.

• writeChildrenHtml( writer, [ filter ] )CKEDITOR.htmlParser.element#writeChildrenHtml

  Sends children of this element to the writer.

  See source

  Parameters

  writer : basicWriter

  The writer to which HTML will be written.

  [ filter ] : filter

• writeHtml( writer, [ filter ] )CKEDITOR.htmlParser.element#writeHtml

  Writes the element HTML to the CKEDITOR.htmlWriter.

  See source

  Parameters

  writer : basicWriter

  The writer to which HTML will be written.

  [ filter ] : filter

  The filter to be applied to this node. Note: It is unsafe to filter an offline (not appended) node.