sub_arctic.contrib
Class GrowDragContainer

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

public class GrowDragContainer

extends uni_container

implements pressable, grow_draggable, move_draggable, does_callback

A container class for one object that provides a grow handle. This establishes constraints on its child so that it follows the size of this object as it grows.

Field Summary

protected callback_object	_callback_obj _callback_obj is the object we make callbacks to.
protected loaded_image	_handle Image for the grow handle
static int	END_MOVE_CALLBACK Constant for "end" callback (called only at end of move).
protected boolean	m_grow_enabled The m_grow_enabled variable is true if the interactor is to support gorw operations.
static int	MOVE_CALLBACK Constant for "move" callback (called on every move, including last).

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

GrowDragContainer(int x, int y, int w, int h, loaded_image hnd_img)
Compatability constructor.

GrowDragContainer(int x, int y, int w, int h, loaded_image hnd_img, callback_object cbo)
Full constructor.

Method Summary

callback_object	callback_obj() Retrieve the object we make callbacks to.
boolean	drag_end(event evt, int x_pos, int y_pos, int st_x, int st_y, int grab_x, int grab_y, java.lang.Object user_info) Handle input corresponding to the end of a drag for move.
boolean	drag_end(event evt, int cur_w, int cur_h, int st_w, int st_h, java.lang.Object user_info) Handle input corresponding to the end of a drag for grow.
boolean	drag_feedback(event evt, int x_pos, int y_pos, int st_x, int st_y, int grab_x, int grab_y, java.lang.Object user_info) Handle a movement during a drag for move.
boolean	drag_feedback(event evt, int cur_w, int cur_h, int st_w, int st_h, java.lang.Object user_info) Handle a movement during a drag for grow.
boolean	drag_start(event evt, int x_pos, int y_pos, int grab_x, int grab_y, java.lang.Object user_info) Handle the start of a drag to the object for moves.
boolean	drag_start(event evt, java.lang.Object user_info) Handle the start of a drag to the object for grows.
protected void	draw_self_local(drawable d) Draw the object's current appearance.
int	first_callback_num() Indicate the first callback number used by this interactor (in this case END_MOVE_CALLBACK).
boolean	grow_enabled() The grow_enabled method indicates the current status of the interactor for grow operations.
loaded_image	handle() Image for the grow handle.
int	last_callback_num() Indicate the last callback number used by this interactor (in this case MOVE_CALLBACK).
void	pick(int pt_x, int pt_y, pick_collector pick_list) Determine if this object is "picked" by the the given point.
boolean	press(event evt, java.lang.Object user_info) Handle mouse button press input to the object.
boolean	release(event evt, java.lang.Object user_info) Companion to press().
interactor	remove_child(int at_indx) Override remove_child to drop constraints.
void	set_callback_obj(callback_object cbo) Set the object we make callbacks to.
void	set_child(int at_indx, interactor chld) Override set_child to establish and/or remove constraints.
void	set_grow_enabled(boolean flag) The set_grow_enabled method sets whether the interactor should support grow operations.
void	set_handle(loaded_image himg) Set the image used for the grow handle.

Methods inherited from class sub_arctic.lib.uni_container

add_child

Methods inherited from class sub_arctic.lib.base_interactor

active_constraints, 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, intrinsic_constraints, 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_a, part_b_constraint, part_b, pick_within_children, picked_by, pos, prev_sibling, register_resource_names, remove_child, remove_user_datum, restyle_look_resources, restyle, set_child_index, 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

_callback_obj

protected callback_object _callback_obj

_callback_obj is the object we make callbacks to.

MOVE_CALLBACK

public static final int MOVE_CALLBACK

Constant for "move" callback (called on every move, including last). This callback provides a Point object with the position of the container in its parent's coordinates.

END_MOVE_CALLBACK

public static final int END_MOVE_CALLBACK

Constant for "end" callback (called only at end of move). This callback provides a Point object with the position of the container in its parent's coordinates.

m_grow_enabled

protected boolean m_grow_enabled

The m_grow_enabled variable is true if the interactor is to support gorw operations.

_handle

protected loaded_image _handle

Image for the grow handle

