sub_arctic.lib
Class h_slider

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.h_slider_display
                    |
                    +--sub_arctic.lib.h_slider
Direct Known Subclasses:
h_scrollbar, scale
public class h_slider
extends h_slider_display
implements pressable, simple_draggable, does_callback

This class creates a slider with either the default or other look. It handles all the input side processing and then uses h_slider_display (from which it is derived) to do the display.

Field Summary
protected  callback_object _callback_obj
          Object we make callbacks to (if non-null)
static int DYNAMIC_CALLBACK
          Constant for dynamic callback (made at each movement)
static int STATIC_CALLBACK
          Constant for static callback (made only at end of movement)
 
Fields inherited from class sub_arctic.lib.h_slider_display
_back_img, _boxed, _large_inc, _left_img, _max_val, _min_val, _right_img, _small_inc, _thumb_img, _thumb_shift, _value
 
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
h_slider(int xv, int yv, int wv, int minv, int maxv, int init_val, int sincv, int lincv, callback_object call_obj)
          Construct a horizontal slider (not a scrollbar) with the default (Artkit) appearance.
h_slider(int xv, int yv, int wv, int minv, int maxv, int init_val, int sincv, int lincv, callback_object call_obj, loaded_image rt_im, loaded_image lf_im, loaded_image th_im, loaded_image back_pat)
          Create a new horizontal slider (not scrollbar).
 
Method Summary
 callback_object callback_obj()
          Object that this slider makes callbacks to when moved.
 boolean drag_end(event evt, java.lang.Object user_info)
          End the simple drag of the thumb.
 boolean drag_feedback(event evt, java.lang.Object user_info)
          Movement within a drag of the thumb.
 boolean drag_start(event evt, java.lang.Object user_info)
          Start of a drag for the thumb.
protected  void dynamic_callback(event evt)
          Do a "dynamic" callback.
 int first_callback_num()
          First valid callback number
 int last_callback_num()
          Last valid callback number
 boolean press(event evt, java.lang.Object user_info)
          Handle mouse presses in our bounds -- makes us the drag focus if they click in the thumb.
 boolean release(event evt, java.lang.Object user_info)
          Companion for press() -- ignore here, it never gets called because we become the drag focus.
 void set_callback_obj(callback_object cb)
          Set the callback object that this button makes callbacks to when moved.
