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
-
inherited
baseVersion : Number
module:engine/model/operation/renameoperation~RenameOperation#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. -
readonly inherited
isDocumentOperation : Boolean
module:engine/model/operation/renameoperation~RenameOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
newName : String
module:engine/model/operation/renameoperation~RenameOperation#newName
New name for the element.
-
oldName : String
module:engine/model/operation/renameoperation~RenameOperation#oldName
Current name of the element.
-
Position before an element to change.
-
Operation type.
Static properties
-
inherited static
className : String
module:engine/model/operation/renameoperation~RenameOperation.className
Name of the operation class used for serialization.
Methods
-
constructor( position, oldName, newName, baseVersion )
module:engine/model/operation/renameoperation~RenameOperation#constructor
Creates an operation that changes element's name.
Parameters
-
clone() → RenameOperation
module:engine/model/operation/renameoperation~RenameOperation#clone
Creates and returns an operation that has the same parameters as this operation.
Returns
RenameOperation
Clone of this operation.
-
getReversed() → RenameOperation
module:engine/model/operation/renameoperation~RenameOperation#getReversed
-
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/renameoperation~RenameOperation#_execute
Executes the operation - modifications described by the operation properties will be applied to the model tree.
-
protected inherited
_validate()
module:engine/model/operation/renameoperation~RenameOperation#_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 ) → AttributeOperation
module:engine/model/operation/renameoperation~RenameOperation.fromJSON
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
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.