sub_arctic.contrib
Class multilist_list

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.contrib.multilist_list

public class multilist_list

extends base_interactor

implements callback_object, does_callback

multilist_list represents a single column in a multilist. This interactor manages the layout of a contained list and an optional title over that list.

Field Summary

static int	ATTACH_CENTER
static int	ATTACH_LEFT
static int	ATTACH_RIGHT
protected callback_object	cb
protected java.util.Vector	contents
protected boolean	fixedorder
protected boolean	fixedsize
protected listbox	listbox
protected multilist	multilist
protected int	position
protected java.lang.Object	title
protected interactor	titleInt

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

multilist_list()

multilist_list(java.lang.Object title)
Create a multilist_list with no list contents, providing only a title object.

multilist_list(java.lang.Object title, java.util.Vector contents, boolean fixedsize, boolean fixedorder, int position, callback_object cb)
Construct a new multilist_list.

Method Summary

callback_object	callback_obj() Return the current callback_object for this interactor.
void	callback(interactor from, event evt, int cbNum, java.lang.Object ui) The multilist_list object implements the callback_object interface.
java.util.Vector	contents() Return the contents vector of the list.
boolean	fixedorder() Return the current value of fixedorder, indicating whether the list should be interactively re-orderable within its multilist via drag-and-drop.
boolean	fixedsize() Return the current value of fixedsize, indicating whether the list should be resizable or not.
listbox	listbox() Return the actual listbox interactor contained within this multilist_list.
multilist	multilist() Return the multilist which contains us, or null.
int	position() Return the current title position flag, either ATTACH_RIGHT, ATTACH_CENTER, or ATTACH_LEFT.
void	set_callback_obj(callback_object cb) Set the callback object of this interactor.
void	set_contents(java.util.Vector contents) Set the contents vector of the list.
void	set_fixedorder(boolean fixedord) Set the fixedorder flag, indicating whether this list's position within its multilist should be interactively changeable.
void	set_fixedsize(boolean fixedsize) Set the fixedsize flag, indicating whether this list's size is fixed within its multilist.
protected void	set_multilist(multilist m) Set the multilist that contains us.
void	set_position(int position) Set the title position flag to one of either ATTACH_LEFT, ATTACH_CENTER, or ATTACH_RIGHT.
void	set_title(java.lang.Object title) Set the title object for this interactor.
interactor	title_interactor() Return the actual title interactor contained within this multilist_list.
java.lang.Object	title() Return the original object passed in to use as the title.

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

ATTACH_LEFT

public static final int ATTACH_LEFT

ATTACH_CENTER

public static final int ATTACH_CENTER

ATTACH_RIGHT

public static final int ATTACH_RIGHT

title

protected java.lang.Object title

titleInt

protected interactor titleInt

contents

protected java.util.Vector contents

fixedsize

protected boolean fixedsize

fixedorder

protected boolean fixedorder

position

protected int position

listbox

protected listbox listbox

cb

protected callback_object cb

multilist

protected multilist multilist

Constructor Detail

multilist_list

public multilist_list(java.lang.Object title,
                      java.util.Vector contents,
                      boolean fixedsize,
                      boolean fixedorder,
                      int position,
                      callback_object cb)

Construct a new multilist_list. This is the full constructor.

Parameters:

Object - title Callers can pass any type of object to use as a title for a multilist_list. If null is passed, the list will be constructed with no title. If an interactor is passed, that interactor will be used as the title. If some other, non-interactor object is passed, the constructor will create a new multilist_title object (basically a label) that contains the stringified representation of the passed object as its label.

Vector - contents The list will be initialized with the stringified representation of the object in this vector.

boolean - fixedsize Indicates whether this column will be fixed in size.

boolean - fixedorder Indicates whether this column can have its position changed interactively via drag-and-drop.

int - position Indicates the preferred position for the title. This value should be one of the contstants ATTACH_LEFT, ATTACH_CENTER, or ATTACH_RIGHT.

callback_object - cb The callback object for this list. The callback behavior for muiltilist_lists is a bit more involved than for basic lists. Normally, callers will pass null here, and any list callbacks will be forwarded to the containing multilist, which will then dispatch them to its callback object. If, however, you want to specify per-list callback objects, you can pass them here and any list callbacks will not get forwarded to the multilist.

multilist_list

public multilist_list(java.lang.Object title)

Create a multilist_list with no list contents, providing only a title object. Fixedsize and fixedorder default to false. ATTACH_CENTER is the default title position. Callbacks will be forwarded to the containing multilist.

multilist_list

public multilist_list()

Method Detail

callback

public void callback(interactor from,
                     event evt,
                     int cbNum,
                     java.lang.Object ui)

The multilist_list object implements the callback_object interface. Basically this method handles the funky forwarding we do of callbacks. If the user has supplied us with a callback object to use, we simply forward any list callbacks to the user-specified object. If they haven't given us any callback object, then we forward list callbacks to the multilist that we live in. This lets developers centralize both list and multilist callback handling in one object. Basically if we ever get into this routine we just forward to our multilist if we have one.

Specified by:

callback in interface callback_object

title

public java.lang.Object title()

Return the original object passed in to use as the title.

contents

public java.util.Vector contents()

Return the contents vector of the list.

fixedsize

public boolean fixedsize()

Return the current value of fixedsize, indicating whether the list should be resizable or not.

fixedorder

public boolean fixedorder()

Return the current value of fixedorder, indicating whether the list should be interactively re-orderable within its multilist via drag-and-drop.

position

public int position()

Return the current title position flag, either ATTACH_RIGHT, ATTACH_CENTER, or ATTACH_LEFT.

listbox

public listbox listbox()

Return the actual listbox interactor contained within this multilist_list. Use this with care!!

title_interactor

public interactor title_interactor()

Return the actual title interactor contained within this multilist_list. Use this with care!!

callback_obj

public callback_object callback_obj()

Return the current callback_object for this interactor. A null return indicates that callbacks are being forwarded to our containing multilist.

Specified by:

callback_obj in interface does_callback

Overrides:

callback_obj in class base_interactor

multilist

public multilist multilist()

Return the multilist which contains us, or null.

set_title

public void set_title(java.lang.Object title)

Set the title object for this interactor. If a null is passed here, no title will be used. If an interactor is passed, that interactor will be used as the title. If some other object is passed, a multilist_title will be created and the stringified representation of the passed object will be used as its label.

set_contents

public void set_contents(java.util.Vector contents)

Set the contents vector of the list.

set_fixedsize

public void set_fixedsize(boolean fixedsize)

Set the fixedsize flag, indicating whether this list's size is fixed within its multilist.

set_fixedorder

public void set_fixedorder(boolean fixedord)

Set the fixedorder flag, indicating whether this list's position within its multilist should be interactively changeable.

set_position

public void set_position(int position)

Set the title position flag to one of either ATTACH_LEFT, ATTACH_CENTER, or ATTACH_RIGHT.

set_callback_obj

public void set_callback_obj(callback_object cb)

Set the callback object of this interactor. If a null is passed, any list callbacks will be forwarded on to the containing multilist.

Specified by:

set_callback_obj in interface does_callback

Overrides:

set_callback_obj in class base_interactor

set_multilist

protected void set_multilist(multilist m)

Set the multilist that contains us. Should only be called by the multilist itself.