All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class sub_arctic.lib.base_interactor

java.lang.Object
   |
   +----sub_arctic.lib.min_interactor
           |
           +----sub_arctic.lib.base_interactor

public class base_interactor

extends min_interactor

implements move_drag_filter

This class provides basic capabilities in 12 areas:

• constructor and initialization support,
• geometry management,
• coordinate system
• transformations,
• hierarchy management,
• traversal support,
• layout,
• picking,
• object status,
• output,
• support for common input protocols,
• user information, and
• debugging support.

Note: due to limitations on some (most?) platforms that do not allow for protected methods in interfaces, a number of routines here (and in the interactor interface) that should be protected, are currently public. These are marked by comments in the code, and will be reverted to protected as soon as enough platforms allow.

By convention (here and throughout the system) instance variables are all protected and begin with an underscore ('_'). When access methods are provide, the read method has the same name but without the underscore (e.g., x()), while the write method begins with 'set_' followed by the base name (e.g., set_x()).

Author:

Scott Hudson

_child_index

Index of this object within the parent's child list.

_child_list

Child interactors of this object.

_constraint_flags

Small bitset of flags indicating facts about the constraints of this interactor.

_enabled_constraint

Encoding of constraint on enabled.

_flags

Small bitset of flags indicating facts about this interactor.

_h

Height of the object.

_h_constraint

Encoding of constraint on h.

_parent

Parent of this object.

_part_a_constraint

Encoding of constraint on part_a.

_part_b_constraint

Encoding of constraint on part_b.

_user_data

A collection of Object references we are holding for the user or application.

_visible_constraint

Encoding of constraint on visible.

_w

Width of the object.

_w_constraint

Encoding of constraint on w.

_x

X position of the object's top-left corner in parent's coordinate system.

_x_constraint

Encoding of constraint on x.

_y

Y position of the object's top-left corner in parent's coordinate system.

_y_constraint

Encoding of constraint on y.

default_child_hint

Default initial allocation for child lists

base_interactor()

Constructor that assumes a position of 0,0, and a (temporary) default size.

base_interactor(int, int)

Constructor that assumes a (temporary) default size.

base_interactor(int, int, int, int)

Full constructor.

active_constraints()

Indicate which parts (coordinates/sizes/values) of this object are currently constrained.

add_child(interactor)

Add a child to the end of the child list.

add_user_datum(Object)

Adds a data item to the collection of data items that we are holding for the user of this interactor.

attach_dependent(int, value_consumer, int)

Register something as interested in (dependent on) one of the parts (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B) of this object.

bound()

