sub_arctic.input
Interface navigable

All Known Implementing Classes:
navigator_base

public abstract interface navigable
extends focusable

This interface supplies an input protocol for objects which accept input controlling tree navigation. Several classes of input methods are supported here: moves within the tree, requests for previews of moves within the tree, indications that the dispatch agent has entered or exited text entry mode, and requests to carry out actions at the current location in the tree.


Method Summary
 boolean enter_text_entry_mode(event evt, java.lang.Object user_info)
          Request to enter text entry mode.
 boolean exit_text_entry_mode(event evt, java.lang.Object user_info)
          Indicate that we are leaving text entry mode and returning to navigation mode.
 boolean navigate_down(event evt, java.lang.Object user_info)
          Navigate downwards in the tree (move to first child).
 boolean navigate_left(event evt, java.lang.Object user_info)
          Navigate left in the tree (move to the previous sibling).
 boolean navigate_right(event evt, java.lang.Object user_info)
          Navigate right in the tree (move to the next sibling).
 boolean navigate_to_top(event evt, java.lang.Object user_info)
          Navigate to the root of the tree.
 boolean navigate_up(event evt, java.lang.Object user_info)
          Navigate upwards in the tree (move to the parent).
 boolean perform_action(int act_num, event evt, java.lang.Object user_info)
          Do an action associated with the interactor at the current location.
 boolean preview_down(event evt, java.lang.Object user_info)
          Perform a preview of the actions that would be taken on a navigate_down().
 boolean preview_left(event evt, java.lang.Object user_info)
          Perform a preview of the actions that would be taken on a navigate_left().
 boolean preview_right(event evt, java.lang.Object user_info)
          Perform a preview of the actions that would be taken on a navigate_right().
 boolean preview_to_top(event evt, java.lang.Object user_info)
          Perform a preview of the actions that would be taken on a navigate_to_top().
 boolean preview_up(event evt, java.lang.Object user_info)
          Perform a preview of the actions that would be taken on a navigate_up().
 
Methods inherited from interface sub_arctic.input.focusable
focus_set_enter, focus_set_exit
 

Method Detail

navigate_up

public boolean navigate_up(event evt,
                           java.lang.Object user_info)
Navigate upwards in the tree (move to the parent).
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

navigate_down

public boolean navigate_down(event evt,
                             java.lang.Object user_info)
Navigate downwards in the tree (move to first child).
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

navigate_left

public boolean navigate_left(event evt,
                             java.lang.Object user_info)
Navigate left in the tree (move to the previous sibling).
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

navigate_right

public boolean navigate_right(event evt,
                              java.lang.Object user_info)
Navigate right in the tree (move to the next sibling).
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

navigate_to_top

public boolean navigate_to_top(event evt,
                               java.lang.Object user_info)
Navigate to the root of the tree.
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

preview_up

public boolean preview_up(event evt,
                          java.lang.Object user_info)
Perform a preview of the actions that would be taken on a navigate_up().
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

preview_down

public boolean preview_down(event evt,
                            java.lang.Object user_info)
Perform a preview of the actions that would be taken on a navigate_down().
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

preview_left

public boolean preview_left(event evt,
                            java.lang.Object user_info)
Perform a preview of the actions that would be taken on a navigate_left().
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

preview_right

public boolean preview_right(event evt,
                             java.lang.Object user_info)
Perform a preview of the actions that would be taken on a navigate_right().
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

preview_to_top

public boolean preview_to_top(event evt,
                              java.lang.Object user_info)
Perform a preview of the actions that would be taken on a navigate_to_top().
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

enter_text_entry_mode

public boolean enter_text_entry_mode(event evt,
                                     java.lang.Object user_info)
Request to enter text entry mode. In this mode, keystrokes that might normally be interpreted by the input agent as navigation commands are treated as normal keystrokes again.
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating successful entry into text entry mode.

exit_text_entry_mode

public boolean exit_text_entry_mode(event evt,
                                    java.lang.Object user_info)
Indicate that we are leaving text entry mode and returning to navigation mode.
Parameters:
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating whether input was accepted

perform_action

public boolean perform_action(int act_num,
                              event evt,
                              java.lang.Object user_info)
Do an action associated with the interactor at the current location. What this action means depends on the interactor. If the action is out of range for an interactor, the input will be rejected (false will be returned). Note: the navigator_agent only supports a limited number of actions (currently 4).
Parameters:
int - act_num the index of the action to be performed
event - evt the event causing this input
Object - user_info information supplied at focus time
Returns:
boolean indicating if the (inputs corresponding to the) action was accepted by the object.