| Package | com.yworks.canvas.input |
| Class | public class NavigationInputMode |
| Inheritance | NavigationInputMode  KeyboardInputMode AbstractConcurrentInputMode AbstractInputMode flash.events.EventDispatcher |
IInputMode that can navigate an IGraph displayed in a
GraphCanvasComponent.
| Property | Defined By | ||
|---|---|---|---|
 | canvas : CanvasComponent [read-only]
The canvas instance this mode is currently installed in or null
| AbstractInputMode | |
| collapsingGroupsAllowed : Boolean
Gets or sets a value that determines whether it is allowed to collapse group nodes
via the NavigationInputMode.collapseGroupCommand. | NavigationInputMode | ||
| controller : ConcurrencyController
Gets or injects the ConcurrencyController for this instance. | AbstractConcurrentInputMode | |
| enabled : Boolean
Gets or sets the enabled state of this input mode. | AbstractConcurrentInputMode | |
| enteringGroupsAllowed : Boolean
Gets or sets a value that determines whether it is allowed to enter group nodes
via the NavigationInputMode.enterGroupCommand. | NavigationInputMode | ||
| exitingGroupsAllowed : Boolean
Determines whether it is allowed to exit the current group node via the
NavigationInputMode.exitGroupCommand. | NavigationInputMode | ||
| expandingGroupsAllowed : Boolean
Determines whether it is allowed to expand group nodes via the
NavigationInputMode.expandGroupCommand. | NavigationInputMode | ||
| graph : IGraph
The graph this mode operates on. | NavigationInputMode | ||
| graphCanvas : GraphCanvasComponent
The graph canvas component this mode acts on. | NavigationInputMode | ||
| inputModeContext : IInputModeContext [read-only]
The context instance this mode is currently installed in or
null if this instance is not installed. | AbstractInputMode | |
| installed : Boolean [read-only]
Whether this mode is currently installed, i.e
if a call to the canvas property will yield a non-null result. | AbstractInputMode | |
| navigableItems : uint
The item types that can be navigated to by this mode as
defined in the class GraphItemTypes. | NavigationInputMode | ||
| preferredCursor : Cursor
Gets or sets the cursor this mode would like to have displayed in the CanvasComponent. | AbstractConcurrentInputMode | |
| selection : IGraphSelection
The IGraphSelection this mode operates on. | NavigationInputMode | ||
| Method | Defined By | ||
|---|---|---|---|
| addHandler(eventRecognizer:Function, handler:Function):void
Adds a given handler to this instance that will be triggered if the
given eventRecognizer recognizes a KeyboardEvent that has been
triggered by the canvas component. | KeyboardInputMode | |
| cancel():void [override]
Releases the mutex if this input mode currently
owns the mutex. | AbstractConcurrentInputMode | |
| clearHandlers(eventRecognizer:Function = null):void
Removes all handlers that have been registered under the given recognizer. | KeyboardInputMode | |
clearSelection():void
Clears the selection. | NavigationInputMode | ||
collapseGroup(groupNode:INode):void
Collapses the given group node to hide the contents of the group node from this
IFoldedGraph. | NavigationInputMode | ||
collapseSelection():void
Performs collapseGroup for all IGraphSelection.selectedNodes. | NavigationInputMode | ||
| dispose():void [override]
Disposes this input mode. | KeyboardInputMode | |
enterGroup(node:INode):void
This method allows for entering a group node so that the currently displayed
IFoldedGraph's IFoldedGraph.localRoot will be reset to
the provided node. | NavigationInputMode | ||
enterSelectedGroup():void
Performs enterGroup for the first valid IGraphSelection.selectedNodes. | NavigationInputMode | ||
exitGroup():void
Exits the current IFoldedGraph.localRoot of the currently displayed
IFoldedGraph view and shows the contents of the parent container. | NavigationInputMode | ||
expandGroup(groupNode:INode):void
Expands the given group node to show the contents of the collapsed group node in
this IFoldedGraph. | NavigationInputMode | ||
expandSelection():void
Performs expandGroup for all IGraphSelection.selectedNodes. | NavigationInputMode | ||
extendSelectionTo(direction:uint):void
Moves the focus into the given direction, extending the selection to the new element. | NavigationInputMode | ||
| getHandlers(eventRecognizer:Function):Iterator
Returns all handlers registered using the given recognizer. | KeyboardInputMode | |
|
Returns an enumerator over all distinct registered recognizers. | KeyboardInputMode | |
| install(context:IInputModeContext):void
Installs this mode into the canvas of the given context. | AbstractInputMode | |
moveFocusTo(direction:uint):void
Moves the focus into the given direction, not changing the current selection. | NavigationInputMode | ||
moveTo(direction:uint):void
Moves the focus into the given direction, setting the selection to the new element. | NavigationInputMode | ||
| removeHandler(eventRecognizer:Function, handler:Function):void
Removes a previously registered handler. | KeyboardInputMode | |
selectCurrentItem():void
Selects the current item. | NavigationInputMode | ||
setCurrentItem(item:IModelItem):void
Sets the "current" item to the given one. | NavigationInputMode | ||
| stop():Boolean [override]
Returns true if this input mode doesn't own
the mutex. | AbstractConcurrentInputMode | |
toggleGroupNodeState(groupNode:INode):void
Toggles the expanded/collapsed state for the given group node in the
IFoldedGraph. | NavigationInputMode | ||
| uninstall(context:IInputModeContext):void
Uninstalls this mode from the canvas. | AbstractInputMode | |
| Method | Defined By | ||
|---|---|---|---|
adjustContentRect():void
Callback that adjusts the CanvasComponent.contentRect to encompass all elements. | NavigationInputMode | ||
| canRequestMutex():Boolean
Determines whether this instance can request the InputMutex. | AbstractConcurrentInputMode | |
| fireInstalled():void | AbstractInputMode | |
| fireInstalling():void | AbstractInputMode | |
| fireUninstalled():void | AbstractInputMode | |
| fireUninstalling():void | AbstractInputMode | |
| handleEvent(evt:Event):void
Traps key events from the canvas control and checks the list
of recognizers. | KeyboardInputMode | |
| hasMutex():Boolean
Determines whether this instance owns the input mutex. | AbstractConcurrentInputMode | |
initialize():void [override]
Adds the handler for the keyboard commands. | NavigationInputMode | ||
installCore(context:IInputModeContext):void [override]
The implementation of the install() method: installs this mode into
the canvas of the given context. | NavigationInputMode | ||
| invalidate():void
Convenience method for subclass implementations that invalidates
the canvasComponent this mode is currently installed in. | AbstractInputMode | |
isCollapseGroupCommand(event:Event):Boolean
Event recognizer for collapse group. | NavigationInputMode | ||
isEnterGroupCommand(event:Event):Boolean
Event recognizer for enter group. | NavigationInputMode | ||
isExitGroupCommand(event:Event):Boolean
Event recognizer for exit group. | NavigationInputMode | ||
isExpandGroupCommand(event:Event):Boolean
Event recognizer for expand group. | NavigationInputMode | ||
isExtendDownCommand(event:Event):Boolean
Event recognizer for extend selection down. | NavigationInputMode | ||
isExtendLeftCommand(event:Event):Boolean
Event recognizer for extend selection left. | NavigationInputMode | ||
isExtendRightCommand(event:Event):Boolean
Event recognizer for extend selection right. | NavigationInputMode | ||
isExtendToChildCommand(event:Event):Boolean
Event recognizer for extend selection to child. | NavigationInputMode | ||
isExtendToParentCommand(event:Event):Boolean
Event recognizer for extend selection to parent. | NavigationInputMode | ||
isExtendUpCommand(event:Event):Boolean
Event recognizer for extend selection up. | NavigationInputMode | ||
isMoveDownCommand(event:Event):Boolean
Event recognizer for move selection down. | NavigationInputMode | ||
isMoveFocusDownCommand(event:Event):Boolean
Event recognizer for move focus down. | NavigationInputMode | ||
isMoveFocusLeftCommand(event:Event):Boolean
Event recognizer for move focus left. | NavigationInputMode | ||
isMoveFocusRightCommand(event:Event):Boolean
Event recognizer for move focus right. | NavigationInputMode | ||
isMoveFocusToChildCommand(event:Event):Boolean
Event recognizer for move focus to child. | NavigationInputMode | ||
isMoveFocusToParentCommand(event:Event):Boolean
Event recognizer for move focus to parent. | NavigationInputMode | ||
isMoveFocusUpCommand(event:Event):Boolean
Event recognizer for move focus up. | NavigationInputMode | ||
isMoveLeftCommand(event:Event):Boolean
Event recognizer for move selection left. | NavigationInputMode | ||
isMoveRightCommand(event:Event):Boolean
Event recognizer for move selection right. | NavigationInputMode | ||
isMoveToChildCommand(event:Event):Boolean
Event recognizer for move selection to child. | NavigationInputMode | ||
isMoveToParentCommand(event:Event):Boolean
Event recognizer for move selection to parent. | NavigationInputMode | ||
isMoveUpCommand(event:Event):Boolean
Event recognizer for move selection up. | NavigationInputMode | ||
onCollapseGroupCommand(event:Event):void
Collapses a group. | NavigationInputMode | ||
| onDisabled():void
Called when the enabled property changes to false. | AbstractConcurrentInputMode | |
| onEnabled():void
Called when the enabled property changes to true. | AbstractConcurrentInputMode | |
onEnterGroupCommand(event:Event):void
Enters a group. | NavigationInputMode | ||
onExitGroupCommand(event:Event):void
Exits a group. | NavigationInputMode | ||
onExpandGroupCommand(event:Event):void
Expands a group. | NavigationInputMode | ||
onExtendDownCommand(event:Event):void
Extends the selection down. | NavigationInputMode | ||
onExtendLeftCommand(event:Event):void
Extends the selection left. | NavigationInputMode | ||
onExtendRightCommand(event:Event):void
Extends the selection right. | NavigationInputMode | ||
onExtendToChildCommand(event:Event):void
Extends the selection to the child. | NavigationInputMode | ||
onExtendToParentCommand(event:Event):void
Extends the selection to the parent. | NavigationInputMode | ||
onExtendUpCommand(event:Event):void
Extends the selection up. | NavigationInputMode | ||
onMoveDownCommand(event:Event):void
Moves the selection left. | NavigationInputMode | ||
onMoveFocusDownCommand(event:Event):void
Moves the focus down. | NavigationInputMode | ||
onMoveFocusLeftCommand(event:Event):void
Moves the focus left. | NavigationInputMode | ||
onMoveFocusRightCommand(event:Event):void
Moves the focus right. | NavigationInputMode | ||
onMoveFocusToChildCommand(event:Event):void
Moves the focus to the child. | NavigationInputMode | ||
onMoveFocusToParentCommand(event:Event):void
Moves the focus to the parent. | NavigationInputMode | ||
onMoveFocusUpCommand(event:Event):void
Moves the focus up. | NavigationInputMode | ||
onMoveLeftCommand(event:Event):void
Moves the selection left. | NavigationInputMode | ||
onMoveRightCommand(event:Event):void
Moves the selection left. | NavigationInputMode | ||
onMoveToChildCommand(event:Event):void
Moves the selection to the child. | NavigationInputMode | ||
onMoveToParentCommand(event:Event):void
Moves the selection to the parent. | NavigationInputMode | ||
onMoveUpCommand(event:Event):void
Moves the selection left. | NavigationInputMode | ||
| onMutexObtained():void
Called when this instance obtains the InputMutex. | AbstractConcurrentInputMode | |
| onMutexReleased():void
Called when this instance released the InputMutex. | AbstractConcurrentInputMode | |
|
Called when the preferredCursor property changes. | AbstractConcurrentInputMode | |
| releaseMutex():void
Releases the mutex that is currently owned by this instance. | AbstractConcurrentInputMode | |
| requestMutex():void
Requests the InputMutex from the current controller. | AbstractConcurrentInputMode | |
Callback that selects the given item. | NavigationInputMode | ||
Callback that actually sets the current item property. | NavigationInputMode | ||
setGraphCanvas(newCanvas:GraphCanvasComponent):void
Sets the graph canvas component to use for the various actions. | NavigationInputMode | ||
shouldBeNavigatedTo(item:IModelItem):Boolean
Callback predicate method that determines whether a given model item should be navigated to. | NavigationInputMode | ||
shouldCollapseGroup(node:INode):Boolean
Predicate method that decides whether it is allowed to collapse the given group node. | NavigationInputMode | ||
shouldEnterGroup(node:INode):Boolean
Predicate method that decides whether it is allowed to enter the specific group node. | NavigationInputMode | ||
shouldExitGroup():Boolean
Predicate method that decides whether it is allowed to exit the current group node. | NavigationInputMode | ||
shouldExpandGroup(node:INode):Boolean
Predicate method that decides whether it is allowed to expand the given group node. | NavigationInputMode | ||
shouldToggleGroupState(node:INode):Boolean
Predicate method that decides whether it is allowed to toggle the collapsed
state of the given group node. | NavigationInputMode | ||
uninstallCore(context:IInputModeContext):void [override] | NavigationInputMode | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the current item changed. | NavigationInputMode | |||
| Dispatched after the input mode was installed. | AbstractInputMode | ||
| Dispatched before the input mode will be installed. | AbstractInputMode | ||
| Dispatched when the default cursor changed. | AbstractConcurrentInputMode | ||
| Dispatched after the input mode was uninstalled. | AbstractInputMode | ||
| Dispatched before the input mode will be uninstalled. | AbstractInputMode | ||
| Constant | Defined By | ||
|---|---|---|---|
| DIRECTION_CHILD : uint = 6 [static]
Move into the direction of the childe in the IGroupedGraph. | NavigationInputMode | ||
| DIRECTION_DOWN : uint = 4 [static]
Move into the direction of the positive y Axis. | NavigationInputMode | ||
| DIRECTION_LEFT : uint = 1 [static]
Move into the direction of the negative x Axis. | NavigationInputMode | ||
| DIRECTION_NONE : uint = 0 [static]
Move to no direction. | NavigationInputMode | ||
| DIRECTION_PARENT : uint = 5 [static]
Move inthe direction of the parent in the IGroupedGraph. | NavigationInputMode | ||
| DIRECTION_RIGHT : uint = 2 [static]
Move into the direction of the positive x Axis. | NavigationInputMode | ||
| DIRECTION_UP : uint = 3 [static]
Move into the direction of the negative y Axis. | NavigationInputMode | ||
| INSTALLED : String = installed [static]
| AbstractInputMode | |
| INSTALLING : String = installing [static]
| AbstractInputMode | |
| PREFERRED_CURSOR_CHANGED : String = preferredCursorChanged [static] | AbstractConcurrentInputMode | |
| UNINSTALLED : String = uninstalled [static]
| AbstractInputMode | |
| UNINSTALLING : String = uninstalling [static]
| AbstractInputMode | |
| collapsingGroupsAllowed | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescollapsingGroupsAllowed:Boolean
Gets or sets a value that determines whether it is allowed to collapse group nodes
via the NavigationInputMode.collapseGroupCommand.
The default value is true.
public function get collapsingGroupsAllowed():Boolean public function set collapsingGroupsAllowed(value:Boolean):voidSee also
| enteringGroupsAllowed | property |
enteringGroupsAllowed:Boolean
Gets or sets a value that determines whether it is allowed to enter group nodes
via the NavigationInputMode.enterGroupCommand.
The default value is true.
public function get enteringGroupsAllowed():Boolean public function set enteringGroupsAllowed(value:Boolean):voidSee also
| exitingGroupsAllowed | property |
exitingGroupsAllowed:Boolean
Determines whether it is allowed to exit the current group node via the
NavigationInputMode.exitGroupCommand.
The default value is true.
public function get exitingGroupsAllowed():Boolean public function set exitingGroupsAllowed(value:Boolean):voidSee also
| expandingGroupsAllowed | property |
expandingGroupsAllowed:Boolean
Determines whether it is allowed to expand group nodes via the
NavigationInputMode.expandGroupCommand.
The default value is true.
public function get expandingGroupsAllowed():Boolean public function set expandingGroupsAllowed(value:Boolean):voidSee also
| graph | property |
graph:IGraphThe graph this mode operates on.
public function get graph():IGraph public function set graph(value:IGraph):void| graphCanvas | property |
graphCanvas:GraphCanvasComponentThe graph canvas component this mode acts on.
public function get graphCanvas():GraphCanvasComponent public function set graphCanvas(value:GraphCanvasComponent):void| navigableItems | property |
navigableItems:uint
The item types that can be navigated to by this mode as
defined in the class GraphItemTypes.
public function get navigableItems():uint public function set navigableItems(value:uint):voidSee also
| selection | property |
selection:IGraphSelection
The IGraphSelection this mode operates on.
public function get selection():IGraphSelection public function set selection(value:IGraphSelection):void| adjustContentRect | () | method |
protected function adjustContentRect():void
Callback that adjusts the CanvasComponent.contentRect to encompass all elements.
This implementation will try to delegate to GraphEditorInputMode.adjustContentRect()
if it can find the GraphEditorInputMode in the inputModeContext,
otherwise CanvasComponent.fitGraphBounds() is called.
| clearSelection | () | method |
public function clearSelection():voidClears the selection.
| collapseGroup | () | method |
public function collapseGroup(groupNode:INode):void
Collapses the given group node to hide the contents of the group node from this
IFoldedGraph.
Parameters
groupNode:INode — The group node to collapse.
|
See also
| collapseSelection | () | method |
public function collapseSelection():void
Performs collapseGroup for all IGraphSelection.selectedNodes.
| enterGroup | () | method |
public function enterGroup(node:INode):void
This method allows for entering a group node so that the currently displayed
IFoldedGraph's IFoldedGraph.localRoot will be reset to
the provided node.
It is possible to both use a local group node that is part of the currently displayed
graph as the node argument, as well as an item that belongs to the
FoldingManager.masterHierarchy to allow for switching to group nodes which
are currently not being displayed in this view.
Parameters
node:INode — The node that needs to be either part of the current graph, or part of the
FoldingManager.masterHierarchy.
|
See also
| enterSelectedGroup | () | method |
public function enterSelectedGroup():void
Performs enterGroup for the first valid IGraphSelection.selectedNodes.
| exitGroup | () | method |
public function exitGroup():void
Exits the current IFoldedGraph.localRoot of the currently displayed
IFoldedGraph view and shows the contents of the parent container.
This method will also clear the selection and select the exited group node.
See also
| expandGroup | () | method |
public function expandGroup(groupNode:INode):void
Expands the given group node to show the contents of the collapsed group node in
this IFoldedGraph.
Parameters
groupNode:INode — The group node to expand
|
See also
| expandSelection | () | method |
public function expandSelection():void
Performs expandGroup for all IGraphSelection.selectedNodes.
| extendSelectionTo | () | method |
public function extendSelectionTo(direction:uint):voidMoves the focus into the given direction, extending the selection to the new element.
Parameters
direction:uint — The direction to move the focus and extend the selection as defined by
the DIRECTION constants of this class.
|
| initialize | () | method |
override protected function initialize():voidAdds the handler for the keyboard commands.
| installCore | () | method |
override protected function installCore(context:IInputModeContext):void
The implementation of the install() method: installs this mode into
the canvas of the given context.
Subclasses should override this method and call super.installCore(context), first.
One-time initialization should be performed in the initialize method.
The install method will call the initialize method the first
time this mode gets installed.
Parameters
context:IInputModeContext — The context to use for installation.
|
| isCollapseGroupCommand | () | method |
protected function isCollapseGroupCommand(event:Event):BooleanEvent recognizer for collapse group.
This implementation returns true if minus (-) is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers expanding groups.
|
| isEnterGroupCommand | () | method |
protected function isEnterGroupCommand(event:Event):BooleanEvent recognizer for enter group.
This implementation returns true if enter is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers entering groups.
|
| isExitGroupCommand | () | method |
protected function isExitGroupCommand(event:Event):BooleanEvent recognizer for exit group.
This implementation returns true if backspace is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers exiting groups.
|
| isExpandGroupCommand | () | method |
protected function isExpandGroupCommand(event:Event):BooleanEvent recognizer for expand group.
This implementation returns true if add (+) is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers expanding groups.
|
| isExtendDownCommand | () | method |
protected function isExtendDownCommand(event:Event):BooleanEvent recognizer for extend selection down.
This implementation returns true if cursor down is pressed
together with the shift key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers extending the selection down.
|
| isExtendLeftCommand | () | method |
protected function isExtendLeftCommand(event:Event):BooleanEvent recognizer for extend selection left.
This implementation returns true if cursor left is pressed
together with the shift key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers extending the selection left.
|
| isExtendRightCommand | () | method |
protected function isExtendRightCommand(event:Event):BooleanEvent recognizer for extend selection right.
This implementation returns true if cursor right is pressed
together with the shift key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers extending the selection right.
|
| isExtendToChildCommand | () | method |
protected function isExtendToChildCommand(event:Event):BooleanEvent recognizer for extend selection to child.
This implementation returns true if page down is pressed
together with the shift key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers extending the selection to the child.
|
| isExtendToParentCommand | () | method |
protected function isExtendToParentCommand(event:Event):BooleanEvent recognizer for extend selection to parent.
This implementation returns true if page up is pressed
together with the shift key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers extending the selection to the parent.
|
| isExtendUpCommand | () | method |
protected function isExtendUpCommand(event:Event):BooleanEvent recognizer for extend selection up.
This implementation returns true if cursor up is pressed
together with the shift key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers extending the selection up.
|
| isMoveDownCommand | () | method |
protected function isMoveDownCommand(event:Event):BooleanEvent recognizer for move selection down.
This implementation returns true if cursor down is pressed
without any modifier.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the selection down.
|
| isMoveFocusDownCommand | () | method |
protected function isMoveFocusDownCommand(event:Event):BooleanEvent recognizer for move focus down.
This implementation returns true if cursor down is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the focus down.
|
| isMoveFocusLeftCommand | () | method |
protected function isMoveFocusLeftCommand(event:Event):BooleanEvent recognizer for move focus left.
This implementation returns true if cursor left is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the focus left.
|
| isMoveFocusRightCommand | () | method |
protected function isMoveFocusRightCommand(event:Event):BooleanEvent recognizer for move focus right.
This implementation returns true if cursor right is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the focus right.
|
| isMoveFocusToChildCommand | () | method |
protected function isMoveFocusToChildCommand(event:Event):BooleanEvent recognizer for move focus to child.
This implementation returns true if page down is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the focus to the child.
|
| isMoveFocusToParentCommand | () | method |
protected function isMoveFocusToParentCommand(event:Event):BooleanEvent recognizer for move focus to parent.
This implementation returns true if page up is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the focus to the parent.
|
| isMoveFocusUpCommand | () | method |
protected function isMoveFocusUpCommand(event:Event):BooleanEvent recognizer for move focus up.
This implementation returns true if cursor up is pressed
together with the ctrl key.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the focus up.
|
| isMoveLeftCommand | () | method |
protected function isMoveLeftCommand(event:Event):BooleanEvent recognizer for move selection left.
This implementation returns true if cursor left is pressed
without any modifier.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the selection left.
|
| isMoveRightCommand | () | method |
protected function isMoveRightCommand(event:Event):BooleanEvent recognizer for move selection right.
This implementation returns true if cursor right is pressed
without any modifier.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the selection right.
|
| isMoveToChildCommand | () | method |
protected function isMoveToChildCommand(event:Event):BooleanEvent recognizer for move selection to child.
This implementation returns true if page down is pressed
without any modifier.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the selection to the child.
|
| isMoveToParentCommand | () | method |
protected function isMoveToParentCommand(event:Event):BooleanEvent recognizer for move selection to parent.
This implementation returns true if page up is pressed
without any modifier.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the selection to the parent.
|
| isMoveUpCommand | () | method |
protected function isMoveUpCommand(event:Event):BooleanEvent recognizer for move selection up.
This implementation returns true if cursor up is pressed
without any modifier.
Parameters
event:Event — The event to verify.
|
Boolean — true if the event triggers moving the selection up.
|
| moveFocusTo | () | method |
public function moveFocusTo(direction:uint):voidMoves the focus into the given direction, not changing the current selection.
Parameters
direction:uint — The direction to move the focus as defined by
the DIRECTION constants of this class.
|
| moveTo | () | method |
public function moveTo(direction:uint):voidMoves the focus into the given direction, setting the selection to the new element.
Parameters
direction:uint — The direction to move the focus and selection as defined by
the DIRECTION constants of this class.
|
| onCollapseGroupCommand | () | method |
protected function onCollapseGroupCommand(event:Event):voidCollapses a group.
Parameters
event:Event |
| onEnterGroupCommand | () | method |
protected function onEnterGroupCommand(event:Event):voidEnters a group.
Parameters
event:Event |
| onExitGroupCommand | () | method |
protected function onExitGroupCommand(event:Event):voidExits a group.
Parameters
event:Event |
| onExpandGroupCommand | () | method |
protected function onExpandGroupCommand(event:Event):voidExpands a group.
Parameters
event:Event |
| onExtendDownCommand | () | method |
protected function onExtendDownCommand(event:Event):voidExtends the selection down.
Parameters
event:Event |
| onExtendLeftCommand | () | method |
protected function onExtendLeftCommand(event:Event):voidExtends the selection left.
Parameters
event:Event |
| onExtendRightCommand | () | method |
protected function onExtendRightCommand(event:Event):voidExtends the selection right.
Parameters
event:Event |
| onExtendToChildCommand | () | method |
protected function onExtendToChildCommand(event:Event):voidExtends the selection to the child.
Parameters
event:Event |
| onExtendToParentCommand | () | method |
protected function onExtendToParentCommand(event:Event):voidExtends the selection to the parent.
Parameters
event:Event |
| onExtendUpCommand | () | method |
protected function onExtendUpCommand(event:Event):voidExtends the selection up.
Parameters
event:Event |
| onMoveDownCommand | () | method |
protected function onMoveDownCommand(event:Event):voidMoves the selection left.
Parameters
event:Event |
| onMoveFocusDownCommand | () | method |
protected function onMoveFocusDownCommand(event:Event):voidMoves the focus down.
Parameters
event:Event |
| onMoveFocusLeftCommand | () | method |
protected function onMoveFocusLeftCommand(event:Event):voidMoves the focus left.
Parameters
event:Event |
| onMoveFocusRightCommand | () | method |
protected function onMoveFocusRightCommand(event:Event):voidMoves the focus right.
Parameters
event:Event |
| onMoveFocusToChildCommand | () | method |
protected function onMoveFocusToChildCommand(event:Event):voidMoves the focus to the child.
Parameters
event:Event |
| onMoveFocusToParentCommand | () | method |
protected function onMoveFocusToParentCommand(event:Event):voidMoves the focus to the parent.
Parameters
event:Event |
| onMoveFocusUpCommand | () | method |
protected function onMoveFocusUpCommand(event:Event):voidMoves the focus up.
Parameters
event:Event |
| onMoveLeftCommand | () | method |
protected function onMoveLeftCommand(event:Event):voidMoves the selection left.
Parameters
event:Event |
| onMoveRightCommand | () | method |
protected function onMoveRightCommand(event:Event):voidMoves the selection left.
Parameters
event:Event |
| onMoveToChildCommand | () | method |
protected function onMoveToChildCommand(event:Event):voidMoves the selection to the child.
Parameters
event:Event |
| onMoveToParentCommand | () | method |
protected function onMoveToParentCommand(event:Event):voidMoves the selection to the parent.
Parameters
event:Event |
| onMoveUpCommand | () | method |
protected function onMoveUpCommand(event:Event):voidMoves the selection left.
Parameters
event:Event |
| selectCurrentItem | () | method |
public function selectCurrentItem():voidSelects the current item.
This method delegates to selectItem.
| selectItem | () | method |
protected function selectItem(canvas:GraphCanvasComponent, item:IModelItem, extendSelection:Boolean):voidCallback that selects the given item.
Parameters
canvas:GraphCanvasComponent — The graph canvas.
| |
item:IModelItem — The item to select.
| |
extendSelection:Boolean — If set to true the current selection is extended otherwise
it is cleared beforehand.
|
See also
| setCurrentItem | () | method |
public function setCurrentItem(item:IModelItem):voidSets the "current" item to the given one.
Parameters
item:IModelItem — The item to set as the current item.
|
See also
| setCurrentItemCore | () | method |
protected function setCurrentItemCore(canvas:GraphCanvasComponent, item:IModelItem):BooleanCallback that actually sets the current item property.
Parameters
canvas:GraphCanvasComponent — The GraphCanvasComponent to set the current item of.
| |
item:IModelItem — The item to set.
|
Boolean — Whether the operation was actually performed.
|
| setGraphCanvas | () | method |
protected function setGraphCanvas(newCanvas:GraphCanvasComponent):voidSets the graph canvas component to use for the various actions.
This will register or unregister the event listeners for the component.
This method is called in response to install and uninstall.
Parameters
newCanvas:GraphCanvasComponent — The graph canvas to use or null.
|
| shouldBeNavigatedTo | () | method |
protected function shouldBeNavigatedTo(item:IModelItem):BooleanCallback predicate method that determines whether a given model item should be navigated to.
This implementation uses the navigableItems property to determine
whether the modelItem can be navigated to.
Parameters
item:IModelItem — The model item.
|
Boolean — Whether the item should be considered for navigational commands.
|
| shouldCollapseGroup | () | method |
protected function shouldCollapseGroup(node:INode):BooleanPredicate method that decides whether it is allowed to collapse the given group node.
This implementation yields the value of collapsingGroupsAllowed.
Parameters
node:INode — The node to collapse.
|
Boolean — Whether to collapse the given group or not.
|
| shouldEnterGroup | () | method |
protected function shouldEnterGroup(node:INode):BooleanPredicate method that decides whether it is allowed to enter the specific group node.
This implementation yields the value of enteringGroupsAllowed.
Parameters
node:INode — The group node to enter.
|
Boolean — Whether to enter the group or not.
|
| shouldExitGroup | () | method |
protected function shouldExitGroup():BooleanPredicate method that decides whether it is allowed to exit the current group node.
This implementation yields the value of exitingGroupAllowed.
Boolean — Whether to exit the current group or not.
|
| shouldExpandGroup | () | method |
protected function shouldExpandGroup(node:INode):BooleanPredicate method that decides whether it is allowed to expand the given group node.
This implementation yields the value of expandingGroupsAllowed.
Parameters
node:INode — The node to expand.
|
Boolean — Whether to expand the given group or not.
|
| shouldToggleGroupState | () | method |
protected function shouldToggleGroupState(node:INode):BooleanPredicate method that decides whether it is allowed to toggle the collapsed state of the given group node.
This implementation uses shouldExpandGroup and shouldCollapseGroup
respectively.
Parameters
node:INode — The node which should be toggled.
|
Boolean — Whether to expand the given group or not.
|
| toggleGroupNodeState | () | method |
public function toggleGroupNodeState(groupNode:INode):void
Toggles the expanded/collapsed state for the given group node in the
IFoldedGraph.
Parameters
groupNode:INode — The group node to toggle the state for.
|
See also
| uninstallCore | () | method |
override protected function uninstallCore(context:IInputModeContext):voidParameters
context:IInputModeContext |
| currentItemChanged | Event |
com.yworks.graph.input.GraphEditorEventcom.yworks.graph.input.GraphEditorEvent.CURRENT_ITEM_CHANGEDDispatched when the current item changed.
Dispatched when a when the current item has changed.| DIRECTION_CHILD | Constant |
public static const DIRECTION_CHILD:uint = 6
Move into the direction of the childe in the IGroupedGraph.
| DIRECTION_DOWN | Constant |
public static const DIRECTION_DOWN:uint = 4Move into the direction of the positive y Axis.
| DIRECTION_LEFT | Constant |
public static const DIRECTION_LEFT:uint = 1Move into the direction of the negative x Axis.
| DIRECTION_NONE | Constant |
public static const DIRECTION_NONE:uint = 0Move to no direction.
| DIRECTION_PARENT | Constant |
public static const DIRECTION_PARENT:uint = 5
Move inthe direction of the parent in the IGroupedGraph.
| DIRECTION_RIGHT | Constant |
public static const DIRECTION_RIGHT:uint = 2Move into the direction of the positive x Axis.
| DIRECTION_UP | Constant |
public static const DIRECTION_UP:uint = 3Move into the direction of the negative y Axis.