RenameOperation (engine/model/operation)
@ckeditor/ckeditor5-engine/src/model/operation/renameoperation
Operation to change element's name.
Using this class you can change element's name.
Filtering
Properties
-
baseVersion : Number
inherited
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. -
isDocumentOperation : Boolean
readonly inherited
Defines whether operation is executed on attached or detached items.
-
newName : String
New name for the element.
-
oldName : String
Current name of the element.
-
Position before an element to change.
-
type : String
readonly inherited
Operation type.
Static properties
-
className : String
inherited static
Name of the operation class used for serialization.
Methods
-
constructor( position, oldName, newName, baseVersion )
Creates an operation that changes element's name.
Parameters
-
clone() → RenameOperation
Creates and returns an operation that has the same parameters as this operation.
Returns
RenameOperation
Clone of this operation.
-
Returns
-
toJSON() → Object
inherited
Custom toJSON method to solve child-parent circular dependencies.
Returns
Object
Clone of this object with the operation property replaced with string.
-
_execute()
protected inherited
Executes the operation - modifications described by the operation properties will be applied to the model tree.
-
_validate()
protected inherited
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
-
fromJSON( json, document ) → AttributeOperation
static
Creates
RenameOperation
object from deserialized object, i.e. from parsed JSON string.Parameters
json : Object
Deserialized JSON object.
document : Document
Document on which this operation will be applied.
Returns