Determines whether this instance should automatically adjust the canvas' contentRect if the graph changes.

The adjustContentRect method is called whenever the content changes and autoAdjustContentRect is set to AdjustContentRectPolicy.ALWAYS or AdjustContentRectPolicy.UNION.

Setting to AdjustContentRectPolicy.ALWAYS will adjust the content rect to fit the current graph bounds. Setting to AdjustContentRectPolicy.UNION will adjust the content rect to a union of the former and current graph bounds (the content rect will never shrink).

The default value is AdjustContentRectPolicy.UNION.

See also

A value indicating whether this mode should automatically remove labels from the graph when a label text has been edited and the label text is empty.

The default value is false.

A value indicating whether clicking on a node should automatically select all bends of self loops adjacent to that node.

The default value is true.

Determines for which types of items a GraphEditorEvent.ITEM_CLICKED should be dispatched upon mouse clicks.

The default value is GraphItemTypes.ALL.

See also

The order of the types of items that should be used to determine which item has been clicked during onClickInputModeClicked.

Change this property to adjust which items will be selected if there are multiple items at a given location. The default order is

• HitTest.BEND
• HitTest.EDGE_LABEL
• HitTest.EDGE
• HitTest.NODE
• HitTest.NODE_LABEL
• HitTest.PORT
• HitTest.ALL

Examples:

         // select the topmost item
         mode.clickHitTestOrder = [HitTest.ALL];
         
         // select the topmost item but prefer nodes and edges (and edge labels and bends) over node labels and ports.
         mode.clickHitTestOrder = [HitTest.BEND|HitTest.EDGE_LABEL|HitTest.EDGE|HitTest.NODE, HitTest.NODE_LABEL, HitTest.PORT, HitTest.ALL];
         

This property can be used as the source for data binding.

See also

Determines which types of items should be selectable through mouse clicks.

The default value is GraphItemTypes.ALL.

See also

Determines whether clipboard operations with the usual shortcuts are enabled on the canvas.

The default value is true.

Gets or sets the margins to use for CanvasComponent.updateContentRect() in adjustContentRect() calls.

See also

The createBendInputMode property.

If the field has not yet been initialized upon first access, the factory method createCreateBendInputMode will be called. Upon change the onCreateBendInputModeChanged method will be called.

Setting a new CreateBendInputMode is not allowed after the GraphEditorInputMode is installed and will throw an exception.

Whether the create bend input mode is enabled.

The default value is true.

This property can be used as the source for data binding.

The CreateBendInputModePriority property.

The default value is 42.

The createEdgeInputMode property.

If the field has not yet been initialized upon first access, the factory method createCreateEdgeInputMode will be called. Upon change the onCreateEdgeInputModeChanged method will be called.

Setting a new CreateEdgeInputMode is not allowed after the GraphEditorInputMode is installed and will throw an exception.

Whether the create edge input mode is enabled.

The default value is true.

This property can be used as the source for data binding.

The CreateEdgeInputModePriority property.

The default value is 45.

Determines which types of items may be deleted using the deleteSelection action.

The default value is GraphItemTypes.ALL.

See also

Gets or sets the property that determines whether the user is allowed to delete currently selected elements using the Delete key.

The default value is true.

The event recognizer function that will be queried to decide if a click should select the item that is currently visible under the mouse cursor, without giving more important items higher priority.

An event recognizer function takes an Event as its only argument and returns a Boolean that indicates whether the event was recognized.

If the value recognizes that the user wanted to use the detail clicking behavior, the hitTestIterator will be queried for the given item and the first item that is returned will be considered a hit. Otherwise all hit items are examined and are priorized by item type. E.g. by default clicking on a node will select the node, even if there is a node label which has been clicked at the same point. If detail selection is recognized, the label will be selected.

The default implementation will recognize events of type com.yworks.canvas.input.ClickEvent, if the shift key was pressed.

The items that can be given focus via the setCurrentItem method.

The items types are defined using a bitwise combination of the constants defined in GraphItemTypes.

The default value is GraphItemTypes.NODE.

See also

Gets the Graph this mode is acting upon.

Gets the GraphControl this mode is working on or null.

