CKEDITOR.plugins.undo.UndoManager

Properties

• readonly

  limit : NumberCKEDITOR.plugins.undo.UndoManager#limit

  See source

  The maximum number of snapshots in the stack. Configurable via CKEDITOR.config.undoStackSize.

• readonly

  locked : ObjectCKEDITOR.plugins.undo.UndoManager#locked

  See source

  When the locked property is not null, the undo manager is locked, so operations like save or update are forbidden.

  The manager can be locked and unlocked by the lock and unlock methods, respectively.

  Defaults to null

• since 4.4.4 readonly

  previousKeyGroup : NumberCKEDITOR.plugins.undo.UndoManager#previousKeyGroup

  See source

  Contains the previously processed key group, based on keyGroups. -1 means an unknown group.

  Defaults to -1

• since 4.4.5 readonly

  strokesLimit : NumberCKEDITOR.plugins.undo.UndoManager#strokesLimit

  See source

  The maximum number of characters typed/deleted in one undo step.

  Defaults to 25

• since 4.4.4

  strokesRecorded : ArrayCKEDITOR.plugins.undo.UndoManager#strokesRecorded

  See source

  An array storing the number of key presses, count in a row. Use keyGroups members as index.

  Note: The keystroke count will be reset after reaching the limit of characters per snapshot.

  Defaults to [0, 0]

• since 4.13.0 private

  _filterRules : Function[]CKEDITOR.plugins.undo.UndoManager#_filterRules

  See source

  An array of filter rules.

  Defaults to []

Static properties

• since 4.4.5 readonly static

  keyGroups : ObjectCKEDITOR.plugins.undo.UndoManager#keyGroups

  See source

  Key groups identifier mapping. Used for accessing members in strokesRecorded.

  • FUNCTIONAL – identifier for the Backspace / Delete key.
  • PRINTABLE – identifier for printable keys.

  Example usage:

  undoManager.strokesRecorded[ undoManager.keyGroups.FUNCTIONAL ];
  

  Defaults to {PRINTABLE: 0, FUNCTIONAL: 1}

• since 4.4.5 readonly static

  navigationKeyCodes : ObjectCKEDITOR.plugins.undo.UndoManager#navigationKeyCodes

  See source

  Codes for navigation keys like Arrows, Page Up/Down, etc. Used by the isNavigationKey method.

  Defaults to {37: 1, 38: 1, 39: 1, 40: 1, 36: 1, 35: 1, 33: 1, 34: 1}

Methods

• constructor( editor ) → UndoManagerCKEDITOR.plugins.undo.UndoManager#constructor

  See source

  Creates an UndoManager class instance.

  Parameters

  editor : editor

  Returns

  UndoManager

