NavigationInputMode (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.view.input.NavigationInputMode

All Implemented Interfaces:

IInputMode
```
public class NavigationInputMode
extends Object
implements IInputMode
```
An IInputMode that can navigate an IGraph displayed in a GraphControl.
This mode is Exclusive by default.

Constructor Summary

Constructors
Constructor and Description

NavigationInputMode()
Initializes a new instance of the NavigationInputMode class.

Constructors
Constructor and Description
`NavigationInputMode()` Initializes a new instance of the `NavigationInputMode` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroupCollapsedListener(IEventHandler<ItemEventArgs<INode>> groupCollapsedEvent)` Adds the given listener for the `GroupCollapsed` event that occurs whenever a group has been `Collapsed`.
`void`	`addGroupCollapsingListener(IEventHandler<ItemEventArgs<INode>> groupCollapsingEvent)` Adds the given listener for the `GroupCollapsing` event that occurs before a group will be `Collapsed`.
`void`	`addGroupEnteredListener(IEventHandler<ItemEventArgs<INode>> groupEnteredEvent)` Adds the given listener for the `GroupEntered` event that occurs whenever a group has been `Entered`.
`void`	`addGroupEnteringListener(IEventHandler<ItemEventArgs<INode>> groupEnteringEvent)` Adds the given listener for the `GroupEntering` event that occurs before a group will be `Entered`.
`void`	`addGroupExitedListener(IEventHandler<ItemEventArgs<INode>> groupExitedEvent)` Adds the given listener for the `GroupExited` event that occurs whenever a group has been `Exited`.
`void`	`addGroupExitingListener(IEventHandler<ItemEventArgs<INode>> groupExitingEvent)` Adds the given listener for the `GroupExiting` event that occurs before a group will be `Exited`.
`void`	`addGroupExpandedListener(IEventHandler<ItemEventArgs<INode>> groupExpandedEvent)` Adds the given listener for the `GroupExpanded` event that occurs whenever a group has been `Expanded`.
`void`	`addGroupExpandingListener(IEventHandler<ItemEventArgs<INode>> groupExpandingEvent)` Adds the given listener for the `GroupExpanding` event that occurs before a group will be `Expanded`.
`protected void`	`adjustContentRect()` Callback that adjusts the `ContentRect` to encompass all elements.
`protected void`	`adjustGroupNodeLocation(boolean collapse, INode groupNode)` Adjust the group node location according to the value of `AutoGroupNodeAlignmentPolicy`.
`void`	`cancel()` Called by the client to unconditionally cancel all editing.
`void`	`clearSelection()` Clears the selection in the `GraphControl`.
`void`	`collapseGroup(INode groupNode)` `Collapses` the given group node to hide the contents of the group node from this `IFoldingView`.
`void`	`collapseSelection()` Performs `collapseGroup(INode)` for all `SelectedNodes`.
`void`	`enterGroup(INode node)` This method allows for entering a group node so that the currently displayed `IFoldingView`'s `LocalRoot` will be reset to the provided node.
`void`	`enterSelectedGroup()` Performs `enterGroup(INode)` for the first valid `SelectedNodes`.
`void`	`exitGroup()` Exits the current `LocalRoot` of the currently displayed `view` and shows the contents of the parent container.
`void`	`expandGroup(INode groupNode)` `Expands` the given group node to show the contents of the collapsed group node in this `IFoldingView`.
`void`	`expandSelection()` Performs `expandGroup(INode)` for all `SelectedNodes`.
`void`	`extendSelectionTo(MoveFocusDirection direction)` Moves the focus into the given direction, extending the selection to the new element.
`NodeAlignmentPolicy`	`getAutoGroupNodeAlignmentPolicy()` Gets the the location that should be kept fixed if toggling a group node state.
`Collection<ICommand>`	`getAvailableCommands()` Gets the list of commands that are available in this instance.
`protected ConcurrencyController`	`getController()` Returns the installed `Controller`.
`IGraph`	`getGraph()` Gets the graph this mode operates on.
`GraphControl`	`getGraphControl()` Gets the `GraphControl` this mode acts on.
`IGraphSelection`	`getGraphSelection()` Gets the `IGraphSelection` this mode operates on.
`IInputModeContext`	`getInputModeContext()` Returns the context instance this mode is currently installed in or `null` if this instance is not installed.
`GraphItemTypes`	`getNavigableItems()` Gets the item types that can be navigated to by this mode.
`int`	`getPriority()` The priority of this input mode.
`GraphItemTypes`	`getSelectableItems()` Gets the types of the items that should be selectable by this instance.
`void`	`install(IInputModeContext context, ConcurrencyController controller)` Installs this mode into the given context that is provided by the canvas.
`boolean`	`isCollapseGroupAllowed()` Gets a value that determines whether it is allowed to collapse group nodes via the `ICommand.COLLAPSE_GROUP`.
`boolean`	`isEnabled()` Gets the enabled state of this input mode.
`boolean`	`isEnterGroupAllowed()` Gets a value that determines whether it is allowed to `enter group nodes` via the `ICommand.ENTER_GROUP`.
`boolean`	`isExclusive()` Gets a value indicating whether this mode will be the only one running when it has the mutex.
`boolean`	`isExitGroupAllowed()` Gets a value that determines whether it is allowed to `exit the current group node` via the `ICommand.EXIT_GROUP`.
`boolean`	`isExpandGroupAllowed()` Gets a value that determines whether it is allowed to `expand group nodes` via the `ICommand.EXPAND_GROUP`.
`boolean`	`isFittingContentAfterGroupActionsEnabled()` Gets a value that determines whether `CanvasControl.fitContent()` or the `ICommand.FIT_CONTENT` should be triggered after a group navigation action.
`boolean`	`isUsingCurrentItemForCommandsEnabled()` Gets a value indicating whether to use the `CurrentItem` as a fallback for the commands if no item is provided in the parameter and the current selection is empty.
`void`	`moveFocusTo(MoveFocusDirection direction)` Moves the focus into the given direction, not changing the current selection.
`void`	`moveTo(MoveFocusDirection direction)` Moves the focus into the given direction, setting the selection to the new element.
`protected void`	`onCanceled()` Called after `cancel()` has been called.
`protected void`	`onConcurrencyControllerActivated()` Called after the `Active` property of the installed `ConcurrencyController` has been set to `true`.
`protected void`	`onConcurrencyControllerDeactivated()` Called after the `Active` property of the installed `ConcurrencyController` has been set to `false`.
`protected void`	`onGroupCollapsed(ItemEventArgs<INode> argument)` Raises the `GroupCollapsed` event.
`protected void`	`onGroupCollapsing(ItemEventArgs<INode> argument)` Raises the `GroupCollapsing` event.
`protected void`	`onGroupEntered(ItemEventArgs<INode> argument)` Raises the `GroupEntered` event.
`protected void`	`onGroupEntering(ItemEventArgs<INode> argument)` Raises the `GroupEntering` event.
`protected void`	`onGroupExited(ItemEventArgs<INode> argument)` Raises the `GroupExited` event.
`protected void`	`onGroupExiting(ItemEventArgs<INode> argument)` Raises the `GroupExiting` event.
`protected void`	`onGroupExpanded(ItemEventArgs<INode> argument)` Raises the `GroupExpanded` event.
`protected void`	`onGroupExpanding(ItemEventArgs<INode> argument)` Raises the `GroupExpanding` event.
`protected void`	`onStopped()` Called after `stop()` has been called.
`void`	`removeGroupCollapsedListener(IEventHandler<ItemEventArgs<INode>> groupCollapsedEvent)` Removes the given listener for the `GroupCollapsed` event that occurs whenever a group has been `Collapsed`.
`void`	`removeGroupCollapsingListener(IEventHandler<ItemEventArgs<INode>> groupCollapsingEvent)` Removes the given listener for the `GroupCollapsing` event that occurs before a group will be `Collapsed`.
`void`	`removeGroupEnteredListener(IEventHandler<ItemEventArgs<INode>> groupEnteredEvent)` Removes the given listener for the `GroupEntered` event that occurs whenever a group has been `Entered`.
`void`	`removeGroupEnteringListener(IEventHandler<ItemEventArgs<INode>> groupEnteringEvent)` Removes the given listener for the `GroupEntering` event that occurs before a group will be `Entered`.
`void`	`removeGroupExitedListener(IEventHandler<ItemEventArgs<INode>> groupExitedEvent)` Removes the given listener for the `GroupExited` event that occurs whenever a group has been `Exited`.
`void`	`removeGroupExitingListener(IEventHandler<ItemEventArgs<INode>> groupExitingEvent)` Removes the given listener for the `GroupExiting` event that occurs before a group will be `Exited`.
`void`	`removeGroupExpandedListener(IEventHandler<ItemEventArgs<INode>> groupExpandedEvent)` Removes the given listener for the `GroupExpanded` event that occurs whenever a group has been `Expanded`.
`void`	`removeGroupExpandingListener(IEventHandler<ItemEventArgs<INode>> groupExpandingEvent)` Removes the given listener for the `GroupExpanding` event that occurs before a group will be `Expanded`.
`void`	`selectCurrentItem()` Selects the `CurrentItem` current item.
`protected void`	`selectItem(GraphControl graphControl, IModelItem item, boolean extendSelection)` Callback that selects the given item.
`void`	`setAutoGroupNodeAlignmentPolicy(NodeAlignmentPolicy value)` Sets the the location that should be kept fixed if toggling a group node state.
`void`	`setCollapseGroupAllowed(boolean value)` Sets a value that determines whether it is allowed to collapse group nodes via the `ICommand.COLLAPSE_GROUP`.
`protected boolean`	`setCurrentItem(GraphControl graphControl, IModelItem item)` Callback that actually sets the current item property.
`void`	`setCurrentItem(IModelItem item)` Sets the "current" item to the given one.
`void`	`setEnabled(boolean value)` Sets the enabled state of this input mode.
`void`	`setEnterGroupAllowed(boolean value)` Sets a value that determines whether it is allowed to `enter group nodes` via the `ICommand.ENTER_GROUP`.
`void`	`setExclusive(boolean value)` Sets a value indicating whether this mode will be the only one running when it has the mutex.
`void`	`setExitGroupAllowed(boolean value)` Sets a value that determines whether it is allowed to `exit the current group node` via the `ICommand.EXIT_GROUP`.
`void`	`setExpandGroupAllowed(boolean value)` Sets a value that determines whether it is allowed to `expand group nodes` via the `ICommand.EXPAND_GROUP`.
`void`	`setFittingContentAfterGroupActionsEnabled(boolean value)` Sets a value that determines whether `CanvasControl.fitContent()` or the `ICommand.FIT_CONTENT` should be triggered after a group navigation action.
`void`	`setGraphControl(GraphControl value)` Sets the `GraphControl` this mode acts on.
`protected void`	`setGraphControlCore(GraphControl graphControl)` Sets the `GraphControl` to use for the various actions.
`void`	`setNavigableItems(GraphItemTypes value)` Sets the item types that can be navigated to by this mode.
`void`	`setPriority(int value)` The priority of this input mode.
`void`	`setSelectableItems(GraphItemTypes value)` Sets the types of the items that should be selectable by this instance.
`void`	`setUsingCurrentItemForCommandsEnabled(boolean value)` Sets a value indicating whether to use the `CurrentItem` as a fallback for the commands if no item is provided in the parameter and the current selection is empty.
`protected boolean`	`shouldCollapseGroup(INode groupNode)` Predicate method that decides whether it is allowed to `collapse` the given group node.
`protected boolean`	`shouldEnterGroup(INode node)` Predicate method that decides whether it is allowed to `enter` the specific group node.
`protected boolean`	`shouldExitGroup()` Predicate method that decides whether it is allowed to `exit` the current group node.
`protected boolean`	`shouldExpandGroup(INode node)` Predicate method that decides whether it is allowed to `expand` the given group node.
`protected boolean`	`shouldNavigateTo(IModelItem item)` Callback predicate method that determines whether a given model item should be navigated to.
`protected boolean`	`shouldSelect(IModelItem item)` Callback predicate method that determines whether a given model item should be selected.
`protected boolean`	`shouldToggleExpansionState(INode node)` Predicate method that decides whether it is allowed to `toggle` the collapsed state of the given group node.
`boolean`	`stop()` Overridden to only return `true` if this instance does not currently `have the input mutex`.
`void`	`toggleExpansionState(INode groupNode)` Toggles the `expanded/collapsed` state for the given group node in the `IFoldingView`.
`void`	`uninstall(IInputModeContext context)` Uninstalls this mode from the given context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NavigationInputMode
```
public NavigationInputMode()
```
    Initializes a new instance of the NavigationInputMode class.
- Method Detail
  - addGroupCollapsedListener
```
public final void addGroupCollapsedListener(IEventHandler<ItemEventArgs<INode>> groupCollapsedEvent)
```
    Adds the given listener for the GroupCollapsed event that occurs whenever a group has been Collapsed.
    
    Parameters:
    
    groupCollapsedEvent - The listener to add.
    
    See Also:
    
    removeGroupCollapsedListener(IEventHandler)
  - addGroupCollapsingListener
```
public final void addGroupCollapsingListener(IEventHandler<ItemEventArgs<INode>> groupCollapsingEvent)
```
    Adds the given listener for the GroupCollapsing event that occurs before a group will be Collapsed.
    
    Parameters:
    
    groupCollapsingEvent - The listener to add.
    
    See Also:
    
    removeGroupCollapsingListener(IEventHandler)
  - addGroupEnteredListener
```
public final void addGroupEnteredListener(IEventHandler<ItemEventArgs<INode>> groupEnteredEvent)
```
    Adds the given listener for the GroupEntered event that occurs whenever a group has been Entered.
    
    Parameters:
    
    groupEnteredEvent - The listener to add.
    
    See Also:
    
    removeGroupEnteredListener(IEventHandler)
  - addGroupEnteringListener
```
public final void addGroupEnteringListener(IEventHandler<ItemEventArgs<INode>> groupEnteringEvent)
```
    Adds the given listener for the GroupEntering event that occurs before a group will be Entered.
    
    Parameters:
    
    groupEnteringEvent - The listener to add.
    
    See Also:
    
    removeGroupEnteringListener(IEventHandler)
  - addGroupExitedListener
```
public final void addGroupExitedListener(IEventHandler<ItemEventArgs<INode>> groupExitedEvent)
```
    Adds the given listener for the GroupExited event that occurs whenever a group has been Exited.
    
    Parameters:
    
    groupExitedEvent - The listener to add.
    
    See Also:
    
    removeGroupExitedListener(IEventHandler)
  - addGroupExitingListener
```
public final void addGroupExitingListener(IEventHandler<ItemEventArgs<INode>> groupExitingEvent)
```
    Adds the given listener for the GroupExiting event that occurs before a group will be Exited.
    
    Parameters:
    
    groupExitingEvent - The listener to add.
    
    See Also:
    
    removeGroupExitingListener(IEventHandler)
  - addGroupExpandedListener
```
public final void addGroupExpandedListener(IEventHandler<ItemEventArgs<INode>> groupExpandedEvent)
```
    Adds the given listener for the GroupExpanded event that occurs whenever a group has been Expanded.
    
    Parameters:
    
    groupExpandedEvent - The listener to add.
    
    See Also:
    
    removeGroupExpandedListener(IEventHandler)
  - addGroupExpandingListener
```
public final void addGroupExpandingListener(IEventHandler<ItemEventArgs<INode>> groupExpandingEvent)
```
    Adds the given listener for the GroupExpanding event that occurs before a group will be Expanded.
    
    Parameters:
    
    groupExpandingEvent - The listener to add.
    
    See Also:
    
    removeGroupExpandingListener(IEventHandler)
  - adjustContentRect
```
protected void adjustContentRect()
```
    Callback that adjusts the ContentRect to encompass all elements.
    This implementation will try to delegate to GraphEditorInputMode.adjustContentRect() if it can find the GraphEditorInputMode in the InputModeContext, otherwise the ICommand.FIT_GRAPH_BOUNDS is executed.
  - adjustGroupNodeLocation
```
protected void adjustGroupNodeLocation(boolean collapse,
                                       INode groupNode)
```
    Adjust the group node location according to the value of AutoGroupNodeAlignmentPolicy.
    
    Parameters:
    
    collapse - true iff the node has just been collapsed.
    
    groupNode - The node that has changed its state.
  - cancel
```
public void cancel()
```
    Description copied from interface: IInputMode
    
    Called by the client to unconditionally cancel all editing.
    This will be called prior to the uninstalling of this instance.
    
    In order to stop an active input mode manually, client code should use the following idiom:
    
    Specified by:
    
    cancel in interface IInputMode
  - clearSelection
```
public void clearSelection()
```
    Clears the selection in the GraphControl.
  - collapseGroup
```
public void collapseGroup(INode groupNode)
```
    Collapses the given group node to hide the contents of the group node from this IFoldingView.
    
    Parameters:
    
    groupNode - The group node to collapse.
    
    See Also:
    
    FoldingManager, isCollapseGroupAllowed()
  - collapseSelection
```
public void collapseSelection()
```
    Performs collapseGroup(INode) for all SelectedNodes.
  - enterGroup
```
public void enterGroup(INode node)
```
    This method allows for entering a group node so that the currently displayed IFoldingView's 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 MasterGraph to allow for switching to group nodes which are currently not being displayed in this view.
    
    Parameters:
    
    node - The node that needs to be either part of the current graph, or part of the MasterGraph.
    
    See Also:
    
    shouldEnterGroup(INode), isEnterGroupAllowed(), FoldingManager
  - enterSelectedGroup
```
public void enterSelectedGroup()
```
    Performs enterGroup(INode) for the first valid SelectedNodes.
  - exitGroup
```
public void exitGroup()
```
    Exits the current LocalRoot of the currently displayed view and shows the contents of the parent container.
    This method will also clear the selection and select the exited group node.
    
    See Also:
    
    FoldingManager, isExitGroupAllowed(), shouldExitGroup()
  - expandGroup
```
public void expandGroup(INode groupNode)
```
    Expands the given group node to show the contents of the collapsed group node in this IFoldingView.
    
    Parameters:
    
    groupNode - The group node to expand
    
    See Also:
    
    FoldingManager, isExpandGroupAllowed()
  - expandSelection
```
public void expandSelection()
```
    Performs expandGroup(INode) for all SelectedNodes.
  - extendSelectionTo
```
public void extendSelectionTo(MoveFocusDirection direction)
```
    Moves the focus into the given direction, extending the selection to the new element.
    
    Parameters:
    
    direction - The direction to move the focus and extend the selection.
  - getAutoGroupNodeAlignmentPolicy
```
public final NodeAlignmentPolicy getAutoGroupNodeAlignmentPolicy()
```
    Gets the the location that should be kept fixed if toggling a group node state.
    Default value is NodeAlignmentPolicy.NONE
    
    Returns:
    
    The AutoGroupNodeAlignmentPolicy.
    
    See Also:
    
    expandGroup(INode), collapseGroup(INode), setAutoGroupNodeAlignmentPolicy(NodeAlignmentPolicy)
  - getAvailableCommands
```
public final Collection<ICommand> getAvailableCommands()
```
    Gets the list of commands that are available in this instance.
    By default, all supported commands are available
    
    Removing commands from this collection also removes the command bindings registered by this instance.
    
    Add supported commands to make them available in this instance.
    
    Supported commands are
    Returns:
    
    The AvailableCommands.
  - getController
```
protected final ConcurrencyController getController()
```
    Returns the installed Controller.
    
    Returns:
    
    The Controller.
  - getGraph
```
public final IGraph getGraph()
```
    Gets the graph this mode operates on.
    
    Returns:
    
    The graph.
  - getGraphControl
```
public final GraphControl getGraphControl()
```
    Gets the GraphControl this mode acts on.
    
    Returns:
    
    The GraphControl.
    
    See Also:
    
    setGraphControl(GraphControl)
  - getGraphSelection
```
public final IGraphSelection getGraphSelection()
```
    Gets the IGraphSelection this mode operates on.
    
    Returns:
    
    The graph selection.
  - getInputModeContext
```
public final IInputModeContext getInputModeContext()
```
    Description copied from interface: IInputMode
    
    Returns the context instance this mode is currently installed in or null if this instance is not installed.
    Note that this instance should not be passed down to subordinate modes or instances. Instead a corresponding context that has this instance set as the ParentInputMode should be used.
    
    Specified by:
    
    getInputModeContext in interface IInputMode
    
    Returns:
    
    The InputModeContext.
  - getNavigableItems
```
public final GraphItemTypes getNavigableItems()
```
    Gets the item types that can be navigated to by this mode.
    
    Returns:
    
    The navigable items.
    
    See Also:
    
    shouldNavigateTo(IModelItem), setNavigableItems(GraphItemTypes)
  - getPriority
```
public final int getPriority()
```
    Description copied from interface: IInputMode
    
    The priority of this input mode.
    The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.
    
    Specified by:
    
    getPriority in interface IInputMode
    
    Returns:
    
    The Priority.
  - getSelectableItems
```
public final GraphItemTypes getSelectableItems()
```
    Gets the types of the items that should be selectable by this instance.
    The selectable items. The default value is GraphItemTypes.NODE.
    
    Returns:
    
    The SelectableItems.
    
    See Also:
    
    setSelectableItems(GraphItemTypes)
  - install
```
public void install(IInputModeContext context,
                    ConcurrencyController controller)
```
    Installs this mode into the given context that is provided by the canvas.
    In general a mode can only be installed into a single canvas at all times.
    
    This method is called to initialize this instance. Subclasses should override this method to register the corresponding event handler delegates for the various input events they need to register with.
    
    Overriding implementations should call the base implementation, first.
    
    Specified by:
    
    install in interface IInputMode
    
    Parameters:
    
    context - The context that this instance shall be installed into. The same instance will be passed to this instance during IInputMode.uninstall(IInputModeContext). A reference to the context may be kept and queried during the time the mode is installed.
    
    controller - The Controller for this mode.
    
    See Also:
    
    IInputMode.uninstall(IInputModeContext)
  - isCollapseGroupAllowed
```
public final boolean isCollapseGroupAllowed()
```
    Gets a value that determines whether it is allowed to collapse group nodes via the ICommand.COLLAPSE_GROUP.
    The default value is true.
    
    Returns:
    
    The CollapseGroupAllowed.
    
    See Also:
    
    collapseGroup(INode), shouldCollapseGroup(INode), FoldingManager, setCollapseGroupAllowed(boolean)
  - isEnabled
```
public boolean isEnabled()
```
    Gets the enabled state of this input mode.
    Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.
    
    Returns:
    
    The Enabled.
    
    See Also:
    
    setEnabled(boolean)
  - isEnterGroupAllowed
```
public final boolean isEnterGroupAllowed()
```
    Gets a value that determines whether it is allowed to enter group nodes via the ICommand.ENTER_GROUP.
    The default value is true.
    
    Returns:
    
    The EnterGroupAllowed.
    
    See Also:
    
    shouldEnterGroup(INode), FoldingManager, setEnterGroupAllowed(boolean)
  - isExclusive
```
public final boolean isExclusive()
```
    Gets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Returns:
    
    The Exclusive.
    
    See Also:
    
    setExclusive(boolean)
  - isExitGroupAllowed
```
public final boolean isExitGroupAllowed()
```
    Gets a value that determines whether it is allowed to exit the current group node via the ICommand.EXIT_GROUP.
    The default value is true.
    
    Returns:
    
    The ExitGroupAllowed.
    
    See Also:
    
    shouldExitGroup(), FoldingManager, setExitGroupAllowed(boolean)
  - isExpandGroupAllowed
```
public final boolean isExpandGroupAllowed()
```
    Gets a value that determines whether it is allowed to expand group nodes via the ICommand.EXPAND_GROUP.
    The default value is true.
    
    Returns:
    
    The ExpandGroupAllowed.
    
    See Also:
    
    shouldExpandGroup(INode), FoldingManager, setExpandGroupAllowed(boolean)
  - isFittingContentAfterGroupActionsEnabled
```
public final boolean isFittingContentAfterGroupActionsEnabled()
```
    Gets a value that determines whether CanvasControl.fitContent() or the ICommand.FIT_CONTENT should be triggered after a group navigation action.
    The default value is true.
    
    Returns:
    
    The FittingContentAfterGroupActionsEnabled.
    
    See Also:
    
    setFittingContentAfterGroupActionsEnabled(boolean)
  - isUsingCurrentItemForCommandsEnabled
```
public final boolean isUsingCurrentItemForCommandsEnabled()
```
    Gets a value indicating whether to use the CurrentItem as a fallback for the commands if no item is provided in the parameter and the current selection is empty.
    This applies to the following commands:
    Returns:
    
    true if the current item should be used as a fallback; false otherwise, which is the default.
    
    See Also:
    
    setUsingCurrentItemForCommandsEnabled(boolean)
  - moveFocusTo
```
public void moveFocusTo(MoveFocusDirection direction)
```
    Moves the focus into the given direction, not changing the current selection.
    
    Parameters:
    
    direction - The direction to move the focus.
  - moveTo
```
public void moveTo(MoveFocusDirection direction)
```
    Moves the focus into the given direction, setting the selection to the new element.
    
    Parameters:
    
    direction - The direction to move the focus and selection.
  - onCanceled
```
protected void onCanceled()
```
    Called after cancel() has been called.
    Can be overridden in subclasses to perform additional actions after the mode has been canceled.
    
    This implementation does nothing.
  - onConcurrencyControllerActivated
```
protected void onConcurrencyControllerActivated()
```
    Called after the Active property of the installed ConcurrencyController has been set to true.
    Can be overridden in subclasses to perform additional actions after the mode has been activated.
    
    Overriding implementations should call the base implementation.
  - onConcurrencyControllerDeactivated
```
protected void onConcurrencyControllerDeactivated()
```
    Called after the Active property of the installed ConcurrencyController has been set to false.
    Can be overridden in subclasses to perform additional actions after the mode has been deactivated.
    
    Overriding implementations should call the base implementation.
  - onGroupCollapsed
```
protected void onGroupCollapsed(ItemEventArgs<INode> argument)
```
    Raises the GroupCollapsed event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupCollapsing
```
protected void onGroupCollapsing(ItemEventArgs<INode> argument)
```
    Raises the GroupCollapsing event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupEntered
```
protected void onGroupEntered(ItemEventArgs<INode> argument)
```
    Raises the GroupEntered event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupEntering
```
protected void onGroupEntering(ItemEventArgs<INode> argument)
```
    Raises the GroupEntering event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupExited
```
protected void onGroupExited(ItemEventArgs<INode> argument)
```
    Raises the GroupExited event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupExiting
```
protected void onGroupExiting(ItemEventArgs<INode> argument)
```
    Raises the GroupExiting event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupExpanded
```
protected void onGroupExpanded(ItemEventArgs<INode> argument)
```
    Raises the GroupExpanded event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onGroupExpanding
```
protected void onGroupExpanding(ItemEventArgs<INode> argument)
```
    Raises the GroupExpanding event.
    
    Parameters:
    
    argument - The ItemEventArgs instance containing the event data.
  - onStopped
```
protected void onStopped()
```
    Called after stop() has been called.
    Can be overridden in subclasses to perform additional actions after the mode has been stopped.
    
    This implementation does nothing.
  - removeGroupCollapsedListener
```
public final void removeGroupCollapsedListener(IEventHandler<ItemEventArgs<INode>> groupCollapsedEvent)
```
    Removes the given listener for the GroupCollapsed event that occurs whenever a group has been Collapsed.
    
    Parameters:
    
    groupCollapsedEvent - The listener to remove.
    
    See Also:
    
    addGroupCollapsedListener(IEventHandler)
  - removeGroupCollapsingListener
```
public final void removeGroupCollapsingListener(IEventHandler<ItemEventArgs<INode>> groupCollapsingEvent)
```
    Removes the given listener for the GroupCollapsing event that occurs before a group will be Collapsed.
    
    Parameters:
    
    groupCollapsingEvent - The listener to remove.
    
    See Also:
    
    addGroupCollapsingListener(IEventHandler)
  - removeGroupEnteredListener
```
public final void removeGroupEnteredListener(IEventHandler<ItemEventArgs<INode>> groupEnteredEvent)
```
    Removes the given listener for the GroupEntered event that occurs whenever a group has been Entered.
    
    Parameters:
    
    groupEnteredEvent - The listener to remove.
    
    See Also:
    
    addGroupEnteredListener(IEventHandler)
  - removeGroupEnteringListener
```
public final void removeGroupEnteringListener(IEventHandler<ItemEventArgs<INode>> groupEnteringEvent)
```
    Removes the given listener for the GroupEntering event that occurs before a group will be Entered.
    
    Parameters:
    
    groupEnteringEvent - The listener to remove.
    
    See Also:
    
    addGroupEnteringListener(IEventHandler)
  - removeGroupExitedListener
```
public final void removeGroupExitedListener(IEventHandler<ItemEventArgs<INode>> groupExitedEvent)
```
    Removes the given listener for the GroupExited event that occurs whenever a group has been Exited.
    
    Parameters:
    
    groupExitedEvent - The listener to remove.
    
    See Also:
    
    addGroupExitedListener(IEventHandler)
  - removeGroupExitingListener
```
public final void removeGroupExitingListener(IEventHandler<ItemEventArgs<INode>> groupExitingEvent)
```
    Removes the given listener for the GroupExiting event that occurs before a group will be Exited.
    
    Parameters:
    
    groupExitingEvent - The listener to remove.
    
    See Also:
    
    addGroupExitingListener(IEventHandler)
  - removeGroupExpandedListener
```
public final void removeGroupExpandedListener(IEventHandler<ItemEventArgs<INode>> groupExpandedEvent)
```
    Removes the given listener for the GroupExpanded event that occurs whenever a group has been Expanded.
    
    Parameters:
    
    groupExpandedEvent - The listener to remove.
    
    See Also:
    
    addGroupExpandedListener(IEventHandler)
  - removeGroupExpandingListener
```
public final void removeGroupExpandingListener(IEventHandler<ItemEventArgs<INode>> groupExpandingEvent)
```
    Removes the given listener for the GroupExpanding event that occurs before a group will be Expanded.
    
    Parameters:
    
    groupExpandingEvent - The listener to remove.
    
    See Also:
    
    addGroupExpandingListener(IEventHandler)
  - selectCurrentItem
```
public void selectCurrentItem()
```
    Selects the CurrentItem current item.
    This method delegates to selectItem(GraphControl, IModelItem, boolean).
  - selectItem
```
protected void selectItem(GraphControl graphControl,
                          IModelItem item,
                          boolean extendSelection)
```
    Callback that selects the given item.
    
    Parameters:
    
    graphControl - The GraphControl.
    
    item - The item to select.
    
    extendSelection - if set to true the current selection is extended otherwise it is cleared beforehand.
    
    See Also:
    
    clearSelection()
  - setAutoGroupNodeAlignmentPolicy
```
public final void setAutoGroupNodeAlignmentPolicy(NodeAlignmentPolicy value)
```
    Sets the the location that should be kept fixed if toggling a group node state.
    Default value is NodeAlignmentPolicy.NONE
    
    Parameters:
    
    value - The AutoGroupNodeAlignmentPolicy to set.
    
    See Also:
    
    expandGroup(INode), collapseGroup(INode), getAutoGroupNodeAlignmentPolicy()
  - setCollapseGroupAllowed
```
public final void setCollapseGroupAllowed(boolean value)
```
    Sets a value that determines whether it is allowed to collapse group nodes via the ICommand.COLLAPSE_GROUP.
    The default value is true.
    
    Parameters:
    
    value - The CollapseGroupAllowed to set.
    
    See Also:
    
    collapseGroup(INode), shouldCollapseGroup(INode), FoldingManager, isCollapseGroupAllowed()
  - setCurrentItem
```
protected boolean setCurrentItem(GraphControl graphControl,
                                 IModelItem item)
```
    Callback that actually sets the current item property.
    
    Parameters:
    
    graphControl - The GraphControl to set the current item of.
    
    item - The item to set.
    
    Returns:
    
    Whether the operation was actually performed.
  - setCurrentItem
```
public void setCurrentItem(IModelItem item)
```
    Sets the "current" item to the given one.
    
    Parameters:
    
    item - The item to set as the current item.
    
    See Also:
    
    setCurrentItem(GraphControl, IModelItem)
  - setEnabled
```
public void setEnabled(boolean value)
```
    Sets the enabled state of this input mode.
    Clients can use this property to disable or reenable this instance. This will set the Enabled property of the installed Controller so a disabled instance should never try to acquire the input mutex.
    
    Parameters:
    
    value - The Enabled to set.
    
    See Also:
    
    isEnabled()
  - setEnterGroupAllowed
```
public final void setEnterGroupAllowed(boolean value)
```
    Sets a value that determines whether it is allowed to enter group nodes via the ICommand.ENTER_GROUP.
    The default value is true.
    
    Parameters:
    
    value - The EnterGroupAllowed to set.
    
    See Also:
    
    shouldEnterGroup(INode), FoldingManager, isEnterGroupAllowed()
  - setExclusive
```
public final void setExclusive(boolean value)
```
    Sets a value indicating whether this mode will be the only one running when it has the mutex.
    The value of this property will be delegated to the Exclusive property of the Controller.
    
    If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise it will always run concurrently with all other modes.
    
    Parameters:
    
    value - The Exclusive to set.
    
    See Also:
    
    isExclusive()
  - setExitGroupAllowed
```
public final void setExitGroupAllowed(boolean value)
```
    Sets a value that determines whether it is allowed to exit the current group node via the ICommand.EXIT_GROUP.
    The default value is true.
    
    Parameters:
    
    value - The ExitGroupAllowed to set.
    
    See Also:
    
    shouldExitGroup(), FoldingManager, isExitGroupAllowed()
  - setExpandGroupAllowed
```
public final void setExpandGroupAllowed(boolean value)
```
    Sets a value that determines whether it is allowed to expand group nodes via the ICommand.EXPAND_GROUP.
    The default value is true.
    
    Parameters:
    
    value - The ExpandGroupAllowed to set.
    
    See Also:
    
    shouldExpandGroup(INode), FoldingManager, isExpandGroupAllowed()
  - setFittingContentAfterGroupActionsEnabled
```
public final void setFittingContentAfterGroupActionsEnabled(boolean value)
```
    Sets a value that determines whether CanvasControl.fitContent() or the ICommand.FIT_CONTENT should be triggered after a group navigation action.
    The default value is true.
    
    Parameters:
    
    value - The FittingContentAfterGroupActionsEnabled to set.
    
    See Also:
    
    isFittingContentAfterGroupActionsEnabled()
  - setGraphControl
```
public final void setGraphControl(GraphControl value)
```
    Sets the GraphControl this mode acts on.
    
    Parameters:
    
    value - The GraphControl.
    
    See Also:
    
    getGraphControl()
  - setGraphControlCore
```
protected void setGraphControlCore(GraphControl graphControl)
```
    Sets the GraphControl to use for the various actions.
    This will register or unregister the CommandBindings for the control. This method is called in response to install(IInputModeContext, ConcurrencyController) and uninstall(IInputModeContext).
    
    Parameters:
    
    graphControl - The control to use or null.
  - setNavigableItems
```
public final void setNavigableItems(GraphItemTypes value)
```
    Sets the item types that can be navigated to by this mode.
    
    Parameters:
    
    value - The navigable items.
    
    See Also:
    
    shouldNavigateTo(IModelItem), getNavigableItems()
  - setPriority
```
public final void setPriority(int value)
```
    The priority of this input mode.
    The priority will influence the order in which the modes will be installed into the canvas control. The lower the priority value, the earlier it will be installed. If two modes are installed using the same priority value, the first one will be installed earlier.
    
    Parameters:
    
    value - The Priority to set.
    
    See Also:
    
    getPriority()
  - setSelectableItems
```
public final void setSelectableItems(GraphItemTypes value)
```
    Sets the types of the items that should be selectable by this instance.
    The selectable items. The default value is GraphItemTypes.NODE.
    
    Parameters:
    
    value - The SelectableItems to set.
    
    See Also:
    
    getSelectableItems()
  - setUsingCurrentItemForCommandsEnabled
```
public final void setUsingCurrentItemForCommandsEnabled(boolean value)
```
    Sets a value indicating whether to use the CurrentItem as a fallback for the commands if no item is provided in the parameter and the current selection is empty.
    This applies to the following commands:
    Parameters:
    
    value - true if the current item should be used as a fallback; false otherwise, which is the default.
    
    See Also:
    
    isUsingCurrentItemForCommandsEnabled()
  - shouldCollapseGroup
```
protected boolean shouldCollapseGroup(INode groupNode)
```
    Predicate method that decides whether it is allowed to collapse the given group node.
    This implementation returns the value of CollapseGroupAllowed.
    
    Returns:
    
    Whether to collapse the given group or not.
  - shouldEnterGroup
```
protected boolean shouldEnterGroup(INode node)
```
    Predicate method that decides whether it is allowed to enter the specific group node.
    This implementation yields the value of EnterGroupAllowed.
    
    Parameters:
    
    node - The group node to enter.
    
    Returns:
    
    Whether to enter the group or not.
  - shouldExitGroup
```
protected boolean shouldExitGroup()
```
    Predicate method that decides whether it is allowed to exit the current group node.
    This implementation yields the value of ExitGroupAllowed.
    
    Returns:
    
    Whether to exit the current group or not.
  - shouldExpandGroup
```
protected boolean shouldExpandGroup(INode node)
```
    Predicate method that decides whether it is allowed to expand the given group node.
    This implementation yields the value of ExpandGroupAllowed.
    
    Returns:
    
    Whether to expand the given group or not.
  - shouldNavigateTo
```
protected boolean shouldNavigateTo(IModelItem item)
```
    Callback predicate method that determines whether a given model item should be navigated to.
    This implementation uses the NavigableItems property to determine whether the item can be navigated to.
    
    Parameters:
    
    item - The model item.
    
    Returns:
    
    Whether the item should be considered for navigational commands.
  - shouldSelect
```
protected boolean shouldSelect(IModelItem item)
```
    Callback predicate method that determines whether a given model item should be selected.
    This implementation uses the SelectableItems property to determine whether the item should be selected.
    
    Parameters:
    
    item - The model item.
    
    Returns:
    
    Whether the item should be selected by the navigational commands.
  - shouldToggleExpansionState
```
protected boolean shouldToggleExpansionState(INode node)
```
    Predicate method that decides whether it is allowed to toggle the collapsed state of the given group node.
    This implementation uses shouldExpandGroup(INode) and shouldCollapseGroup(INode) respectively.
    
    Returns:
    
    Whether to expand the given group or not.
  - stop
```
public boolean stop()
```
    Overridden to only return true if this instance does not currently have the input mutex.
    
    Specified by:
    
    stop in interface IInputMode
    
    Returns:
    
    true iff this instance does not own the mutex.
    
    See Also:
    
    IInputMode.cancel()
  - toggleExpansionState
```
public void toggleExpansionState(INode groupNode)
```
    Toggles the expanded/collapsed state for the given group node in the IFoldingView.
    
    Parameters:
    
    groupNode - The group node to toggle the state for.
    
    See Also:
    
    FoldingManager
  - uninstall
```
public void uninstall(IInputModeContext context)
```
    Uninstalls this mode from the given context.
    This code should clean up all changes made to the canvas in the IInputMode.install(IInputModeContext, ConcurrencyController) method. After a mode has been uninstalled it can be installed again into the same or another canvas.
    
    Overriding implementations should call the base implementation after their own code.
    
    Specified by:
    
    uninstall in interface IInputMode
    
    Parameters:
    
    context - The context to deregister from. This is the same instance that had been passed to IInputMode.install(IInputModeContext, ConcurrencyController) during installation.

Class NavigationInputMode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NavigationInputMode

Method Detail

addGroupCollapsedListener

addGroupCollapsingListener

addGroupEnteredListener

addGroupEnteringListener

addGroupExitedListener

addGroupExitingListener

addGroupExpandedListener

addGroupExpandingListener

adjustContentRect

adjustGroupNodeLocation

cancel

clearSelection

collapseGroup

collapseSelection

enterGroup

enterSelectedGroup

exitGroup

expandGroup

expandSelection

extendSelectionTo

getAutoGroupNodeAlignmentPolicy

getAvailableCommands

getController

getGraph

getGraphControl

getGraphSelection

getInputModeContext

getNavigableItems

getPriority

getSelectableItems

install

isCollapseGroupAllowed

isEnabled

isEnterGroupAllowed

isExclusive

isExitGroupAllowed

isExpandGroupAllowed

isFittingContentAfterGroupActionsEnabled

isUsingCurrentItemForCommandsEnabled

moveFocusTo

moveTo

onCanceled

onConcurrencyControllerActivated

onConcurrencyControllerDeactivated

onGroupCollapsed

onGroupCollapsing

onGroupEntered

onGroupEntering

onGroupExited

onGroupExiting

onGroupExpanded

onGroupExpanding

onStopped

removeGroupCollapsedListener

removeGroupCollapsingListener

removeGroupEnteredListener

removeGroupEnteringListener

removeGroupExitedListener

removeGroupExitingListener

removeGroupExpandedListener

removeGroupExpandingListener

selectCurrentItem

selectItem

setAutoGroupNodeAlignmentPolicy

setCollapseGroupAllowed

setCurrentItem

setCurrentItem

setEnabled

setEnterGroupAllowed

setExclusive

setExitGroupAllowed

setExpandGroupAllowed

setFittingContentAfterGroupActionsEnabled