Constructor Detail

GrowDragContainer

public GrowDragContainer(int x,
                         int y,
                         int w,
                         int h,
                         loaded_image hnd_img,
                         callback_object cbo)

Full constructor. The boolean parameter controls whether the container does bounding box feedback, or simply grows with no other specific feedback.

Parameters:

int - x the initial x position of this object.

int - y the initial y position of this object.

int - w the initial width of this object.

int - w the initial height of this object.

loaded_image - hnd_img an image for the grow handle.

callback_object - cbo the object to receive move callbacks.

GrowDragContainer

public GrowDragContainer(int x,
                         int y,
                         int w,
                         int h,
                         loaded_image hnd_img)

Compatability constructor. The boolean parameter controls whether the container does bounding box feedback, or simply grows with no other specific feedback.

Parameters:

int - x the initial x position of this object.

int - y the initial y position of this object.

int - w the initial width of this object.

int - w the initial height of this object.

loaded_image - hnd_img an image for the grow handle.

Method Detail

callback_obj

public callback_object callback_obj()

Retrieve the object we make callbacks to.

Specified by:

callback_obj in interface does_callback

Returns:

callback_object the callback object.

Overrides:

callback_obj in class base_interactor

set_callback_obj

public void set_callback_obj(callback_object cbo)

Set the object we make callbacks to.

Specified by:

set_callback_obj in interface does_callback

Parameters:

callback_object - cbo the new callback object.

Overrides:

set_callback_obj in class base_interactor

first_callback_num

public int first_callback_num()

Indicate the first callback number used by this interactor (in this case END_MOVE_CALLBACK).

Specified by:

first_callback_num in interface does_callback

Returns:

int the first valid callback number used by this object to make callbacks.

Overrides:

first_callback_num in class base_interactor

See Also:

sub_arctic.lib.input#callback_object

last_callback_num

public int last_callback_num()

Indicate the last callback number used by this interactor (in this case MOVE_CALLBACK).

Specified by:

last_callback_num in interface does_callback

Returns:

int the last valid callback number used by this object to make callbacks.

Overrides:

last_callback_num in class base_interactor

See Also:

sub_arctic.lib.input#callback_object

grow_enabled

public boolean grow_enabled()

The grow_enabled method indicates the current status of the interactor for grow operations.

Returns:

boolean true for growing enabled.

set_grow_enabled

public void set_grow_enabled(boolean flag)

The set_grow_enabled method sets whether the interactor should support grow operations.

handle

public loaded_image handle()

Image for the grow handle.

Returns:

loaded_image the current image for the grow handle.

set_handle

public void set_handle(loaded_image himg)

Set the image used for the grow handle.

Parameters:

loaded_image - himg the new image for the grow handle.

set_child

public void set_child(int at_indx,
                      interactor chld)

Override set_child to establish and/or remove constraints.

Parameters:

int - at_indx the index to place the child at.

interactor - chld the child interactor.

Overrides:

set_child in class base_interactor

remove_child

public interactor remove_child(int at_indx)

Override remove_child to drop constraints.

Parameters:

int - at_index index of child to remove.

Returns:

interactor the removed child.

Overrides:

remove_child in class base_interactor

press

public boolean press(event evt,
                     java.lang.Object user_info)

Handle mouse button press input to the object. Here, we start dragging.

Specified by:

press in interface pressable

Parameters:

event - evt the press event.

Object - user_info information associated with this object at pick time.

Returns:

boolean indicating whether the input was consumed.

release

public boolean release(event evt,
                       java.lang.Object user_info)

Companion to press(). Here we ignore this.

Specified by:

release in interface pressable

Parameters:

event - evt the release event.

Object - user_info information associated with this object at pick time.

Returns:

boolean indicating whether the input was consumed (here always false).

drag_start

public boolean drag_start(event evt,
                          java.lang.Object user_info)

Handle the start of a drag to the object for grows.

Specified by:

drag_start in interface grow_draggable

Parameters:

event - evt the event "causing" the drag.

Object - user_info information associated with this object at pick time.

Returns:

boolean indicating whether the input was consumed.

drag_start

