sub_arctic.lib
Class label_toggle

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.multi_button
                    |
                    +--sub_arctic.lib.toggle
                          |
                          +--sub_arctic.lib.label_toggle
public class label_toggle
extends toggle

These are toggles which occupy a fixed width and have a label just to the right of the image. They support the style interface and can be used to create either labeled check boxes or labeled radio_buttons.

Field Summary
protected static int _default_separation
          Separation between toggle and label.
protected  java.awt.Font _font
          The font for this object.
protected  loaded_image[] _images
           
protected  int _requested_width
          Requested width is the total width of the interactor or -1 if we don't care and want to size by string.
protected  java.lang.String _text
          The text of the label.
protected  loaded_image[] _transition_images
           
protected  boolean is_radio_button
          If this is true, we are going to use the image of radio_button otherwise we use the image of a checkbox.
 
Fields inherited from class sub_arctic.lib.toggle
_default_look, _group_link
 
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
label_toggle(boolean radio, callback_object call_obj, int width, java.awt.Font f, java.lang.String l)
          Create a new label_toggle.
label_toggle(boolean radio, callback_object call_obj, int width, java.awt.Font f, java.lang.String l, loaded_image[] im)
          Constructor which makes a label toggle from a pair of images and doesn't require x and y coordinates.
label_toggle(boolean radio, callback_object call_obj, int width, java.awt.Font f, java.lang.String l, loaded_image[] im, loaded_image[] tim)
          $CLO - added.
label_toggle(int x, int y, boolean radio, callback_object call_obj, int width, java.awt.Font f, java.lang.String l)
          Create a new label_toggle.
label_toggle(int x, int y, boolean radio, callback_object call_obj, int width, java.awt.Font f, java.lang.String l, loaded_image[] im)
          Same as full constructor, but takes a pair of images to use for the display of the interactor.
label_toggle(int x, int y, boolean radio, callback_object call_obj, int width, java.awt.Font f, java.lang.String l, loaded_image[] im, loaded_image[] tim)
          $CLO - added.
 
Method Summary
protected  void compute_images()
          This builds the images of the text & toggle.
 int default_separation()
          Return the separation between label and toggle.
 java.awt.Font font()
          Return the font for this object.
 loaded_image[] images()
           
 int requested_width()
          Return the width the creator of the label requested.
 void set_font(java.awt.Font f)
          Set the font in use for this toggle.
 void set_requested_width(int w)
          Set the width to use for labels.
 void set_text(java.lang.String s)
          Modify the string in use by the label
 java.lang.String text()
          Access the text of the label.
 loaded_image[] transition_images()
           
 
Methods inherited from class sub_arctic.lib.toggle
add_to_group_of, default_look, default_transition, drop_from_group, group_link, group_prev, next_state, set_cur_state
 
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, part_a, press, release, set_callback_obj, 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

_default_separation

protected static int _default_separation
Separation between toggle and label.

_font

protected java.awt.Font _font
The font for this object. If you don't supply a font, the one chosen for you is the one returned from the style_manager.

_text

protected java.lang.String _text
The text of the label.

_requested_width

protected int _requested_width
Requested width is the total width of the interactor or -1 if we don't care and want to size by string.

is_radio_button

protected boolean is_radio_button
If this is true, we are going to use the image of radio_button otherwise we use the image of a checkbox.

_images

protected loaded_image[] _images

_transition_images

protected loaded_image[] _transition_images
Constructor Detail

label_toggle

public label_toggle(int x,
                    int y,
                    boolean radio,
                    callback_object call_obj,
                    int width,
                    java.awt.Font f,
                    java.lang.String l)
Create a new label_toggle. Full constructor.
Parameters:
int - x the x position of the object.
int - y the y position of the object.
boolean - radio true if you want the look of a radio button, false if you want the look of a checkbox.
callback_object - call_obj the object to deliver callbacks to.
int - width the width of the label in pixels.
Font - f the font to use for this object (or pass null to get the default font).
String - l the label's string.

label_toggle

public label_toggle(boolean radio,
                    callback_object call_obj,
                    int width,
                    java.awt.Font f,
                    java.lang.String l)
