list/legacylist/legacyconverters

Constants

• cleanList : GetCallback<UpcastElementEvent>

  module:list/legacylist/legacyconverters~cleanList

  A view-to-model converter for the <ul> and <ol> view elements that cleans the input view of garbage. This is mostly to clean whitespaces from between the <li> view elements inside the view list element, however, also incorrect data can be cleared if the view was incorrect.

  See source (with github icon)

• cleanListItem : GetCallback<UpcastElementEvent>

  module:list/legacylist/legacyconverters~cleanListItem

  A view-to-model converter for the <li> elements that cleans whitespace formatting from the input view.

  See source (with github icon)

• modelIndentPasteFixer : GetCallback<ModelInsertContentEvent>

  module:list/legacylist/legacyconverters~modelIndentPasteFixer

  A fixer for pasted content that includes list items.

  It fixes indentation of pasted list items so the pasted items match correctly to the context they are pasted into.

  Example:

  <listItem listType="bulleted" listIndent=0>A</listItem>
  <listItem listType="bulleted" listIndent=1>B^</listItem>
  // At ^ paste:  <listItem listType="bulleted" listIndent=4>X</listItem>
  //              <listItem listType="bulleted" listIndent=5>Y</listItem>
  <listItem listType="bulleted" listIndent=2>C</listItem>
  

  Copy code

  Should become:

  <listItem listType="bulleted" listIndent=0>A</listItem>
  <listItem listType="bulleted" listIndent=1>BX</listItem>
  <listItem listType="bulleted" listIndent=2>Y/listItem>
  <listItem listType="bulleted" listIndent=2>C</listItem>
  

  Copy code

  See source (with github icon)

• modelViewChangeType : GetCallback<DowncastAttributeEvent<ModelElement>>

  module:list/legacylist/legacyconverters~modelViewChangeType

  A model-to-view converter for the type attribute change on the listItem model element.

  This change means that the <li> element parent changes from <ul> to <ol> (or vice versa). This is accomplished by breaking view elements and changing their name. The next modelViewMergeAfterChangeType converter will attempt to merge split nodes.

  Splitting this conversion into 2 steps makes it possible to add an additional conversion in the middle. Check modelViewChangeType to see an example of it.

  See source (with github icon)

• modelViewMergeAfter : GetCallback<DowncastRemoveEvent>

  module:list/legacylist/legacyconverters~modelViewMergeAfter

  A special model-to-view converter introduced by the list feature. This converter takes care of merging view lists after something is removed or moved from near them.

  Example:

  // Model:                        // View:
  <listItem>foo</listItem>         <ul><li>foo</li></ul>
  <paragraph>xxx</paragraph>       <p>xxx</p>
  <listItem>bar</listItem>         <ul><li>bar</li></ul>
  
  // After change:                 // Correct view guaranteed by this converter:
  <listItem>foo</listItem>         <ul>
  <listItem>bar</listItem>             <li>foo</li>
                                       <li>bar</li>
                                   </ul>
  

  Copy code

  See source (with github icon)

• modelViewMergeAfterChangeType : GetCallback<DowncastAttributeEvent<ModelElement>>

  module:list/legacylist/legacyconverters~modelViewMergeAfterChangeType

  A model-to-view converter that attempts to merge nodes split by modelViewChangeType.

  See source (with github icon)

• modelViewSplitOnInsert : GetCallback<DowncastInsertEvent<ModelElement>>

  module:list/legacylist/legacyconverters~modelViewSplitOnInsert

  A special model-to-view converter introduced by the list feature. This converter is fired for insert change of every model item, and should be fired before the actual converter. The converter checks whether the inserted model item is a non-listItem element. If it is, and it is inserted inside a view list, the converter breaks the list so the model element is inserted to the view parent element corresponding to its model parent element.

  The converter prevents such situations:

  // Model:                        // View:
  <listItem>foo</listItem>         <ul>
  <listItem>bar</listItem>             <li>foo</li>
                                       <li>bar</li>
                                   </ul>
  
  // After change:                 // Correct view guaranteed by this converter:
  <listItem>foo</listItem>         <ul><li>foo</li></ul><p>xxx</p><ul><li>bar</li></ul>
  <paragraph>xxx</paragraph>       // Instead of this wrong view state:
  <listItem>bar</listItem>         <ul><li>foo</li><p>xxx</p><li>bar</li></ul>
  

  Copy code

  See source (with github icon)

• viewModelConverter : GetCallback<UpcastElementEvent>

  module:list/legacylist/legacyconverters~viewModelConverter

  A view-to-model converter that converts the <li> view elements into the listItem model elements.

  To set correct values of the listType and listIndent attributes the converter:

  • checks <li>'s parent,
  • stores and increases the conversionApi.store.indent value when <li>'s sub-items are converted.

  See source (with github icon)

Functions