MergeOperation
Operation to merge two elements.
The merged element is the parent of sourcePosition and it is merged into the parent of
targetPosition. All nodes from the merged element are moved to targetPosition.
The merged element is moved to the graveyard at graveyardPosition.
Properties
-
affectedSelectable : ModelSelectablereadonlymodule:engine/model/operation/mergeoperation~MergeOperation#affectedSelectableA selectable that will be affected by the operation after it is executed.
The exact returned parameter differs between operation types.
-
baseVersion : null | numberinheritedmodule:engine/model/operation/mergeoperation~MergeOperation#baseVersionversionon which operation can be applied. If you try to apply operation with different base version than the document version the model-document-applyOperation-wrong-version error is thrown. -
module:engine/model/operation/mergeoperation~MergeOperation#batchBatch to which the operation is added or
nullif the operation is not added to any batch yet.Note, that a non-document operation has this property always set to
null, and is never added to any batch. -
deletionPosition : ModelPositionreadonlymodule:engine/model/operation/mergeoperation~MergeOperation#deletionPositionPosition before the merged element (which will be deleted).
-
module:engine/model/operation/mergeoperation~MergeOperation#graveyardPositionPosition in graveyard to which the merged element will be moved.
-
howMany : numbermodule:engine/model/operation/mergeoperation~MergeOperation#howManySummary offset size of nodes which will be moved from the merged element to the new parent.
-
isDocumentOperation : booleanreadonlyinheritedmodule:engine/model/operation/mergeoperation~MergeOperation#isDocumentOperationDefines whether operation is executed on attached or detached items.
-
movedRange : ModelRangereadonlymodule:engine/model/operation/mergeoperation~MergeOperation#movedRangeArtificial range that contains all the nodes from the merged element that will be moved to
sourcePosition. The range starts atsourcePositionand ends in the same parent, atPOSITIVE_INFINITYoffset. -
module:engine/model/operation/mergeoperation~MergeOperation#sourcePositionPosition inside the merged element. All nodes from that element after that position will be moved to
targetPosition. -
module:engine/model/operation/mergeoperation~MergeOperation#targetPositionPosition which the nodes from the merged elements will be moved to.
-
type : 'merge'readonlymodule:engine/model/operation/mergeoperation~MergeOperation#typeOperation type.
Static properties
-
className : stringreadonlystaticmodule:engine/model/operation/mergeoperation~MergeOperation.classNameName of the operation class used for serialization.
Methods
-
constructor( sourcePosition, howMany, targetPosition, graveyardPosition, baseVersion )module:engine/model/operation/mergeoperation~MergeOperation#constructorCreates a merge operation.
Parameters
sourcePosition : ModelPositionPosition inside the merged element. All nodes from that element after that position will be moved to
targetPosition.howMany : numberSummary offset size of nodes which will be moved from the merged element to the new parent.
targetPosition : ModelPositionPosition which the nodes from the merged elements will be moved to.
graveyardPosition : ModelPositionPosition in graveyard to which the merged element will be moved.
baseVersion : null | numberDocument
versionon which operation can be applied ornullif the operation operates on detached (non-document) tree.
-
clone() → MergeOperationmodule:engine/model/operation/mergeoperation~MergeOperation#cloneCreates and returns an operation that has the same parameters as this operation.
Returns
-
getReversed() → Operationmodule:engine/model/operation/mergeoperation~MergeOperation#getReversed -
toJSON() → unknownmodule:engine/model/operation/mergeoperation~MergeOperation#toJSONCustom toJSON method to solve child-parent circular dependencies.
Returns
unknownClone of this object with the operation property replaced with string.
-
_execute() → voidinternalmodule:engine/model/operation/mergeoperation~MergeOperation#_executeExecutes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
_validate() → voidinternalmodule:engine/model/operation/mergeoperation~MergeOperation#_validateChecks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.
Returns
void
Static methods
-
fromJSON( json, document ) → MergeOperationstaticmodule:engine/model/operation/mergeoperation~MergeOperation.fromJSONCreates
MergeOperationobject from deserialized object, i.e. from parsed JSON string.Parameters
json : anyDeserialized JSON object.
document : ModelDocumentDocument on which this operation will be applied.
Returns