CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 4/API
Class

CKEDITOR.dom.iterator

class
See source

Represents the iterator class. It can be used to iterate over all elements (or even text nodes in case of enlargeBr set to false) which establish "paragraph-like" spaces within the passed range.

// <h1>[foo</h1><p>bar]</p>
var iterator = range.createIterator();
iterator.getNextParagraph(); // h1 element
iterator.getNextParagraph(); // p element

// <ul><li>[foo</li><li>bar]</li>
// With enforceRealBlocks set to false the iterator will return two list item elements.
// With enforceRealBlocks set to true the iterator will return two paragraphs and the DOM will be changed to:
// <ul><li><p>foo</p></li><li><p>bar</p></li>

Filtering

Properties

  • since 4.3.0 readonly

    activeFilter : filter

    See source

    Iterator's active filter. It is set by the getNextParagraph method when it enters a nested editable.

  • enforceRealBlocks : Boolean

    See source

    Whether the iterator should create a transformable block if the current one contains text and cannot be transformed. For example new blocks will be established in elements like <li> or <td>.

    Defaults to false

  • enlargeBr : Boolean

    See source

    Whether to include <br> elements in the enlarged range. Should be set to false when using the iterator in the CKEDITOR.ENTER_BR mode.

    Defaults to true

  • since 4.3.0 readonly

    filter : filter

    See source

    Default iterator's filter. It is set only for nested iterators.

  • forceBrBreak : Boolean

    See source

    Defaults to false

  • readonly

    range : range

    See source

Methods

  • constructor( range ) → iterator

    See source

    Creates an iterator class instance.

    Parameters

    range : range

    Returns

    iterator

  • getNextParagraph( [ blockTag ] )

    See source

    Returns the next paragraph-like element or null if the end of a range is reached.

    Parameters

    [ blockTag ] : String

    Name of a block element which will be established by the iterator in block-less elements (see enforceRealBlocks).

    Defaults to 'p'

  • since 4.4.6 private

    _getNextSourceNode( node, startFromSibling, lastNode ) → node

    See source

    Gets the next element to check or null when the lastNode or the range's root is reached. Bookmarks are skipped.

    Parameters

    node : node
    startFromSibling : Boolean
    lastNode : node

    Returns

    node