API / geotoolkit / controls / tools / editors / commands / AbstractCommand / AbstractCommand
commands.AbstractCommand.AbstractCommand
Abstract command to store information about actions made by AbstractEditor
Constructors
Methods
Methods
▸ createInverse(): AbstractCommand
Returns inverse command
▸ getClassName(): string
string
▸ getEventName(): string
Returns event to be fired when command is applied
string
Returns target command node
▸ getOptions(): Record<string, any>
Returns command options
Record<string, any>
▸ isRejected(): boolean
Returns rejected state
boolean
the state
▸ isSeparate(): boolean
Returns true if command is separate, false otherwise
boolean
▸ merge(command): boolean
Tries to merge current with another command. If successful, return true and second command won't be stored in history. Returns false otherwise.
| Name | Type | Description |
|---|---|---|
command | AbstractCommand | command to merge |
boolean
▸ reject(): AbstractCommand
Rejects action
this
▸ setNode(node): AbstractCommand
Sets target node for the command
this
▸ setOptions(options): AbstractCommand
Sets extra options to be stored in command
| Name | Type | Description |
|---|---|---|
options | Record<string, any> | some extra options for the command to store |
this
▸ setSeparate(isSeparate): AbstractCommand
Sets command to be separate or not (true by default). Not separate commands are ignored by history undo/redo actions and considered as a part of the last separate command.
| Name | Type | Description |
|---|---|---|
isSeparate | boolean | true if command should be considered as a separate operation (in undo/redo history), false otherwise |
this
▸ Static getClassName(): string
string