yfiles.client.tiles.EditMode
Class EditMode

This class implements a main edit mode for interacting with a graph displayed in a GraphCanvas. The EditMode dispatches some of its tasks to instances of CreateEdgeMode, MoveSelectionMode, RectangularSelectionMode and EditLabelMode, respectively. If the EditMode is activated, it maintains a GraphSelection and connects selecting nodes and edges to highlighting these nodes and edges in the graph canvas. It handles user input by changing the graph possibly through activating one of the above mentioned input modes as child modes. A list of user input gestures and the actions they trigger is given in the comment for activate().

All Parent Classes:

InputMode

EditMode

EditMode(/*GraphCanvas*/ canvas, /*Boolean?*/ selectNodes, /*Boolean?*/ selectEdges, /*Boolean?*/ routeEdges, /*HierarchyManager?*/ hierarchyManager)

This class implements a main edit mode for interacting with a graph displayed in a GraphCanvas. The EditMode dispatches some of its tasks to instances of CreateEdgeMode, MoveSelectionMode, RectangularSelectionMode and EditLabelMode, respectively. If the EditMode is activated, it maintains a GraphSelection and connects selecting nodes and edges to highlighting these nodes and edges in the graph canvas. It handles user input by changing the graph possibly through activating one of the above mentioned input modes as child modes. A list of user input gestures and the actions they trigger is given in the comment for activate().

Parameters:

canvas - the canvas instance this mode works on

selectNodes - if true, nodes are selectable (default true)

selectEdges - if true, edges are selectable (default true)

routeEdges - if true, newly created edges are roued (default false)

hierarchyManager - optional hierarchy manager for the graph of the canvas

activate

activate()

activates this input mode. The canvas is fix()ed. Certain user gestures trigger changes of the graph or the activation of one of the child input modes which might change the graph in turn.

• Clicking on a node or an edge, clears the current selection and selects the node or the edge.
• Clicking on a node or an edge with the CTRL key pressed, leaves the current selection as it is and toggles the selection state of the node or the edge.
• Clicking on an empty space with a current selection clears the current selection.
• Clicking on an empty space without a current selection creates a new node.
• Dragging the mouse starting on an empty space or an edge activates the RectangularSelectionMode.
• Dragging the mouse starting on a node which is not selected activates the CreateEdgeMode.
• Dragging the mouse starting on a node which is selected activates the MoveSelectionMode.
• Pressing the DEL key deletes the current selection.

Moreover there is a visual indication, whether the mouse is considered to be over a node or an edge or over empty space.

clearSelection

clearSelection()

clears the current selection.

deactivate

deactivate()

deactivates this input mode. The selection is cleared. The canvas is release()d. The user input as described in activate() is no longer handled.

editLabel

editLabel(/*String*/ id)

starts editing a node label. This method can be used in event handlers for menu entries or buttons.

Parameters:

id - id of a node or a node label

getEdgeTestSensitivity

Number getEdgeTestSensitivity()

gets the edge test sensitivity in pixels (view units).

getSelection

GraphSelection getSelection()

returns the current selection.

setEdgeTestSensitivity

setEdgeTestSensitivity(/*Number*/ sensitivity)

sets the edge test sensitivity in pixels (view units).