public boolean drag_start(event evt,
                          int x_pos,
                          int y_pos,
                          int grab_x,
                          int grab_y,
                          java.lang.Object user_info)

Handle the start of a drag to the object for moves.

Specified by:

drag_start in interface move_draggable

Parameters:

event - evt the event "causing" the start of the drag.

int - x_pos x position of new position (in parent's coords).

int - y_pos y position of new position (in parent's coords).

int - grab_x x position where we started the drag (in local coords).

int - grab_y y position where we started the drag (in local coords).

Object - user_info information provided when this object requested focus.

Returns:

boolean indicating whether the input was consumed (in this case it always is).

drag_feedback

public boolean drag_feedback(event evt,
                             int cur_w,
                             int cur_h,
                             int st_w,
                             int st_h,
                             java.lang.Object user_info)

Handle a movement during a drag for grow. Here we just set our size to follow the size indicated by the drag.

Specified by:

drag_feedback in interface grow_draggable

Parameters:

event - evt the event "causing" the drag.

int - cur_w new width indicated by drag.

int - cur_h new width indicated by drag.

int - st_w initial width of this object.

int - st_h initial height of this object.

Object - user_info information associated with this object at pick time.

Returns:

boolean indicating whether the input was consumed.

drag_feedback

public boolean drag_feedback(event evt,
                             int x_pos,
                             int y_pos,
                             int st_x,
                             int st_y,
                             int grab_x,
                             int grab_y,
                             java.lang.Object user_info)

Handle a movement during a drag for move. Here we just set our position to follow the event location and do the move callback.

Specified by:

drag_feedback in interface move_draggable

Parameters:

event - evt the event "causing" the start of the drag.

int - x_pos x position of new position (in parent's coords).

int - y_pos y position of new position (in parent's coords).

int - start_x x position where we started the drag (in parent's coords).

int - start_y y position where we started the drag (in parent's coords).

int - grab_x x position where we started the grab (in local coords).

int - grab_y y position where we started the grab (in local coords).

Object - user_info information provided when this object requested focus.

Returns:

boolean indicating whether the input was consumed (in this case it always is).

drag_end

public boolean drag_end(event evt,
                        int cur_w,
                        int cur_h,
                        int st_w,
                        int st_h,
                        java.lang.Object user_info)

Handle input corresponding to the end of a drag for grow.

Specified by:

drag_end in interface grow_draggable

Parameters:

event - evt the event "causing" the drag.

int - cur_w new width indicated by drag.

int - cur_h new width indicated by drag.

int - st_w initial width of this object.

int - st_h initial height of this object.

Object - user_info information associated with this object at pick time.

Returns:

boolean indicating whether the input was consumed.

drag_end

public boolean drag_end(event evt,
                        int x_pos,
                        int y_pos,
                        int st_x,
                        int st_y,
                        int grab_x,
                        int grab_y,
                        java.lang.Object user_info)

Handle input corresponding to the end of a drag for move.

Specified by:

drag_end in interface move_draggable

Parameters:

event - evt the event "causing" the start of the drag.

int - x_pos x position of new position (in parent's coords).

int - y_pos y position of new position (in parent's coords).

int - start_x x position where we started the drag (in parent's coords).

int - start_y y position where we started the drag (in parent's coords).

int - grab_x x position where we started the grab (in local coords).

int - grab_y y position where we started the grab (in local coords).

Object - user_info information provided when this object requested focus.

Returns:

boolean indicating whether the input was consumed (in this case it always is).

pick

public void pick(int pt_x,
                 int pt_y,
                 pick_collector pick_list)

Determine if this object is "picked" by the the given point. In this case, we are only picked if they hit our grow handle at the lower right.

Parameters:

int - pt_x the x coordinate of the query point.

int - pt_y the y coordinate of the query point.

pick_collector - pick_list the result list we add ourselves to if we are picked.

Overrides:

pick in class base_interactor

draw_self_local

protected void draw_self_local(drawable d)

Draw the object's current appearance. This draws the children, along with a border rectangle and drag handle at the lower right.

Parameters:

drawable - d the surface to draw on.

Overrides:

draw_self_local in class base_interactor