CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 5/API
Class

RenameOperation (engine/model/operation)

@ckeditor/ckeditor5-engine/src/model/operation/renameoperation

class

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 : Batch | null

    inherited

    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 : Position

    Position before an element to change.

  • type : String

    readonly inherited

    Operation type.

    Overrides: 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

    position : Position

    Position before an element to change.

    oldName : String

    Current name of the element.

    newName : String

    New name for the element.

    baseVersion : Number | null

    Document version on which operation can be applied or null if the operation operates on detached (non-document) tree.

    Overrides: Operation#constructor

  • clone() → RenameOperation

    Creates and returns an operation that has the same parameters as this operation.

    Returns

    RenameOperation

    Clone of this operation.

    Overrides: Operation#clone

  • getReversed() → RenameOperation

    See Operation#getReversed().

    Returns

    RenameOperation
    Overrides: Operation#getReversed

  • 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.

    Overrides: Operation#toJSON

  • _execute()

    protected inherited

    Executes the operation - modifications described by the operation properties will be applied to the model tree.

    Overrides: Operation#_execute

  • _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.

    Overrides: Operation#_validate

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

    AttributeOperation