Class TransactionUndoManager

UndoManager that wraps transaction commits and restores these.

Hierarchy (View Summary)

UndoManager
- TransactionUndoManager

Index

Constructors

Accessors

Methods

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

Constructors

constructor

new TransactionUndoManager(
transactions?: IStore,
maxStack?: number,
): TransactionUndoManager
Parameters
- Optionaltransactions: IStore
- maxStack: number = 50
Returns TransactionUndoManager
Overrides UndoManager.constructor

Accessors

maxStack

get maxStack(): number
Returns number
Inherited from UndoManager.maxStack

Methods

addListener

addListener(listener: IUndoManagerListener): RemoveListener
Parameters
- listener: IUndoManagerListener
Returns RemoveListener
Inherited from UndoManager.addListener

addUndoOperation

addUndoOperation(operation: IUndoOperation): void
Add an undo operation to the stack.
Parameters
- operation: IUndoOperation
Returns void
Inherited from UndoManager.addUndoOperation

clear

clear(): void
Clear the stack.

Returns void
Overrides UndoManager.clear

close

close(): void
Close the undo manager and remove the listener.

Returns void

getRedoDescriptions

getRedoDescriptions(): readonly string[]
Returns readonly string[]
Inherited from UndoManager.getRedoDescriptions

getTopRedoDescription

getTopRedoDescription(): string
Returns string
Inherited from UndoManager.getTopRedoDescription

getTopUndoDescription

getTopUndoDescription(): string
Returns string
Inherited from UndoManager.getTopUndoDescription

getUndoDescriptions

getUndoDescriptions(): readonly string[]
Returns readonly string[]
Inherited from UndoManager.getUndoDescriptions

hasRedo

hasRedo(): boolean
Returns true if there are redo actions on the stack.

Returns boolean
Remarks
These can be either as a result of an undo or a repeatable action.

Inherited from UndoManager.hasRedo

hasUndo

hasUndo(): boolean
Returns true if there are undo actions on the stack.

Returns boolean
Inherited from UndoManager.hasUndo

redo

redo(count?: number): void
Redo the last redo actions on the stack.
Parameters
- Optionalcount: number
  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

Inherited from UndoManager.redo

setRepeatableOperation

setRepeatableOperation(operation: IRepeatableOperation): 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.
- Clears the redo stack and does NOT add this operation to the undo stack.
Inherited from UndoManager.setRepeatableOperation

undo

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