list/legacylist/legacyutils

Creates a list item ViewContainerElement.

Parameters

writer : ViewDowncastWriter

The writer instance.

Returns

ViewContainerElement

Returns a first list view element that is direct child of the given view element.

Parameters

viewElement : ViewElement

Returns

null | ViewElement

Helper function that creates a <ul><li></li></ul> or (<ol>) structure out of the given modelItem model listItem element. Then, it binds the created view list item (<li>) with the model listItem element. The function then returns the created view list item (<li>).

Parameters

modelItem : ModelItem

Model list item.

conversionApi : DowncastConversionApi

Conversion interface.

Returns

ViewContainerElement

View list element.

Checks whether the given list-style-type is supported by numbered or bulleted list.

Parameters

listStyleType : string

Returns

null | 'numbered' | 'bulleted'

Returns an array with all listItem elements in the model selection.

It returns all the items even if only a part of the list is selected, including items that belong to nested lists. If no list is selected, it returns an empty array. The order of the elements is not specified.

Parameters

model : Model

Returns

Array<ModelElement>

Helper function that searches for a previous list item sibling of a given model item that meets the given criteria passed by the options object.

Parameters

modelItem : null | ModelItem

options : object

Search criteria.

Properties

[ options.direction ] : 'forward' | 'backward'

Walking direction.

[ options.listIndent ] : number

The reference indentation.

[ options.sameIndent ] : boolean

Whether the sought sibling should have the same indentation.

[ options.smallerIndent ] : boolean

Whether the sought sibling should have a smaller indentation.

Returns

null | ModelElement

Returns an array with all listItem elements that represent the same list.

It means that values of listIndent, listType, listStyle, listReversed and listStart for all items are equal.

Additionally, if the position is inside a list item, that list item will be returned as well.

Parameters

position : ModelPosition

Starting position.

direction : 'forward' | 'backward'

Walking direction.

Returns

Array<ModelElement>

Helper function that inserts a view list at a correct place and merges it with its siblings. It takes a model list item element (modelItem) and a corresponding view list item element (injectedItem). The view list item should be in a view list element (<ul> or <ol>) and should be its only child. See comments below to better understand the algorithm.

Parameters

modelItem : ModelElement

Model list item.

injectedItem : ViewContainerElement

conversionApi : DowncastConversionApi

Conversion interface.

model : Model

The model instance.

Returns

void

Helper function that takes two parameters that are expected to be view list elements, and merges them. The merge happens only if both parameters are list elements of the same type (the same element name and the same class attributes).

Parameters

viewWriter : ViewDowncastWriter

The writer instance.

firstList : ViewItem

The first element to compare.

secondList : ViewItem

The second element to compare.

Returns

null | ViewPosition

The position after merge or null when there was no merge.

Helper function that for a given view.Position, returns a view.Position that is after all view.UIElements that are after the given position.

For example: <container:p>foo^<ui:span></ui:span><ui:span></ui:span>bar</container:p> For position ^, the position before "bar" will be returned.

Parameters

viewPosition : ViewPosition

Returns

ViewPosition