Class ActionPool

Brief

A Pool of actions for undo/redo purpose

Hierarchy

ActionPool

Index

Constructors

Accessors

maxSize redoActionNames undoActionNames

Methods

clear execute redo undo

Constructors

constructor

new ActionPool(size?: number): ActionPool
Parameters
- size: number = 10
Returns ActionPool

Accessors

maxSize

get maxSize(): number
Returns number
set maxSize(s: number): void
Parameters
- s: number
Returns void

redoActionNames

get redoActionNames(): any[]
Returns any[]

undoActionNames

get undoActionNames(): any[]
Returns any[]

Methods

clear

clear(): void
Returns void

execute

execute(do_: (() => void), undo_?: (() => void), name?: string): boolean
Register and execute an action.

Note
Only valid actions are registered in the pool (and then executed of couse).
Parameters
- do_: (() => void)
  
  Can be either a function (or lambda) or an Action
  - - (): void
    - Returns void
- Optional undo_: (() => void)
  
  If do_ is an Action, undo_ is irrelevant.
  - - (): void
    - Returns void
- Optional name: string
Returns boolean

redo

redo(n?: number): void
Parameters
- n: number = 1
Returns void

undo

undo(n?: number): void
Parameters
- n: number = 1
Returns void