his property is set by setGraphControl which is triggered if this mode is installed in a GraphCanvasComponent.

Returns the selectionModel as an IGraphSelection.

Determines whether Ctrl-G-presses should result in calls to groupSelection().

The default value is true.

See also

Gets or sets the HitTestEnumerator property.

The enumerator will be queried for hit tests if the user clicks on the canvas. If the field has not yet been initialized upon first access, the factory method createHitTestEnumerator will be called.

The hitTestOrdering.

The hitTestOrdering is an array of HitTest constants that determines the ordering in which items are tested for click hits.

Determines which types of items may have their labels edited.

One or a bitwise combination of the constants defined in GraphItemTypes.

The default is GraphItemTypes.LABELED_ITEM|GraphItemTypes.LABEL which allows for editing the labels of labeled items and existing labels.

See also

Gets or sets the LabelEditingAllowed property that determines whether the label editor will be automatically invoked if the F2 key is pressed.

If this flag is set to true pressing F2 will start the label editor.

The default value is true.

See also

Determines which types of items should be selected during marquee selections.

The default value is A combination of GraphItemTypes.NODE, GraphItemTypes.EDGE and GraphItemTypes.BEND..

See also

Determines which types of items should movable using the moveInputMode.

The default value is GraphItemTypes.ALL.

See also

The MoveLabelInputMode property.

This mode is responsible for moving labels to another candidate position. If the field has not yet been initialized upon first access, the factory method createMoveLabelInputMode will be called. Upon change the onMoveLabelInputModeChanged method will be called.

Setting a new MoveLabelInputMode is not allowed after the GraphEditorInputMode is installed and will throw an exception.

Whether the move label input mode is enabled.

The default value is true.

This property can be used as the source for data binding.

The event recognizer function that will be queried to decide if a click is deemed a multi selection gesture.

An event recognizer function takes an Event as its only argument and returns a Boolean that indicates whether the event was recognized.

The default implementation will recognize events of type com.yworks.canvas.input.ClickEvent, if the ctrl key was pressed.

The keyboard navigation input mode.

This mode is responsible for navigating and traversing the elements in the IGraph. If the field has not yet been initialized upon first access, the factory method createNavigationInputMode will be called. Upon change the onNavigationInputModeChanged method will be called.

Setting a new NavigationInputMode is not allowed after the GraphEditorInputMode is installed and will throw an exception.

Whether the keyboard navigation input mode is enabled.

The default value is true.

This property can be used as the source for data binding.

The keyboard navigation mode priority.

The default value is 55.

Whether createNode will be called when the canvas is clicked.

See also

The callback that is responsible for creating a new node, e.g. in response to a mouse click.

The node creator function has to take the current context and IGraph instance and the IPoint location as arguments, and returns the created node:

		 var nodeCreator:Function = function( context:IInputModeContext, graph:IGraph, location:IPoint ):INode {
		   var node:INode = ..
		   ..
		   return node;
		 }
		 

Gets or sets the orthogonal edge editing context.

The default value is null..

The offset for paste operation if clipboard operations are enabled.

The default value is (15, 15).

Gets or sets the reparentNodeHandler property.

This handler will be delegated to by an implementation of the IReparentNodeHandler interface that this class puts into the childInputModeContextLookup. The child input modes will query this interface to perform node reparenting operations if the graph is an IGroupedGraph. If the field has not yet been initialized upon first access, the factory method createReparentNodeHandler will be called. Upon change the onReparentNodeHandlerChanged method will be called.

See also

Gets or sets a property that determines whether the user may reparent nodes using a move gesture.

This setting is only of relevance if the graph is a hierarchic graph. This setting overrides the currently set reparentNodeHandler if set to false.

The default value is true.

See also

Determines which types of items should be selectable at all.

The default value is GraphItemTypes.ALL.

See also

Determines which types of items should have their IHandles shown.

The default value is GraphItemTypes.ALL.

See also

The textEditorInputMode property.

If the field has not yet been initialized upon first access, the factory method createTextEditorInputMode will be called. Upon change the onTextEditorInputModeChanged method will be called.

