sub_arctic.lib
Class top_level

java.lang.Object
  |
  +--sub_arctic.lib.min_interactor
        |
        +--sub_arctic.lib.base_interactor
              |
              +--sub_arctic.lib.base_parent_interactor
                    |
                    +--sub_arctic.lib.top_level
Direct Known Subclasses:
debug_lens_top_level, fake_top_level

public class top_level
extends base_parent_interactor

This class is the top interactor of a sub_arctic interface. top_level interactors are hosted in AWT components like interactor_frame, interactor_applet, and interactor_canvas. top_levels should not have constraints placed on their width, height or position, at least not once they have been hosted into an AWT component. The width and height of a top_level are controlled by its containing component.


Field Summary
protected  java.awt.Component _awt_parent
           
protected  java.awt.Rectangle _damage_area
          This holds the area of damage to this interactors display
protected  drawable _offscreen_graphics
          The drawing context for putting graphics on the backing store
protected  java.awt.Image _offscreen_image
          Our backing store (offscreen copy of the image of the interface)
protected  java.awt.Dimension _offscreen_size
          This is the size of the backing store.
 
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
top_level()
          Construct a top level and give it default values for x,y, width and height.
top_level(int x_v, int y_v, int w_v, int h_v)
          Construct a top_level object with know x,y, width and height.
 
Method Summary
 java.awt.Component awt_parent()
          Return the AWT component which hosts this interactor.
 void configure()
          Configure the subtree after it has been damaged, but before it is redrawn.
protected  void damage_fixed()
          Clear the dirty bit for this object (object is not damaged)
 void damage_self(interactor originator, java.lang.Object user_info, java.awt.Point top_left, java.awt.Dimension sz)
          Set the dirty bits and accumulate a damage rectangle of the size at the given point.
 void draw_self(drawable parent_d)
          Draw the image of this interactor (and its children) on the supplied drawable.
 void set_awt_parent(java.awt.Component par)
          Set the component that this this interactor is hosted in.
protected  void setup_offscreen(drawable screen_d)
          Create the offscreen storage used for the backing store.
 
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, constraint_flag_is_set, constraint_flag_string, constraint_on, custom_fun1, custom_fun2, damage_from_child, 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_local, 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

_awt_parent

protected java.awt.Component _awt_parent

_offscreen_image

protected java.awt.Image _offscreen_image
Our backing store (offscreen copy of the image of the interface)

_offscreen_graphics

protected drawable _offscreen_graphics
The drawing context for putting graphics on the backing store

_offscreen_size

protected java.awt.Dimension _offscreen_size
This is the size of the backing store.

_damage_area

protected java.awt.Rectangle _damage_area
This holds the area of damage to this interactors display
Constructor Detail

top_level

public top_level(int x_v,
                 int y_v,
                 int w_v,
                 int h_v)
Construct a top_level object with know x,y, width and height.
Parameters:
int - x_v the x coordinate of this interactor (should be zero unless you want this interactor to not cover all of its hosting AWT parent).
int - y_v the y coordinate of this interactor (should be zero unless you want this interactor to not cover all of its hosting AWT parent).
int - w_v the width of this top_level (this is also tied to the size of the AWT component).
int - h_v the height of this top_level (this is also tied to the size of the AWT component).

top_level

public top_level()
Construct a top level and give it default values for x,y, width and height. We assume that the system will fill in these values later.
Method Detail

set_awt_parent

public void set_awt_parent(java.awt.Component par)
Set the component that this this interactor is hosted in.
Parameters:
Component - par the hosting component.

awt_parent

public java.awt.Component awt_parent()
Return the AWT component which hosts this interactor.
Returns:
Component the AWT component hosting this interactor

setup_offscreen

protected void setup_offscreen(drawable screen_d)
Create the offscreen storage used for the backing store.
Parameters:
drawable - screen_d the drawable corresponding to the screen

draw_self

public void draw_self(drawable parent_d)
Draw the image of this interactor (and its children) on the supplied drawable. This draws first on an off-screen image then throws the whole thing up on the screen in one drawing operation.
Parameters:
drawable - parent_d the drawable to render the image on
Overrides:
draw_self in class base_interactor

configure

public void configure()
Configure the subtree after it has been damaged, but before it is redrawn. Here we are careful not to start an actual configure pass if we have not been damaged since we get redraw requests at the top level due to "outside" damage such as window exposures.
Overrides:
configure in class base_interactor

damage_fixed

protected void damage_fixed()
Clear the dirty bit for this object (object is not damaged)
Overrides:
damage_fixed in class base_interactor

damage_self

public void damage_self(interactor originator,
                        java.lang.Object user_info,
                        java.awt.Point top_left,
                        java.awt.Dimension sz)
Set the dirty bits and accumulate a damage rectangle of the size at the given point.
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_self in class base_interactor