Create a new label_toggle. You don't need to supply the coordinates because we assume you are using constraints to locate the object on the screen.
Parameters:
callback_object - call_obj the object to deliver callbacks to.
int - width the width of the label in pixels.
Font - f the font to use for this object (or pass null to get the default font).
String - l the label's string.

label_toggle

public label_toggle(int x,
                    int y,
                    boolean radio,
                    callback_object call_obj,
                    int width,
                    java.awt.Font f,
                    java.lang.String l,
                    loaded_image[] im)
Same as full constructor, but takes a pair of images to use for the display of the interactor.
Parameters:
int - x the x position of the object.
int - y the y position of the object.
boolean - radio true if you want the look of a radio button, false if you want the look of a checkbox.
callback_object - call_obj the object to deliver callbacks to.
int - width the width of the label in pixels.
Font - f the font to use for this object (or pass null to get the default font).
String - l the label's string.
loaded_image[] - im the array of images to use for this interactor's display (array must be of size 2)

label_toggle

public label_toggle(boolean radio,
                    callback_object call_obj,
                    int width,
                    java.awt.Font f,
                    java.lang.String l,
                    loaded_image[] im)
Constructor which makes a label toggle from a pair of images and doesn't require x and y coordinates.
Parameters:
callback_object - call_obj the object to deliver callbacks to.
int - width the width of the label in pixels.
Font - f the font to use for this object (or pass null to get the default font).
String - l the label's string.
loaded_image[] - im the array of images to use for this interactor's display (array must be of size 2)

label_toggle

public label_toggle(boolean radio,
                    callback_object call_obj,
                    int width,
                    java.awt.Font f,
                    java.lang.String l,
                    loaded_image[] im,
                    loaded_image[] tim)
$CLO - added. Constructor which makes a label toggle from a pair of images and pair of transitions and doesn't require x and y coordinates.
Parameters:
boolean - radio true if you want the look of a radio button, false if you want the look of a checkbox.
callback_object - call_obj the object to deliver callbacks to.
int - width the width of the label in pixels.
Font - f the font to use for this object (or pass null to get the default font).
String - l the label's string.
loaded_image[] - im the array of images to use for this interactor's display (array must be of size 2)
loaded_image[] - tim the array of images to use for this interactor's transitions (array must be of size 2)

label_toggle

public label_toggle(int x,
                    int y,
                    boolean radio,
                    callback_object call_obj,
                    int width,
                    java.awt.Font f,
                    java.lang.String l,
                    loaded_image[] im,
                    loaded_image[] tim)
$CLO - added. Full constructor. Takes a pair of images to use for the display of the interactor and a pair of images for transitions
Parameters:
int - x the x position of the object.
int - y the y position of the object.
boolean - radio true if you want the look of a radio button, false if you want the look of a checkbox.
callback_object - call_obj the object to deliver callbacks to.
int - width the width of the label in pixels.
Font - f the font to use for this object (or pass null to get the default font).
String - l the label's string.
loaded_image[] - im the array of images to use for this interactor's display (array must be of size 2)
loaded_image[] - tim the array of images to use for this interactor's transitions (array must be of size 2)
Method Detail

default_separation

public int default_separation()
Return the separation between label and toggle.
Returns:
int the number of pixels between label and toggle

font

public java.awt.Font font()
Return the font for this object. It defaults to being the one set in the style_manager.
Returns:
Font the font being used for this object.

set_font

public void set_font(java.awt.Font f)
Set the font in use for this toggle. If you pass null, you'll get the default font from the style_manager.
Parameters:
Font - f the new font

text

public java.lang.String text()
Access the text of the label.
Returns:
String the text of the label

set_text

public void set_text(java.lang.String s)
Modify the string in use by the label
Parameters:
String - s the string to change the label to.

requested_width

public int requested_width()
Return the width the creator of the label requested.
Returns:
int the size the programmer wanted for this label

set_requested_width

public void set_requested_width(int w)
Set the width to use for labels.
Parameters:
int - w the new width of the label

compute_images

protected void compute_images()
This builds the images of the text & toggle. It computes the height from the font metric.

images

public loaded_image[] images()

transition_images

public loaded_image[] transition_images()