Bounding rectangle of the object (in parent's coordinate system).

child(int)

Return the child at the given index int the child list (whose first element is at index 0).

child_index()

Return the child index of this interactor (within its parent).

clear_child_list()

Remove all the children of this interactors.

clear_constraint_flag_bit(int)

Set the given constraint_flag bit(s) to false.

clear_flag_bit(int)

Set the given flag bit(s) to false.

configure()

Do the constraint evaluation necessary to make sure all visible objects in the subtree rooted at this object have up-to-date bounds (and other information) prior to drawing.

constraint_flag_is_set(int)

Determine if a particular bit (or bits) is set in the constraint_flag set for the interactor.

constraint_flag_string()

Convert a constraint flag set into a human readable string.

constraint_on(int)

Return a constraint object representing the constraint (if any) attached to the specified part (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B).

custom_fun1(int, int)

A custom function accessible in the constraint system.

custom_fun2(int, int, int)

A custom function accessible in the constraint system.

damage_fixed()

Indicate that any previous damage to the object's appearance has been fixed (by redrawing it).

damage_from_child(interactor, Object, Point, Dimension)

Indicate that a change to a child (or grandchild, etc.) affects the given screen region (expressed in the coordinates of this object).

damage_self()

Indicate that the object has been modified in such as way that any or all of its appearance may change and its area of the screen needs to be redrawn.

damage_self(int, int, int, int)

Indicate that the object has been modified in such as way that its appearance within the given area of the screen (expressed in local coordinates) might change and needs to be redrawn.

damage_self(interactor, Object, Point, Dimension)

Indicate that the object has been modified in such as way that its appearance within the given area of the screen (expressed in local coordinates) might change and needs to be redrawn.

damage_self(Object)

Indicate that the object has been modified in such as way that any or all of its appearance may change and its area of the screen needs to be redrawn.

damage_self(Point, Dimension)

Indicate that the object has been modified in such as way that its appearance within the given area of the screen (expressed in local coordinates) might change and needs to be redrawn.

detach_dependent(int, value_consumer, int)

Remove an (object,part) pair from the dependent (interested in) list associated with a particular part of this object.

drag_feature_point()

Indicate the current "feature point" of an object.

draw_children(drawable)

Helper routine to draw the children of this interactor in normal (low to high index) drawing order.

draw_self(drawable)

Draw the object's current appearance.

draw_self_local(drawable)

Draw the object's current appearance (along with that of its children).

enabled()

Indicate if object is enabled.

enabled_constraint()

Return a constraint object representing the constraint (if any) attached to enabled.

enter_local_coordinates(drawable)

Given a drawable surface set up for the parent coordinate space, create a new drawable set up for the local coordinate space.

eval(int)

Bring the indicated value up to date with respect to any defining constraints.

eval_enabled()

Bring enabled up to date with respect to any defining constraint.

eval_h()

Bring h up to date with respect to any defining constraint.

eval_part_a()

Bring part_a up to date with respect to any defining constraint.

eval_part_b()

Bring part_b up to date with respect to any defining constraint.

eval_visible()

Bring visible up to date with respect to any defining constraint.

eval_w()

Bring w up to date with respect to any defining constraint.

eval_x()

Bring x up to date with respect to any defining constraint.

eval_y()

Bring y up to date with respect to any defining constraint.

exit_local_coords(drawable, drawable)

Do the work to exit the local coordinate system.

feature_point(int)

Access to the "feature points" of an object (by index).

feature_point_enabled(int)

Indicate whether the indicated "feature point" of an object is considered to be enabled.

filter_pt(Point, interactor, Point)

Default point filter.

find_child(interactor)

Find the given child in the child list and return its index.

fixed_children()

Indicate whether this interactor uses a fixed set of children.

flag_is_set(int)

Determine if a particular bit (or bits) is set in the flag set for the interactor.

flag_string()

Convert a flag set into a human readable string.

focus_set_enter(event, focus_dispatch_agent, Object)

Default action for entering a focus set.

focus_set_exit(event, focus_dispatch_agent, Object)

Default action for exiting a focus set.

get_awt_component()

Retrieve the AWT component that this sub_arctic object is drawn within.

get_external_constraint(int)

Get the external value provider (if any) associated with the given part value (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B).

get_part(int)

Get the specified component (X, Y, W, or H) or of object's geometry.

get_top_level()

Retrieve the top_level interactor (if any) that this object is installed (perhaps several levels down) under.

get_value(int)

Get an up-to-date copy of a particular part value(X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B).

global_to_local(int, int)

Transform a point in global coordinate space (that is the coordinate system of the top_level object which roots the interactor tree this object is in) into the local space of the object.

global_to_local(Point)

Transform a point in global coordinate space (that is the coordinate system of the top_level object which roots the interactor tree this object is in) into the local space of the object.

h()

Height of the object.

h_constraint()

Return a constraint object representing the constraint (if any) attached to h.

handle_cycle(int)

Handle a cycle detected in constraints on a given part of this object.

inform_ood(int, int, int)

Inform the object that the indicated part of a potentially related object is out-of-date (this is called from ood_inform_all()).

insert_child(int, interactor)

Insert a child at the given location, moving current children at or after that index further down in the list.

inside_bounds(int, int)

Determine if the given point (in the local coordinates of this object) is inside the extent of this object's normal bound.

into_local(int, int)

Transform a point from parent's coordinate space to local coordinates of this object.

into_local(Point)

Transform a point from parent's coordinate space to local coordinates of this object.

into_parent(int, int)

Transform a local point into the parent's coordinate space.

into_parent(Point)

Transform a local point into the parent's coordinate space.

intrinsic_constraints()

Indicate which parts (coordinates/sizes/values) of this object are intrinsically constrained by the internals of the object.

is_constrained(int)

Indicate whether a specific part is currently constrained.

local_to_global(int, int)

Transform a point in the local coordinate space into the global space (that is the coordinate system of the top_level object which roots the interactor tree this object is in).

local_to_global(Point)

Transform a point in the local coordinate space into the global space (that is the coordinate system of the top_level object which roots the interactor tree this object is in).

mark_all_ood()

Mark all geometric parts of this object out of date.

mark_enabled_ood()

Mark enabled value and anything that directly or indirectly depends on it as out-of-date.

mark_h_ood()

Mark h value and anything that directly or indirectly depends on it as out-of-date.

mark_ood(int)

Mark the given value as out of date.

mark_part_a_ood()

Mark part_a value and anything that directly or indirectly depends on it as out-of-date.

mark_part_b_ood()

Mark part_b value and anything that directly or indirectly depends on it as out-of-date.

mark_reparented_ood()

Mark all our geometric parts out-of-date and tell all potentially dependent objects that all our parts are out-of-date (this gets done when we move around in the hierarchy).

mark_visible_ood()

Mark visible value and anything that directly or indirectly depends on it as out-of-date.

mark_w_ood()

Mark w value and anything that directly or indirectly depends on it as out-of-date.

mark_x_ood()

Mark x value and anything that directly or indirectly depends on it as out-of-date.

mark_y_ood()

Mark y value and anything that directly or indirectly depends on it as out-of-date.

marked_ood()

Indicate which values are currently marked as potentially out of date with respect to their constraints.

move_child_downward(int)

Move the child currently at the given index in the child list down one position in drawing order (which is one position earlier in the list).

move_child_downward(interactor)

Move the given child down one position in drawing order of the child list (which is earlier in the list).

move_child_to_bottom(int)

Move the child currently at the given index in the child list to the bottom in drawing order (which is first in the list).

move_child_to_bottom(interactor)

Move the given child to the bottom of the child list in drawing order (which is first in the list).

move_child_to_top(int)

Move the child currently at the given index in the child list to the top in drawing order (which is last in the list).

move_child_to_top(interactor)

Move the given child to the top of the child list in drawing order (which is last in the list).

move_child_upward(int)

Move the child currently at the given index in the child list up one position in drawing order (which is one position further into the list).

move_child_upward(interactor)

Move the given child up one position in drawing order of the child list (which is later in the list).

move_downward()

Move this object one position lower in its parent's drawing order (which is one position earlier in its child list).

move_to_bottom()

Move this object to the bottom of its parent's drawing order (first in its child list).

move_to_top()

Move this object to the top of its parent's drawing order (last in its child list).

move_upward()

Move this object one position higher in its parent's drawing order (which is one position further into its child list).

new_look_configure()

Recompute the size and other properties of this interactor that may have been changed by a change in style resources.

next_sibling()

Return the next sibling of this object (or null if there is none).

num_children()

Indicate the number of children this interactor currently has.

num_feature_points()

The number of "feature points" of an object.

ood_inform_all(int)

Tell all potentially dependent objects about an out of date part.

parent()

Return the parent of this interactor.

part_a()

Return the value of part_a.

part_a_constraint()

Return a constraint object representing the constraint (if any) attached to part_a.

part_b()

Return the value of part_b.

part_b_constraint()

Return a constraint object representing the constraint (if any) attached to part_b.

pick(int, int, pick_collector)

Determine if this object and/or any of its decedent objects is "picked" by the the given point.

pick_within_children(int, int, pick_collector)

Utility routine to perform pick over children.

picked_by(int, int)

Determine if the given point (in the local coordinates of this object) is inside the extent of the object picking purposes.

pos()

Position of the top-left corner of this object in the parent coordinate system.

prev_sibling()

Return the previous sibling of this object (or null if there is none).

register_resource_names()

Register any style resource names owned by this class.

remove_child(int)

Remove the child found at the given index and return it.

remove_child(interactor)

Remove the given child from the child list.

remove_user_datum(Object)

Removes a data item from the collection of data items that we are holding for the user of this interactor.

restyle(style)

Force a restyle of the interactor under the given style.

restyle_look_resources(style)

"Restyle" current style-based resources used by this interactor to conform to the given style (here in the base class we do nothing).

set_child(int, interactor)

Set the child at the given index replacing any child that was previously there.

set_child_index(int)

Set the child index of this interactor (within its parent).

set_constraint(int, constraint)

Establish a constraint on the given value (one of X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B).

set_constraint(int, value_provider, int)

Establish an "external" or "heavyweight" constraint on the given value (one of X, Y, W, H, VISIBLE, ENABLED, PART_A, PART_B).

set_constraint_flag_bit(int)

Set the given constraint_flag bit(s) to true.

set_constraint_flag_bit(int, boolean)

Set the given constraint_flag bit(s) to the given value.

set_enabled(boolean)

Set the enabled status of the interactor.

set_enabled_constraint(constraint)

Establish a constraint on the enabled value of this object.

set_enabled_constraint(std_ext_constraint)

Establish a standard external constraint on the enabled value of this object.

set_enabled_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the enabled value of this object.

set_flag_bit(int)

Set the given flag bit(s) to true.

set_flag_bit(int, boolean)

Set the given flag bit(s) to the given value.

set_h(int)

Set height of object.

set_h_constraint(constraint)

Establish a constraint on the h value of this object.

set_h_constraint(std_ext_constraint)

Establish a standard external constraint on the h value of this object.

set_h_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the h value of this object.

set_intrinsic_h(int)

Set intrinsic height.

set_intrinsic_size(int, int)

Set intrinsic size.

set_intrinsic_w(int)

Set intrinsic width.

set_parent(interactor)

Set the parent of this interactor.

set_part_a(int)

Set part_a of object.

set_part_a_constraint(constraint)

Establish a constraint on the part_a value of this object.

set_part_a_constraint(std_ext_constraint)

Establish a standard external constraint on the part_a value of this object.

set_part_a_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the part_a value of this object.

set_part_b(int)

Set part_b of object.

set_part_b_constraint(constraint)

Establish a constraint on the part_b value of this object.

set_part_b_constraint(std_ext_constraint)

Establish a standard external constraint on the part_b value of this object.

set_part_b_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the part_b value of this object.

set_pos(int, int)

Set position of this object in parent coordinate system.

set_pos(Point)

Set position of this object in parent coordinate system.

set_raw_enabled(boolean)

Set enabled value directly bypassing the constraint system (but doing screen damage).

set_raw_h(int)

Set h value directly bypassing the constraint system (but doing movement damage).

set_raw_part_a(int)

Set part_a value directly bypassing the constraint system.

set_raw_part_b(int)

Set part_b value directly bypassing the constraint system.

set_raw_visible(boolean)

Set visible value directly bypassing the constraint system (but doing screen damage).

set_raw_w(int)

Set w value directly bypassing the constraint system (but doing movement damage).

set_raw_x(int)

Set x value directly bypassing the constraint system (but doing movement damage).

set_raw_y(int)

Set y value directly bypassing the constraint system (but doing movement damage).

set_size(int, int)

Set the size of the object.

set_style_lock(boolean)

Lock or unlock the style of this interactor.

set_user_info(Object)

Set the uninterpreted "user information" that we are holding for the user of this object.

set_visible(boolean)

Set the visibility of the interactor.

set_visible_constraint(constraint)

Establish a constraint on the visible value of this object.

set_visible_constraint(std_ext_constraint)

Establish a standard external constraint on the visible value of this object.

set_visible_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the visible value of this object.

set_w(int)

Set width of object.

set_w_constraint(constraint)

Establish a constraint on the w value of this object.

set_w_constraint(std_ext_constraint)

Establish a standard external constraint on the w value of this object.

set_w_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the w value of this object.

set_x(int)

Set x component of position in parent coordinate system.

set_x_constraint(constraint)

Establish a constraint on the x value of this object.

set_x_constraint(std_ext_constraint)

Establish a standard external constraint on the x value of this object.

set_x_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the x value of this object.

set_y(int)

Set y component of position in parent coordinate system.

set_y_constraint(constraint)

Establish a constraint on the y value of this object.

set_y_constraint(std_ext_constraint)

Establish a standard external constraint on the y value of this object.

set_y_constraint(value_provider, int)

Establish an "external" or "heavyweight" constraint on the y value of this object.

setup_for_children()

Helper method to set up object to support children.

setup_for_children(int)

Helper method to set up object to support an expandable set of children.

setup_for_fixed_children(int)

Helper method to set up object to support a fixed set of children.

size()

Size of the object.

style_change()

This calls style_change_local() on itself and all its descendents to notify them of a change in the global current style.

style_change_local()

Inform the interactor that the global current style has changed and that it may need to restyle itself.

supports_children()

Indicate whether this interactor supports children.

tag_str()

Convert to a small tag string which indicates the type of interactor along with a (hopefully unique) integer (its hashCode) that can be used to identify it during debugging.

toString()

Convert to a human readable string.

traverse_and_collect(int, int, interactor_pred, interactor_pred, traversal_xform, Object, pick_collector)

Do a traversal of the interactor tree to collect nodes meeting some criteria (or perform actions on qualifying nodes).

traverse_and_collect_children(int, int, boolean, interactor_pred, interactor_pred, traversal_xform, Object, pick_collector)

Helper routine for traverse_and_collect() -- does recursive traversal of children in either left-to-right or right-to-left order.

traverse_and_collect_parent(int, interactor_pred, Object, pick_collector)

Helper routine for traverse_and_collect() -- this does test on a single (parent) object.

trivial_reject(drawable)

Do a trivial reject test that indicates whether the bounds of this object are entirely outside the clipping region of the given drawable object.

trivial_reject(drawable, Rectangle)

Do a trivial reject test that indicates whether the given bounding box is entirely outside the clipping region of the given drawable object.

user_data()

Access to the collection of data items that we are holding for the user of this interactor.

user_info()

Access to uninterpreted "user information" that we are holding for the user of this object.

value_ood(int, value_provider, int)

Indicate that a part value (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B) with an external constraint attached should be marked out-of-date because something it depends on (externally) is out-of-date.

visible()

Indicate if the object considers itself visible.

visible_constraint()

Return a constraint object representing the constraint (if any) attached to visible.

w()

Width of the object.

w_constraint()

Return a constraint object representing the constraint (if any) attached to w.

x()

X position of the top-left corner of this object in the parent coordinate system.

x_constraint()

Return a constraint object representing the constraint (if any) attached to x.

x_into_local(int)

Transform an x value from parent's coordinate space to local coords.

x_into_parent(int)

Transform an x value form local coordinates into the parent's coordinate space.

y()

Y position of the top-left corner of this object in the parent coordinate system.

y_constraint()

Return a constraint object representing the constraint (if any) attached to y.

y_into_local(int)

Transform an y value from parent's coordinate space to local coords.

y_into_parent(int)

Transform an y value form local coordinates into the parent's coordinate space.

  protected int _x

X position of the object's top-left corner in parent's coordinate system. Like all instance variables of this class, this variable should probably never be accessed directly -- use the public access methods instead.

See Also:

x, set_x

  protected int _y

Y position of the object's top-left corner in parent's coordinate system. Like all instance variables of this class, this variable should probably never be accessed directly -- use the public access methods instead.

See Also:

y, set_y

  protected int _w

Width of the object. Like all instance variables of this class, this variable should probably never be accessed directly -- use the public access methods instead.

See Also:

w, set_w

  protected int _h

Height of the object. Like all instance variables of this class, this variable should probably never be accessed directly -- use the public access methods instead.

See Also:

h, set_h

  protected int _x_constraint

Encoding of constraint on x. This instance variable should never be set directly.

See Also:

constraint, x_constraint, set_x_constraint

  protected int _y_constraint

Encoding of constraint on y. This instance variable should never be set directly.

See Also:

constraint, y_constraint, set_y_constraint

  protected int _w_constraint

Encoding of constraint on w. This instance variable should never be set directly.

See Also:

constraint, w_constraint, set_w_constraint

  protected int _h_constraint

Encoding of constraint on h. This instance variable should never be set directly.

See Also:

constraint, h_constraint, set_h_constraint

  protected int _visible_constraint

Encoding of constraint on visible. This instance variable should never be set directly.

See Also:

constraint, visible_constraint, set_visible_constraint

  protected int _enabled_constraint

Encoding of constraint on enabled. This instance variable should never be set directly.

See Also:

constraint, enabled_constraint, set_enabled_constraint

  protected int _part_a_constraint

Encoding of constraint on part_a. This instance variable should never be set directly.

See Also:

constraint, part_a_constraint, set_part_a_constraint

  protected int _part_b_constraint

Encoding of constraint on part_b. This instance variable should never be set directly.

See Also:

constraint, part_b_constraint, set_part_b_constraint

  protected interactor _parent

Parent of this object. Can be null if object is not currently installed in an interactor tree, or if this is a top_level interactor. This instance variable should never be set directly.

See Also:

parent, set_parent

  protected int _child_index

Index of this object within the parent's child list. This instance variable should never be set directly.

See Also:

child_index, set_child_index

  protected Vector _child_list

Child interactors of this object. _child_list will be null for interactor classes that do not support children (in that case, the SUPPORTS_CHILDREN bit in _flags should also be 0). Interactor classes with FIXED_CHILDREN set to 1 will always have the same number of children and attempting to assign outside that range will cause an error. In general, entries may be null.

See Also:

num_children, child, set_child, add_child, insert_child, remove_child, find_child, move_child_to_top, move_child_to_bottom, move_child_upward, move_child_downward

  protected int _flags

Small bitset of flags indicating facts about this interactor. See interactor_consts.java for possible values and their meaning. Flag values are normally tested and set by flag_is_set(), set_flag_bit(), and clear_flag_bit().

See Also:

interactor_consts, flag_is_set, set_flag_bit, clear_flag_bit

  protected int _constraint_flags

Small bitset of flags indicating facts about the constraints of this interactor. See interactor_consts.java for possible values and their meaning. Flag values are normally tested and set by constraint_flag_is_set(), set_constraint_flag_bit(), and clear_constraint_flag_bit().

See Also:

interactor_consts, constraint_flag_is_set, set_constraint_flag_bit, clear_constraint_flag_bit

  protected Vector _user_data

A collection of Object references we are holding for the user or application. The Objects in this collection are attached to the interactor, but otherwise the toolkit itself does not touch them. This allows for example, callback objects to retrieve application specific information related to this object.

See Also:

user_data, add_user_datum, remove_user_datum, user_info, set_user_info

  protected final static int default_child_hint

Default initial allocation for child lists

  public base_interactor(int x_v,
                         int y_v,
                         int w_v,
                         int h_v)

Full constructor.

Parameters:

int - x_v x position of this interactor within its parent's coordinate system.

int - y_v y position of this interactor within its parent's coordinate system.

int - w_v width of this interactor.

int - h_v height of this interactor.

  public base_interactor(int x_v,
                         int y_v)

Constructor that assumes a (temporary) default size.

Parameters:

int - x_v x position of this interactor within its parent's coordinate system.

int - y_v y position of this interactor within its parent's coordinate system.

  public base_interactor()

Constructor that assumes a position of 0,0, and a (temporary) default size.

  protected void setup_for_children(int size_hint)

Helper method to set up object to support an expandable set of children. This will normally be called from the constructor of a subclass that wants to support children (by default, base_interactor does not). The size_hint indicates how much storage to initially allocate in the child list Vector (however, num_children() initially returns 0 regardless of what is given here).

Parameters:

int - size_hint hint for initial size allocation for the child vector.

  protected void setup_for_children()

Helper method to set up object to support children. This will normally be called from the constructor of a subclass that wants to support children (by default, base_interactor does not).

  protected void setup_for_fixed_children(int number)

Helper method to set up object to support a fixed set of children. This will normally be called from the constructor of a subclass that wants to support children (by default base_interactor does not), but which either assigns specific meanings/roles to specific children, or for some other reason limits the number of children it will support. This method allocates the given number of slots for children and sets them each to null. int number the number of children this object will have.

  public Point pos()

Position of the top-left corner of this object in the parent coordinate system. If either coordinate is controlled by a constraint, it will be brought up to date before this value is returned.

Returns:

Point the position of the object.

Overrides:

pos in class min_interactor

  public int x()

X position of the top-left corner of this object in the parent coordinate system. If this coordinate is controlled by a constraint, it will be brought up to date before this value is returned.

Returns:

int the x position of the object.

Overrides:

x in class min_interactor

  public int y()

Y position of the top-left corner of this object in the parent coordinate system. If this coordinate is controlled by a constraint, it will be brought up to date before this value is returned.

Returns:

int the y position of the object.

Overrides:

y in class min_interactor

  public Dimension size()

Size of the object. If either the width or height of the object is controlled by a constraint, it will be brought up to date before this value is returned.

Returns:

Dimension the size of the object.

Overrides:

size in class min_interactor

  public int w()

Width of the object. If this value is controlled by a constraint, it will be brought up to date before being returned.

Returns:

int the width of the object.

Overrides:

w in class min_interactor

  public int h()

Height of the object. If this value is controlled by a constraint, it will be brought up to date before being returned.

Returns:

int the height of the object.

Overrides:

h in class min_interactor

  public Rectangle bound()

Bounding rectangle of the object (in parent's coordinate system).

Returns:

Rectangle the bounding rectangle of the object.

Overrides:

bound in class min_interactor

  public int get_part(int what_code)

Get the specified component (X, Y, W, or H) or of object's geometry. This also now works for VISIBLE, ENABLED, PART_A, and PART_B.

Parameters:

what_code - part number whose value is being requested.

Returns:

int the value of the requested part (after brining any attached constraints up-to-date).

Overrides:

get_part in class min_interactor

  public void set_pos(int xv,
                      int yv)

Set position of this object in parent coordinate system.

Parameters:

int - yv y coordinate of the position.

int - xv x coordinate of the position.

Overrides:

set_pos in class min_interactor

  public void set_pos(Point p)

Set position of this object in parent coordinate system.

Parameters:

Point - p the new position.

Overrides:

set_pos in class min_interactor

  protected void set_raw_x(int v)

Set x value directly bypassing the constraint system (but doing movement damage). This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Parameters:

int - v the new value for x.

  public void set_x(int v)

Set x component of position in parent coordinate system.

Parameters:

int - v the new value for x.

Overrides:

set_x in class min_interactor

  protected void set_raw_y(int v)

Set y value directly bypassing the constraint system (but doing movement damage). This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Parameters:

int - v the new value for y.

  public void set_y(int v)

Set y component of position in parent coordinate system.

Parameters:

int - v the new value for y.

Overrides:

set_y in class min_interactor

  public void set_size(int wv,
                       int hv)

Set the size of the object.

Parameters:

int - wv the new value for w.

int - hv the new value for h.

Overrides:

set_size in class min_interactor

  protected void set_intrinsic_size(int wv,
                                    int hv)

Set intrinsic size. This method is called by subclasses to establish or change the size of the interactor when its size is considered to be intrinsically constrained. This method marks values out of date, but does not declare damage for the object.

Parameters:

int - wv the new value for w.

int - hv the new value for h.

  protected void set_raw_w(int v)

Set w value directly bypassing the constraint system (but doing movement damage). This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Parameters:

int - v the new value for w.

  public void set_w(int v)

Set width of object.

Parameters:

int - v the new value for y.

Overrides:

set_w in class min_interactor

  protected void set_intrinsic_w(int wv)

Set intrinsic width. This method is called by subclasses to establish or change the width of the interactor when its width is considered to be intrinsically constrained. This method marks values out of date, but does not declare damage for the object.

Parameters:

int - wv new value for w.

  protected void set_raw_h(int v)

Set h value directly bypassing the constraint system (but doing movement damage). This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Parameters:

int - v the new value for the height.

  public void set_h(int v)

Set height of object.

Parameters:

int - v the new value for the height.

Overrides:

set_h in class min_interactor

  protected void set_intrinsic_h(int hv)

Set intrinsic height. This method is called by subclasses to establish or change the height of the interactor when its width is considered to be intrinsically constrained. This method marks values out of date, but does not declare damage for the object.

Parameters:

int - hv the new value for the height.

  public boolean visible()

Indicate if the object considers itself visible. If a constraint is attached the value will be brought up-to-date with respect to the constraint first.

Returns:

boolean the visibility status of the object

Overrides:

visible in class min_interactor

  protected void set_raw_visible(boolean v)

Set visible value directly bypassing the constraint system (but doing screen damage). This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Parameters:

boolean - v the new visibility status.

  public void set_visible(boolean v)

Set the visibility of the interactor.

Parameters:

boolean - v the new visibility status.

Overrides:

set_visible in class min_interactor

  public boolean enabled()

Indicate if object is enabled. If a constraint is attached the value will be brought up-to-date with respect to the constraint first.

Note: currently setting an object disabled will keep it from being picked by the normal picking mechanism. This will (normally) disable positional inputs and as a side effect most focus based input (unless the the object is already the focus). However, since enabled status was added after many of the core interactor classes were created, for the most part the interactors in the library do not yet properly reflect the enable/disable status in their visual appearance. This is an important deficiency which we hope to correct in future releases.

Returns:

boolean the enable status of the interactor.

Overrides:

enabled in class min_interactor

  protected void set_raw_enabled(boolean v)

Set enabled value directly bypassing the constraint system (but doing screen damage). This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Parameters:

boolean - v the new enable status.

  public void set_enabled(boolean v)

Set the enabled status of the interactor.

Parameters:

boolean - v new value of enabled.

Overrides:

set_enabled in class min_interactor

  public int part_a()

Return the value of part_a. Part_a is a generic value that may be maintained by an interactor to represent some specific semantically meaningful part of its state that it wants to make available for use in the (lightweight) constraint system. For example, sliders make their "thumb value" available as part_a. Here in the base class, part_a is not implemented (it is intrinsically constrained to 0). see the commented out sample code in the source for details of how to implement a custom part_a for interactor subclasses. Alternately, you can inherit from the interactor_with_parts or parent_with_parts classes rather than base_interactor.

Returns:

int the value of part_a (after constraint evaluation if necessary).

Overrides:

part_a in class min_interactor

See Also:

interactor_with_parts, parent_with_parts

  protected void set_raw_part_a(int v)

Set part_a value directly bypassing the constraint system. This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Here in the base class we have not implemented part_a, so this has no effect. In subclasses, this should first test if this is a change. if it is, then this should modify the value and (in most cases) call damage_self(). See the commented out sample code in the source for complete details. Better yet you can just inherit an implementation from interactor_with_parts or parent_with_parts.

Parameters:

int - v the new value for part_a

See Also:

interactor_with_parts, parent_with_parts

  public void set_part_a(int v)

Set part_a of object. If part is controlled by a constraint, an exception is thrown. Here in the base class this is always the case.

For subclasses implementing part_a see the commented out sample code in the source or inherit from interactor_with_parts or parent_with_parts.

Parameters:

int - v the new value for part_a

Overrides:

set_part_a in class min_interactor

  public int part_b()

Return the value of part_b. Part_b is a generic value that may be maintained by an interactor to represent some specific semantically meaningful part of its state that it wants to make available for use in the (lightweight) constraint system. For example, sliders make their "thumb value" available as part_b. Here in the base class, part_b is not implemented (it is intrinsically constrained to 0). see the commented out sample code in the source for details of how to implement a custom part_b for interactor subclasses. Alternately, you can inherit from the interactor_with_parts or parent_with_parts classes rather than base_interactor.

Returns:

int the value of part_b (after constraint evaluation if necessary).

Overrides:

part_b in class min_interactor

See Also:

interactor_with_parts, parent_with_parts

  protected void set_raw_part_b(int v)

Set part_b value directly bypassing the constraint system. This should normally only be done by the constraint system or some other part of the system which takes care of marking things out-of-date, etc. itself.

Here in the base class we have not implemented part_b, so this has no effect. In subclasses, this should first test if this is a change. if it is, then this should modify the value and (in most cases) call damage_self(). See the commented out sample code in the source for complete details. Better yet you can just inherit an implementation from interactor_with_parts or parent_with_parts.

Parameters:

int - v the new value for part_b

See Also:

interactor_with_parts, parent_with_parts

  public void set_part_b(int v)

Set part_b of object. If part is controlled by a constraint, an exception is thrown. Here in the base class this is always the case.

For subclasses implementing part_b see the commented out sample code in the source or inherit from interactor_with_parts or parent_with_parts.

Parameters:

int - v the new value for part_b

Overrides:

set_part_b in class min_interactor

  public Point local_to_global(int xv,
                               int yv)

Transform a point in the local coordinate space into the global space (that is the coordinate system of the top_level object which roots the interactor tree this object is in).

Parameters:

int - xv x coordinate of point to transform.

int - yv y coordinate of point to transform.

Returns:

Point resulting point.

Overrides:

local_to_global in class min_interactor

  public Point local_to_global(Point local_pt)

Transform a point in the local coordinate space into the global space (that is the coordinate system of the top_level object which roots the interactor tree this object is in).

Parameters:

Point - local_pt point to transform.

Returns:

Point resulting point.

Overrides:

local_to_global in class min_interactor

  public Point global_to_local(int xv,
                               int yv)

Transform a point in global coordinate space (that is the coordinate system of the top_level object which roots the interactor tree this object is in) into the local space of the object.

Parameters:

int - xv x coordinate of point to transform.

int - yv y coordinate of point to transform.

Returns:

Point resulting point.

Overrides:

global_to_local in class min_interactor

  public Point global_to_local(Point global_pt)

Transform a point in global coordinate space (that is the coordinate system of the top_level object which roots the interactor tree this object is in) into the local space of the object.

Parameters:

Point - global_pt point to transform.

Returns:

Point resulting point.

Overrides:

global_to_local in class min_interactor

  public Point into_local(int xv,
                          int yv)

Transform a point from parent's coordinate space to local coordinates of this object.

Parameters:

int - xv x coordinate of point to transform.

int - yv y coordinate of point to transform.

Returns:

Point resulting point.

Overrides:

into_local in class min_interactor

  public Point into_local(Point parent_pt)

Transform a point from parent's coordinate space to local coordinates of this object.

Parameters:

Point - parent_pt point to transform.

Returns:

Point resulting point.

Overrides:

into_local in class min_interactor

  public int x_into_local(int xv)

Transform an x value from parent's coordinate space to local coords.

Parameters:

int - xv x coordinate of to transform.

Returns:

int resulting x coordinate.

Overrides:

x_into_local in class min_interactor

  public int y_into_local(int yv)

Transform an y value from parent's coordinate space to local coords.

Parameters:

int - yv y coordinate of to transform.

Returns:

int resulting y coordinate.

Overrides:

y_into_local in class min_interactor

  public Point into_parent(int xv,
                           int yv)

Transform a local point into the parent's coordinate space.

Parameters:

int - xv x coordinate of point to transform.

int - yv y coordinate of point to transform.

Returns:

Point resulting point.

Overrides:

into_parent in class min_interactor

  public Point into_parent(Point local_pt)

Transform a local point into the parent's coordinate space.

Parameters:

Point - local_pt point to transform.

Returns:

Point resulting point.

Overrides:

into_parent in class min_interactor

  public int x_into_parent(int xv)

Transform an x value form local coordinates into the parent's coordinate space.

Parameters:

int - xv x coordinate of to transform.

Returns:

int resulting x coordinate.

Overrides:

x_into_parent in class min_interactor

  public int y_into_parent(int yv)

Transform an y value form local coordinates into the parent's coordinate space.

Parameters:

int - yv y coordinate of to transform.

Returns:

int resulting y coordinate.

Overrides:

y_into_parent in class min_interactor

  public interactor parent()

Return the parent of this interactor.

Returns:

interactor the parent of this interactor or null if this object is an orphan or is a top_level (root) interactor.

Overrides:

parent in class min_interactor

  public void set_parent(interactor par)

Set the parent of this interactor.

Warning: this method should be protected (but isn't since various implementations don't allow protected in interfaces). This method should not be invoked from "outside the system". Always use the normal child manipulation routines instead.

Parameters:

interactor - par new parent for this object.

Overrides:

set_parent in class min_interactor

  public top_level get_top_level()

Retrieve the top_level interactor (if any) that this object is installed (perhaps several levels down) under. This top_level interactor provides the "global" coordinate space for this interactor. Null is returned if this object is not currently installed somewhere under a top_level interactor.

Returns:

top_level the top_level object we are installed under or null if there is no such object.

Overrides:

get_top_level in class min_interactor

  public Component get_awt_component()

Retrieve the AWT component that this sub_arctic object is drawn within. If this object is not part of an active interface, null will be returned.

Overrides:

get_awt_component in class min_interactor

  public int child_index()

Return the child index of this interactor (within its parent). This value is obviously not going to be correct for orphan objects.

Returns:

int index of this interactor within its parent's child list.

Overrides:

child_index in class min_interactor

  public void set_child_index(int indx)

Set the child index of this interactor (within its parent).

Warning: this method should be protected (but isn't since various implementations don't allow protected in interfaces). This method should not be invoked except from the within the normal child manipulation routines.Always use those routines instead.

Parameters:

int - indx the new index of the child.

Overrides:

set_child_index in class min_interactor

  public interactor prev_sibling()

Return the previous sibling of this object (or null if there is none).

Returns:

interactor the child before this one in its parent's child list or null if there is no such object.

Overrides:

prev_sibling in class min_interactor

  public interactor next_sibling()

Return the next sibling of this object (or null if there is none).

Returns:

interactor the child after this one in its parent's child list or null if there is no such object.

Overrides:

next_sibling in class min_interactor

  public boolean supports_children()

Indicate whether this interactor supports children. Interactors that support children will have their SUPPORTS_CHILDREN flag set.

Returns:

boolean indicating whether this object supports children.

Overrides:

supports_children in class min_interactor

  public boolean fixed_children()

Indicate whether this interactor uses a fixed set of children. This is done if the interactor assigns fixed roles/meanings to particular children, or for some other reason limits its total number of children. If this is not set, then the child list is expandable and the system will move entries over to fill in null children (although you cannot rely on this behavior since it is possible to explicitly set a child at a given index to null and sneak nulls into the child list in other ways). If this is set, then removed children will be set to null, and the child list will not be otherwise modified. In addition, if this is set, then operations that would normally reorder children throw an exception instead. An object which uses fixed children will have its FIXED_CHILDREN flag set.

Returns:

boolean indicating whether this object supports fixed children.

Overrides:

fixed_children in class min_interactor

  public int num_children()

Indicate the number of children this interactor currently has. For interactors with fixed children, the interactor will always have this this number, hence it is also the maximum number of children. Interactors that do not support children always return 0. Note: there may be null children in the child list but they are counted as children here.

Returns:

int number of slots in this object's child list.

Overrides:

num_children in class min_interactor

  public interactor child(int i)

Return the child at the given index int the child list (whose first element is at index 0). If the index given is beyond the range of the current child list, or the interactor does not support children, then null is returned. Requests for negative children cause an exception. Note that child lists may contain null children.

Parameters:

int - i the index of the requested child.

Returns:

interactor the child object at the requested index.

Overrides:

child in class min_interactor

  public void set_child(int at_indx,
                        interactor chld)

Set the child at the given index replacing any child that was previously there. The child list will be expanded as necessary to accommodate the given child. If the child list is expanded, missing children will be set to null.

Parameters:

int - at_indx position in the child list to replace.

interactor - chld the child object to place at that position.

Overrides:

set_child in class min_interactor

  public void add_child(interactor chld)

Add a child to the end of the child list.

Parameters:

interactor - chld the child to add.

Overrides:

add_child in class min_interactor

  public void insert_child(int at_indx,
                           interactor chld)

Insert a child at the given location, moving current children at or after that index further down in the list.

Overrides:

insert_child in class min_interactor

  public void clear_child_list()

Remove all the children of this interactors. For interactors with no children, this call has no effect.

  public interactor remove_child(int at_indx)

Remove the child found at the given index and return it. For interactors with fixed children, the child slot at the index is set to null. For other interactors, later children are moved over in the list to fill in the gap.

Parameters:

int - at_indx the index to remove the child from.

Overrides:

remove_child in class min_interactor

  public void remove_child(interactor the_child)

Remove the given child from the child list. For interactors with fixed children, the child slot is set to null. For other interactors, later children are moved up in the list to fill in the gap. If the child is not in the child list, nothing happens.

Parameters:

interactor - the_child the child to be removed.

Overrides:

remove_child in class min_interactor

  public int find_child(interactor the_child)

Find the given child in the child list and return its index. If the child is no in the child list -1 is returned.

Parameters:

interactor - the_child the child we are searching for.

Returns:

int the index of that child in the child list or -1 if the child is not found.

Overrides:

find_child in class min_interactor

  public void move_child_to_top(int chld_indx)

Move the child currently at the given index in the child list to the top in drawing order (which is last in the list).

Parameters:

int - chld_indx the index of the child to move.

Overrides:

move_child_to_top in class min_interactor

  public void move_child_to_top(interactor the_child)

Move the given child to the top of the child list in drawing order (which is last in the list). If the child is not in the list, nothing happens.

Parameters:

interactor - the_child the child to move.

Overrides:

move_child_to_top in class min_interactor

  public void move_child_to_bottom(int chld_indx)

Move the child currently at the given index in the child list to the bottom in drawing order (which is first in the list).

Parameters:

int - chld_indx the index of the child to move.

Overrides:

move_child_to_bottom in class min_interactor

  public void move_child_to_bottom(interactor the_child)

Move the given child to the bottom of the child list in drawing order (which is first in the list). If the child is not in the list, nothing happens.

Parameters:

interactor - the_child the child to move.

Overrides:

move_child_to_bottom in class min_interactor

  public void move_child_upward(int chld_indx)

Move the child currently at the given index in the child list up one position in drawing order (which is one position further into the list).

Parameters:

int - chld_indx the index of the child to move.

Overrides:

move_child_upward in class min_interactor

  public void move_child_upward(interactor the_child)

Move the given child up one position in drawing order of the child list (which is later in the list). If the child is not in the list, nothing happens.

Parameters:

interactor - the_child the child to move.

Overrides:

move_child_upward in class min_interactor

  public void move_child_downward(int chld_indx)

Move the child currently at the given index in the child list down one position in drawing order (which is one position earlier in the list).

Parameters:

int - chld_indx the index of the child to move.

Overrides:

move_child_downward in class min_interactor

  public void move_child_downward(interactor the_child)

Move the given child down one position in drawing order of the child list (which is earlier in the list). If the child is not in the list, nothing happens.

Parameters:

interactor - the_child the child to move.

Overrides:

move_child_downward in class min_interactor

  public void move_to_top()

Move this object to the top of its parent's drawing order (last in its child list).

Overrides:

move_to_top in class min_interactor

  public void move_to_bottom()

Move this object to the bottom of its parent's drawing order (first in its child list).

Overrides:

move_to_bottom in class min_interactor

  public void move_upward()

Move this object one position higher in its parent's drawing order (which is one position further into its child list).

Overrides:

move_upward in class min_interactor

  public void move_downward()

Move this object one position lower in its parent's drawing order (which is one position earlier in its child list).

Overrides:

move_downward in class min_interactor

  public int intrinsic_constraints()

Indicate which parts (coordinates/sizes/values) of this object are intrinsically constrained by the internals of the object. For, example an icon object with a fixed size image would intrinsically constrain its width and height. The result is reported as an integer formed from or-ing together zero or more of the constants: X, Y, W, H, VISIBLE, ENABLED, PART_A or PART_B (for the icon described above that would be W | H).

Returns:

int bitset indicating which parts of the object are intrinsically constrained.

Overrides:

intrinsic_constraints in class min_interactor

  public int active_constraints()

Indicate which parts (coordinates/sizes/values) of this object are currently constrained. This always includes the intrinsic constraints, but may also indicate other constraints that have been applied to the object. The result is reported as an integer formed from or-ing together zero or more of the constants: X, Y, W, H, VISIBLE, ENABLED, PART_A and PART_B. Values that are constrained may not be assigned to directly (an exception will be thrown).

Parameters:

int - bitset indicating which parts of the object are constrained.

Overrides:

active_constraints in class min_interactor

  public boolean is_constrained(int coord_code)

Indicate whether a specific part is currently constrained. The query argument should be one of the constants: X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B. Values that are constrained may not be assigned to (an exception will be thrown).

Parameters:

int - coord_code the object part we are enquiring about.

Returns:

boolean indicating whether it is constrained.

Overrides:

is_constrained in class min_interactor

  public constraint constraint_on(int coord_code)

Return a constraint object representing the constraint (if any) attached to the specified part (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B).

Parameters:

int - coord_code the code for the object part in question.

Returns:

constraint the constraint attached to the given part.

Overrides:

constraint_on in class min_interactor

  public constraint x_constraint()

Return a constraint object representing the constraint (if any) attached to x.

Returns:

constraint the constraint attached to x.

Overrides:

x_constraint in class min_interactor

  public constraint y_constraint()

Return a constraint object representing the constraint (if any) attached to y.

Returns:

constraint the constraint attached to x.

Overrides:

y_constraint in class min_interactor

  public constraint w_constraint()

Return a constraint object representing the constraint (if any) attached to w.

Returns:

constraint the constraint attached to w.

Overrides:

w_constraint in class min_interactor

  public constraint h_constraint()

Return a constraint object representing the constraint (if any) attached to h.

Returns:

constraint the constraint attached to h.

Overrides:

h_constraint in class min_interactor

  public constraint visible_constraint()

Return a constraint object representing the constraint (if any) attached to visible.

Returns:

constraint the constraint attached to visible.

Overrides:

visible_constraint in class min_interactor

  public constraint enabled_constraint()

Return a constraint object representing the constraint (if any) attached to enabled.

Returns:

constraint the constraint attached to enabled.

Overrides:

enabled_constraint in class min_interactor

  public constraint part_a_constraint()

Return a constraint object representing the constraint (if any) attached to part_a.

Returns:

constraint the constraint attached to part_a.

Overrides:

part_a_constraint in class min_interactor

  public constraint part_b_constraint()

Return a constraint object representing the constraint (if any) attached to part_b.

Returns:

constraint the constraint attached to part_a.

Overrides:

part_b_constraint in class min_interactor

  public void set_constraint(int coord_code,
                             constraint a_constraint)

Establish a constraint on the given value (one of X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B). This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

int - coord_code code for the part whose constraint we replace.

constraint - a_constraint the constraint to replace it with.

Overrides:

set_constraint in class min_interactor

  public void set_constraint(int code,
                             value_provider ext_obj,
                             int ext_part)

Establish an "external" or "heavyweight" constraint on the given value (one of X, Y, W, H, VISIBLE, ENABLED, PART_A, PART_B). This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

int - coord_code code for the part whose constraint we replace.

constraint - a_constraint the constraint to replace it with.

Overrides:

set_constraint in class min_interactor

  public void set_x_constraint(constraint a_constraint)

Establish a constraint on the x value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception. Only horizontally oriented constraints can be attached to x (if a vertically oriented value is need, use an external constraint).

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_x_constraint in class min_interactor

  public void set_x_constraint(value_provider ext_obj,
                               int ext_part)

Establish an "external" or "heavyweight" constraint on the x value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_x_constraint in class min_interactor

  public void set_x_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the x value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_x_constraint in class min_interactor

  public void set_y_constraint(constraint a_constraint)

Establish a constraint on the y value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception. Only vertically oriented constraints can be attached to y (if a horizontally oriented value is need, use an external constraint).

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_y_constraint in class min_interactor

  public void set_y_constraint(value_provider ext_obj,
                               int ext_part)

Establish an "external" or "heavyweight" constraint on the y value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_y_constraint in class min_interactor

  public void set_y_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the y value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_y_constraint in class min_interactor

  public void set_w_constraint(constraint a_constraint)

Establish a constraint on the w value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception. Only horizontally oriented constraints can be attached to w (if a vertically oriented value is need, use an external constraint).

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_w_constraint in class min_interactor

  public void set_w_constraint(value_provider ext_obj,
                               int ext_part)

Establish an "external" or "heavyweight" constraint on the w value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_w_constraint in class min_interactor

  public void set_w_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the w value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_w_constraint in class min_interactor

  public void set_h_constraint(constraint a_constraint)

Establish a constraint on the h value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception. Only vertically oriented constraints can be attached to h (if a horizontally oriented value is need, use an external constraint).

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_h_constraint in class min_interactor

  public void set_h_constraint(value_provider ext_obj,
                               int ext_part)

Establish an "external" or "heavyweight" constraint on the h value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_h_constraint in class min_interactor

  public void set_h_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the h value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_h_constraint in class min_interactor

  public void set_visible_constraint(constraint a_constraint)

Establish a constraint on the visible value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_visible_constraint in class min_interactor

  public void set_visible_constraint(value_provider ext_obj,
                                     int ext_part)

Establish an "external" or "heavyweight" constraint on the visible value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_visible_constraint in class min_interactor

  public void set_visible_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the visible value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_visible_constraint in class min_interactor

  public void set_enabled_constraint(constraint a_constraint)

Establish a constraint on the enabled value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_enabled_constraint in class min_interactor

  public void set_enabled_constraint(value_provider ext_obj,
                                     int ext_part)

Establish an "external" or "heavyweight" constraint on the enabled value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_enabled_constraint in class min_interactor

  public void set_enabled_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the enabled value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_enabled_constraint in class min_interactor

  public void set_part_a_constraint(constraint a_constraint)

Establish a constraint on the part_a value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_part_a_constraint in class min_interactor

  public void set_part_a_constraint(value_provider ext_obj,
                                    int ext_part)

Establish an "external" or "heavyweight" constraint on the part_a value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_part_a_constraint in class min_interactor

  public void set_part_a_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the part_a value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_part_a_constraint in class min_interactor

  public void set_part_b_constraint(constraint a_constraint)

Establish a constraint on the part_b value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

constraint - a_constraint the constraint to replace it with.

Overrides:

set_part_b_constraint in class min_interactor

  public void set_part_b_constraint(value_provider ext_obj,
                                    int ext_part)

Establish an "external" or "heavyweight" constraint on the part_b value of this object. This attaches a value exported by a particular part of some value_provider object and replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

value_provider - ext_obj the external object providing the value.

int - ext_part the part number of the part of that object providing the value.

Overrides:

set_part_b_constraint in class min_interactor

  public void set_part_b_constraint(std_ext_constraint ext_cnstr)

Establish a standard external constraint on the part_b value of this object. This replaces any constraint currently in place. However, an attempt to replace an intrinsic constraint will result in an exception.

Parameters:

std_ext_constraint - ext_cnstr the constraint to attach.

Overrides:

set_part_b_constraint in class min_interactor

  public int marked_ood()

Indicate which values are currently marked as potentially out of date with respect to their constraints. Typically this information is needed only by the constraint system, since values are generally brought up to date whenever they are requested.

Returns:

s int a bitset indicating the parts of this object which are currently marked out-of-date.

Overrides:

marked_ood in class min_interactor

  public void mark_ood(int coord_code)

Mark the given value as out of date. This will recursively mark anything that directly or indirectly depends on the given value. This should normally only be called by the constraint system, since setting values via set_*() will automatically call this routine.

Parameters:

int - the part to mark out-of-date. This should be one of the values: X, Y, W, H, ENABLED, PART_A, or PART_B.

Overrides:

mark_ood in class min_interactor

  public void mark_all_ood()

Mark all geometric parts of this object out of date. This happens for example when we reparent it.

Overrides:

mark_all_ood in class min_interactor

  public void mark_x_ood()

Mark x value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_x_ood in class min_interactor

  public void mark_y_ood()

Mark y value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_y_ood in class min_interactor

  public void mark_w_ood()

Mark w value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_w_ood in class min_interactor

  public void mark_h_ood()

Mark h value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_h_ood in class min_interactor

  public void mark_visible_ood()

Mark visible value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_visible_ood in class min_interactor

  public void mark_enabled_ood()

Mark enabled value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_enabled_ood in class min_interactor

  public void mark_part_a_ood()

Mark part_a value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_part_a_ood in class min_interactor

  public void mark_part_b_ood()

Mark part_b value and anything that directly or indirectly depends on it as out-of-date.

Overrides:

mark_part_b_ood in class min_interactor

  protected void ood_inform_all(int which_part)

Tell all potentially dependent objects about an out of date part. This is used by the lightweight constraint system to infer dependency edges that are not explicitly stored. Basically we tell everyone that might have a dependency edge from us (all the local neighborhood) and they work out whether they have the edge or not based on the attached constraint. If they do have the edge they mark themselves out-of-date, otherwise they ignore this.

Parameters:

int - which_part the code of the part of this object which is informing all the others that it is out-of-date.

  public void mark_reparented_ood()

Mark all our geometric parts out-of-date and tell all potentially dependent objects that all our parts are out-of-date (this gets done when we move around in the hierarchy). This affects, x, y, w, and h, but not visible, enabled, part_a, or part_b.

Overrides:

mark_reparented_ood in class min_interactor

  public void inform_ood(int from_type,
                         int from_part,
                         int nth_child)

Inform the object that the indicated part of a potentially related object is out-of-date (this is called from ood_inform_all()). The related object can be one of OBJCODE_SELF, OBJCODE_PARENT, OBJCODE_SOME_CHILD, OBJCODE_NEXT_SIBLING, or OBJCODE_PREV_SIBLING, and the indicated part can be X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B.

The nth_child parameter is used only if OBJCODE_SOME_CHILD is passed, in which case it indicates the index of the child in question. If parts of this object are actually dependent upon the given part they are marked out-of-date and the mark out-of-date traversal is continued recursively from them. If not, we do nothing.

Parameters:

int - from_type the type of object we are being informed by (must be one of OBJCODE_SELF, OBJCODE_PARENT, OBJCODE_SOME_CHILD, OBJCODE_NEXT_SIBLING, or OBJCODE_PREV_SIBLING).

int - from_part the part code of the part of that object which is informing us that it is out-of-date.

int - nth_child if from_type is OBJCODE_SOME_CHILD, this parameter indicates which child it is (otherwise it is ignored).

Overrides:

inform_ood in class min_interactor

See Also:

ood_inform_all

  public boolean handle_cycle(int part_code)

Handle a cycle detected in constraints on a given part of this object. If this routine returns true, then evaluation proceeds. If this returns false then, the current value of the attribute (which may have been set by this routine) is left in place but marked up-to-date. By default, we call manager.handle_cycle() which provides a global policy for handling cycles (manager.handle_cycle() defaults to ignoring the cycle, which amounts to breaking the cycle "once-around", its also possible to print a debugging message, or a stack trace and/or force an error exit).

Parameters:

int - part_code the part of this object that involves a cycle.

Returns:

boolean indicating whether we should proceed with evaluation.

Overrides:

handle_cycle in class min_interactor

See Also:

handle_cycle

  public void eval(int coord_code)

Bring the indicated value up to date with respect to any defining constraints. This routine does not typically need to be called explicitly since normal requests for values do evaluations before returning.

Parameters:

int - coord_code the part whose value should be evaluated.

Overrides:

eval in class min_interactor

  public void eval_x()

Bring x up to date with respect to any defining constraint.

Overrides:

eval_x in class min_interactor

  public void eval_y()

Bring y up to date with respect to any defining constraint.

Overrides:

eval_y in class min_interactor

  public void eval_w()

Bring w up to date with respect to any defining constraint.

Overrides:

eval_w in class min_interactor

  public void eval_h()

Bring h up to date with respect to any defining constraint.

Overrides:

eval_h in class min_interactor

  public void eval_visible()

Bring visible up to date with respect to any defining constraint.

Overrides:

eval_visible in class min_interactor

  public void eval_enabled()

Bring enabled up to date with respect to any defining constraint.

Overrides:

eval_enabled in class min_interactor

  public void eval_part_a()

Bring part_a up to date with respect to any defining constraint.

Overrides:

eval_part_a in class min_interactor

  public void eval_part_b()

Bring part_b up to date with respect to any defining constraint.

Overrides:

eval_part_b in class min_interactor

  public provider_part_ref get_external_constraint(int for_part)

Get the external value provider (if any) associated with the given part value (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B). Returns null if there is no external provider.

Parameters:

int - for_part the part we are asking about.

Returns:

provider_part_ref the external value provider associated with that part, or null if there is none.

Overrides:

get_external_constraint in class min_interactor

  public Object get_value(int part_number)

Get an up-to-date copy of a particular part value(X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B). An Integer object will be returned.

Parameters:

int - part_number the part being requested.

Returns:

Object an Integer object containing the value of the requested part.

Overrides:

get_value in class min_interactor

  public void attach_dependent(int on_part_num,
                               value_consumer dep_obj,
                               int dep_part)

Register something as interested in (dependent on) one of the parts (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B) of this object. The entity registered is a part within a value_consumer object (typically an external_constraint). Whenever the part value in question is marked out-of-date, the value_ood() method is invoked on each currently registered (object,part) pair.

Parameters:

int - on_part_num the part of this object that the dependency is being attached to.

value_consumer - dep_obj the object that is dependent.

int - dep_part the part within that object which is dependent.

Overrides:

attach_dependent in class min_interactor

  public void detach_dependent(int on_part_num,
                               value_consumer dep_obj,
                               int dep_part)

Remove an (object,part) pair from the dependent (interested in) list associated with a particular part of this object.

Parameters:

int - on_part_num the part of this object that the dependency is attached to.

value_consumer - dep_obj the object that was dependent.

int - dep_part the part within that object which was dependent.

Overrides:

detach_dependent in class min_interactor

  public void value_ood(int for_part_here,
                        value_provider prov_obj,
                        int prov_part)

Indicate that a part value (X, Y, W, H, VISIBLE, ENABLED, PART_A, or PART_B) with an external constraint attached should be marked out-of-date because something it depends on (externally) is out-of-date.

Parameters:

int - for_part_here part within this object that should be marked out-of-date.

value_provider - prov_obj object that we depend on.

int - prov_part part within that object that is

Overrides:

value_ood in class min_interactor

  public int custom_fun1(int val1,
                         int const_val)

A custom function accessible in the constraint system. This function is accessible from the (lightweight) constraint system and can be overridden by particular subclasses to perform custom computations associated with that class. This version is passed a single parameter value derived from a depended upon object, plus a constant value taken from the constraint.

Important note: for the constraint system to work correctly, this function must compute its value solely on its parameters and not access additional information from this object or other objects (since the attribute constrained to the result of this function will not hear about changes and be properly updated).

Parameters:

int - val1 a value from a depended upon object.

int - const_val a constant value taken from the constraint.

Returns:

s int by default this returns the sum of the two values. More interesting functions will be provided by subclasses.

Overrides:

custom_fun1 in class min_interactor

  public int custom_fun2(int val1,
                         int val2,
                         int const_val)

A custom function accessible in the constraint system. This function is accessible from the (lightweight) constraint system and can be overridden by particular subclasses to perform custom computations associated with that class. This version is passed two parameter values derived from a depended upon object, plus a constant value taken from the constraint.

Important note: for the constraint system to work correctly, this function must compute its value solely on its parameters and not access additional information from this object or other objects (since the attribute constrained to the result of this function will not hear about changes and be properly updated).

Parameters:

int - val1 a value from a depended upon object.

int - val2 another value from a depended upon object.

int - const_val a constant value taken from the constraint.

Returns:

s int by default this returns the sum of the three values. More interesting functions will be provided by subclasses.

Overrides:

custom_fun2 in class min_interactor

  public void configure()

Do the constraint evaluation necessary to make sure all visible objects in the subtree rooted at this object have up-to-date bounds (and other information) prior to drawing. This routine implements the "configure" pass which occurs right before the pass that does the actual drawing.

Important note: In addition to the work done here in the base class (which should almost always be done by invoking super() from any subclass implementations), each subclass should also be certain to update anything which could effect its bounds here, and not in draw_self_local(). So for example if the height of an object depends on a font that might have changed, the potentially new height must be computed and set here and not in draw_self_local(). In general, for things to work out right it must be the case that this object's bound is correct once this method returns. The reason for this is that by the time draw_self_local() is called, the clipping region corresponding to the bound of this object will have already been set and changing the bound then will not modify the clipping region accordingly (so the drawing may be incorrect).

Overrides:

configure in class min_interactor

  public boolean inside_bounds(int pt_x,
                               int pt_y)

Determine if the given point (in the local coordinates of this object) is inside the extent of this object's normal bound. You should not normally override this routine to handle picking of non-rectangular objects. Do that in picked_by() instead.

Parameters:

int - pt_x x coordinate of the query point.

int - pt_y y coordinate of the query point.

Returns:

boolean indicating whether the point is inside the objects bounding box.

Overrides:

inside_bounds in class min_interactor

See Also:

picked_by

  public boolean picked_by(int pt_x,
                           int pt_y)

Determine if the given point (in the local coordinates of this object) is inside the extent of the object picking purposes. Be default, this method just checks the normal bound (bounding box), however, it can be overridden to support accurate picking of non-rectangular objects.

Parameters:

int - pt_x x coordinate of the query point.

int - pt_y y coordinate of the query point.

Returns:

boolean indicating whether the point is inside the objects bounding box.

Overrides:

picked_by in class min_interactor

See Also:

inside_bounds

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

Determine if this object and/or any of its decedent objects is "picked" by the the given point. If it is, it must add itself to the end of the given given pick_collection by calling report_pick(). If not, it should leave the pick_collector as is.

This method is also responsible for recursively invoking itself as appropriate for its children (this is usually done using the pick_within_children() utility routine). By default we pick against any children first (since they are by default drawn last) and then this object. However, if the drawing order is changed from the default, this method must be changed to reflect (the reverse of) that non-standard order. For example, if this object does drawing both under and on top of its children, two sets of part specific tests would typically be needed, one before recursively picking the children, and one after.

Parameters:

int - pt_x x coordinate of the query point.

int - pt_y y coordinate of the query point.

pick_collector - pick_list object that collects and returns pick results.

Overrides:

pick in class min_interactor

See Also:

pick_within_children

  protected void pick_within_children(int pt_x,
                                      int pt_y,
                                      pick_collector pick_list)

Utility routine to perform pick over children. The point is given in local coordinates of the parent object.

Parameters:

int - pt_x x coordinate of the query point.

int - pt_y y coordinate of the query point.

pick_collector - pick_list object that collects and returns pick results.

  public void traverse_and_collect(int traversal_kind,
                                   int traversal_order,
                                   interactor_pred inclusion_test,
                                   interactor_pred continue_test,
                                   traversal_xform xform_parent_to_child,
                                   Object parameters,
                                   pick_collector collection_result)

Do a traversal of the interactor tree to collect nodes meeting some criteria (or perform actions on qualifying nodes). Traversals are given a specialized "kind" so that subclasses can recognize and override behavior for certain traversals, while keeping default behavior for the rest. In addition, several traversal orders are provided. Qualification for collection (or action) is done by an inclusion test predicate object. This predicate is given the interactor in question as well as some (optional) data specific to the predicate. This data is passed in from the root of the traversal and (optionally) transformed from parent to child values as the traversal proceeds. Objects are collected (along with optional additional data) by adding them to a pick_collector object. Recursive traversal is stopped when either leaves are reached or the continue_test predicate for an interior node fails (in which case its children will not be visited).

Examples of possible traversals include:
Replacement for the normal pick operation:

   traverse_and_collect(pick_trav, TRAV_DRAW, pt_inside_bounds, pt_inside_bounds,
                        coord_parent_to_local, pick_pt, result);
 

and a tree dump:

   traverse_and_collect(dump_trav, TRAV_PRE, dump_interactor, incr_int,
                        null, new Integer(0), result)
 

where dump_interactor printed to the node to System.out at the indentation level of its Integer parameter, but always returns false

Parameters:

traversal_kind - a unique integer (i.e., generated by manager.unique_int()) that represents the kind of traversal being performed.

traversal_order - one of TRAV_DRAW, TRAV_PICK, TRAV_PRE, or TRAV_POST indicating drawing order, pick order, left-to-right pre-order, or left-to-right post-order traversal.

inclusion_test - an interactor predicate object which is to perform the inclusion test for this traversal. If the traversal is being done for its action side-effects (rather than a collection, per se) then this object's test() method should perform that action on selected nodes. A null inclusion_test is treated as a function that selects everything (always returns true).

continue_test - an interactor_predicate object which determines if the given object's children are traversed. If this method returns false, then the children will not be visited. A null continue_test is is treated as a function that always returns true.

xform_parent_to_child - object containing a method to transform the parameters data (passed to the inclusion_test) from its parent condition to the condition suitable for use by a given child. This can be used, for example, to transform a point from the parent's coordinates into those of a child. A null object is treated as the identity transformation (i.e. uses the parent's parameters directly for all children).

parameters - the initial parameters data passed to the inclusion_test at the root, then transformed by xform_parent_to_child for recursive calls on children.

collection_result - a pick_collector object which holds a list of interactors collected by this traversal (and optional associated data). If an object determines that it should be a part of the collection of this traversal, it should add itself to this collection by calling its report_pick() method.

Overrides:

traverse_and_collect in class min_interactor

  protected void traverse_and_collect_parent(int traversal_kind,
                                             interactor_pred inclusion_test,
                                             Object parameters,
                                             pick_collector collection_result)

Helper routine for traverse_and_collect() -- this does test on a single (parent) object.

Parameters:

int - traversal_kind the identifier for this traversal type.

interactor_pred - inclusion_test the predicate we are testing this object against.

Object - parameters the additional parameters to be passed to that predicate.

pick_collector - collection_result the object that collects and returns any objects which are selected.

See Also:

traverse_and_collect

  public void traverse_and_collect_children(int traversal_kind,
                                            int traversal_order,
                                            boolean l_to_r,
                                            interactor_pred inclusion_test,
                                            interactor_pred continue_test,
                                            traversal_xform xform_parent_to_child,
                                            Object parameters,
                                            pick_collector collection_result)

Helper routine for traverse_and_collect() -- does recursive traversal of children in either left-to-right or right-to-left order.

Parameters:

int - traversal_kind the traversal type id.

int - traversal_order traversal order we are to use.

boolean - l_to_r true for left-to-right traversal, false for right-to-left.

interactor_pred - inclusion_test the inclusion test for the traversal (see traverse_and_collect()).

interactor_pred - continue_test the continue test for the traversal(see traverse_and_collect()).

traversal_xform - xform_parent_to_child the parameter transformer for the traversal(see traverse_and_collect()).

Object - parameters the parameters passed to the inclusion and continue test predicates.

pick_collector - collection_result the object which collects and returns the selected objects.

See Also:

traverse_and_collect

  public final boolean flag_is_set(int mask_value)

Determine if a particular bit (or bits) is set in the flag set for the interactor. In the case of testing for multiple flag bits, they must all be set to get a result of true. See interactor_consts for possible values that can be queried.

Parameters:

int - mask_value the flag bit or bits we are enquiring about.

Returns:

boolean indicating whether the bit or bits are (all) set.

Overrides:

flag_is_set in class min_interactor

See Also:

interactor_consts

  protected final void set_flag_bit(int mask_value,
                                    boolean v)

Set the given flag bit(s) to the given value. See interactor_consts for possible values that can be set.

Parameters:

int - mask_value the bit or bits to be modified within the flags.

boolean - v the value to set those bits to.

See Also:

interactor_consts

  protected final void set_flag_bit(int mask_value)

Set the given flag bit(s) to true. See interactor_consts for possible values that can be set.

Parameters:

int - mask_value the bit or bits to be modified within the flags.

See Also:

interactor_consts

  protected final void clear_flag_bit(int mask_value)

Set the given flag bit(s) to false. See interactor_consts for possible values that can be set.

Parameters:

int - mask_value the bit or bits to be modified within the flags.

See Also:

interactor_consts

  public final boolean constraint_flag_is_set(int mask_value)

Determine if a particular bit (or bits) is set in the constraint_flag set for the interactor. In the case of testing for multiple constraint_flag bits, they must all be set to get a result of true. See interactor_consts for possible values that can be queried.

Overrides:

constraint_flag_is_set in class min_interactor

  protected final void set_constraint_flag_bit(int mask_value,
                                               boolean v)

Set the given constraint_flag bit(s) to the given value. See interactor_consts for possible values that can be set.

Parameters:

int - mask_value the bit or bits to be modified within the flags.

boolean - v the value to set those bits to.

See Also:

interactor_consts

  protected final void set_constraint_flag_bit(int mask_value)

Set the given constraint_flag bit(s) to true. See interactor_consts for possible values that can be set.

Parameters:

int - mask_value the bit or bits to be modified within the flags.

See Also:

interactor_consts

  protected final void clear_constraint_flag_bit(int mask_value)

Set the given constraint_flag bit(s) to false. See interactor_consts for possible values that can be set.

Parameters:

int - mask_value the bit or bits to be modified within the flags.

See Also:

interactor_consts

  protected drawable enter_local_coordinates(drawable parent_draw)

Given a drawable surface set up for the parent coordinate space, create a new drawable set up for the local coordinate space. This surface will have a translation installed corresponding to the local origin, and will clip to the extent of the local object.

Parameters:

drawable - parent_draw the drawable set up for the parent.

Returns:

drawable a new drawable set up for the child.

  protected void exit_local_coords(drawable parent_draw,
                                   drawable local_draw)

Do the work to exit the local coordinate system. Here this does nothing since we just revert to the original parent drawable. However, this is here as a useful hook for subclasses that need to do something else at this point.

Parameters:

drawable - parent_draw the drawable used by our parent.

drawable - local_draw the drawable derived from it used by us.

  public static boolean trivial_reject(drawable d,
                                       Rectangle bounding_box)

Do a trivial reject test that indicates whether the given bounding box is entirely outside the clipping region of the given drawable object. Returns true if nothing inside the box will survive the clip and hence need not be drawn. This can also be used for optimizing drawing by testing whether an expensive object is completely clipped away before trying to draw it.

Parameters:

drawable - d the drawable whose current clipping we are testing against.

Rectangle - bounding_box the bounding box we are comparing that with.

  public boolean trivial_reject(drawable d)

Do a trivial reject test that indicates whether the bounds of this object are entirely outside the clipping region of the given drawable object. The drawable object is assumed to be configured for our parent's coordinate system. Returns true if nothing inside our bounds will survive the clip and hence need not be drawn. This test is used in draw_self() to avoid drawing anything for the object if none of it could show up anyway.

Parameters:

drawable - d the drawable whose current clipping we are testing against.

Rectangle - bounding_box the bounding box we are comparing that with.

Overrides:

trivial_reject in class min_interactor

See Also:

draw_self

  public void draw_self(drawable parent_d)

Draw the object's current appearance. The drawable object passed in is still set up in the parent's coordinate system. This routine normally sets up the transformation for the local coordinate system, then calls draw_self_local(). Consequently, most interactors do not override this routine, but instead override draw_self_local().

Parameters:

drawable - parent_d a drawable (still set up for the parent) to produce output on.

Overrides:

draw_self in class min_interactor

See Also:

draw_self_local

  protected void draw_self_local(drawable d)

Draw the object's current appearance (along with that of its children). The drawable object passed in will be set up for the local coordinate system. Most interactors override this routine to provide a custom appearance, but this routine is not called directly to produce output (that is done with draw_self()).

Normal drawing order with respect to children is to draw the this object (the parent) first, then draw the children (so they appear on top). Drawing children (in normal low to high index order) can be done by the draw_children() utility routine. Note that if normal drawing order is overridden changes also must be made to the picking routines (pick() and pick_within_children()) as well.

Parameters:

drawable - d a drawable object (set up for this object) to produce output on.

See Also:

draw_self, draw_children, pick, pick_within_children

  protected void draw_children(drawable d)

Helper routine to draw the children of this interactor in normal (low to high index) drawing order. This simply calls draw_self() for each child in order. Note that if normal drawing order is overridden changes also must be made to the picking routines (pick() and pick_within_children()) as well.

Parameters:

drawable - d a drawable object (set up for this object) to produce output on.

See Also:

draw_self, draw_self_local, pick, pick_within_children

  protected void damage_fixed()

Indicate that any previous damage to the object's appearance has been fixed (by redrawing it). This is normally called automatically by draw_self and need not be called elsewhere.

  public void damage_self(Point top_left,
                          Dimension sz)

Indicate that the object has been modified in such as way that its appearance within the given area of the screen (expressed in local coordinates) might change and needs to be redrawn. This does not update any attributes controlling size and position of this object or any other object up the parent chain, but instead uses existing values (reflecting the existing sizes and positions). If you need to damage this object's updated position, explicitly update it first.

Parameters:

Point - top_left top left corner of the damaged rectangle.

Dimension - sz size of the damaged rectangle.

Overrides:

damage_self in class min_interactor

  public void damage_self(int left,
                          int top,
                          int wid,
                          int hi)

Indicate that the object has been modified in such as way that its appearance within the given area of the screen (expressed in local coordinates) might change and needs to be redrawn. This does not update any attributes controlling size and position of this object or any other object up the parent chain, but instead uses existing values (reflecting the existing sizes and positions). If you need to damage this object's updated position, explicitly update it first.

Parameters:

int - left left edge of the damaged rectangle.

int - top top edge of the damaged rectangle.

int - wid width of the damaged rectangle.

int - hi height of the damaged rectangle.

Overrides:

damage_self in class min_interactor

  public void damage_self()

Indicate that the object has been modified in such as way that any or all of its appearance may change and its area of the screen needs to be redrawn.

Overrides:

damage_self in class min_interactor

  public void damage_from_child(interactor originator,
                                Object user_info,
                                Point top_left,
                                Dimension sz)

Indicate that a change to a child (or grandchild, etc.) affects the given screen region (expressed in the coordinates of this object). This is responsible for passing damage up the tree.

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 min_interactor

  public void damage_self(Object user_info)

Indicate that the object has been modified in such as way that any or all of its appearance may change and its area of the screen needs to be redrawn.

Parameters:

Object - user_info uninterpreted information supplied by the originator at damage time.

Overrides:

damage_self in class min_interactor

  public void damage_self(interactor originator,
                          Object user_info,
                          Point top_left,
                          Dimension sz)

Indicate that the object has been modified in such as way that its appearance within the given area of the screen (expressed in local coordinates) might change and needs to be redrawn. The damage may have been caused by a child (or grandchild, ...), in which case the originator parameter indicates the responsible interactor. The damage_type parameter is an uninterpreted Object reference which was supplied by the originator at the time the damage was reported.

This method does not update any attributes controlling size and position of this object or any other object up the parent chain, but instead uses existing values (reflecting the existing sizes and positions). If you need to damage this object's updated position, explicitly update it first.

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 min_interactor

  public int num_feature_points()

The number of "feature points" of an object. Feature points are points within an object which are interesting for alignment, snapping or other purposes. They are used by the move_drag and snap_drag agents.

Feature points are expressed in the local coordinates of the object in question. Objects by default provide 5 points corresponding to their corners and center. Constants representing indexes for these standard points are defined in interactor_consts. Additional points with specialized meanings may be provided by subclasses.

Returns:

int the number of feature points this object has.

Overrides:

num_feature_points in class min_interactor

See Also:

move_drag_focus_agent, move_draggable, move_drag_filter, std_drag_filters, snap_drag_agent, snap_draggable, snap_targetable, interactor_consts

  public Point feature_point(int indx)

Access to the "feature points" of an object (by index). Feature points are points within an object which are interesting for alignment, snapping or other purposes. They are used by the move_drag and snap_drag agents.

Feature points are expressed in the local coordinates of the object in question. Objects by default provide 5 points corresponding to their corners and center. Constants representing indexes for these standard points are defined in interactor_consts. Additional points with specialized meanings may be provided by subclasses. If an index out of range is given the top-left corner (index FEATURE_TOP_LEFT which is always 0,0) is returned.

Parameters:

int - indx the index of the requested feature point.

Returns:

Point the location of the requested feature point in local coordinates.

Overrides:

feature_point in class min_interactor

See Also:

move_drag_focus_agent, move_draggable, move_drag_filter, std_drag_filters, snap_drag_agent, snap_draggable, snap_targetable, interactor_consts

  public boolean feature_point_enabled(int indx)

Indicate whether the indicated "feature point" of an object is considered to be enabled. Feature points are points within an object which are interesting for alignment, snapping or other purposes. They are used by the move_drag and snap_drag agents.

Feature points are expressed in the local coordinates of the object in question. Objects by default provide 5 points corresponding to their corners and center. Constants representing indexes for these standard points are defined in interactor_consts. Additional points with specialized meanings may be provided by subclasses.

By default all standard feature points are always enabled. If an index out of range is given false will always be returned.

Parameters:

int - indx the index of the feature point in question.

Returns:

boolean indicating whether it is enabled.

Overrides:

feature_point_enabled in class min_interactor

See Also:

move_drag_focus_agent, move_draggable, move_drag_filter, std_drag_filters, snap_drag_agent, snap_draggable, snap_targetable, interactor_consts

  public int drag_feature_point()

Indicate the current "feature point" of an object. This point will be used by the move_drag agent to control dragging. Feature points are points within an object which are interesting for alignment, snapping or other purposes. The current feature point is used by the move_drag agent. See that agent for complete details. Feature points are expressed in the local coordinates of the object in question. Objects by default provide 5 points corresponding to their corners and center. Constants representing indexes for these standard points are defined in interactor_consts. Additional points with specialized meanings may be provided by subclasses.

Note: this routine and the ones that use it ignore the enable status of the point as returned by feature_point_enabled(). This routine defaults to the top left corner of the object.

Returns:

the index of the current feature point.

Overrides:

drag_feature_point in class min_interactor

See Also:

move_drag_focus_agent, move_draggable, move_drag_filter, std_drag_filters, interactor_consts

  public void focus_set_enter(event cause_evt,
                              focus_dispatch_agent of_agent,
                              Object user_info)

Default action for entering a focus set. Several of the focus agents handle focus entry in custom ways (and do not call this routine) and many objects don't need to do anything special when they enter the focus set since they requested the focus themselves. So we provide a default here for ignoring the dispatch. This is only relevant for objects implementing the focusable interface (or one of the other input dispatch protocol interfaces derived from it), but its easy enough to do here and saves a bit of coding in subclasses.

Parameters:

event - cause_evt the event that caused the focus.

focus_dispatch_agent - of_agent the agent doing the focus.

Object - user_info uninterpreted information that was given to the agent when the focus was requested.

See Also:

focusable, focus_dispatch_agent

  public void focus_set_exit(event cause_evt,
                             focus_dispatch_agent of_agent,
                             Object user_info)

Default action for exiting a focus set. Several of the focus agents handle focus entry in custom ways (and do not call this routine) and many objects don't need to do anything special when they enter the focus set since they requested the focus themselves. So we provide a default here for ignoring the dispatch. This is only relevant for objects implementing the focusable interface (or one of the other input dispatch protocol interfaces derived from it), but its easy enough to do here and saves a bit of coding in subclasses.

Parameters:

event - cause_evt the event that caused the focus.

focus_dispatch_agent - of_agent the agent doing the focus.

Object - user_info uninterpreted information that was given to the agent when the focus was requested.

See Also:

focusable, focus_dispatch_agent

  public Point filter_pt(Point original_pt,
                         interactor obj,
                         Point feature_pt)

Default point filter. Point filters are used by the move_drag agent to limit the area of a drag or transform the path of a drag. Here we use the identity filter, so it imposes no limit or translation. A collection of useful filters that can be called from subclass specializations of this method can be found in std_drag_filters.

Parameters:

original_pt - the point to be filtered (in parent's coords).

drag_obj - the object being dragged.

feature_pt - the feature point within the object being dragged that is being filtered (in object's coords).

Returns:

the location of the filtered point

See Also:

move_drag_filter, move_drag_focus_agent, move_draggable, std_drag_filters, interactor_consts

  public Enumeration user_data()

Access to the collection of data items that we are holding for the user of this interactor. These data items are for the use of the application or user only, and are typically used to associate application specific information with a particular interactor. Data items can be entered using add_user_datum(), and deleted using remove_user_datum(). These data items are not modified by the toolkit, and can later be retrieved with this method as needed. The ordering of the data items in the returned Enumeration is not guaranteed to follow any rules, and may change between invocations.

Returns:

s Enumeration a collection of the data items attached to this interactor.

Overrides:

user_data in class min_interactor

See Also:

add_user_datum, remove_user_datum

  public void add_user_datum(Object datum)

Adds a data item to the collection of data items that we are holding for the user of this interactor. These data items are for the use of the application or user only, and are typically used to associate application specific information with a particular interactor. Data items can be entered using this method. The same Object can be entered multiple times, and will occur in the Enumeration returned by user_data() multiple times. Data items can be deleted using remove_user_datum(). These data items are not modified by the toolkit, and can later be retrieved with user_data() as needed.

Parameters:

Object - datum the data item to associate with this interactor.

Overrides:

add_user_datum in class min_interactor

See Also:

user_data, remove_user_datum

  public boolean remove_user_datum(Object datum)

Removes a data item from the collection of data items that we are holding for the user of this interactor. These data items are for the use of the application or user only, and are typically used to associate application specific information with a particular interactor. Data items can be entered using add_user_datum(), and deleted using this method. If the given Object is not associated with the interactor, no changes are made and a value of false is returned. If the given Object has been entered multiple times, only one instance is removed by invoking this method. These data items are not modified by the toolkit, and can later be retrieved with user_data() as needed.

Parameters:

Object - datum the data item to remove from association with this interactor.

Returns:

s boolean true iff successful, false if the given datum is not currently associated with this interactor.

Overrides:

remove_user_datum in class min_interactor

See Also:

user_data, add_user_datum

  public Object user_info()

Access to uninterpreted "user information" that we are holding for the user of this object. This information is for use of the user or application only and is typically used to associated application specific information with a particular interactor object. This information can be entered using set_user_info(). It is not modified by the toolkit, and can later be retrieved with this routine as needed.

Note that only one "user information" object can be associated with an interactor. The "user data" methods maintain a collection of objects.

Returns:

s Object the user info object attached to this interactor.

Overrides:

user_info in class min_interactor

See Also:

user_data, add_user_datum, remove_user_datum

, set_user_info

  public void set_user_info(Object user_inf)

Set the uninterpreted "user information" that we are holding for the user of this object. This information is for use of the user or application only and is typically used to associated application specific information with a particular interactor object. This information can be entered using this routine. It is not modified by the toolkit, and can later be retrieved with user_info() as needed.

Note that only one "user information" object can be associated with an interactor. The "user data" methods maintain a collection of objects.

Parameters:

Object - user_inf the object to associate with this interactor.

Overrides:

set_user_info in class min_interactor

See Also:

user_data, add_user_datum, remove_user_datum

, user_info

  public static void register_resource_names()

Register any style resource names owned by this class. This should be overriden by any subclass which needs to declare resource names and called by a static initialization block in that class. This code may also force other classes it implicitly depends on (e.g. for fallback names) register their names by calling their register_resource_names() methods. Note: This may be called more than once, so it should be set up so that calling it more than once causes does not register the names more than once.

  public void set_style_lock(boolean lock_v)

Lock or unlock the style of this interactor. When the style is locked, restyling requests are ignored.

Parameters:

boolean - lock_v new value of locked status (true == locked)

Overrides:

set_style_lock in class min_interactor

  public void style_change_local()

Inform the interactor that the global current style has changed and that it may need to restyle itself. This should reconstruct any style-based resources used by the interactor under the new current style and recompute the size of the object and any other properties that this effects. If the interactor is style-locked, this has no effect. Here in the base class, this is equivalent to calling "restyle(style_mangager.current_style())".

See Also:

restyle

  public void style_change()

This calls style_change_local() on itself and all its descendents to notify them of a change in the global current style.

Overrides:

style_change in class min_interactor

See Also:

style_change_local

  public void restyle(style new_style)

Force a restyle of the interactor under the given style. This should reconstruct any style-based resources held by the interactor under the given style, and then recompute the size of the object and any other properties that this effects. If the interactor is style-locked, this has no effect.

Parameters:

style - new_style the style to put the interactor under.

Overrides:

restyle in class min_interactor

  protected void restyle_look_resources(style new_style)

"Restyle" current style-based resources used by this interactor to conform to the given style (here in the base class we do nothing).

Parameters:

style - new_style the style to restyle resources under.

  protected void new_look_configure()

Recompute the size and other properties of this interactor that may have been changed by a change in style resources. This should be called whenever the interactor has been restyled (e.g., it is called automatically from restyle()) or resources affecting the size of the object or its visual appearance are changed in some other way. Here in the base class, this does nothing.

  public String flag_string()

Convert a flag set into a human readable string.

Returns:

String displaying the values of the flag set.

  public String constraint_flag_string()

Convert a constraint flag set into a human readable string.

Returns:

String displaying the values of the flag set.

  public String toString()

Convert to a human readable string.

Returns:

String a human readable dump of the object.

Overrides:

toString in class Object

  public String tag_str()

Convert to a small tag string which indicates the type of interactor along with a (hopefully unique) integer (its hashCode) that can be used to identify it during debugging.

Returns:

String an terse identifying tag string for the object.

Overrides:

tag_str in class min_interactor

All Packages  Class Hierarchy  This Package  Previous  Next  Index