sub_arctic.new_lib
Class toggle

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.new_lib.multi_button
                    |
                    +--sub_arctic.new_lib.toggle

Direct Known Subclasses:

checkbox, label_toggle, radio_button

public class toggle

extends multi_button

implements inout_draggable, pressable

This class is a common superclass for checkbox and radio_button. Here in the base class we do nothing about the style system and how things look, but provide the common behavior.

Toggles may be put into groups in by selecting some toggle (some instance of this class or its subclasses) as the "leader" of the group. Having done this, you should create the leader object with no other toggle as its "group_with" parameter when you create it. When you create all the other members of the group however, they should be "linked" to the leader either by naming the leader in the constructor or by using the add_to_group_of with the leader as the "name" of the group. You can drop any items from the group by using the drop_from_group. A toggle may be in only one group at a time. If you drop the leader from a group, the remaining members stay in the group and "elect" a new leader (although it doesn't matter, since they are already in the group).

Frequently, people can use the text_toggle_collection object and get the behaviors they need for forming groups without understanding the above.

See Also:

text_toggle_collection, checkbox, radio_button

Field Summary

protected toggle

_group_link Link for circular list of radio button group.

Fields inherited from class sub_arctic.new_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

	toggle(int x, int y, loaded_image[] st_looks, loaded_image[] trans_looks, toggle group_with, callback_object call_obj) Full constructor.
protected	toggle(int x, int y, toggle group_with, callback_object call_obj) Partial constructor for use by subclasses.
	toggle(loaded_image[] st_looks, loaded_image[] trans_looks, callback_object call_obj) Constructor that defaults to a 0,0 position and no group.
	toggle(loaded_image[] st_looks, loaded_image[] trans_looks, toggle group_with, callback_object call_obj) Constructor that defaults to a 0,0 position.

Method Summary

void	add_to_group_of(toggle other) Add us to the group the given toggle is in.
void	drop_from_group() Drop us from our current group
toggle	group_link() Link for circular list of radio button group.
protected toggle	group_prev() Return the previous toggle in our circular group list.
int	next_state() Override next_state to provide group behavior.
void	set_cur_state(int st) Override set_cur_state to reset other group members (if any) if we are being set (put in state 1).

Methods inherited from class sub_arctic.new_lib.multi_button

calc_size, callback_obj, cur_state, do_action, do_callback, draw_self_local, find_current_style, 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, new_look_configure, part_a, press, release, restyle_look_resources, 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, 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, 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

_group_link

protected toggle _group_link

Link for circular list of radio button group. If we are not in a group, this will refer to ourselves.

Constructor Detail

toggle

public toggle(int x,
              int y,
              loaded_image[] st_looks,
              loaded_image[] trans_looks,
              toggle group_with,
              callback_object call_obj)

Full constructor. The two image sets should each have two entries. The "looks" images provide the appearance when the toggle is quiescent in states 0 (off) and 1. The (optional) transition images provide the appearance between states 0 and 1, and between states 1 and 0 respectively. If no transition images are given the appearence in the next state acts as the transition appearance.

Parameters:

int - x x position of the toggle.

int - y y position of the toggle.

loaded_image[] - st_looks set of images for normal looks.

loaded_image[] - trans_looks set of images for looks during transitions between states (can be null to denote not special transition appearances).

toggle - group_with toggle to group this with to get radio_button semantics (or null for no grouping).

callback_object - call_obj object that gets callbacks about state changes.

toggle

public toggle(loaded_image[] st_looks,
              loaded_image[] trans_looks,
              toggle group_with,
              callback_object call_obj)

Constructor that defaults to a 0,0 position.

Parameters:

loaded_image[] - st_looks set of images for normal looks.

loaded_image[] - trans_looks set of images for looks during transitions between states (can be null to denote not special transition appearances).

toggle - group_with toggle to group this with to get radio_button semantics (or null for no grouping).

callback_object - call_obj object that gets callbacks about state changes.

toggle

public toggle(loaded_image[] st_looks,
              loaded_image[] trans_looks,
              callback_object call_obj)

Constructor that defaults to a 0,0 position and no group.

Parameters:

loaded_image[] - st_looks set of images for normal looks.

loaded_image[] - trans_looks set of images for looks during transitions between states (can be null to denote not special transition appearances).

callback_object - call_obj object that gets callbacks about state changes.

toggle

protected toggle(int x,
                 int y,
                 toggle group_with,
                 callback_object call_obj)

Partial constructor for use by subclasses. This temporarily supplied null image arrays that are to be filled in later, but otherwise is the same as the full constructor. The two image sets should each have two entries. The "looks" images provide the appearance when the toggle is quiescent in states 0 (off) and 1. The (optional) transition images provide the appearance between states 0 and 1, and between states 1 and 0 respectively. If no transition images are given the appearence in the next state acts as the transition appearance.

Parameters:

int - x x position of the toggle.

int - y y position of the toggle.

loaded_image[] - st_looks set of images for normal looks.

loaded_image[] - trans_looks set of images for looks during transitions between states (can be null to denote not special transition appearances).

toggle - group_with toggle to group this with to get radio_button semantics (or null for no grouping).

callback_object - call_obj object that gets callbacks about state changes.

Method Detail

group_link

public toggle group_link()

Link for circular list of radio button group. If we are not in a group, this will refer to ourselves.

Returns:

toggle our link in the circular group list.

set_cur_state

public void set_cur_state(int st)

Override set_cur_state to reset other group members (if any) if we are being set (put in state 1).

Parameters:

int - st new state.

Overrides:

set_cur_state in class multi_button

next_state

public int next_state()

Override next_state to provide group behavior. If we are not in a group then we just toggle. However, if we are in a group then we transition from off to on, but not on to off (we get reset by another group member being set).

Returns:

int the state we will enter if activated again.

Overrides:

next_state in class multi_button

group_prev

protected toggle group_prev()

Return the previous toggle in our circular group list.

Returns:

toggle the toggle before us in the group list.

drop_from_group

public void drop_from_group()

Drop us from our current group

add_to_group_of

public void add_to_group_of(toggle other)

Add us to the group the given toggle is in.

Parameters:

toggle - other the toggle whose group we are joining.