API / geotoolkit / controls / tools / editors / History / History
Editors history that stores editing commands and is able to undo/redo it
↳
History
Constructors
Methods
Methods
▸ canRedo(): boolean
Checks if there is command in history to redo
boolean
▸ canUndo(): boolean
Checks if there is command in history to undo
boolean
▸ clear(): History
Removes all records from the history
this
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getCurrentPosition(): number
Returns current position in history (number of commands recorded from initial to the current state)
number
▸ getRegistry(): Registry
Gets editors registry
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify<E>(type, source, args?): History
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | History | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): History
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: History, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): History
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: History, args: EventMap[E]) => void | to be called |
this
▸ push(command, editor?): History
Pushes editor's command to the history
Fires
EditEvents.BeforeCommandApplied
Fires
Fires
Fires
| Name | Type | Description |
|---|---|---|
command | AbstractCommand | command to push |
Optional editor | AbstractEditorBase<Node | Node[]> | editor generated command |
▸ redo(): History
Reapplies last canceled command in history (if possible)
Fires
Fires
EditEvents.BeforeCommandApplied
Fires
Fires
Fires
▸ setRegistry(registry): History
Sets registry for node editors
| Name | Type | Description |
|---|---|---|
registry | Registry | the editors registry |
▸ setSilent(bool): History
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ undo(): History
Cancels last command in history (if possible)
Fires
Fires
EditEvents.BeforeCommandApplied
Fires
Fires
Fires
▸ Static getClassName(): string
string