Class TransferArrayItem<T>

An undoable command that transfers an element from one array to another.

Type Parameters

Hierarchy

UndoableCommand
- TransferArrayItem

Index

Constructors

constructor

new TransferArrayItem<T>(srcArray, tgtArray, srcIndex, tgtIndex, cmdName): TransferArrayItem<T>
Creates the command.
Type Parameters
- T
Parameters
- srcArray: T[]
  The array to take the transferred element from.
- tgtArray: T[]
  The array to put the transferred element in.
- srcIndex: number
  The index at which the element is located in the source array.
- tgtIndex: number
  The index at which the element must be put in the destination array.
- cmdName: string
  The name of the command.
Returns TransferArrayItem<T>
Overrides UndoableCommand.constructor
- Defined in impl/command/library/TransferArrayItem.ts:55

Properties

`Protected` _srcArray

_srcArray: T[]

The array to take the transferred element from.

`Protected` _srcIndex

_srcIndex: number

The index at which the element is located in the source array.

`Protected` _tgtArray

_tgtArray: T[]

The array to put the transferred element in.

`Protected` _tgtIndex

_tgtIndex: number

The index at which the element must be put in the target array.

`Protected` `Readonly` cmdName

cmdName: string

The name of the command.

`Protected` status

status: CmdStatus

The state of the command.

Accessors

srcArray

get srcArray(): T[]
Returns T[]
- Defined in impl/command/library/TransferArrayItem.ts:97
set srcArray(value): void
Parameters
- value: T[]
Returns void
- Defined in impl/command/library/TransferArrayItem.ts:101

srcIndex

get srcIndex(): number
Returns number
- Defined in impl/command/library/TransferArrayItem.ts:113
set srcIndex(value): void
Parameters
- value: number
Returns void
- Defined in impl/command/library/TransferArrayItem.ts:117

tgtArray

get tgtArray(): T[]
Returns T[]
- Defined in impl/command/library/TransferArrayItem.ts:105
set tgtArray(value): void
Parameters
- value: T[]
Returns void
- Defined in impl/command/library/TransferArrayItem.ts:109

tgtIndex

get tgtIndex(): number
Returns number
- Defined in impl/command/library/TransferArrayItem.ts:121
set tgtIndex(value): void
Parameters
- value: number
Returns void
- Defined in impl/command/library/TransferArrayItem.ts:125

Methods

canExecute

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

Returns boolean
True if the command can be executed.
Overrides UndoableCommand.canExecute
- Defined in impl/command/library/TransferArrayItem.ts:72

cancel

cancel(): void
Marks the command has aborted.

Returns void
Inherited from UndoableCommand.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 UndoableCommand.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 UndoableCommand.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 UndoableCommand.execute
- Defined in impl/command/CommandBase.ts:49

`Protected` execution

execution(): 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
Overrides UndoableCommand.execution
- Defined in impl/command/library/TransferArrayItem.ts:68

flush

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

Returns void
Inherited from UndoableCommand.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 UndoableCommand.getStatus
- Defined in impl/command/CommandBase.ts:106

getUndoName

getUndoName(): string
Returns string
The name of the undo command.
Overrides UndoableCommand.getUndoName
- Defined in impl/command/library/TransferArrayItem.ts:77

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.
Inherited from UndoableCommand.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 UndoableCommand.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 UndoableCommand.isDone
- Defined in impl/command/CommandBase.ts:98

redo

redo(): void
Redoes the cancelled command.

Returns void
Overrides UndoableCommand.redo
- Defined in impl/command/library/TransferArrayItem.ts:81

undo

undo(): void
Cancels the command.

Returns void
Overrides UndoableCommand.undo
- Defined in impl/command/library/TransferArrayItem.ts:89

Class TransferArrayItem<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

srcArray: T[]

tgtArray: T[]

srcIndex: number

tgtIndex: number

cmdName: string

Returns TransferArrayItem<T>

Properties

Protected _srcArray

Protected _srcIndex

Protected _tgtArray

Protected _tgtIndex

Protected Readonly cmdName

Protected status

Accessors

srcArray

Returns T[]

Parameters

value: T[]

Returns void

srcIndex

Returns number

Parameters

value: number

Returns void

tgtArray

Returns T[]

Parameters

value: T[]

Returns void

tgtIndex

Returns number

Parameters

value: number

Returns void

Methods

canExecute

Returns boolean

cancel

Returns void

Protected createMemento

Returns void

done

Returns void

execute

Returns boolean | Promise<boolean>

Protected execution

Returns void

flush

Returns void

getStatus

Returns CmdStatus

getUndoName

Returns string

getVisualSnapshot

Returns UndoableSnapshot

hadEffect

Returns boolean

isDone

Returns boolean

redo

Returns void

undo

Returns void

Settings

Member Visibility

Theme

`Protected` _srcArray

`Protected` _srcIndex

`Protected` _tgtArray

`Protected` _tgtIndex

`Protected` `Readonly` cmdName

`Protected` status

`Protected` createMemento

`Protected` execution