com.sharkysoft.fig.core

Class Figure

java.lang.Object

com.sharkysoft.fig.core.doodle.ChildDoodle

com.sharkysoft.fig.core.doodle.FlatDoodle

com.sharkysoft.fig.core.doodle.CompoundDoodle

com.sharkysoft.fig.core.Figure

All Implemented Interfaces:

DefaultOriginDoodle, Doodle, ParentDoodle, ToolTip

Direct Known Subclasses:

ExcitableFigure

public class Figure
extends CompoundDoodle

Models figure as collection of shapes.

Details: A Figure is a model of a layered, two-dimensional figure, which is a collection of shapes (Doodle). This class publishes model change events and provides drawing and hit testing support to views.

Author:

Sharky

Field Summary

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

mDoodles, mDoodlesSorted

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

mToolTip, mZOrder

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

mParent

Constructor Summary

Constructors

Constructor and Description
Figure()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Doodle iDoodle) Adds doodle to figure.
boolean	paint(FigGraphics iG) Renders figure.
void	remove(Doodle iDoodle) Removes shape from figure.
void	sendDoodleChanged(Doodle iShape) Repaints views.
void	subscribe(FigureObserver iObserver) Registers observer.
void	unsubscribe(FigureObserver iObserver) Unregisters observer.

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

contains, draw, getBounds, getDoodles, getDoodlesAt, getZOrder, hasDescendant, identifyDoodle, setZOrder

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

getToolTip, setToolTip

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

Constructor Detail

Figure

public Figure()

Method Detail

subscribe

public void subscribe(FigureObserver iObserver)

Registers observer.

Details: subscribe registers the given observer to receive notifications when the figure changes. The observer must not be null.

Parameters:

iObserver - observer to register

See Also:

unsubscribe(FigureObserver)

unsubscribe

public void unsubscribe(FigureObserver iObserver)

Unregisters observer.

Details: unsubscribe unregisters the given observer so that it will stop receiving notifications when the figure changes. The observer should have already been registered via subscribe, but there is no harm if this is not the case. No action is taken if the observer is not registered or if the observer is null.

Parameters:

iObserver - observer unregister

See Also:

subscribe(FigureObserver)

add

public void add(Doodle iDoodle)

Adds doodle to figure.

Details: This method adds the given shape to this figure. All figure observers are notified via FigureObserver.doodleAdded(Figure, Doodle). An appropriate FigureObserver.doodleChanged(Figure, Doodle) message is also sent. In most cases, this message will result in repainting the view.

Overrides:

add in class CompoundDoodle

Parameters:

iDoodle - doodle to add

See Also:

remove(Doodle)

remove

public void remove(Doodle iDoodle)

Removes shape from figure.

Details: This method removes the given doodle from this figure. All figure observers are notified via FigureObserver.doodleRemoved(Figure, Doodle). An appropriate FigureObserver.doodleChanged(Figure, Doodle) message is also sent. In most cases, this message will result in repainting the view.

Overrides:

remove in class CompoundDoodle

Parameters:

iDoodle - doodle to remove

See Also:

add(Doodle)

sendDoodleChanged

public void sendDoodleChanged(Doodle iShape)

Repaints views.

Details: This method generates a FigureObserver.doodleChanged(Figure, Doodle) message, with the area set to the bounds of the given shape. This generally causes all views to mark the area covered by the shape for repainting.

Specified by:

sendDoodleChanged in interface ParentDoodle

Overrides:

sendDoodleChanged in class CompoundDoodle

Parameters:

iShape - shape covering area to invalidate

paint

public boolean paint(FigGraphics iG)

Renders figure.

Details: paint renders this figure using the supplied graphics environment.

Before this figure can be rendered correctly, its member shapes must be sorted by Z-order. However, because re-sorting the shape collection prior to each paint request can result in unreasonable processing overhead, draw takes a "lazy" approach by re-sorting its members only when it has reason to believe that they may be unsorted. There are two possible situations where re-sorting can be triggered:

1. Shapes have been added to this figure since the last time the collection was sorted. When this situation occurs, paint re-sorts the collection immediately before paint the figure.

2. While drawing the figure, paint discovers unsorted shapes. In this case, some painting may have already occurred, and paint cannot continue, because continuing would result in an incorrect result. Nor can paint simply re-sort the shapes and start over, because the painting surface may have already been soiled in the first pass. Thus, paint's only recourse is to abort the operation and signal to the client that it was unsuccessful. It is then up to the client to call paint again. The next time the client calls paint, paint will re-sort the shapes before painting.

The view, supplied as a InteractiveFigureView, allows shapes to customize their appearance for various views. For example, a shape could be configured to be invisible in one view, and visible in another. Use of this parameter is optional, and null is an acceptable value. The caller of paint should set this parameter to the widget on which the figure is being drawn. (This model presupposes that each widget will only display one figure, an assumption that may be abandoned in the future.)

paint returns true if drawing was successful, false otherwise.

Parameters:

iG - the graphics context

Returns:

true iff successful