: Interface list

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

sub_arctic.lib
Interface list_element

All Known Implementing Classes:: text_list_element

public abstract interface list_element
extends interactor

This interface is the API that listboxes use to communicate with their elements. Any object that implements this interface may be placed into a listbox.

Fields inherited from class sub_arctic.lib.interactor_consts

DAMAGED,  
ENABLED,  
ENABLED_HAS_EXT_NOTIFY,  
ENABLED_IN_PROCESS,  
ENABLED_IS_HORIZONTAL,  
ENABLED_OOD,  
FEATURE_BOTTOM_LEFT,  
FEATURE_BOTTOM_RIGHT,  
FEATURE_CENTER,  
FEATURE_NONE,  
FEATURE_TOP_LEFT,  
FEATURE_TOP_RIGHT,  
FIRST_FREE_FEATURE,  
FIRST_FREE_FLAG,  
FIXED_CHILDREN,  
H,  
H_HAS_EXT_NOTIFY,  
H_IN_PROCESS,  
H_OOD,  
IS_ENABLED,  
IS_VISIBLE,  
OOD_BITS,  
PART_A,  
PART_A_HAS_EXT_NOTIFY,  
PART_A_IN_PROCESS,  
PART_A_IS_HORIZONTAL,  
PART_A_OOD,  
PART_B,  
PART_B_HAS_EXT_NOTIFY,  
PART_B_IN_PROCESS,  
PART_B_IS_HORIZONTAL,  
PART_B_OOD,  
STYLE_LOCKED,  
SUPPORTS_CHILDREN,  
TRAV_DRAW,  
TRAV_PICK,  
TRAV_POST,  
TRAV_PRE,  
VISIBLE,  
VISIBLE_HAS_EXT_NOTIFY,  
VISIBLE_IN_PROCESS,  
VISIBLE_IS_HORIZONTAL,  
VISIBLE_OOD,  
W,  
W_HAS_EXT_NOTIFY,  
W_IN_PROCESS,  
W_OOD,  
X,  
X_HAS_EXT_NOTIFY,  
X_IN_PROCESS,  
X_OOD,  
Y,  
Y_HAS_EXT_NOTIFY,  
Y_IN_PROCESS,  
Y_OOD

Fields inherited from class sub_arctic.constraints.std_constraint_consts

FIRST_CHILD,  
LAST_CHILD,  
MAX_CHILD,  
MIN_CHILD,  
NEXT_SIBLING,  
NO_CONSTRAINT,  
OTHER,  
PARENT,  
PREV_SIBLING,  
SELF,  
ZERO

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()` This method is called by the listbox to try to get a more convenient representation of the list_element for the user-level code.
`boolean`	`focused()` This method is used to query the object about whether or not it is the focus.
`void`	`highlight()` This method will be called by the listbox to inform the object that it should highlight.
`boolean`	`highlighted()` This returns the current highlight status of the object.
`void`	`lost_focus()` This method is used to inform the object that it is not the focus any longer.
`int`	`preferred_width()` This should return the preferred width of this item.
`void`	`unhighlight()` This method will be called by the listbox to inform the object that it should no longer be highlighted.

Methods inherited from interface sub_arctic.lib.interactor

active_constraints, 
add_child, 
add_user_datum, 
attach_dependent, 
bound, 
child_index, 
child, 
configure, 
constraint_flag_is_set, 
constraint_on, 
custom_fun1, 
custom_fun2, 
damage_from_child, 
damage_self, 
damage_self, 
damage_self, 
damage_self, 
damage_self, 
detach_dependent, 
do_action, 
do_action, 
drag_feature_point, 
draw_self, 
enabled_constraint, 
enabled, 
eval_enabled, 
eval_h, 
eval_part_a, 
eval_part_b, 
eval_visible, 
eval_w, 
eval_x, 
eval_y, 
eval, 
feature_point_enabled, 
feature_point, 
find_child, 
fixed_children, 
flag_is_set, 
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, 
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, 
next_sibling, 
num_actions, 
num_children, 
num_feature_points, 
parent, 
part_a_constraint, 
part_a, 
part_b_constraint, 
part_b, 
pick, 
picked_by, 
pos, 
prev_sibling, 
remove_child, 
remove_child, 
remove_user_datum, 
restyle, 
set_child_index, 
set_child, 
set_constraint, 
set_constraint, 
set_enabled_constraint, 
set_enabled_constraint, 
set_enabled_constraint, 
set_enabled, 
set_h_constraint, 
set_h_constraint, 
set_h_constraint, 
set_h, 
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_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, 
size, 
style_change, 
supports_children, 
tag_str, 
toString, 
traverse_and_collect, 
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

Method Detail

highlight

public void highlight()

This method will be called by the listbox to inform the object that it should highlight. This does not (necessarily) imply that the user clicked on this object, as this selection might be programmatic or the result of user actions which select a group of objects.

Implementations of this interface can assume that are not initially highlighted.

unhighlight

public void unhighlight()

This method will be called by the listbox to inform the object that it should no longer be highlighted.

convert_to_object

public java.lang.Object convert_to_object()

This method is called by the listbox to try to get a more convenient representation of the list_element for the user-level code. If you return an object here that object will be placed in the "selected set" of objects when the user-level code asks for the set of selected objects or in the vector of "contents" when the user asks for that. If you return null here, the object implementing this interface will be placed in the set of selections or contents.

This function is here to allow objects which have simple semantics to export those semantics to user-level code. For example, an implementation of this interface which displays text strings will want to return the string displayed from this function, rather than the object which does the display.

Returns:: Object the object which this object can be converted to for simplifying user-level code.

highlighted

public boolean highlighted()

This returns the current highlight status of the object.

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.

lost_focus

public void lost_focus()

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

focused

public boolean focused()

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

Returns:: boolean true if this object is the focus

preferred_width

public int preferred_width()

This should return the preferred width of this item. The item must be able to display itself at any width, however. This is used by the parent to determine which list element is widest and force all the children to be that width.

Returns:: int the object's preferred width in pixels