Insertion (engine/model/utils)

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

Properties

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

  Elements with which the inserted elements can be merged.

  See source

  <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)

  Copy

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

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

  See source

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

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

  See source

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

  Schema of the model.

  See source

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

  Batch to which operations will be added.

  See source

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

  private

  End of the affected range. See getAffectedRange.

  See source

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

  private

  Beginning of the affected range. See getAffectedRange.

  See source

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

  private

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

  See source

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

  private

  The current position in the temporary DocumentFragment.

  See source

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

  private

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

  See source

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

  private

  The reference to the first inserted node.

  See source

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

  private

  The reference to the last auto paragraph node.

  See source

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

  private

  The reference to the last inserted node.

  See source

Methods

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

  Destroys Insertion instance.

  See source

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

  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.

  See source

  Returns

  Range | null

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

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

  See source

  Returns

  Range | null

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

  Handles insertion of a set of nodes.

  See source

  Parameters

  nodes : Iterable.<Node>

  Nodes to insert.

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

  private

  Append a node to the temporary DocumentFragment.

  See source

  Parameters

  node : Node

  The node to insert.

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

  private

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

  See source

  Parameters

  node : Node

  The node which could potentially be merged.

  Returns

  Boolean

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

  private

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

  See source

  Parameters

  node : Node

  The node which could potentially be merged.

  Returns

  Boolean

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

  private

  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.

  See source

  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.

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

  private

  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.

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

  private

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

  See source

  Parameters

  contextElement : Element

  The element in which context the node should be checked.

  childNode : Node

  The node to check.

  Returns

  Element | null

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

  private

  Parameters

  node : Node

  The disallowed node which needs to be handled.

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

  private

  Handles insertion of a single node.

  See source

  Parameters

  node : Node

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

  private

  Parameters

  node : Element

  The object element.

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

  private

  Inserts the temporary DocumentFragment into the model.

  See source

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

  private

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

  See source

  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.

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

  private

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

  See source

  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.

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

  private

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

  See source

  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

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

  private

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

  See source

  Parameters

  node : Node

  The node which needs to be autoparagraphed.

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

  private

  Updates the last node after the auto paragraphing.

  See source

  Parameters

  node : Node

  The last auto paragraphing node.