Class UndoHistory`Abstract`

A history of undone/redone objects. Why a pure abstract class and not an interface? Because interfaces are not retained at runtime in TS and we want DI (that thus cannot inject interface types).

Hierarchy

UndoHistory
- UndoHistoryImpl

Implements

UndoHistoryBase

Index

Constructors

Methods

add clear getLastOrEmptyRedoMessage getLastOrEmptyUndoMessage getLastRedo getLastRedoMessage getLastUndo getLastUndoMessage getRedo getSizeMax getUndo redo redosObservable setSizeMax undo undosObservable

Constructors

constructor

new UndoHistory(): UndoHistory
Returns UndoHistory

Methods

`Abstract` add

add(undoable): void
Adds an undoable object to the collector.
Parameters
- undoable: Undoable
  The undoable object to add.
Returns void
Implementation of UndoHistoryBase.add
- Defined in api/undo/UndoHistory.ts:26

`Abstract` clear

clear(): void
Removes all the undoable objects of the collector.

Returns void
Implementation of UndoHistoryBase.clear
- Defined in api/undo/UndoHistory.ts:28

`Abstract` getLastOrEmptyRedoMessage

getLastOrEmptyRedoMessage(): string
Returns string
The last redoable object name or an empty string if there is no last object.
Implementation of UndoHistoryBase.getLastOrEmptyRedoMessage
- Defined in api/undo/UndoHistory.ts:58

`Abstract` getLastOrEmptyUndoMessage

getLastOrEmptyUndoMessage(): string
Returns string
The last undoable object name or an empty string if there is no last object.
Implementation of UndoHistoryBase.getLastOrEmptyUndoMessage
- Defined in api/undo/UndoHistory.ts:56

`Abstract` getLastRedo

getLastRedo(): undefined | Undoable
Returns undefined | Undoable
The last redoable object or undefined if there is no last object.
Implementation of UndoHistoryBase.getLastRedo
- Defined in api/undo/UndoHistory.ts:50

`Abstract` getLastRedoMessage

getLastRedoMessage(): undefined | string
Returns undefined | string
The last redoable object name or undefined if there is no last object.
Implementation of UndoHistoryBase.getLastRedoMessage
- Defined in api/undo/UndoHistory.ts:54

`Abstract` getLastUndo

getLastUndo(): undefined | Undoable
Returns undefined | Undoable
The last undoable object or undefined if there is no last object.
Implementation of UndoHistoryBase.getLastUndo
- Defined in api/undo/UndoHistory.ts:48

`Abstract` getLastUndoMessage

getLastUndoMessage(): undefined | string
Returns undefined | string
The last undoable object name or undefined if there is no last object.
Implementation of UndoHistoryBase.getLastUndoMessage
- Defined in api/undo/UndoHistory.ts:52

`Abstract` getRedo

getRedo(): readonly Undoable[]
Returns readonly Undoable[]
The stack of saved redoable objects
- Defined in api/undo/UndoHistory.ts:42

`Abstract` getSizeMax

getSizeMax(): number
Returns number
The max number of saved undoable objects.
- Defined in api/undo/UndoHistory.ts:63

`Abstract` getUndo

getUndo(): readonly Undoable[]
Returns readonly Undoable[]
The stack of saved undoable objects.
- Defined in api/undo/UndoHistory.ts:37

`Abstract` redo

redo(): void
Redoes the last undoable object.

Returns void
Implementation of UndoHistoryBase.redo
- Defined in api/undo/UndoHistory.ts:32

`Abstract` redosObservable

redosObservable(): Observable<undefined | Undoable>
A stream for observing changes regarding the last redoable object.

Returns Observable<undefined | Undoable>
An observable value of optional redoable objects: if empty, this means that no redoable object are stored anymore.
Implementation of UndoHistoryBase.redosObservable
- Defined in api/undo/UndoHistory.ts:46

`Abstract` setSizeMax

setSizeMax(max): void
Parameters
- max: number
  The max number of saved undoable objects. Must be great than 0.
Returns void
- Defined in api/undo/UndoHistory.ts:68

`Abstract` undo

undo(): void
Undoes the last undoable object.

Returns void
Implementation of UndoHistoryBase.undo
- Defined in api/undo/UndoHistory.ts:30

`Abstract` undosObservable

undosObservable(): Observable<undefined | Undoable>
A stream for observing changes regarding the last undoable object.

Returns Observable<undefined | Undoable>
An observable value of optional undoable objects: if empty, this means that no undoable object are stored anymore.
Implementation of UndoHistoryBase.undosObservable
- Defined in api/undo/UndoHistory.ts:44

Generated using TypeDoc