sub_arctic.lib
Class menu_button

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.multi_button
                    |
                    +--sub_arctic.lib.menu_button

public class menu_button
extends multi_button
implements pressable, menu_notifier


Field Summary
protected  java.awt.Font _font
          The font for this object.
protected  menu _menu
          This holds a pointer to our menu that we will pop up.
protected  java.lang.String _text
          The text string on this object.
protected  int _x_spacing
          The x spacing for this object.
protected  int _y_spacing
          The y spacing for this object.
 
Fields inherited from class sub_arctic.lib.multi_button
_callback_obj, _cur_state, _in_transition, _state_looks, _transition_looks, BUTTON_ACTION_CALLBACK
 
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
menu_button(java.lang.String s, java.awt.Font f, menu m)
          Construct a menu button given a string and a given font.
menu_button(java.lang.String s, menu m)
          Construct a menu button given a string.
 
Method Summary
 void menu_done()
          This method gets called by the menu_agent to inform us that the interaction is completed.
 boolean menu_modify(int x, int y, event evt)
          This function is called to alert the notifier that the interaction is now over their area.
 menu popup_menu()
          This returns the menu we are currently using as our popup.
 boolean press(event e, java.lang.Object user_info)
          This function is called in response to a press method.
 boolean release(event e, java.lang.Object user_info)
           
 void set_font(java.awt.Font f)
          Set the font associated with this object.
 void set_popup_menu(menu m)
          This sets the value of the current popup menu.
 void set_text(java.lang.String t)
          Set the text of this object.
 void set_x_spacing(int x)
          Set the x spacing.
 void set_y_spacing(int y)
          Set the y spacing.
protected  void style_changed()
          Redraw the images for this menu button.
 java.lang.String text()
          Retrieve the text value on this object.
 int x_spacing()
          Get the x spacing.
 int y_spacing()
          Get the y spacing.
 
Methods inherited from class sub_arctic.lib.multi_button
calc_size, callback_obj, cur_state, do_action, do_callback, draw_self_local, first_callback_num, get_state_look, get_transition_look, inout_drag_end, inout_drag_enter, inout_drag_exit, inout_drag_start, intrinsic_constraints, last_callback_num, next_state, part_a, set_callback_obj, set_cur_state, set_looks, set_part_a, set_raw_part_a, set_state_look, set_transition_look, state_looks, transition_looks
 
Methods inherited from class sub_arctic.lib.base_interactor
active_constraints, add_child, add_user_datum, attach_dependent, bound, 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_callback, drag_feature_point, draw_children, 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, 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, is_constrained, 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_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_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_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_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

_x_spacing

protected int _x_spacing
The x spacing for this object.

_y_spacing

protected int _y_spacing
The y spacing for this object.

_menu

protected menu _menu
This holds a pointer to our menu that we will pop up.

_text

protected java.lang.String _text
The text string on this object.

_font

protected java.awt.Font _font
The font for this object.
Constructor Detail

menu_button

public menu_button(java.lang.String s,
                   menu m)
Construct a menu button given a string. We assume you will use constraints (or direct setting) to position this object.
Parameters:
String - s the string to display on the menu button.
menu - m the menu to pop up when the button is pressed.

menu_button

public menu_button(java.lang.String s,
                   java.awt.Font f,
                   menu m)
Construct a menu button given a string and a given font. We assume you will use constraints to position this object or set the position directly.
Parameters:
String - s the string to display on the menu button.
Font - f font we draw labels in.
menu - m the menu to pop up when the button is pressed.
Method Detail

x_spacing

public int x_spacing()
Get the x spacing.
Returns:
int the amount of x spacing

set_x_spacing

public void set_x_spacing(int x)
Set the x spacing.
Parameters:
int - x the new value for the x spacing

y_spacing

public int y_spacing()
Get the y spacing.
Returns:
int the amount of y spacing

set_y_spacing

public void set_y_spacing(int y)
Set the y spacing.
Parameters:
int - y the new value for the y spacing

popup_menu

public menu popup_menu()
This returns the menu we are currently using as our popup.
Returns:
menu the current menu for this menubutton

set_popup_menu

public void set_popup_menu(menu m)
This sets the value of the current popup menu.
Parameters:
menu - m the new menu to use

press

public boolean press(event e,
                     java.lang.Object user_info)
This function is called in response to a press method.
Specified by:
press in interface pressable
Parameters:
event - e the event to dispatch (the mouse down).
Object - user_info (currently ignored) the object passed to the pick_collector at pick-time.
Returns:
boolean true if this event was dispatched.
Overrides:
press in class multi_button

release

public boolean release(event e,
                       java.lang.Object user_info)
Specified by:
release in interface pressable
Overrides:
release in class multi_button

text

public java.lang.String text()
Retrieve the text value on this object.
Returns:
String the text on this menu button

set_text

public void set_text(java.lang.String t)
Set the text of this object.
Parameters:
String - t the new text to display on this menu button

set_font

public void set_font(java.awt.Font f)
Set the font associated with this object. If you set the font to null, you'll get the system default font.
Parameters:
Font - f the new font

style_changed

protected void style_changed()
Redraw the images for this menu button.

menu_done

public void menu_done()
This method gets called by the menu_agent to inform us that the interaction is completed.
Specified by:
menu_done in interface menu_notifier

menu_modify

public boolean menu_modify(int x,
                           int y,
                           event evt)
This function is called to alert the notifier that the interaction is now over their area. The notifier should return true if it modified the set of objects in the menu focus in response to this call. Menu_buttons don't use this call and always return false.
Specified by:
menu_modify in interface menu_notifier
Parameters:
int - x the x coordinate (in the notifiers coordinate system) of the cursor.
int - y the y coordinate (in the notifiers coordinate system) of the cursor.
event - evt the event we are testing.
Returns:
boolean true if the notifier modified the focus set of the menu agent in response to this.