sub_arctic.lib
Class text_menu_item

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.menu_item
                    |
                    +--sub_arctic.lib.text_menu_item
Direct Known Subclasses:
pullright_menu_item

public class text_menu_item
extends menu_item

This class implements a menu_item with a string of text on it.

See Also:
menu

Field Summary
protected  java.awt.Font _font
          This objects font.
protected  loaded_image[] _look
          Store the two looks for this object.
protected  java.lang.String _text
          The text string on this object.
protected  int _x_border
          The amount of border to use in x.
protected  int _y_border
          The amount of border to use in y.
 
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
text_menu_item(java.lang.String s, java.awt.Font f, int width)
          Construct a text menu item given a string, a font, and a width.
text_menu_item(java.lang.String s, int width)
          Simple default version of a constructor which doesn't require a font.
 
Method Summary
protected  void draw_self_local(drawable d)
          Draw yourself...
 java.awt.Font font()
          Return this object's font.
 int intrinsic_constraints()
          Return that our width and height are intrinsically computed.
static int max_item_width(java.lang.String[] strings, java.awt.Font f)
          This function is a convenience for figuring out which of a set of strings will have the widest menu and item and what the widest value is.
 void set_font(java.awt.Font f)
          Set the font used for this object.
 void set_text(java.lang.String s)
          Set the string on this object.
 void set_x_border(int v)
          Change the amount of horizontal spacing
 void set_y_border(int v)
          Change the amount of vertical spacing.
protected  void style_changed()
           
 java.lang.String text()
          Return the text on this object.
 java.lang.String toString()
          Return a debugging string.
 int x_border()
          Return the size of the x border.
 int y_border()
          Return the size of the y border.
 
Methods inherited from class sub_arctic.lib.menu_item
highlight, unhighlight
 
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, 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, 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, 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 text string on this object.

_font

protected java.awt.Font _font
This objects font. It will be null if they want the system default font.

_x_border

protected int _x_border
The amount of border to use in x.

_y_border

protected int _y_border
The amount of border to use in y.

_look

protected loaded_image[] _look
Store the two looks for this object.
Constructor Detail

text_menu_item

public text_menu_item(java.lang.String s,
                      java.awt.Font f,
                      int width)
Construct a text menu item given a string, a font, and a width.
Parameters:
String - s the string to be displayed on the item.
Font - f the font to use for this item.
int - width the width of this object.

text_menu_item

public text_menu_item(java.lang.String s,
                      int width)
Simple default version of a constructor which doesn't require a font.
Parameters:
String - s the string to be displayed on the item.
int - width the width of this object.
Method Detail

text

public java.lang.String text()
Return the text on this object.
Returns:
String the string of text on this object.

set_text

public void set_text(java.lang.String s)
Set the string on this object. This function does NOT imply a re-computation of the width of this object.
Parameters:
String - s the new text string for this object.

font

public java.awt.Font font()
Return this object's font. This will return the system's default font if you don't set the font explicitly.
Returns:
Font the font in use for this object.

set_font

public void set_font(java.awt.Font f)
Set the font used for this object. Set this to null if you want the system default font.
Parameters:
Font - f the font for this object.

x_border

public int x_border()
Return the size of the x border.
Returns:
int the number of pixels of horizontal spacing (appears on both right and left).

set_x_border

public void set_x_border(int v)
Change the amount of horizontal spacing
Parameters:
int - v the new amount of x spacing.

y_border

public int y_border()
Return the size of the y border.
Returns:
int the number of pixels of vertical spacing (appears on both top and bottom).

set_y_border

public void set_y_border(int v)
Change the amount of vertical spacing.
Parameters:
int - v the new amount of y spacing.

style_changed

protected void style_changed()

draw_self_local

protected void draw_self_local(drawable d)
Draw yourself... depends the value of the highlight func. defined in menu_item.
Parameters:
drawable - d the surface to draw yourself on.
Overrides:
draw_self_local in class base_interactor

intrinsic_constraints

public int intrinsic_constraints()
Return that our width and height are intrinsically computed.
Returns:
int the constant value of W | H
Overrides:
intrinsic_constraints in class base_interactor

toString

public java.lang.String toString()
Return a debugging string.
Returns:
String a string representing this object and its position.
Overrides:
toString in class base_interactor

max_item_width

public static int max_item_width(java.lang.String[] strings,
                                 java.awt.Font f)
This function is a convenience for figuring out which of a set of strings will have the widest menu and item and what the widest value is. It assumes the default spacing of 2 in x and 1 in y.
Parameters:
String[] - strings the array of strings to consider.
Font - f the font you'll be using to render these strings (use null for a default font).
Returns:
int the width of the widest of these strings