sub_arctic.lib
Class text_list_element

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.oneline_text_display
                    |
                    +--sub_arctic.lib.label
                          |
                          +--sub_arctic.lib.text_list_element

Direct Known Subclasses:

object_list_element

public class text_list_element

extends label

implements list_element

This class implements a list item which can display a text string. It is basically a label which knows how to change its display based being selected.

Field Summary

protected boolean	_focus This variable holds our state of focusedness.
protected boolean	_highlighted We store whether we are highlighted or not.

Fields inherited from class sub_arctic.lib.label

_above_spacing, _autosize, _below_spacing, _draw_colors, _opaque

Fields inherited from class sub_arctic.lib.oneline_text_display

_colors, _end_of_selection, _font, _h_spacing, _metric, _start_of_selection, _text, _v_spacing, _x_adjust, BOXED, have_focus, NO_SELECTION, SELECT_END

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_list_element(java.lang.String text)
Create a text_list_element with a string.

text_list_element(java.lang.String text, java.awt.Font font)
Create a text_list_element with a string & a font.

Method Summary

void	become_focus() This method is used to inform the object that it has become the focus of a listbox.
java.lang.Object	convert_to_object() Return the convenient representation of this object.
void	draw_self_local(drawable d) Draw this object on the drawable provided.
boolean	focused() This method is used to query the object about whether or not it is the focus.
void	highlight() Implement the highlight behavior for this list element.
boolean	highlighted() Return if the object is highlighted right now.
void	lost_focus() This method is used to inform the object that it is not the focus any longer.
static java.util.Vector	make_contents_vector(java.lang.String[] contents, java.awt.Font font) This static function is a convenience for creating a Vector text_list_elements from an array of strings.
static java.util.Vector	make_contents_vector(java.util.Vector contents, java.awt.Font font) This static function is a convenience for creating a Vector text_list_elements from a Vector of strings.
int	preferred_width() Compute the preferred width for the parent.
void	unhighlight() Implement the unhighlight behavior for this list element.

Methods inherited from class sub_arctic.lib.label

above_spacing, autosize, below_spacing, calculate_size, draw_colors, intrinsic_constraints, natural_size, opaque, set_above_spacing, set_autosize, set_below_spacing, set_draw_colors, set_font, set_intrinsic_h, set_opaque, set_text

Methods inherited from class sub_arctic.lib.oneline_text_display

boxed, colors, end_of_selection, ensure_inside, font, h_spacing, set_boxed, set_colors, set_h_spacing, set_selection, set_v_spacing, start_of_selection, text, v_spacing, x_adjust

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_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

_highlighted

protected boolean _highlighted

We store whether we are highlighted or not. Initially, we aren't.

_focus

protected boolean _focus

This variable holds our state of focusedness.

Constructor Detail

text_list_element

public text_list_element(java.lang.String text)

Create a text_list_element with a string. This will use the default font.

Parameters:

String - text the text display.

text_list_element

public text_list_element(java.lang.String text,
                         java.awt.Font font)

Create a text_list_element with a string & a font. If you supply null for the font, you will get the system's default font.

Parameters:

String - text the text display.

Font - font the font to use (or null for the system default font).

Method Detail

highlight

public void highlight()

Implement the highlight behavior for this list element.

Specified by:

highlight in interface list_element

unhighlight

public void unhighlight()

Implement the unhighlight behavior for this list element.

Specified by:

unhighlight in interface list_element

convert_to_object

public java.lang.Object convert_to_object()

Return the convenient representation of this object.

This is a convenient way to use subclassing with listboxes. If you return an object of your own from this method, you will receive it when you ask for listbox contents or selected sets. This lets you easily get at application semantics in your code when using listboxes that display "strings". E.g. if you are displaying a list of filenames in the listbox, you might want to return File objects from this method so when the user selects a file, you won't have to go looking for that File object again.

Specified by:

convert_to_object in interface list_element

Returns:

Object a string with the text of this object in it

draw_self_local

public void draw_self_local(drawable d)

Draw this object on the drawable provided.

Parameters:

drawable - d the drawable to draw on.

Overrides:

draw_self_local in class label

highlighted

public boolean highlighted()

Return if the object is highlighted right now.

Specified by:

highlighted in interface list_element

Returns:

boolean true if the object is currently highlighted

make_contents_vector

public static java.util.Vector make_contents_vector(java.lang.String[] contents,
                                                    java.awt.Font font)

This static function is a convenience for creating a Vector text_list_elements from an array of strings.

Parameters:

String[] - contents the strings to make elements out of.

Font - font the font to use (or pass null for a default font).

Returns:

Vector a vector suitable for use with set_contents() on listbox_display.

make_contents_vector

public static java.util.Vector make_contents_vector(java.util.Vector contents,
                                                    java.awt.Font font)

This static function is a convenience for creating a Vector text_list_elements from a Vector of strings.

Parameters:

Vector - contents the strings to make elements out of.

Font - font the font to use (or pass null for a default font).

Returns:

Vector a vector suitable for use with set_contents() on listbox_display.

preferred_width

public int preferred_width()

Compute the preferred width for the parent.

Specified by:

preferred_width in interface list_element

Returns:

int the size of the text string being displayed + 4 pixels of border.

become_focus

public void become_focus()

This method is used to inform the object that it has become the focus of a listbox. Listbox elements should draw themselves differently to indicate this demarcation. Listbox elements may be the focus when they are not highlighted and vice-versa.

Specified by:

become_focus in interface list_element

lost_focus

public void lost_focus()

This method is used to inform the object that it is not the focus any longer.

Specified by:

lost_focus in interface list_element

focused

public boolean focused()

This method is used to query the object about whether or not it is the focus.

Specified by:

focused in interface list_element

Returns:

boolean true if this object is the focus