com.sharkysoft.fig.core.doodle

Class DoodleDecorator<T extends Doodle>

java.lang.Object

com.sharkysoft.fig.core.doodle.ChildDoodle

com.sharkysoft.fig.core.doodle.DoodleDecorator<T>

Type Parameters:

T - the doodle type

All Implemented Interfaces:

DefaultOriginDoodle, Doodle, ParentDoodle

Direct Known Subclasses:

TransformedDoodle, ViewDoodle

public abstract class DoodleDecorator<T extends Doodle>
extends ChildDoodle
implements ParentDoodle

Decorates Doodles.

Details: A DoodleDecorator wraps a Doodle and forwards calls and return values between the sender and the receiver. By itself, this class is worthless. It is intended to be subclassed so that individual methods can be overridden with decorating behavior.

All calls except Doodle.setParent(ParentDoodle) are forwarded. (Forwarding Doodle.setParent(ParentDoodle) would result in unintentional communication between the "decoratee" and this decorator's parent, bypassing this decorator.) When this decorator is constructed, it sets itself as the decoratee's parent.

Only Doodle methods are forwarded in this decorator. Object methods, such as Object.equals(Object), Object.hashCode(), etc. are the subclass' responsibility.

Author:

Sharky

Field Summary

Fields

Modifier and Type	Field and Description
protected T	mDoodle

Fields inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

mParent

Constructor Summary

Constructors

Constructor and Description
DoodleDecorator(T iDoodle)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(AffineTransform iTransform, Point2D iPoint) Tests point for contact with doodle.
boolean	draw(FigGraphics iG) Renders doodle.
Rectangle2D	getBounds(AffineTransform iTransform, Rectangle2D oBounds) Returns rectangular extent.
T	getDoodle()
float	getZOrder() Determines rendering priority for overlapping shapes.
boolean	hasDescendant(Doodle iDoodle)
void	sendDoodleChanged(Doodle iShape) Advises container to react to changes in contained doodle.

Methods inherited from class com.sharkysoft.fig.core.doodle.ChildDoodle

getDefaultOrigin, getParent, redraw, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sharkysoft.fig.core.doodle.Doodle

setParent

Field Detail

mDoodle

protected final T extends Doodle mDoodle

Constructor Detail

DoodleDecorator

public DoodleDecorator(T iDoodle)

Method Detail

getDoodle

public T getDoodle()

contains

public boolean contains(AffineTransform iTransform,
               Point2D iPoint)

Description copied from interface: Doodle

Tests point for contact with doodle.

Details: Doodle.contains(AffineTransform, Point2D) returns true if the given point lies on this doodle, false otherwise.

A provided AffineTransform reveals the characteristics of the view where containment is being tested. This is useful only for Doodles that alter their logical form in order to accommodate the view. Most implementations will simply ignore this transform, and in some cases, this transform may be null, indicating that the transform is not to be considered. In any case, the point being tested is already in figure coordinates.

Specified by:

contains in interface Doodle

Parameters:

iTransform - current viewing transform

iPoint - point to test

Returns:

true iff point hits shape

draw

public boolean draw(FigGraphics iG)

Description copied from interface: Doodle

Renders doodle.

Details: Doodle.draw(FigGraphics) renders this doodle using the supplied graphics environment. When the host FigureView is repainting itself, it will probably call this method, albeit indirectly, to redraw its figure's components. This method returns true if drawing was successful, false otherwise.

Specified by:

draw in interface Doodle

Parameters:

iG - the graphics context

Returns:

true iff drawing was successful

getBounds

public Rectangle2D getBounds(AffineTransform iTransform,
                    Rectangle2D oBounds)

Description copied from interface: Doodle

Returns rectangular extent.

Details: This method returns the rectangular extent of this Doodle. The rectangle returned is in logical (i.e. figure) units, not display units.

A provided AffineTransformreveals the characteristics of the viewing context in which the bounds will be considered. This information is meaningful only in Doodles that alter their logical form to accommodate the view, such as ViewDoodle. Most implementations will simply ignore this transform, and in some cases, this transform may be null, indicating that the transform is a "don't- care." Regardless of the transform provided, the rectangle returned must be in figure coordinates, not view coordinates.

Optionally, the caller may pass in a pre-existing rectangle and have it re-initialized with the result. If the provided rectangle is null, a new rectangle will be instantiated, initialized with the result, and returned. In either case, the rectangle containing the result is returned.

Specified by:

getBounds in interface Doodle

Parameters:

iTransform - the current viewing transform

oBounds - destination for result

Returns:

the extent

getZOrder

public float getZOrder()

Description copied from interface: Doodle

Determines rendering priority for overlapping shapes.

Details: When two doodles in a figure overlap, one doodle must be displayed above the other. Doodle.getZOrder() is called to determine which doodle is "higher." Greater values win.

Specified by:

getZOrder in interface Doodle

Returns:

the Z-order

sendDoodleChanged

public void sendDoodleChanged(Doodle iShape)

Description copied from interface: ParentDoodle

Advises container to react to changes in contained doodle.

Details: ParentDoodle.sendDoodleChanged(Doodle) notifies this container that a doodle contained by this container has changed. This message propagates up the containment hierarchy, and generally causes all of the views to refresh themselves.

Specified by:

sendDoodleChanged in interface ParentDoodle

Parameters:

iShape - doodle that changed

hasDescendant

public boolean hasDescendant(Doodle iDoodle)

Specified by:

hasDescendant in interface ParentDoodle