CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

RenameOperation (engine/model/operation)

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

class
See source

Operation to change element's name.

Using this class you can change element's name.

Filtering

Properties

  • readonly

    affectedSelectable : Selectable

    See source

    A selectable that will be affected by the operation after it is executed.

    The exact returned parameter differs between operation types.

  • inherited

    baseVersion : null | number

    See source

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

    See source

    Batch to which the operation is added or null if the operation is not added to any batch yet.

  • readonly inherited

    isDocumentOperation : boolean

    See source

    Defines whether operation is executed on attached or detached items.

  • newName : string

    See source

    New name for the element.

  • oldName : string

    See source

    Current name of the element.

  • position : Position

    See source

    Position before an element to change.

  • readonly

    type : 'rename'

    See source

    Operation type.

Static properties

  • readonly static

    className : string

    See source

    Name of the operation class used for serialization.

Methods

  • constructor( position, oldName, newName, baseVersion )

    See source

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

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

  • clone() → RenameOperation

    See source

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

    Returns

    RenameOperation

    Clone of this operation.

  • getReversed() → Operation

    See source

    See Operation#getReversed().

    Returns

    Operation

  • toJSON() → unknown

    See source

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

    Clone of this object with the operation property replaced with string.

  • internal

    _execute() → void

    See source

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

    Returns

    void

  • internal

    _validate() → void

    See source

    Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.

    Returns

    void

Static methods

  • static

    fromJSON( json, document ) → RenameOperation

    See source

    Creates RenameOperation object from deserialized object, i.e. from parsed JSON string.

    Parameters

    json : any

    Deserialized JSON object.

    document : Document

    Document on which this operation will be applied.

    Returns

    RenameOperation