sub_arctic.lib
Class display_help_container

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.base_parent_interactor
                    |
                    +--sub_arctic.lib.display_help_container

public class display_help_container
extends base_parent_interactor
implements display_help

This is a general purpose container which can take any object as its only child. Once an object is put in this container, the container can generate a "display help" string onto the top of the containing interface. This display help string is generated after the pointer has been stationary on this object for a few seconds (i.e. when we get told mouse_stationary())


Field Summary
protected  java.lang.String _text
          The help text
protected  label help_text
          This is where we stash the top level's extra child while its up.
 
Fields inherited from class sub_arctic.lib.base_interactor
_child_index, _child_list, _clip_bounds, _constraint_flags, _enabled_constraint, _flags, _h, _h_constraint, _parent, _part_a_constraint, _part_b_constraint, _user_data, _visible_constraint, _w, _w_constraint, _x, _x_constraint, _y, _y_constraint, default_child_hint
 
Constructor Summary
display_help_container(interactor i, java.lang.String text)
          Construct a display help container given an interactor and a string.
 
Method Summary
 boolean help_close(event evt, java.lang.Object user_info)
          This method is called to inform the object that the help text should not be displayed any longer.
 boolean help_open(event evt, java.lang.Object user_info)
          This method is called to inform the object that the help text should be displayed now.
 boolean mouse_enter(event evt, java.lang.Object user_info)
          This method is called when the pointer enters our area and when no other agent has dispatched the event.
 boolean mouse_exit(event evt, java.lang.Object user_info)
          This method is called when the pointer leaves our area.
 void set_text(java.lang.String t)
          Set the current help text.
 java.lang.String text()
          Retrieve the current help text.
 
Methods inherited from class sub_arctic.lib.base_interactor
active_constraints, add_child, add_user_datum, attach_dependent, bound, callback_obj, child_index, child, clear_child_list, clear_constraint_flag_bit, clear_flag_bit, configure, constraint_flag_is_set, constraint_flag_string, constraint_on, custom_fun1, custom_fun2, damage_fixed, damage_from_child, damage_self, damage_self, damage_self, damage_self, damage_self, detach_dependent, do_action, do_action, do_callback, do_callback, drag_feature_point, draw_children, draw_self_local, draw_self, enabled_constraint, enabled, enter_local_coordinates, eval_enabled, eval_h, eval_part_a, eval_part_b, eval_visible, eval_w, eval_x, eval_y, eval, exit_local_coords, feature_point_enabled, feature_point, filter_pt, find_child, first_callback_num, fixed_children, flag_is_set, flag_string, focus_set_enter, focus_set_exit, get_awt_component, get_external_constraint, get_part, get_top_level, get_value, global_to_local, global_to_local, h_constraint, h, handle_cycle, inform_ood, insert_child, inside_bounds, into_local, into_local, into_parent, into_parent, intrinsic_constraints, is_constrained, last_callback_num, local_to_global, local_to_global, mark_all_ood, mark_enabled_ood, mark_h_ood, mark_ood, mark_part_a_ood, mark_part_b_ood, mark_reparented_ood, mark_visible_ood, mark_w_ood, mark_x_ood, mark_y_ood, marked_ood, move_child_downward, move_child_downward, move_child_to_bottom, move_child_to_bottom, move_child_to_top, move_child_to_top, move_child_upward, move_child_upward, move_downward, move_to_bottom, move_to_top, move_upward, new_look_configure, next_sibling, num_actions, num_children, num_feature_points, ood_inform_all, parent, part_a_constraint, part_a, part_b_constraint, part_b, pick_within_children, pick, picked_by, pos, prev_sibling, register_resource_names, remove_child, remove_child, remove_user_datum, restyle_look_resources, restyle, set_callback_obj, set_child_index, set_child, set_constraint_flag_bit, set_constraint_flag_bit, set_constraint, set_constraint, set_enabled_constraint, set_enabled_constraint, set_enabled_constraint, set_enabled, set_flag_bit, set_flag_bit, set_h_constraint, set_h_constraint, set_h_constraint, set_h, set_intrinsic_h, set_intrinsic_size, set_intrinsic_w, set_parent, set_part_a_constraint, set_part_a_constraint, set_part_a_constraint, set_part_a, set_part_b_constraint, set_part_b_constraint, set_part_b_constraint, set_part_b, set_pos, set_pos, set_raw_enabled, set_raw_h, set_raw_part_a, set_raw_part_b, set_raw_visible, set_raw_w, set_raw_x, set_raw_y, set_size, set_style_lock, set_user_info, set_visible_constraint, set_visible_constraint, set_visible_constraint, set_visible, set_w_constraint, set_w_constraint, set_w_constraint, set_w, set_x_constraint, set_x_constraint, set_x_constraint, set_x, set_y_constraint, set_y_constraint, set_y_constraint, set_y, setup_for_children, setup_for_children, setup_for_fixed_children, size, style_change_local, style_change, supports_children, tag_str, toString, traverse_and_collect_children, traverse_and_collect_parent, traverse_and_collect, trivial_reject, trivial_reject, user_data, user_info, value_ood, visible_constraint, visible, w_constraint, w, x_constraint, x_into_local, x_into_parent, x, y_constraint, y_into_local, y_into_parent, y
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

_text

protected java.lang.String _text
The help text

help_text

protected label help_text
This is where we stash the top level's extra child while its up.
Constructor Detail

display_help_container

public display_help_container(interactor i,
                              java.lang.String text)
Construct a display help container given an interactor and a string.
Parameters:
interactor - i the interactor to display the help for
String - text the help text to display (should be short)
Method Detail

text

public java.lang.String text()
Retrieve the current help text.
Returns:
String the current help text string

set_text

public void set_text(java.lang.String t)
Set the current help text.
Parameters:
String - t the new text

mouse_enter

public boolean mouse_enter(event evt,
                           java.lang.Object user_info)
This method is called when the pointer enters our area and when no other agent has dispatched the event. We do nothing here since we are planning to display help text.
Parameters:
event - evt the event to dispatch.
Object - user_info the object you passed to the pick_collector at pick_time.
Returns:
boolean return true if you dispatched this event.

mouse_exit

public boolean mouse_exit(event evt,
                          java.lang.Object user_info)
This method is called when the pointer leaves our area. This method does nothing, we are only using the display help interface.
Parameters:
event - evt the event to dispatch
Object - user_info the object you passed to the pick_collector at pick_time (of the mouse_enter not this event)
Returns:
boolean return true if you dispatched this event.

help_open

public boolean help_open(event evt,
                         java.lang.Object user_info)
This method is called to inform the object that the help text should be displayed now.
Specified by:
help_open in interface display_help
Parameters:
event - evt the event we are handling (ignored)
Object - user_info the user info from a previous pick (also ignored)
Returns:
boolean we always handle the event and thus always return true

help_close

public boolean help_close(event evt,
                          java.lang.Object user_info)
This method is called to inform the object that the help text should not be displayed any longer.
Specified by:
help_close in interface display_help
Parameters:
event - evt the event we are handling (ignored)
Object - user_info the user info from a previous pick (also ignored)
Returns:
boolean we always handle the event and thus always return true