• since 4.13.0

  addFilterRule( rule )CKEDITOR.plugins.undo.UndoManager#addFilterRule

  See source

  Registers a filtering rule.

  Parameters

  rule : Function

  Callback function that returns filtered data.

  getNextImage( isUndo ) → ImageCKEDITOR.plugins.undo.UndoManager#getNextImage

  See source

  Gets the closest available image.

  Parameters

  isUndo : Boolean

  If true, it will return the previous image.

  Returns

  Image

  Next image or null.

  since 4.4.5

  keyGroupChanged( keyCode ) → BooleanCKEDITOR.plugins.undo.UndoManager#keyGroupChanged

  See source

  Whether the new keyCode belongs to a different group than the previous one (previousKeyGroup).

  Parameters

  keyCode : Number

  Returns

  Boolean

  since 4.0.0

  lock( [ dontUpdate ], [ forceUpdate ] )CKEDITOR.plugins.undo.UndoManager#lock

  See source

  Locks the snapshot stack to prevent any save/update operations and when necessary, updates the tip of the snapshot stack with the DOM changes introduced during the locked period, after the unlock method is called.

  It is mainly used to ensure any DOM operations that should not be recorded (e.g. auto paragraphing) are not added to the stack.

  Note: For every lock call you must call unlock once to unlock the undo manager.

  Parameters

  [ dontUpdate ] : Boolean

  When set to true, the last snapshot will not be updated with current content and selection. By default, if undo manager was up to date when the lock started, the last snapshot will be updated to the current state when unlocking. This means that all changes done during the lock will be merged into the previous snapshot or the next one. Use this option to gain more control over this behavior. For example, it is possible to group changes done during the lock into a separate snapshot.

  [ forceUpdate ] : Boolean

  When set to true, the last snapshot will always be updated with the current content and selection regardless of the current state of the undo manager. When not set, the last snapshot will be updated only if the undo manager was up to date when locking. Additionally, this option makes it possible to lock the snapshot when the editor is not in the wysiwyg mode, because when it is passed, the snapshots will not need to be compared.

  redo()CKEDITOR.plugins.undo.UndoManager#redo

  See source

  Performs a redo operation on current index.

  redoable() → BooleanCKEDITOR.plugins.undo.UndoManager#redoable

  See source

  Checks the current redo state.

  Returns

  Boolean

  Whether the document has a previous state to retrieve.

  refreshState()CKEDITOR.plugins.undo.UndoManager#refreshState

  See source

  Refreshes the state of the undo manager as well as the state of the undo and redo commands.

  reset()CKEDITOR.plugins.undo.UndoManager#reset

  See source

  Resets the undo stack.

  resetType()CKEDITOR.plugins.undo.UndoManager#resetType

  See source

  Resets all typing variables.

  type

  restoreImage( image )CKEDITOR.plugins.undo.UndoManager#restoreImage

  See source

  Sets editor content/selection to the one stored in image.

  Parameters

  image : Image

  save( onContentOnly, image, [ autoFireChange ] )CKEDITOR.plugins.undo.UndoManager#save

  See source

  Saves a snapshot of the document image for later retrieval.

  Parameters

  onContentOnly : Boolean

  If set to true, the snapshot will be saved only if the content has changed.

  image : Image

  An optional image to save. If skipped, current editor will be used.

  [ autoFireChange ] : Boolean

  If set to false, will not trigger the CKEDITOR.editor.change event to editor.

  Defaults to true

  type( keyCode, [ strokesPerSnapshotExceeded ] )CKEDITOR.plugins.undo.UndoManager#type

  See source

  Handles keystroke support for the undo manager. It is called on the keyup event for keystrokes that can change the editor content.

  Parameters

  keyCode : Number

  The key code.

  [ strokesPerSnapshotExceeded ] : Boolean

  When set to true, the method will behave as if the strokes limit was exceeded regardless of the strokesRecorded value.

  undo()CKEDITOR.plugins.undo.UndoManager#undo

  See source

  Performs an undo operation on current index.

  undoable() → BooleanCKEDITOR.plugins.undo.UndoManager#undoable

  See source

  Checks the current undo state.

  Returns

  Boolean

  Whether the document has a future state to restore.

  since 4.0.0

  unlock()CKEDITOR.plugins.undo.UndoManager#unlock

  See source

  Unlocks the snapshot stack and checks to amend the last snapshot.

  See lock for more details.

  update( [ newImage ] )CKEDITOR.plugins.undo.UndoManager#update

  See source

  Updates the last snapshot of the undo stack with the current editor content.

  Parameters

  [ newImage ] : Image

  The image which will replace the current one. If it is not set, it defaults to the image taken from the editor.

  since 4.4.4

  updateSelection( newSnapshot ) → BooleanCKEDITOR.plugins.undo.UndoManager#updateSelection

  See source

  Amends the last snapshot and changes its selection (only in case when content is equal between these two).

  Parameters

  newSnapshot : Image

  New snapshot with new selection.

  Returns

  Boolean

  Returns true if selection was amended.

  Static methods

  • since 4.4.5 static

    getKeyGroup( keyCode ) → NumberCKEDITOR.plugins.undo.UndoManager#getKeyGroup

    See source

    Returns the group to which the passed keyCode belongs.

    Parameters

    keyCode : Number

    Returns

    Number

  • since 4.4.5 static

    getOppositeKeyGroup( keyGroup ) → NumberCKEDITOR.plugins.undo.UndoManager#getOppositeKeyGroup

    See source

    Parameters

    keyGroup : Number

    Returns

    Number

  • since 4.4.5 static

    ieFunctionalKeysBug( keyCode ) → BooleanCKEDITOR.plugins.undo.UndoManager#ieFunctionalKeysBug

    See source

    Whether we need to use a workaround for functional (Backspace, Delete) keys not firing the keypress event in Internet Explorer in this environment and for the specified keyCode.

    Parameters

    keyCode : Number

    Returns

    Boolean

  • since 4.4.5 static

    isNavigationKey( keyCode ) → BooleanCKEDITOR.plugins.undo.UndoManager#isNavigationKey

    See source

    Checks whether a key is one of navigation keys (Arrows, Page Up/Down, etc.). See also the navigationKeyCodes property.

    Parameters

    keyCode : Number

    Returns

    Boolean