RootAttributeOperation (engine/model/operation)
@ckeditor/ckeditor5-engine/src/model/operation/rootattributeoperation
Operation to change root element's attribute. Using this class you can add, remove or change value of the attribute.
This operation is needed, because root elements can't be changed through
Filtering
Properties
-
inherited
baseVersion : Number
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#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. -
inherited
batch : Batch | null
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#batch
Batch to which the operation is added or
null
if the operation is not added to any batch yet. -
readonly inherited
isDocumentOperation : Boolean
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
readonly
key : String
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#key
Key of an attribute to change or remove.
-
readonly
newValue : *
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#newValue
New value to set for the attribute. If
null
, then the operation just removes the attribute. -
readonly
oldValue : *
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#oldValue
Old value of the attribute with given key or
null
if adding a new attribute. -
readonly
root : RootElement
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#root
Root element to change.
-
readonly inherited
type : String
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#type
Operation type.
Static properties
-
inherited static
className : String
module:engine/model/operation/rootattributeoperation~RootAttributeOperation.className
Name of the operation class used for serialization.
Methods
-
constructor( root, key, oldValue, newValue, baseVersion )
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#constructor
Creates an operation that changes, removes or adds attributes on root element.
Parameters
root : RootElement
Root element to change.
key : String
Key of an attribute to change or remove.
oldValue : *
Old value of the attribute with given key or
null
if adding a new attribute.newValue : *
New value to set for the attribute. If
null
, then the operation just removes the attribute.baseVersion : Number | null
Document
version
on which operation can be applied ornull
if the operation operates on detached (non-document) tree.
Related:
-
clone() → RootAttributeOperation
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#clone
Creates and returns an operation that has the same parameters as this operation.
Returns
RootAttributeOperation
Clone of this operation.
-
getReversed() → RootAttributeOperation
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#getReversed
-
inherited
toJSON() → Object
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#toJSON
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/rootattributeoperation~RootAttributeOperation#_execute
Executes the operation - modifications described by the operation properties will be applied to the model tree.
-
protected inherited
_validate()
module:engine/model/operation/rootattributeoperation~RootAttributeOperation#_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
-
static
fromJSON( json, document ) → RootAttributeOperation
module:engine/model/operation/rootattributeoperation~RootAttributeOperation.fromJSON
Creates RootAttributeOperation object from deserilized object, i.e. from parsed JSON string.
Parameters
json : Object
Deserialized JSON object.
document : 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.