yfiles.client.tiles.InputMode
Class InputMode

This is a base class for chainable controllers handling user input to a GraphCanvas.

InputMode

InputMode(/*GraphCanvas*/ canvas)

This is a base class for chainable controllers handling user input to a GraphCanvas.

_attachEventListeners

_attachEventListeners()

rewrite this function in derived classes to attach the event listeners needed for the specific subclass. The default implementation in this class is just a dummy function.

_detachEventListeners

_detachEventListeners()

rewrite this function in derived classes to detach all event listeners used in the specific subclass. The default implementation in this class is just a dummy function.

activate

activate()

activates this input mode. All descendant input modes are deactivated and unchained. This method calls _attachEventListeners(). If this function is rewritten in subclasses, the super function has to be called.

deactivate

deactivate()

deactivates this input mode and any descendant input mode. This function calls _detachEventListeners(). If this function is rewritten in subclasses, the super function has to be called.

getGraph

Graph getGraph()

returns the graph of the graph canvas for this input mode.

isActive

Boolean isActive()

returns true, if this input mode or a descendant input mode is active.

onReactivate

onReactivate(/*InputMode*/ child)

is called after this mode was reactivated. The child input mode was activated via setChild before. When it was deactivated, this input was reactivated and this callback is invoked. The default implementation does nothing. It can be overridden in subclasses or used as an event to connect to.

restoreCursor

restoreCursor()

restores the cursor for the graph canvas (see setCursor()).

setChild

Boolean setChild(/*InputMode*/ another)

adds another InputMode as a child of this InputMode, if this InputMode is active. This InputMode detaches its event handlers, and the child input mode gets activated. Once the child input mode is deactivated, this InputMode attaches its event handlers and becomes active again.

setCursor

setCursor(/*String*/ cursor, /*String?*/ oldCursor)

sets the cursor for the graph canvas to the give style (e.g., "pointer"). If oldCursor is given, it will be used in restoreCursor().

setEdgeTestSensitivity

setEdgeTestSensitivity(/*float*/ sensitivity)

sets the edge test sensitivity in world units for the hit test belonging to this input mode.