sub_arctic.input
Interface move_draggable

All Known Subinterfaces:
move_press_draggable, snap_draggable
All Known Implementing Classes:
drag_icon, GrowDragContainer, drag_container, semantic_lens, historical_whiteboard, circ_lens

public abstract interface move_draggable
extends focusable, interactor

Input protocol for objects wishing to receive drag input suitable for moving the object.

See Also:
move_drag_focus_agent

Fields inherited from class sub_arctic.lib.interactor_consts
DAMAGED, ENABLED, ENABLED_HAS_EXT_NOTIFY, ENABLED_IN_PROCESS, ENABLED_IS_HORIZONTAL, ENABLED_OOD, FEATURE_BOTTOM_LEFT, FEATURE_BOTTOM_RIGHT, FEATURE_CENTER, FEATURE_NONE, FEATURE_TOP_LEFT, FEATURE_TOP_RIGHT, FIRST_FREE_FEATURE, FIRST_FREE_FLAG, FIXED_CHILDREN, H, H_HAS_EXT_NOTIFY, H_IN_PROCESS, H_OOD, IS_ENABLED, IS_VISIBLE, OOD_BITS, PART_A, PART_A_HAS_EXT_NOTIFY, PART_A_IN_PROCESS, PART_A_IS_HORIZONTAL, PART_A_OOD, PART_B, PART_B_HAS_EXT_NOTIFY, PART_B_IN_PROCESS, PART_B_IS_HORIZONTAL, PART_B_OOD, STYLE_LOCKED, SUPPORTS_CHILDREN, TRAV_DRAW, TRAV_PICK, TRAV_POST, TRAV_PRE, VISIBLE, VISIBLE_HAS_EXT_NOTIFY, VISIBLE_IN_PROCESS, VISIBLE_IS_HORIZONTAL, VISIBLE_OOD, W, W_HAS_EXT_NOTIFY, W_IN_PROCESS, W_OOD, X, X_HAS_EXT_NOTIFY, X_IN_PROCESS, X_OOD, Y, Y_HAS_EXT_NOTIFY, Y_IN_PROCESS, Y_OOD
 
Fields inherited from class sub_arctic.constraints.std_constraint_consts
FIRST_CHILD, LAST_CHILD, MAX_CHILD, MIN_CHILD, NEXT_SIBLING, NO_CONSTRAINT, OTHER, PARENT, PREV_SIBLING, SELF, ZERO
 
Method Summary
 boolean drag_end(event evt, int x, int y, int start_x, int start_y, int grab_x, int grab_y, java.lang.Object user_info)
          Dispatch input corresponding to the end of a drag.
 boolean drag_feedback(event evt, int x, int y, int start_x, int start_y, int grab_x, int grab_y, java.lang.Object user_info)
          Dispatch a movement during a drag.
 boolean drag_start(event evt, int x, int y, int grab_x, int grab_y, java.lang.Object user_info)
          Dispatch the start of a drag to the object.
 
Methods inherited from interface sub_arctic.input.focusable
focus_set_enter, focus_set_exit
 
Methods inherited from interface sub_arctic.lib.interactor
active_constraints, add_child, add_user_datum, attach_dependent, bound, child_index, child, configure, constraint_flag_is_set, constraint_on, custom_fun1, custom_fun2, damage_from_child, damage_self, damage_self, damage_self, damage_self, damage_self, detach_dependent, do_action, do_action, drag_feature_point, draw_self, enabled_constraint, enabled, eval_enabled, eval_h, eval_part_a, eval_part_b, eval_visible, eval_w, eval_x, eval_y, eval, feature_point_enabled, feature_point, find_child, fixed_children, flag_is_set, 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, next_sibling, num_actions, num_children, num_feature_points, parent, part_a_constraint, part_a, part_b_constraint, part_b, pick, picked_by, pos, prev_sibling, remove_child, remove_child, remove_user_datum, restyle, set_child_index, set_child, set_constraint, set_constraint, set_enabled_constraint, set_enabled_constraint, set_enabled_constraint, set_enabled, set_h_constraint, set_h_constraint, set_h_constraint, set_h, 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_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, size, style_change, supports_children, tag_str, toString, traverse_and_collect, 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
 

Method Detail

drag_start

public boolean drag_start(event evt,
                          int x,
                          int y,
                          int grab_x,
                          int grab_y,
                          java.lang.Object user_info)
Dispatch the start of a drag to the object. Returns true if the drag is accepted (and hence the event consumed). The x,y values give the position of the start of drag in the parent's coordinate system as filtered by the move_drag_filter object established with the move_drag agent (if any). The event retains the original raw coordinate values. grab_x, grab_y indicate the offset of the drag start point from the origin of the object (this indicates the "grab point" within the object). The user_info object passed here will be the one that was given to the agent when focus was established.
Parameters:
event - evt The event which "caused" the drag.
int - x x position where object should be placed at start of drag (in parent's coordinates).
int - y y position where object should be placed at start of drag (in parent's coordinates).
int - grab_x x position where drag started (in local coords).
int - grab_y y position where drag started (in local coords).
Object - user_info uninterpreted information provided when the object was made the move-drag focus.
Returns:
boolean indicating whether the input was consumed.

drag_feedback

public boolean drag_feedback(event evt,
                             int x,
                             int y,
                             int start_x,
                             int start_y,
                             int grab_x,
                             int grab_y,
                             java.lang.Object user_info)
Dispatch a movement during a drag. Returns true if the event should be considered to have been consumed. The x,y values give the current position of the of drag in the parent's coordinate system as filtered by the move_drag_filter object established with the move_drag agent (if any). start_x, start_y give the start position of the drag (again, filtered by the established move_drag_filter object, if any). The event retains the original raw coordinate values. grab_x, grab_y indicate the offset of the drag start point from the origin of the object at the start of dragging (this indicates the "grab point" within the object). The user_info object passed here will be the one that was given to the agent when focus was established.
Parameters:
event - evt The event which "caused" the drag.
int - x x position where object should be placed at start of drag (in parent's coordinates).
int - y y position where object should be placed at start of drag (in parent's coordinates).
int - start_x x position where drag started (in parent's coords).
int - start_y y position where drag started (in parent's coords).
int - grab_x x position where drag started (in local coords).
int - grab_y y position where drag started (in local coords).
Object - user_info uninterpreted information provided when the object was made the move-drag focus.
Returns:
boolean indicating whether the input was consumed.

drag_end

public boolean drag_end(event evt,
                        int x,
                        int y,
                        int start_x,
                        int start_y,
                        int grab_x,
                        int grab_y,
                        java.lang.Object user_info)
Dispatch input corresponding to the end of a drag. Returns true if the even should be considered to have been consumed. The x,y values give the current position of the of drag in the parent's coordinate system as filtered by the move_drag_filter object established with the move_drag agent (if any). start_x, start_y give the start position of the drag (again, filtered by the established move_drag_filter object, if any). The event retains the original raw coordinate values. start_off_x, start_off_y indicate the offset of the drag start point from the origin of the object at the start of dragging (this indicates the "grab point" within the object). The user_info object passed here will be the one that was given to the agent when focus was established.
Parameters:
event - evt The event which "caused" the drag.
int - x x position where object should be placed at start of drag (in parent's coordinates).
int - y y position where object should be placed at start of drag (in parent's coordinates).
int - start_x x position where drag started (in parent's coords).
int - start_y y position where drag started (in parent's coords).
int - grab_x x position where drag started (in local coords).
int - grab_y y position where drag started (in local coords).
Object - user_info uninterpreted information provided when the object was made the move-drag focus.
Returns:
boolean indicating whether the input was consumed.