Insertion (engine/model/utils)

@ckeditor/ckeditor5-engine/src/model/utils/insertcontent

Properties

• canMergeWith : Setmodule:engine/model/utils/insertcontent~Insertion#canMergeWith

  See source

  Elements with which the inserted elements can be merged.

  <p>x^</p><p>y</p> + <p>z</p> (can merge to <p>x</p>)
  <p>x</p><p>^y</p> + <p>z</p> (can merge to <p>y</p>)
  <p>x^y</p> + <p>z</p> (can merge to <p>xy</p> which will be split during the action,
  						so both its pieces will be added to this set)
  

• model : Modelmodule:engine/model/utils/insertcontent~Insertion#model

  See source

  The model in context of which the insertion should be performed.

• position : Positionmodule:engine/model/utils/insertcontent~Insertion#position

  See source

  The position at which (or near which) the next node will be inserted.

• schema : Schemamodule:engine/model/utils/insertcontent~Insertion#schema

  See source

  Schema of the model.

• writer : Batchmodule:engine/model/utils/insertcontent~Insertion#writer

  See source

  Batch to which operations will be added.

• private

  _affectedEnd : LivePosition | nullmodule:engine/model/utils/insertcontent~Insertion#_affectedEnd

  See source

  End of the affected range. See getAffectedRange.

• private

  _affectedStart : LivePosition | nullmodule:engine/model/utils/insertcontent~Insertion#_affectedStart

  See source

  Beginning of the affected range. See getAffectedRange.

• private

  _documentFragment : DocumentFragmentmodule:engine/model/utils/insertcontent~Insertion#_documentFragment

  See source

  The temporary DocumentFragment used for grouping multiple nodes for single insert operation.

• private

  _documentFragmentPosition : Positionmodule:engine/model/utils/insertcontent~Insertion#_documentFragmentPosition

  See source

  The current position in the temporary DocumentFragment.

• private

  _filterAttributesOf : Array.<Node>module:engine/model/utils/insertcontent~Insertion#_filterAttributesOf

  See source

  The array of nodes that should be cleaned of not allowed attributes.

• private

  _firstNode : Nodemodule:engine/model/utils/insertcontent~Insertion#_firstNode

  See source

  The reference to the first inserted node.

• private

  _lastAutoParagraph : Nodemodule:engine/model/utils/insertcontent~Insertion#_lastAutoParagraph

  See source

  The reference to the last auto paragraph node.

• private

  _lastNode : Nodemodule:engine/model/utils/insertcontent~Insertion#_lastNode

  See source

  The reference to the last inserted node.

Methods

• destroy()module:engine/model/utils/insertcontent~Insertion#destroy

  See source

  Destroys Insertion instance.

• getAffectedRange() → Range | nullmodule:engine/model/utils/insertcontent~Insertion#getAffectedRange

  See source

  Returns a range which contains all the performed changes. This is a range that, if removed, would return the model to the state before the insertion. Returns null if no changes were done.

  Returns

  Range | null

• getSelectionRange() → Range | nullmodule:engine/model/utils/insertcontent~Insertion#getSelectionRange

  See source

  Returns range to be selected after insertion. Returns null if there is no valid range to select after insertion.

  Returns

  Range | null

• handleNodes( nodes )module:engine/model/utils/insertcontent~Insertion#handleNodes

  See source

  Handles insertion of a set of nodes.

  Parameters

  nodes : Iterable.<Node>

  Nodes to insert.

• private

  _appendToFragment( node )module:engine/model/utils/insertcontent~Insertion#_appendToFragment

  See source

  Append a node to the temporary DocumentFragment.

  Parameters

  node : Node

  The node to insert.

• private

  _canMergeLeft( node ) → Booleanmodule:engine/model/utils/insertcontent~Insertion#_canMergeLeft

  See source

  Checks whether specified node can be merged with previous sibling element.

  Parameters

  node : Node

  The node which could potentially be merged.

  Returns

  Boolean

• private

  _canMergeRight( node ) → Booleanmodule:engine/model/utils/insertcontent~Insertion#_canMergeRight

  See source

  Checks whether specified node can be merged with next sibling element.

  Parameters

  node : Node

  The node which could potentially be merged.

  Returns

  Boolean

• private

  _checkAndAutoParagraphToAllowedPosition( node ) → Booleanmodule:engine/model/utils/insertcontent~Insertion#_checkAndAutoParagraphToAllowedPosition

  See source

  Checks if a node can be inserted in the given position or it would be accepted if a paragraph would be inserted. It also handles inserting the paragraph.

  Parameters

  node : Node

  The node.

  Returns

  Boolean

  Whether an allowed position was found. false is returned if the node isn't allowed at the current position or in auto paragraph, true if was.

• private

  _checkAndSplitToAllowedPosition( node ) → Booleanmodule:engine/model/utils/insertcontent~Insertion#_checkAndSplitToAllowedPosition

  See source

  Parameters

  node : Node

  Returns

  Boolean

  Whether an allowed position was found. false is returned if the node isn't allowed at any position up in the tree, true if was.

• private

  _getAllowedIn( contextElement, childNode ) → Element | nullmodule:engine/model/utils/insertcontent~Insertion#_getAllowedIn

  See source

  Gets the element in which the given node is allowed. It checks the passed element and all its ancestors.

  Parameters

  contextElement : Element

  The element in which context the node should be checked.

  childNode : Node

  The node to check.

  Returns

  Element | null

• private

  _handleDisallowedNode( node )module:engine/model/utils/insertcontent~Insertion#_handleDisallowedNode

  See source

  Parameters

  node : Node

  The disallowed node which needs to be handled.

• private

  _handleNode( node )module:engine/model/utils/insertcontent~Insertion#_handleNode

  See source

  Handles insertion of a single node.

  Parameters

  node : Node

• private

  _handleObject( node )module:engine/model/utils/insertcontent~Insertion#_handleObject

  See source

  Parameters

  node : Element

  The object element.

• private

  _insertPartialFragment()module:engine/model/utils/insertcontent~Insertion#_insertPartialFragment

  See source

  Inserts the temporary DocumentFragment into the model.

• private

  _mergeOnLeft()module:engine/model/utils/insertcontent~Insertion#_mergeOnLeft

  See source

  Merges the previous sibling of the first node if it should be merged.

  After the content was inserted we may try to merge it with its siblings. This should happen only if the selection was in those elements initially.

• private

  _mergeOnRight()module:engine/model/utils/insertcontent~Insertion#_mergeOnRight

  See source

  Merges the next sibling of the last node if it should be merged.

  After the content was inserted we may try to merge it with its siblings. This should happen only if the selection was in those elements initially.

• private

  _setAffectedBoundaries( position )module:engine/model/utils/insertcontent~Insertion#_setAffectedBoundaries

  See source

  Sets _affectedStart and _affectedEnd to the given position. Should be used before a change is done during insertion process to mark the affected range.

  This method is used before inserting a node or splitting a parent node. _affectedStart and _affectedEnd are also changed during merging, but the logic there is more complicated so it is left out of this function.

  Parameters

  position : Position

• private

  _tryAutoparagraphing( node )module:engine/model/utils/insertcontent~Insertion#_tryAutoparagraphing

  See source

  Tries wrapping the node in a new paragraph and inserting it this way.

  Parameters

  node : Node

  The node which needs to be autoparagraphed.

• private

  _updateLastNodeFromAutoParagraph( node )module:engine/model/utils/insertcontent~Insertion#_updateLastNodeFromAutoParagraph

  See source

  Updates the last node after the auto paragraphing.

  Parameters

  node : Node

  The last auto paragraphing node.