protected  void static_callback(event evt)
          Do a "static" callback (#1).
 
Methods inherited from class sub_arctic.lib.h_slider_display
back_img, boxed, conform, draw_self_local, intrinsic_constraints, large_inc, left_img, max_val, min_val, part_a, right_img, set_back_img, set_boxed, set_large_inc, set_left_img, set_max_val, set_min_val, set_part_a, set_raw_part_a, set_right_img, set_small_inc, set_thumb_img, set_thumb_shift, set_value, small_inc, thumb_img, thumb_offset, thumb_shift, value
 
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, 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

_callback_obj

protected callback_object _callback_obj
Object we make callbacks to (if non-null)

STATIC_CALLBACK

public static final int STATIC_CALLBACK
Constant for static callback (made only at end of movement)

DYNAMIC_CALLBACK

public static final int DYNAMIC_CALLBACK
Constant for dynamic callback (made at each movement)
Constructor Detail

h_slider

public h_slider(int xv,
                int yv,
                int wv,
                int minv,
                int maxv,
                int init_val,
                int sincv,
                int lincv,
                callback_object call_obj,
                loaded_image rt_im,
                loaded_image lf_im,
                loaded_image th_im,
                loaded_image back_pat)
Create a new horizontal slider (not scrollbar). This is the full constructor interface with all the possible options.
Parameters:
int - xv x position
int - yv y position
int - wv width in pixels
int - minv minimum slider value
int - maxv maximum slider value
int - init_val initial slider value.
int - sincv small increment value (when the left or right buttons are pushed).
int - lincv large increment value (the user clicks in the thumb area but not on the thumb).
callback_object - call_obj the object which receives the callbacks (see above).
loaded_image - rt_im image for right button.
loaded_image - lf_im image for left button.
loaded_image - th_im image for thumb.
loaded_image - back_pat image for the background pattern.

h_slider

public h_slider(int xv,
                int yv,
                int wv,
                int minv,
                int maxv,
                int init_val,
                int sincv,
                int lincv,
                callback_object call_obj)
Construct a horizontal slider (not a scrollbar) with the default (Artkit) appearance.
Parameters:
int - xv x position.
int - yv y position.
int - wv width in pixels.
int - minv minimum slider value.
int - maxv maximum slider value.
int - init_val initial slider value.
int - sincv small increment value (when the left or right buttons are pushed).
int - lincv large increment value (the user clicks in the thumb area but not on the thumb).
callback_object - call_obj the object which receives the callbacks (see above).
Method Detail

callback_obj

public callback_object callback_obj()
Object that this slider makes callbacks to when moved. There are two callbacks made. Number 0 is made dynamically as the slider moves, while number 1 is made only once the slider is released. In both cases the callback_info contains an Integer object with the value of the slider.
Specified by:
callback_obj in interface does_callback
Returns:
callback_object the object we make callbacks to
Overrides:
callback_obj in class base_interactor

set_callback_obj

public void set_callback_obj(callback_object cb)
Set the callback object that this button makes callbacks to when moved. There are two callbacks made. Number 0 is made dynamically as the slider moves, while number 1 is made only once the slider is released. In both cases the callback_info contains an Integer object with the value of the slider.
Specified by:
set_callback_obj in interface does_callback
Parameters:
callback_object - cb the new object to which we make callbacks.
Overrides:
set_callback_obj in class base_interactor

first_callback_num

public int first_callback_num()
First valid callback number
Specified by:
first_callback_num in interface does_callback
Overrides:
first_callback_num in class base_interactor

last_callback_num

public int last_callback_num()
Last valid callback number
Specified by:
last_callback_num in interface does_callback
Overrides:
last_callback_num in class base_interactor

dynamic_callback

protected void dynamic_callback(event evt)
Do a "dynamic" callback. This is callback that gets used while the thumb of the slider is being dragged.
Parameters:
event - evt the event which caused this callback

static_callback

protected void static_callback(event evt)
Do a "static" callback (#1). This is the callback when the thumb is "dropped" (and the mouse released). You should use this callback exclusively if you don't want the dragged objects to move as the scrollbar is moved but only when the thumb is released.
Parameters:
event - evt the event which caused this callback

press

public boolean press(event evt,
                     java.lang.Object user_info)
Handle mouse presses in our bounds -- makes us the drag focus if they click in the thumb.
Specified by:
press in interface pressable
Parameters:
event - evt the press event (mouse down).
Object - user_info the information that was handed to the pick_collector when this object was deemed to be picked (this value is given to the drag focus agent also, so it will be propagated along to the drag calls below).
Returns:
boolean true if we consumed this event, which we will

release

public boolean release(event evt,
                       java.lang.Object user_info)
Companion for press() -- ignore here, it never gets called because we become the drag focus.
Specified by:
release in interface pressable
Parameters:
event - evt the release event.
Object - user_info the information that was handed to the pick_collector when this object was deemed to be picked.

drag_start

public boolean drag_start(event evt,
                          java.lang.Object user_info)
Start of a drag for the thumb.
Specified by:
drag_start in interface simple_draggable
Parameters:
event - evt the event that is starting the drag (usually a press).
Object - user_info the object passed to the simple drag_agent

drag_feedback

public boolean drag_feedback(event evt,
                             java.lang.Object user_info)
Movement within a drag of the thumb.
Specified by:
drag_feedback in interface simple_draggable
Parameters:
event - evt the drag event (mouse move).
Object - user_info the object passed to the simple drag_agent.

drag_end

public boolean drag_end(event evt,
                        java.lang.Object user_info)
End the simple drag of the thumb.
Specified by:
drag_end in interface simple_draggable
Parameters:
event - evt the end of the drag event (mouse release usually).
Object - user_info the object passed to the simple drag_agent.