sub_arctic.lib
Class scale

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.h_slider_display
                    |
                    +--sub_arctic.lib.h_slider
                          |
                          +--sub_arctic.lib.scale

public class scale
extends h_slider

This class implements a scale -- a horizontal scrollbar with no buttons on the ends and a fixed size thumb. It uses the style system for its display.


Fields inherited from class sub_arctic.lib.h_slider
_callback_obj, DYNAMIC_CALLBACK, STATIC_CALLBACK
 
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
scale(int wv, int minv, int maxv, callback_object obj)
          Constructor for a scale with some reasonable defaults.
scale(int wv, int minv, int maxv, int init_val, int lincv, callback_object obj)
          Constructor for a scale which assumes you will position it either directly or with constraints.
scale(int xv, int yv, int wv, int minv, int maxv, int init_val, int lincv, callback_object obj)
          Full constructor for a scale.
 
Method Summary
 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.
 void draw_self_local(drawable d)
          Override the drawing code in h_slider_display to allow us to not have the end pieces of the scrollbar.
 boolean press(event evt, java.lang.Object user_info)
          Override the press behavior to avoid the system getting confused about us not having the end pieces.
 void style_changed()
          This function is called to create the appearance of the scale.
protected  int thumb_offset()
          We override the function that computes the offset of the thumb to ignore the areas that normally would be used for the end pieces.
 
Methods inherited from class sub_arctic.lib.h_slider
callback_obj, drag_end, dynamic_callback, first_callback_num, last_callback_num, release, set_callback_obj, static_callback
 
Methods inherited from class sub_arctic.lib.h_slider_display
back_img, boxed, conform, 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_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
 

Constructor Detail

scale

public scale(int xv,
             int yv,
             int wv,
             int minv,
             int maxv,
             int init_val,
             int lincv,
             callback_object obj)
Full constructor for a scale.
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 - lincv large increment value (the user clicks in the thumb area but not on the thumb).
callback_object - obj the object which receives the callbacks.

scale

public scale(int wv,
             int minv,
             int maxv,
             int init_val,
             int lincv,
             callback_object obj)
Constructor for a scale which assumes you will position it either directly or with constraints.
Parameters:
int - wv width in pixels.
int - minv minimum slider value.
int - maxv maximum slider value.
int - init_val initial slider value.
int - lincv large increment value (the user clicks in the thumb area but not on the thumb).
callback_object - obj the object which receives the callbacks.

scale

public scale(int wv,
             int minv,
             int maxv,
             callback_object obj)
Constructor for a scale with some reasonable defaults. We default the initial value to the minimum value and the large increment to 1/4 of the range of the scale. We assume you will use constraints or directly set the position of this object.
Parameters:
int - wv width in pixels
int - minv minimum slider value
int - maxv maximum slider value
callback_object - obj the object which receives the callbacks.
Method Detail

style_changed

public void style_changed()
This function is called to create the appearance of the scale.

draw_self_local

public void draw_self_local(drawable d)
Override the drawing code in h_slider_display to allow us to not have the end pieces of the scrollbar.
Parameters:
drawable - d the drawing surface to put the image on.
Overrides:
draw_self_local in class h_slider_display

thumb_offset

protected int thumb_offset()
We override the function that computes the offset of the thumb to ignore the areas that normally would be used for the end pieces.
Returns:
int the amount the thumb should be shifted right to account for the value of the scale.
Overrides:
thumb_offset in class h_slider_display

press

public boolean press(event evt,
                     java.lang.Object user_info)
Override the press behavior to avoid the system getting confused about us not having the end pieces.
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.
Overrides:
press in class h_slider

drag_start

public boolean drag_start(event evt,
                          java.lang.Object user_info)
Start of a drag for the thumb. Override to avoid the calculation for the left image.
Parameters:
event - evt the event that is starting the drag (usually a press)
Object - user_info the object passed to the simple drag_agent
Overrides:
drag_start in class h_slider

drag_feedback

public boolean drag_feedback(event evt,
                             java.lang.Object user_info)
Movement within a drag of the thumb. Overridden to avoid the calculations involving the end pieces.
Parameters:
event - evt the drag event (mouse move).
Object - user_info the object passed to the simple drag_agent.
Overrides:
drag_feedback in class h_slider