Class: AbstractEditingTool

• new AbstractEditingTool(options)

• Protected new AbstractEditingTool(options?)

AbstractTool.constructor

▸ addListener(eventName, listener): AbstractEditingTool

add event listener. The listener receives the message when the system event happens.

Deprecated

since 4.0 use .on() instead. Note that 3 args callback should be used in subscription via .on(): (eventType, source, args)

AbstractEditingTool

AbstractTool.addListener

▸ canRedo(): boolean

Checks if there is command in history to redo

boolean

▸ canUndo(): boolean

Checks if there is command in history to undo

boolean

▸ captureMouseUp(): void

listen to window mouse events in order to catch a mouse up action outside of the tool container DOM element. useful for example when you pan and release click outside of DOM element.

void

AbstractTool.captureMouseUp

▸ Protected createEditor(options): AbstractEditorBase<Node | Node[]>

Returns editor to edit node with provided options

Throws

if supported editor was not found and default editor was not set

AbstractEditorBase<Node | Node[]>

▸ dispose(): void

Dispose tool.

void

AbstractTool.dispose

▸ editNode(node): AbstractEditingTool

Starts editing the node provided

AbstractEditingTool

this

▸ execute(command): AbstractEditingTool

Applies the specified command to the associated node and appends it to history

AbstractEditingTool

▸ fireEvent(eventName, eventArgs?): void

This method is Protected. Fire an Event.

Deprecated

since 4.0 use .notify() instead. Note that 3 args callback should be used in subscription via .on()

void

AbstractTool.fireEvent

▸ getActiveShape(): Node

Returns currently edited shape. Relevant for EditMode.Ghost mode.

Node

▸ getClassName(): string

string

AbstractTool.getClassName

▸ getEditMode(): EditMode

Returns tool current edit mode

EditMode

▸ getEditor(): AbstractEditorBase<Node | Node[]>

Returns current editor tool (if exists)

AbstractEditorBase<Node | Node[]>

▸ Protected getEventRadius(eventArgs): number

Returns device radius for the provided event

number

AbstractTool.getEventRadius

▸ getHistory(): History

Returns current history

History

▸ getManipulatorLayer(): CompositeNode<Node>

return manipulator layer

CompositeNode<Node>

layer

AbstractTool.getManipulatorLayer

▸ getMouseRadius(): number

Returns current device radius for mouse events

number

AbstractTool.getMouseRadius

▸ getName(): string

return tool name if any

string

name of the tool

AbstractTool.getName

▸ getParentTool(): AbstractCompositeTool

Gets parent tool

AbstractCompositeTool

parent tool

AbstractTool.getParentTool

▸ getProperties(): OptionsOut

Returns all properties

OptionsOut

tool options

AbstractTool.getProperties

▸ getProperty(name): any

Gets dynamic property by name. These properties can be used as a property bags

any

AbstractTool.getProperty

▸ getPropertyKeys(): string[]

Returns known properties keys

string[]

AbstractTool.getPropertyKeys

▸ Protected getRegistry(): Registry

Registry

▸ getRoot(): AbstractCompositeTool

Gets root tool

AbstractCompositeTool

parent tool

AbstractTool.getRoot

▸ getShape(): Node | Node[]

Returns the origin of currently edited shape (if exists, null otherwise).

Node | Node[]

▸ getTouchRadius(): number

Returns current device radius for touch events

number

AbstractTool.getTouchRadius

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

AbstractTool.hasEventListener

▸ isActive(): boolean

return active state

boolean

AbstractTool.isActive

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

AbstractTool.isDisposed

▸ Protected isDoubleClick(point, eventArgs?): boolean

returns true if double clicked

boolean

AbstractTool.isDoubleClick

▸ isEnabled(): boolean

returns enable state

boolean

state

AbstractTool.isEnabled

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

AbstractTool.isSilent

▸ isTouchEvent(eventArgs): boolean

return true if the event is a touch event and false otherwise.

boolean

AbstractTool.isTouchEvent

▸ notify<E>(type, source, args?): AbstractEditingTool

Notify listeners

AbstractEditingTool

this

AbstractTool.notify

▸ off<E>(type?, callback?): AbstractEditingTool

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.

AbstractEditingTool

this

AbstractTool.off

▸ on<E>(type, callback): AbstractEditingTool

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.

Example

