Class UndoableCommand`Abstract`

The base class for undoable UI commands.

Hierarchy

CommandBase
- UndoableCommand

Implements

Undoable

Index

Constructors

Properties

Methods

canExecute cancel createMemento done execute execution flush getStatus getUndoName getVisualSnapshot hadEffect isDone redo undo

Constructors

constructor

new UndoableCommand(): UndoableCommand
Creates the command with the status 'created'.

Returns UndoableCommand
Inherited from CommandBase.constructor
- Defined in impl/command/CommandBase.ts:30

Properties

`Protected` status

status: CmdStatus

The state of the command.

Methods

canExecute

canExecute(): boolean
Checks whether the command can be executed.

Returns boolean
True if the command can be executed.
Inherited from CommandBase.canExecute
- Defined in impl/command/CommandBase.ts:110

cancel

cancel(): void
Marks the command has aborted.

Returns void
Inherited from CommandBase.cancel
- Defined in impl/command/CommandBase.ts:102

`Protected` createMemento

createMemento(): void
Actions may need to create a memento before their first execution. This is the goal of the operation that should be overridden. This operator is called a single time before the first execution of the command.

Returns void
Inherited from CommandBase.createMemento
- Defined in impl/command/CommandBase.ts:47

done

done(): void
Marks the command as "done" and sends it to the command registry.

Returns void
Inherited from CommandBase.done
- Defined in impl/command/CommandBase.ts:92

execute

execute(): boolean | Promise<boolean>
Executes (if possible) the commands.

Returns boolean | Promise<boolean>
True: the command has been executed.
Inherited from CommandBase.execute
- Defined in impl/command/CommandBase.ts:49

`Protected` `Abstract` execution

execution(): void | Promise<void>
This method contains the statements to execute the command. This method is automatically called by 'execute' and must not be called explicitly.

Returns void | Promise<void>
Inherited from CommandBase.execution
- Defined in impl/command/CommandBase.ts:86

flush

flush(): void
Flushes the UI command. The command must not be used after that.

Returns void
Inherited from CommandBase.flush
- Defined in impl/command/CommandBase.ts:38

getStatus

getStatus(): CmdStatus
Provides the status of the command.

Returns CmdStatus
The status of the command.
Inherited from CommandBase.getStatus
- Defined in impl/command/CommandBase.ts:106

getUndoName

getUndoName(): string
Returns string
The name of the undo command.
Implementation of Undoable.getUndoName
- Defined in impl/command/UndoableCommand.ts:23

getVisualSnapshot

getVisualSnapshot(): UndoableSnapshot
Gives some information about the impact of a command.

Returns UndoableSnapshot
Information about the impact of the commmand as an SVG element or text.
Implementation of Undoable.getVisualSnapshot
- Defined in impl/command/UndoableCommand.ts:27

hadEffect

hadEffect(): boolean
State whether the execution of this command has effects on the system.

Returns boolean
True: the command has effects on the system.
Inherited from CommandBase.hadEffect
- Defined in impl/command/CommandBase.ts:88

isDone

isDone(): boolean
To know whether the command has been marked as 'done'.

Returns boolean
True: the command has been marked as 'done'.
Inherited from CommandBase.isDone
- Defined in impl/command/CommandBase.ts:98

`Abstract` redo

redo(): void
Redoes the cancelled command.

Returns void
Implementation of Undoable.redo
- Defined in impl/command/UndoableCommand.ts:31

`Abstract` undo

undo(): void
Cancels the command.

Returns void
Implementation of Undoable.undo
- Defined in impl/command/UndoableCommand.ts:33

Generated using TypeDoc