sub_arctic.input
Class raw_focus_agent

java.lang.Object
  |
  +--sub_arctic.input.dispatch_agent
        |
        +--sub_arctic.input.focus_dispatch_agent
              |
              +--sub_arctic.input.raw_focus_agent

public class raw_focus_agent
extends focus_dispatch_agent

This class implements the raw focus agent. This agent is focus based and delivers raw events to requesting objects. This can be used as a hook for extensions. This agent handles the raw_input_acceptor input protocol.

See Also:
raw_input_acceptor

Field Summary
protected  java.lang.reflect.Method raw_input
          Keep a reference to the Method that represents the handle_raw_input method of the raw_input_acceptor protcol.
 
Fields inherited from class sub_arctic.input.focus_dispatch_agent
_focus_set, _user_info_set
 
Constructor Summary
raw_focus_agent()
          Simple constructor.
 
Method Summary
 boolean allowable_focus(focusable candidate_obj)
          Allow objects in this focus set only if they implement the raw_input_acceptor interface.
 boolean dispatch_event(event evt, java.lang.Object user_info, interactor to_obj, int seq_num)
          Attempt to dispatch an event under this agent.
 
Methods inherited from class sub_arctic.input.focus_dispatch_agent
add_to_focus, clear_focus, focus_item, focus_set_size, inform_focus_enter, inform_focus_exit, is_in_focus, remove_from_focus, set_focus_to, user_info_item
 
Methods inherited from class sub_arctic.input.dispatch_agent
after_dispatch_notify, dispatch_unused_event, event_is_useful
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

raw_input

protected java.lang.reflect.Method raw_input
Keep a reference to the Method that represents the handle_raw_input method of the raw_input_acceptor protcol.
Constructor Detail

raw_focus_agent

public raw_focus_agent()
Simple constructor.
Method Detail

allowable_focus

public boolean allowable_focus(focusable candidate_obj)
Allow objects in this focus set only if they implement the raw_input_acceptor interface.
Parameters:
focusable - candidate_obj the object we are testing for suitability.
Returns:
boolean indicating if the object is suitable to go in the focus set
Overrides:
allowable_focus in class focus_dispatch_agent

dispatch_event

public boolean dispatch_event(event evt,
                              java.lang.Object user_info,
                              interactor to_obj,
                              int seq_num)
Attempt to dispatch an event under this agent.
Parameters:
event - evt the event to try to dispatch.
Object - user_info ignored (since this is a focus agent).
interactor - to_obj ignored (since this is a focus agent).
int - seq_num ignored (since this is a focus agent).
Returns:
boolean indicating whether the event was consumed.
Overrides:
dispatch_event in class focus_dispatch_agent