CKEditor Ecosystem Documentation

Report an issue

Home/CKEditor 4/API

Class

CKEDITOR.dom.rangeList

class

Represents a list os CKEDITOR.dom.range objects, which can be easily iterated sequentially.

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Methods

constructor( [ ranges ] ) → rangeList

Creates a rangeList class instance.

See source

Parameters

[ ranges ] : range | range[]

The ranges contained on this list. Note that, if an array of ranges is specified, the range sequence should match its DOM order. This class will not help to sort them.

Returns

rangeList
createBookmarks( [ serializable ] ) → Array

Create bookmarks for all ranges. See CKEDITOR.dom.range.createBookmark.

See source

Parameters

[ serializable ] : Boolean

See CKEDITOR.dom.range.createBookmark.

Defaults to false

Returns

Array

Array of bookmarks.
createBookmarks2( [ normalized ] ) → Array

Create "unobtrusive" bookmarks for all ranges. See CKEDITOR.dom.range.createBookmark2.

See source

Parameters

[ normalized ] : Boolean

See CKEDITOR.dom.range.createBookmark2.

Defaults to false

Returns

Array

Array of bookmarks.
createIterator() → rangeListIterator

Creates an instance of the rangeList iterator, it should be used only when the ranges processing could be DOM intrusive, which means it may pollute and break other ranges in this list. Otherwise, it's enough to just iterate over this array in a for loop.

See source

Returns

rangeListIterator
moveToBookmarks( bookmarks )

Move each range in the list to the position specified by a list of bookmarks.

See source

Parameters

bookmarks : Array

The list of bookmarks, each one matching a range in the list.