// Using in derived tool
import type {EventMap as EventMapBase} from '@int/geotoolkit/controls/tools/AbstractTool';
export type EventMap = EventMapBase & {
[MyToolEvents.onValueChanged]: MyToolEventArgs
}
export enum MyToolEvents {
onValueChanged = 'onValueChanged'
}
export class MyTool extends AbstractTool {
public declare on: <E extends keyof EventMap>(type: E, callback: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
protected declare notify: <E extends keyof EventMap>(type: E, source: AbstractTool, args?: EventMap[E]) => this;
public declare off: <E extends keyof EventMap>(type: E, callback?: (eventType: E, sender: this, args: EventMap[E]) => void) => this;
// ...
}

AbstractEditingTool

AbstractTool.on

▸ Protected onActiveStateChanged(): void

Fires

Events.onStateChanged

void

AbstractTool.onActiveStateChanged

▸ Protected onBeforeCommandApplying(eventName, history, command): void

Fires the EditEvents.BeforeCommandApplied event

void

▸ Protected onCommandApplied(eventName, history, command): void

Fires the EditEvents.CommandApplied event and the event according to the command event name

void

▸ Protected onCommandApplying(eventName, history, command): void

Fires the EditEvents.CommandApplying event

void

▸ Protected onCommandRedo(eventName, history, command): void

Fires the EditEvents.Redo event

void

▸ Protected onCommandUndo(eventName, history, command): void

Fires the EditEvents.Undo event

void

▸ Protected onEnabledStateChanged(): void

Fires

Events.onEnabledStateChanged

void

AbstractTool.onEnabledStateChanged

▸ Protected onKeyDown(eventArgs): void

Handles key down event

void

▸ Protected onKeyUp(eventArgs): void

Handles key up event

void

▸ Protected onMouseDown(eventArgs): void

void

▸ Protected onMouseMove(eventArgs): void

void

▸ Protected onMouseUp(eventArgs): void

void

▸ Protected onNodeCreated(editor, eventArgs): void

Node created handler

void

▸ pageToCanvas(eventArgs, externalPlot?): Object

return position relative to the canvas

Object

AbstractTool.pageToCanvas

▸ pointToModel(model, eventArgs): Point

converts device coordinates to inner coordinates of node

Point

AbstractTool.pointToModel

▸ redo(): AbstractEditingTool

Reapplies last canceled command in history (if possible)

AbstractEditingTool

▸ removeListener(eventName, listener?): AbstractEditingTool

remove event listener. The listener reveives the message when the system event happens.

Deprecated

since 4.0 use .off() instead.

AbstractEditingTool

AbstractTool.removeListener

▸ setActive(active): AbstractEditingTool

set active state

Fires

Events.onStateChanged

AbstractEditingTool

AbstractTool.setActive

▸ setEditMode(mode): AbstractEditingTool

Sets tool edit mode (for nodes with node manipulators)

AbstractEditingTool

this

▸ Protected setEditor(editor): AbstractEditingTool

For internal use

AbstractEditingTool

this

▸ setEnabled(enabled): AbstractEditingTool

set enable state

Fires

Events.onEnabledStateChanged

Fires

Events.onStateChanged

AbstractEditingTool

this

AbstractTool.setEnabled

▸ setMouseRadius(radius): AbstractEditingTool

Sets device radius for mouse events

AbstractEditingTool

this

AbstractTool.setMouseRadius

▸ setName(name): AbstractEditingTool

set tool name

AbstractEditingTool

AbstractTool.setName

▸ setProperties(props?): AbstractEditingTool

Sets paint tool properties (mode, styles, etc.)

AbstractEditingTool

this

AbstractTool.setProperties

▸ setProperty(name, value): AbstractEditingTool

Sets dynamic property by name

AbstractEditingTool

this

AbstractTool.setProperty

▸ setSilent(bool): AbstractEditingTool

Set silent mode

AbstractEditingTool

this

AbstractTool.setSilent

▸ setSlotEnabled(eventName, value, target?): AbstractEditingTool

Sets slot enabled

AbstractEditingTool

AbstractTool.setSlotEnabled

▸ setSlots(slots?, merge?): AbstractEditingTool

Sets new slots.

Example

const slots = {
'pointerdown': (event: EventArgs) => {
// event is an instance of @int/geotoolkit/controls/tools/EventArgs
...
}
};
tool.setSlots(slots);

AbstractEditingTool

this

AbstractTool.setSlots

▸ setTouchRadius(radius): AbstractEditingTool

Sets device radius for touch events

AbstractEditingTool

this

AbstractTool.setTouchRadius

▸ Protected start(eventArgs?): AbstractEditingTool

start

AbstractEditingTool

AbstractTool.start

▸ Protected stop(): AbstractEditingTool

stop

AbstractEditingTool

AbstractTool.stop

▸ toggle(): AbstractEditingTool

switch enable state to opposite state

AbstractEditingTool

AbstractTool.toggle

▸ undo(): AbstractEditingTool

Cancels last command in history (if possible)

AbstractEditingTool

▸ update(): AbstractEditingTool

Forces editing shapes and handles to be updated

AbstractEditingTool

this

▸ updateHandles(): AbstractEditingTool

Forces editing handles to be synchronized with shape

AbstractEditingTool

this

▸ Static canvasToClient(plotPoint, plot): Point

Convert plot coordinates to global coordinates

Point

AbstractTool.canvasToClient

▸ Static clientToCanvas(nativeEvent, plot): Point

Convert global coordinates to plot coordinates

Point

AbstractTool.clientToCanvas

▸ Static getClassName(): string

string

AbstractTool.getClassName

▸ Static getExclusiveTool(plot): AbstractTool

return exclusive tool associated with plot

AbstractTool

tool

AbstractTool.getExclusiveTool

▸ Static getNativeEventName(eventName): string[]

Returns native event name

string[]

AbstractTool.getNativeEventName

▸ Static isTouchEvent(eventArgs): eventArgs is TouchEvent

return true if the event is a touch event and false otherwise.

eventArgs is TouchEvent

AbstractTool.isTouchEvent

▸ Static lock(plot, tool): void

Set exclusive tool for plot

void

AbstractTool.lock

▸ Static setDefaultMouseRadius(radius): void

Sets default device radius for mouse events

void

AbstractTool.setDefaultMouseRadius

▸ Static setDefaultTouchRadius(radius): void

Sets default device radius for touch events

void

AbstractTool.setDefaultTouchRadius

▸ Static unlock(value): void

Remove exclusive tool from plot

void

AbstractTool.unlock