Setting a new TextEditorInputMode is not allowed after the GraphEditorInputMode is installed and will throw an exception.

Whether the text editor input mode is enabled.

The default value is true.

This property can be used as the source for data binding.

The TextEditorInputModePriority property.

The default value is 100.

Determines whether undo/redo operations with the usual shortcuts are enabled on the canvas.

The default value is true.

Determines whether Ctrl-U-presses should result in calls to ungroupSelection().

The default value is true.

See also

Creates a new instance.

When no graph and no selection model is provided, they will be set when the input mode is installed on a GraphCanvasComponent.

See also

Updates the canvas' contentRect using CanvasComponent#updateContentRect() and contentRectMargins.

This method is called whenever the content changes and autoAdjustContentRect is set to AdjustContentRectPolicy.ALWAYS or AdjustContentRectPolicy.UNION.

See also

Parameters

Actually performs the click operation on the given item.

This will dispatch the GraphEditorEvent.ITEM_CLICKED event and unless the event is handled by any of the event handlers (event.isDefaultPrevented()), this will ultimately select the item and possibly self loop bends, if autoSelectSelfloopBends is enabled. The previous selection will be cleared, unless the multiSelectionRecognizer is triggered.

Parameters

See also

Closes the label editor if it is currently open.

Parameters

Copies the currently selected elements to the clipboard.

Factory method for the createBendInputMode property.

This method will be called upon first access to the createBendInputMode property.

Factory method for the createEdgeInputMode property.

This method will be called upon first access to the createEdgeInputMode property.

Callback method to create a custom label configuration when a new label should be created.

Parameters

Factory method for the hitTestEnumerator property.

This method will be called upon first access to the hitTestIterator property. The hit test iterator is responsible for enumerating possible hits for a given coordinate in the world coordinate system given the current state of the canvas.

Interactively creates a new label for the provided labeled item.

this method will invoke the text editor that will let the user edit the text of the label. If the user commits the label text the label will be added to the labeled item.

Parameters

See also

Factory method for the MoveLabelInputMode property.

This method will be called upon first access to the moveLabelInputMode property.

Parameters

Factory method for the navigationInputMode property.

This method will be called upon first access to the navigationInputMode property.

Creates a node given a certain click point.

This implementation delegates to the current nodeCreator or simply returns null if there is no such callback.

Parameters

Factory method for the ReparentNodeHandler property. This method will be called upon first access to the reparentNodeHandler property.

See also

Factory method for the textEditorInputMode property.

This method will be called upon first access to the textEditorInputMode property.

Cuts and inserts the currently selected elements to the clipboard.

This method deletes the currently selected elements.

Disables all submodes.

Initiates the handleInputMode to drag the given bend.

Parameters

Triggers the editing of the given label.

This implementation uses the canvas.input.TextEditorInputMode to display en editor to edit the label.

Parameters

See also

Called when a reparenting gesture is finished.

This method moves the reparented nodes to the front.

Parameters

See also

Used as a callback to find hits underneath a certain clicked point.

This implementation uses the hitTestIterator to determine the hits and getClosestHits to find the closest of several possible hits.

Parameters

See also

This method filters the passed IModelItems and returns only those closest to the passed location. It is used by the method findHits and delegates to HitTestUtil.getClosestHits.

Parameters

See also

Creates a new group for all of the currently selected elements.

This implementation will delegate the actual creation of the group to the graph's IGroupedGraph's groupNodes() implementation found in the lookup of the graph. By default, this method will be called in response to a Ctrl-G-key press recognized by the keyboardInputMode. This method will also clear the selection and select the newly created group node.

See also

Called by click to query the item for a IActionButtonProvider in its lookup and handle it appropriately.

This method will query the IActionButtonProvider and check whether the click occured inside the provided button bounds, and if so, will invoke the action and and return true.

Parameters

See also

Installs this mode into the given context.

Installation ususally means registering some event listeners on the canvasComponent or on canvasComponent.root.

Parameters

This method will marquee select the items in the graph.

Parameters

See also

Called when the mouse has been clicked at a given location.

