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

CKEDITOR.plugins.pastetools.filters.word.lists

class

Filtering

Properties

  • numbering : Object

    since 4.13.0

    Numbering helper.

    See source

Methods

  • calculateValue( element ) → Number

    since 4.13.0 private

    Calculates the value for a given <li> element based on preceding list items (e.g. the value attribute). It could also look at the start attribute of its parent list (<ol>).

    See source

    Parameters

    element : element

    The <li> element.

    Returns

    Number

  • chopDiscontinuousLists( list, lists )

    since 4.13.0 private

    Converts a single, flat list items array into an array with a hierarchy of items.

    See source

    As the list gets chopped, it will be forced to render as a separate list, even if it has a deeper nesting level. For example, for level 3 it will create a structure like ol > li > ol > li > ol > li.

    Note that list items within a single list but with different levels that did not get chopped will still be rendered as a list tree later.

    Parameters

    list : element[]

    An array containing list items.

    lists : element[]

    All the lists in the pasted content represented by an array of arrays of list items. Modified by this method.

  • cleanup( listElements )

    since 4.13.0 private

    Final cleanup — removes all cke-* helper attributes.

    See source

    Parameters

    listElements : element[]

  • convertToFakeListItem( editor, element )

    since 4.13.0 private

    Converts an element to an element with the cke:li tag name.

    See source

    Parameters

    editor : editor
    element : element

  • convertToRealListItems( root ) → element[]

    since 4.13.0 private

    Converts any fake list items contained within root into real <li> elements.

    See source

    Parameters

    root : element

    Returns

    element[]

    An array of converted elements.

  • createLists( root ) → element[]

    since 4.13.0 private

    See source

    Parameters

    root : element

    An element to be looked through for lists.

    Returns

    element[]

    An array of created list items.

  • determineListItemValue( element )

    since 4.13.0 private

    Tries to determine the li[value] attribute for a given list item. The element given must have a parent in order for this function to work properly.

    See source

    Parameters

    element : element

  • dissolveList( element )

    since 4.13.0 private

    See source

    Parameters

    element : element

  • getListItemInfo( list ) → Object

    since 4.13.0 private

    Returns Word-generated information about the given list item, mainly by parsing the mso-list CSS property.

    See source

    Note: Paragraphs with mso-list are also counted as list items because Word serves list items as paragraphs.

    Parameters

    list : element

    Returns

    Object

    ret

  • getSymbolInfo( symbol, type ) → Object

    since 4.13.0 private

    Returns an object describing the given symbol.

    See source

    Parameters

    symbol : String
    type : String

    Returns

    Object

    ret

  • isAListContinuation( listElement ) → Boolean

    since 4.13.0 private

    Checks if this list is a direct continuation of a list interrupted by a list with a different ID and with a different level. So if you look at the following list:

    See source
    • list1 level1
    • list1 level1
      • list2 level2
      • list2 level2
    • list1 level1

    It would return true, which means it is a continuation, and should not be chopped. However, if any paragraph or anything else appears in-between, it should be broken into different lists.

    You can see fixtures from issue https://dev.ckeditor.com/ticket/7918 as an example.

    Parameters

    listElement : element

    The list to be checked.

    Returns

    Boolean

  • thisIsAListItem( editor, element ) → Boolean

    since 4.13.0 private

    Checks if a given element is a list item-alike.

    See source

    Parameters

    editor : editor
    element : element

    Returns

    Boolean