Class UndoHistoryImpl

Implementation of the undo history (linear)

Hierarchy

UndoHistory
- UndoHistoryImpl

Constructors

constructor

new UndoHistoryImpl(): UndoHistoryImpl
Create the undo history

Returns UndoHistoryImpl
Overrides UndoHistory.constructor
- Defined in impl/undo/UndoHistoryImpl.ts:47

Properties

`Private` `Readonly` redoPublisher

redoPublisher: Subject<undefined | Undoable>

`Private` `Readonly` redos

redos: Undoable[]

Contains the redoable objects.

`Private` sizeMax

sizeMax: number

The maximal number of undo.

`Private` `Readonly` undoPublisher

undoPublisher: Subject<undefined | Undoable>

`Private` `Readonly` undos

undos: Undoable[]

Contains the undoable objects.

Methods

add

add(undoable): void
Adds an undoable object to the collector.
Parameters
- undoable: Undoable
  The undoable object to add.
Returns void
Overrides UndoHistory.add
- Defined in impl/undo/UndoHistoryImpl.ts:80

clear

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

Returns void
Overrides UndoHistory.clear
- Defined in impl/undo/UndoHistoryImpl.ts:65

`Private` clearRedo

clearRedo(): void
Returns void
- Defined in impl/undo/UndoHistoryImpl.ts:73

getLastOrEmptyRedoMessage

getLastOrEmptyRedoMessage(): string
Returns string
The last redoable object name or an empty string if there is no last object.
Overrides UndoHistory.getLastOrEmptyRedoMessage
- Defined in impl/undo/UndoHistoryImpl.ts:132

getLastOrEmptyUndoMessage

getLastOrEmptyUndoMessage(): string
Returns string
The last undoable object name or an empty string if there is no last object.
Overrides UndoHistory.getLastOrEmptyUndoMessage
- Defined in impl/undo/UndoHistoryImpl.ts:128

getLastRedo

getLastRedo(): undefined | Undoable
Returns undefined | Undoable
The last redoable object or undefined if there is no last object.
Overrides UndoHistory.getLastRedo
- Defined in impl/undo/UndoHistoryImpl.ts:140

getLastRedoMessage

getLastRedoMessage(): undefined | string
Returns undefined | string
The last redoable object name or undefined if there is no last object.
Overrides UndoHistory.getLastRedoMessage
- Defined in impl/undo/UndoHistoryImpl.ts:124

getLastUndo

getLastUndo(): undefined | Undoable
Returns undefined | Undoable
The last undoable object or undefined if there is no last object.
Overrides UndoHistory.getLastUndo
- Defined in impl/undo/UndoHistoryImpl.ts:136

getLastUndoMessage

getLastUndoMessage(): undefined | string
Returns undefined | string
The last undoable object name or undefined if there is no last object.
Overrides UndoHistory.getLastUndoMessage
- Defined in impl/undo/UndoHistoryImpl.ts:120

getRedo

getRedo(): readonly Undoable[]
Returns readonly Undoable[]
The stack of saved redoable objects
Overrides UndoHistory.getRedo
- Defined in impl/undo/UndoHistoryImpl.ts:162

getSizeMax

getSizeMax(): number
Returns number
The max number of saved undoable objects.
Overrides UndoHistory.getSizeMax
- Defined in impl/undo/UndoHistoryImpl.ts:144

getUndo

getUndo(): readonly Undoable[]
Returns readonly Undoable[]
The stack of saved undoable objects.
Overrides UndoHistory.getUndo
- Defined in impl/undo/UndoHistoryImpl.ts:158

redo

redo(): void
Redoes the last undoable object.

Returns void
Overrides UndoHistory.redo
- Defined in impl/undo/UndoHistoryImpl.ts:106

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.
Overrides UndoHistory.redosObservable
- Defined in impl/undo/UndoHistoryImpl.ts:61

setSizeMax

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

undo

undo(): void
Undoes the last undoable object.

Returns void
Overrides UndoHistory.undo
- Defined in impl/undo/UndoHistoryImpl.ts:92

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.
Overrides UndoHistory.undosObservable
- Defined in impl/undo/UndoHistoryImpl.ts:57

Generated using TypeDoc