This implementation will use the findHits method to determine what has been clicked and then invoke click if clickSelectableItems is set to values other than GraphItemTypes.NONE. If an item has been hit, the current selection will be cleared, unless the multiSelectionRecognizer is triggered. If nothing has been hit, it will clear the current selection.

Otherwise, if nodeCreationAllowed is true, a node will be created using the createNode callback.

Parameters

See also

Parameters

Callback that is called as soon as createBendInputMode created a new bend.

This method selects the bend and starts the handleInputMode using the handle for the newly created bend. The bend is created using the hit edge's IBendCreator implementation, as obtained from the edge's ILookup.lookup and calls dragBend.

Parameters

Called when the createBendInputMode property value changes.

Parameters

Called when the createEdgeInputMode property value changes

Parameters

Callback that is called as soon as createEdgeInputMode created a new edge.

Parameters

Callback that delegates to selectAll if selectElementsAllowed is true.

Parameters

Callback that delegates to deleteSelection if deleteElementsAllowed is true.

Parameters

Callback that is invoked if the F2 key is pressed and labelEditingAllowed is set to true.

This method determines the label to edit and delegates to editLabel .

Callback that triggers OnEditLabel.

Parameters

Called when the graphCanvas property changes.

This will update the internal state of the modes.

Parameters

Called when the graph property changes. This will update the internal state of the modes.

Parameters

Called when the graphSelection property changes.

This will update the internal state of the modes.

Parameters

Parameters

Parameters

Called when a new Label is added after pressing F2.

Parameters

Parameters

Called when a drag operation is finished

Parameters

Called when the moveLabelInputMode property value changes and after initialization of the field.

Parameters

Callback that is called as soon as moveLabelInputMode has moved a label.

Parameters

Called when the navigationInputMode property value changes and after initialization of the field.

Parameters

Called when a new node is created by this input mode.

Dispatches a NodeCreatedEvent.NODE_CREATED event.

Parameters

Called when a node is reparented by this input mode.

Dispatches a GraphEditorHierarchyEvent.NODE_REPARENTED event.

Parameters

Called when the reparentNodeHandler property value changes and after initialization of the field.

Parameters

See also

Called when the textEditorInputMode property value changes

Parameters

Called when a label's text was edited by the TextEditorInputMode.

Parameters

Called when text editing was cancelled by the TextEditorInputMode.

Parameters

Pastes the current clipboard contents.

Redoes the last Redoable change.

Delegates to the graph's undoEngine's UndoEngine.redo method.

Clears the current selection and selects all nodes and bends in this graph.

By default, this method will be called in response to a Ctrl-A-key press recognized by the keyboardInputMode

Callback that is used by this instance to set the current item on the GraphCanvasComponent.currentItem.

Parameters

Set a new Graph for this mode.

Triggers onGraphChanged.

Parameters

Sets the GraphCanvasComponent that is associated with this instance.

This will register a listener for the graphChanged and selectionChanged events to upgrade the graph and graphSelection property accordingly.

Parameters

Set a new GraphSelection for this mode.

Triggers onGraphSelectionChanged.

Parameters

Sets the label's text after it has been edited using editLabel.

This method gets called by onTextEditorInputModeTextEdited and depending on autoRemoveEmptyLabels it will either set the label's text or remove it from the graph.

Parameters

Callback that determines whether a GraphEditorEvent.ITEM_CLICKED should be dispatched for the provided IModelItem.

This implementation uses the clickableItems property to determine whether the item can be set to the current item.

Parameters

Callback that determines whether the provided IModelItem should be selected upon mouse clicks.

This implementation uses the clickSelectableItems property to determine whether the item can be set to the current item.

Parameters

Determines whether the item should be deleted.

Parameters

Callback that determines whether the provided IModelItem should be selected upon marquee selection.

This implementation uses the marqueeSelectableItems property to determine whether the item can be set to the current item.

Parameters

Determines whether to make the item movable using the moveInputMode.

Parameters

See also

Callback method that determines whether the label or the labels of the provided item should be edited in response to onEditLabel.

This implementation returns true if the type of the given item is among the labelEditableItems.

Parameters

See also

Parameters

Callback that determines whether the provided IModelItem should be set to the current item.

