DetachOperation (engine/model/operation)
@ckeditor/ckeditor5-engine/src/model/operation/detachoperation
Operation to permanently remove node from detached root. Note this operation is only a local operation and won't be send to the other clients.
Filtering
Properties
-
inherited
baseVersion : Number
module:engine/model/operation/detachoperation~DetachOperation#baseVersion
version
on 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. -
Batch to which the operation is added or
null
if the operation is not added to any batch yet. -
howMany : Number
module:engine/model/operation/detachoperation~DetachOperation#howMany
Offset size of moved range.
-
readonly inherited
isDocumentOperation : Boolean
module:engine/model/operation/detachoperation~DetachOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
sourcePosition : Position
module:engine/model/operation/detachoperation~DetachOperation#sourcePosition
Position before the first model item to detach.
-
Operation type.
Static properties
-
inherited static
className : String
module:engine/model/operation/detachoperation~DetachOperation.className
Name of the operation class used for serialization.
Methods
-
constructor( sourcePosition, howMany )
module:engine/model/operation/detachoperation~DetachOperation#constructor
Creates an insert operation.
Parameters
sourcePosition : Position
Position before the first model item to move.
howMany : Number
Offset size of moved range. Moved range will start from
sourcePosition
and end atsourcePosition
with offset shifted byhowMany
.
-
Creates and returns an operation that has the same parameters as this operation.
Returns
Operation
Clone of this operation.
-
inherited
getReversed() → Operation
module:engine/model/operation/detachoperation~DetachOperation#getReversed
Creates and returns a reverse operation. Reverse operation when executed right after the original operation will bring back tree model state to the point before the original operation execution. In other words, it reverses changes done by the original operation.
Keep in mind that tree model state may change since executing the original operation, so reverse operation will be "outdated". In that case you will need to transform it by all operations that were executed after the original operation.
Returns
Operation
Reversed operation.
-
Custom toJSON method to solve child-parent circular dependencies.
Returns
Object
Clone of this object with the operation property replaced with string.
-
protected inherited
_execute()
module:engine/model/operation/detachoperation~DetachOperation#_execute
Executes the operation - modifications described by the operation properties will be applied to the model tree.
-
protected inherited
_validate()
module:engine/model/operation/detachoperation~DetachOperation#_validate
Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.
Static methods
-
inherited static
fromJSON( json, doc ) → Operation
module:engine/model/operation/detachoperation~DetachOperation.fromJSON
Creates Operation object from deserilized object, i.e. from parsed JSON string.
Parameters
json : Object
Deserialized JSON object.
doc : Document
Document on which this operation will be applied.
Returns
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.