Class UndoManager

A stack of undo/redo actions.

Index

Constructors

Accessors

Methods

addListener addUndoOperation clear getRedoDescriptions getTopRedoDescription getTopUndoDescription getUndoDescriptions hasRedo hasUndo notifyOnStackChange redo setRepeatableOperation undo

Constructors

constructor

new UndoManager(maxStack?): UndoManager
Parameters
- maxStack: number = 50
Returns UndoManager

Accessors

maxStack

get maxStack(): number
Returns number

Methods

addListener

addListener(listener): RemoveListener
Parameters
- listener: IUndoManagerListener
Returns RemoveListener

addUndoOperation

addUndoOperation(operation): void
Parameters
- operation: IUndoOperation
Returns void

clear

clear(notify?): void
Parameters
- notify: boolean = true
Returns void

getRedoDescriptions

getRedoDescriptions(): readonly string[]
Returns readonly string[]

getTopRedoDescription

getTopRedoDescription(): string
Returns string

getTopUndoDescription

getTopUndoDescription(): string
Returns string

getUndoDescriptions

getUndoDescriptions(): readonly string[]
Returns readonly string[]

hasRedo

hasRedo(): boolean
Returns boolean

hasUndo

hasUndo(): boolean
Returns boolean

notifyOnStackChange

notifyOnStackChange(): void
Returns void

redo

redo(count?): void
Redo the last redo actions on the stack.
Parameters
- count: number = 1
  number of actions to undo, default is 1
Returns void
Remarks
The redo stack a list of all items that have an undo. Adding another item to the undo stack

setRepeatableOperation

setRepeatableOperation(operation): void
Sets repeatable action.
Parameters
- operation: IRepeatableOperation
Returns void
Remarks
A repeatable action is an action that a user can do multiple times 'usually on various selections'. For example styling a field adding a similar operation to the undo stack is usually expected and has to be done done separately by the caller. This will clear the redo stack and does NOT add this operation to the undo stack.

undo

undo(count?): void
Undo the last actions on the stack.
Parameters
- count: number = 1
  number of actions to undo, default is 1
Returns void