This implementation uses the focusableItems property to determine whether the item can be set to the current item.

Parameters

Determines whether to show the handles for the given item.

Parameters

Toggles the expanded state for the given group node in the IFoldedGraph.

Parameters

See also

Undoes the last undoable change.

Delegates to the graph's undoEngine's UndoEngine.undo method.

Makes each of the currently selected nodes a direct child of the root group (if not already).

This implementation will delegate the actual re-parenting of nodes to the graph's IGroupedGraph's setParent() implementation found in the lookup of the graph.

By default, this method will be called in response to a Ctrl-U-key press recognized by the keyboardInputMode.

See also

Unistalls this mode.

Deregisters event listeners from the graph canvas and sets the graph canvas for this input mode to null.

Parameters

Dispatched when a new bend has been created by the user. The item property of the event contains the newly added bend.

Dispatched when bend has been deleted by the user. The item property of the event contains the bend which has been removed. Note that the item is not part of the graph anymore at the time this event is dispatched.

This event will only be dispatched if the bend is explicitly deleted by the user. It will not be dispatched if the bend is removed because its edge is removed.

This event will only be dispatched for bends which will be deleted by direct user interaction, i.e. which were selected when the delete key was pressed. It will not be dispatched if a bend is removed because its edge is removed.

Dispatched when the current item changed.

Only focusableItems trigger this event.

Dispatched before a bend will be deleted by the user. The item property of the event contains the bend which will be removed.

This event will only be dispatched if the bend is explicitly deleted by the user. It will not be dispatched if the bend is removed because its edge is removed.

Dispatched before an edge will be deleted by the user. The item property of the event contains the edge which will be removed.

This event will only be dispatched if the edge is explicitly deleted by the user. It will not be dispatched if the edge is removed because its source or target node is removed.

This event will only be dispatched for edges which will be deleted by direct user interaction, i.e. which were selected when the delete key was pressed. It will not be dispatched if an edge is removed because its source or parent node is removed.

Dispatched before a label will be deleted by the user. The item property of the event contains the label which will be deleted.

This event will only be dispatched if the label is explicitly deleted by the user. It will not be dispatched if the label is removed because its owner is removed or because its text is set to null.

This event will only be dispatched for labels which will be deleted by direct user interaction, i.e. which were selected when the delete key was pressed. It will not be dispatched if a label is removed because its owner is removed.

Dispatched before a node will be deleted by the user. The item property of the event contains the node which will be deleted.

Dispatched when an edge is added by the user. The item property of the event contains the newly added edge.

This event will only be dispatched for bends which have been deleted by direct user interaction, i.e. which were selected when the delete key was pressed. It will not be dispatched if a bend is removed because its edge is removed.

Dispatched when an edge has been deleted by the user. The item property of the event contains the edge which has been removed. Note that the item is not part of the graph anymore at the time this event is dispatched.

This event will only be dispatched if the edge is explicitly deleted by the user. It will not be dispatched if the edge is removed because its source or target node is removed.

This event will only be dispatched for edges which will be deleted by direct user interaction, i.e. which were selected when the delete key was pressed. It will not be dispatched if an edge is removed because its source or parent node is removed.

Dispatched when a graph item has been clicked.

Only clickSelectableItems trigger this event.

Dispatched when a label is changed by the user (after pressing F2 key). The item property of the event contains the changed label.

Dispatched when a label is added by the user (after pressing F2 key). The item property of the event contains the newly added label.

Dispatched when a label has been deleted by the user. The item property of the event contains the label which has been removed. Note that the item is not part of the graph anymore at the time this event is dispatched.

This event will only be dispatched if the label is explicitly deleted by the user. It will not be dispatched if the label is removed because its owner is removed or because its text is set to null.

This event will only be dispatched for labels which were deleted by direct user interaction, i.e. which were selected when the delete key was pressed. It will not be dispatched if a label is removed because its owner is removed.

Dispatched when a node is added by the user. The item property of the event contains the newly added node.

Dispatched when a node has been deleted by the user. The item property of the event contains the node which has been removed. Note that the item is not part of the graph anymore at the time this event is dispatched.

Dispatched when a node is reparented by the user.