Class TreeUndoHistoryImpl

constructor

• new TreeUndoHistoryImpl(keepPath?): TreeUndoHistoryImpl

• Parameters

  • keepPath: boolean = false

  Returns TreeUndoHistoryImpl

Readonly root

Readonly undoableNodes

currentNode

• get currentNode(): UndoableTreeNode

• The current node. As the history is a tree in which one can navigate using undo, redo, gotTo, this current node refers to the node where the system state is.

  Returns UndoableTreeNode

keepPath

• get keepPath(): boolean

• States whether the path of kept. If kept, users cannot delete nodes.

  Returns boolean

path

• get path(): readonly number[]

• Returns the ordered sequence of undoable's ID that the user performed. This permits to keep traces of what the users did and how they arrived to the final state.

  Returns readonly number[]

add

• add(undoable): void

• Adds an undoable object to the collector.

  Parameters

  • undoable: Undoable

    The undoable object to add.

  Returns void

clear

• clear(): void

• Removes all the undoable objects of the collector.

  Returns void

delete

• delete(id): void

• Deletes the targeted node. Works only if the history does not keep the usage path (see path()).

  Parameters

  • id: number

    The node ID to remove. It removes all the branch from this node. Does not remove the branch if the current node is in it.

  Returns void

export

• export(fn): TreeUndoHistoryDTO

• Exports the history.

  Parameters

  • fn: ((undoable) => unknown)

    The function that converts undoable objects into ad-hoc formats.

    • • (undoable): unknown

      • Parameters

        • undoable: Undoable

        Returns unknown

  Returns TreeUndoHistoryDTO

getLastOrEmptyRedoMessage

• getLastOrEmptyRedoMessage(): string

• Returns string

  The last redoable object name or an empty string if there is no last object.

getLastOrEmptyUndoMessage

• getLastOrEmptyUndoMessage(): string

• Returns string

  The last undoable object name or an empty string if there is no last object.

getLastRedo

• getLastRedo(): undefined | Undoable

• Returns undefined | Undoable

  The last redoable object or undefined if there is no last object.

getLastRedoMessage

• getLastRedoMessage(): undefined | string

• Returns undefined | string

  The last redoable object name or undefined if there is no last object.

getLastUndo

• getLastUndo(): undefined | Undoable

• Returns undefined | Undoable

  The last undoable object or undefined if there is no last object.

getLastUndoMessage

• getLastUndoMessage(): undefined | string

• Returns undefined | string

  The last undoable object name or undefined if there is no last object.

getPositions

• getPositions(): Map<number, number>

• Computes the position (in the large) of each node. Useful for layouting.

  Returns Map<number, number>

goTo

• goTo(id): void

• Moves to the given node ID.

  Parameters

  • id: number

    The node ID contained in the tree. Moves to it if correct.

  Returns void

import

• import(dtoHistory, fn): void

• Imports the given DTO history. Flushes the current history.

  Parameters

  • dtoHistory: TreeUndoHistoryDTO

    The DTO history to import.

  • fn: ((dtoUndoable) => Undoable)

    The convertion fonction that transforms undoable DTO (of nodes) into Undoable.

    • • (dtoUndoable): Undoable

      • Parameters

        • dtoUndoable: unknown

        Returns Undoable

  Returns void

redo

• redo(): void

• Redoes the last undoable object.

  Returns void

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.

undo

• undo(): void

• Undoes the last undoable object.

  Returns void

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.