Class: BatchCommand

history.BatchCommand(textopt)

History command that can contain/execute multiple other commands.

Constructor

new BatchCommand(textopt)

Parameters:
Name Type Attributes Description
text string <optional>

An optional string visible to user related to this change

Implements:
Source:

Methods

addSubCommand(cmd) → {void}

Adds a given command to the history stack.

Parameters:
Name Type Description
cmd Command

The undo command object to add

Source:
Returns:
Type
void

apply(handler) → {void}

Runs "apply" on all subcommands.

Parameters:
Name Type Description
handler module:history.HistoryEventHandler
Implements:
Source:
Fires:
Returns:
Type
void

elements() → {Array.<Element>}

Iterate through all our subcommands.

Implements:
Source:
Returns:

All the elements we are changing

Type
Array.<Element>

isEmpty() → {boolean}

Source:
Returns:

Indicates whether or not the batch command is empty

Type
boolean

unapply(handler) → {void}

Runs "unapply" on all subcommands.

Parameters:
Name Type Description
handler module:history.HistoryEventHandler
Implements:
Source:
Fires:
Returns:
Type
void