sub_arctic.lib
Class halo_container

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.base_parent_interactor
                    |
                    +--sub_arctic.lib.halo_container
public class halo_container
extends base_parent_interactor

This class is an interactor which draws a halo around the position of one of its decendent interactors. It basically tracks the position of the interactor it is focused on and draws a halo display over the top of its children such that the halo matches the position of the focus object.

Field Summary
protected  java.awt.Color _halo_color
          The color of the halo ring.
protected  int _halo_offset
          The offset of the halo from the reference object.
protected  int _halo_width
          The width of the halo ring.
protected  interactor _reference_obj
          The reference object we draw the halo around.
 
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
halo_container(interactor ref)
          Constructor defaulting to a halo_offset of 2, a width of 6, and a green halo.
halo_container(interactor ref, int halo_off, int halo_w, java.awt.Color halo_clr)
          Constructor with 0,0 position and default width (assuming constraints will set the width).
halo_container(int xv, int yv, int wv, int hv, interactor ref, int halo_off, int halo_w, java.awt.Color halo_clr)
          Full constructor.
 
Method Summary
 void damage_from_child(interactor originator, java.lang.Object user_info, java.awt.Point top_left, java.awt.Dimension sz)
          Override damage propagation to catch damage from our reference object and expand it to include the halo.
protected  void draw_self_local(drawable d)
          Draw the object's current appearance.
 java.awt.Color halo_color()
          The color of the halo ring.
 void halo_color(java.awt.Color clr)
          Set The color of the halo ring.
 int halo_offset()
          The offset of the halo from the reference object.
 void halo_offset(int off)
          Set the offset of the halo from the reference object.
 int halo_width()
          The width of the halo ring.
 void halo_width(int w)
          Set The width of the halo ring.
 interactor reference_obj()
          The reference object we draw the halo around.
 void set_reference_obj(interactor ref)
          Set the reference object we draw the halo around.
 
Methods inherited from class sub_arctic.lib.base_interactor
active_constraints, add_child, add_user_datum, attach_dependent, bound, callback_obj, 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_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, first_callback_num, 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, last_callback_num, 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, pick, picked_by, pos, prev_sibling, register_resource_names, remove_child, remove_child, remove_user_datum, restyle_look_resources, restyle, set_callback_obj, 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_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

_reference_obj

protected interactor _reference_obj
The reference object we draw the halo around. If this is set to null, no halo will be drawn. Note: This must be set to an object which is a decendent of this object (but this is not checked). If this is not the case, the halo will not be updated properly.

_halo_offset

protected int _halo_offset
The offset of the halo from the reference object. Positive offsets refer to positions outside the bounds of the reference objects, while negative offsets are inside the bounds.

_halo_width

protected int _halo_width
The width of the halo ring.

_halo_color

protected java.awt.Color _halo_color
The color of the halo ring.
Constructor Detail

halo_container

public halo_container(int xv,
                      int yv,
                      int wv,
                      int hv,
                      interactor ref,
                      int halo_off,
                      int halo_w,
                      java.awt.Color halo_clr)
Full constructor.
Parameters:
int - xv x position of the interactor
int - yv y position of the interactor
int - wv width of the interactor
int - hv height of the interactor
interactor - ref reference object we draw the halo around. If this is set to null, no halo will be drawn. If this is set to an object which is not a decendent of this object, the halo will not be updated properly.
int - halo_off offset for halo position. An offset to 1 will draw the inside of the halo ring 1 pixel outside the bounds of the reference object.
int - halo_w width of the halo in pixels.
Color - halo_clr color to draw the halo in.

halo_container

public halo_container(interactor ref,
                      int halo_off,
                      int halo_w,
                      java.awt.Color halo_clr)
Constructor with 0,0 position and default width (assuming constraints will set the width).
Parameters:
interactor - ref reference object we draw the halo around. If this is set to null, no halo will be drawn. If this is set to an object which is not a decendent of this object, the halo will not be updated properly.
int - halo_off offset for halo position. An offset to 1 will draw the inside of the halo ring 1 pixel outside the bounds of the reference object.
int - halo_w width of the halo in pixels.
Color - halo_clr color to draw the halo in.

halo_container

public halo_container(interactor ref)
Constructor defaulting to a halo_offset of 2, a width of 6, and a green halo.
Parameters:
interactor - ref reference object we draw the halo around. If this is set to null, no halo will be drawn. If this is set to an object which is not a decendent of this object, the halo will not be updated properly.
Method Detail

reference_obj

public interactor reference_obj()
The reference object we draw the halo around. If this is set to null, no halo will be drawn. Note: This must be set to an object which is a decendent of this object (but this is not checked). If this is not the case, the halo will not be updated properly.
Returns:
iteractor the reference object

set_reference_obj

public void set_reference_obj(interactor ref)
Set the reference object we draw the halo around. If this is set to null, no halo will be drawn. Note: This must be set to an object which is a decendent of this object (but this is not checked). If this is not the case, the halo will not be updated properly.
Parameters:
iteractor - ref the new reference object

halo_offset

public int halo_offset()
The offset of the halo from the reference object. Positive offsets refer to positions outside the bounds of the reference objects, while negative offsets are inside the bounds.
Returns:
int the offset

halo_offset

public void halo_offset(int off)
Set the offset of the halo from the reference object. Positive offsets refer to positions outside the bounds of the reference objects, while negative offsets are inside the bounds.
Parameters:
int - off the new offset

halo_width

public int halo_width()
The width of the halo ring.
Returns:
int the width of the halo ring;

halo_width

public void halo_width(int w)
Set The width of the halo ring.
Parameters:
int - w the new width

halo_color

public java.awt.Color halo_color()
The color of the halo ring.
Returns:
int the color of the halo ring;

halo_color

public void halo_color(java.awt.Color clr)
Set The color of the halo ring.
Parameters:
Color - clr the new color

draw_self_local

protected void draw_self_local(drawable d)
Draw the object's current appearance. Basically we draw the children, then if the reference object is not null, we determine its position and draw a halo for it on top of all the children.
Parameters:
drawable - d a drawable object (set up for this object) to produce output on.
Overrides:
draw_self_local in class base_interactor

damage_from_child

public void damage_from_child(interactor originator,
                              java.lang.Object user_info,
                              java.awt.Point top_left,
                              java.awt.Dimension sz)
Override damage propagation to catch damage from our reference object and expand it to include the halo.
Parameters:
interactor - originator the interactor that caused the damage.
Object - user_info uninterpreted information supplied by the originator at damage time.
Point - top_left top-left corner of child's damage area (in our coordinate system).
Dimension - sz size of the damage area.
Overrides:
damage_from_child in class base_interactor