CKEDITOR.htmlParser.comment

Properties

• readonly

  type : NumberCKEDITOR.htmlParser.comment#type

  See source

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

  Defaults to CKEDITOR.NODE_COMMENT

• value : StringCKEDITOR.htmlParser.comment#value

  See source

  The comment text.

• private

  _ : ObjectCKEDITOR.htmlParser.comment#_

  See source

  Defaults to {isBlockLike: false}

Methods

• inherited

  constructor() → nodeCKEDITOR.htmlParser.comment#constructor

  See source

  Creates a node class instance.

  Returns

  node

• since 4.1.0

  filter( filter ) → BooleanCKEDITOR.htmlParser.comment#filter

  See source

  Filter this comment with given filter.

  Parameters

  filter : filter

  Returns

  Boolean

  Method returns false when this comment has been removed or replaced with other node. This is an information for CKEDITOR.htmlParser.element.filterChildren that it has to repeat filter on current position in parent's children array.

  since 4.3.0 inherited

  getAscendant( condition ) → elementCKEDITOR.htmlParser.comment#getAscendant

  See source

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

  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.

  since 4.3.0 inherited

  getIndex() → NumberCKEDITOR.htmlParser.comment#getIndex

  See source

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

  Returns

  Number

  since 4.1.0 inherited

  insertAfter( node )CKEDITOR.htmlParser.comment#insertAfter

  See source

  Insert this node after given one.

  Parameters

  node : node

  The node that will precede this element.

  since 4.1.0 inherited

  insertBefore( node )CKEDITOR.htmlParser.comment#insertBefore

  See source

  Insert this node before given one.

  Parameters

  node : node

  The node that will follow this element.

  since 4.1.0 inherited

  remove()CKEDITOR.htmlParser.comment#remove

  See source

  Remove this node from a tree.

  since 4.1.0 inherited

  replaceWith( node )CKEDITOR.htmlParser.comment#replaceWith

  See source

  Replace this node with given one.

  Parameters

  node : node

  The node that will replace this one.

  since 4.3.0 inherited

  wrapWith( wrapper ) → elementCKEDITOR.htmlParser.comment#wrapWith

  See source

  Wraps this element with given wrapper.

  Parameters

  wrapper : element

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

  Returns

  element

  Wrapper.

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

  See source

  Writes the HTML representation of this comment to a CKEDITOR.htmlWriter.

  Parameters

  writer : basicWriter

  The writer to which write the HTML.

  [ filter ] : filter

  The filter to be applied to this node. Note: it's unsafe to filter offline (not appended) node.