org.jhotdraw.samples.odg.figures

Class ODGRectFigure

java.lang.Object

org.jhotdraw.beans.AbstractBean

org.jhotdraw.draw.AbstractFigure

org.jhotdraw.draw.AbstractAttributedFigure

org.jhotdraw.samples.odg.figures.ODGAttributedFigure

org.jhotdraw.samples.odg.figures.ODGRectFigure

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Figure, ODGFigure, DOMStorable

public class ODGRectFigure
extends ODGAttributedFigure
implements ODGFigure

ODGRect.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.jhotdraw.draw.Figure

CONNECTABLE_PROPERTY, REMOVABLE_PROPERTY, SELECTABLE_PROPERTY, TRANSFORMABLE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ODGRectFigure() Creates a new instance.
ODGRectFigure(double x, double y, double width, double height)
ODGRectFigure(double x, double y, double width, double height, double rx, double ry)

Method Summary

Modifier and Type	Method and Description
ODGRectFigure	clone() Returns a clone of the figure, with clones of all aggregated figures, such as children and decorators.
boolean	contains(java.awt.geom.Point2D.Double p) Checks if a Point2D.Double is inside the figure.
java.util.Collection<Handle>	createHandles(int detailLevel) Creates handles used to manipulate the figure.
Connector	findCompatibleConnector(Connector c, boolean isStartConnector) Gets a compatible connector.
Connector	findConnector(java.awt.geom.Point2D.Double p, ConnectionFigure prototype) Returns the Figures connector for the specified location.
Dimension2DDouble	getArc()
double	getArcHeight()
double	getArcWidth()
java.awt.geom.Rectangle2D.Double	getBounds() Returns the untransformed logical bounds of the figure as a Rectangle.
java.awt.geom.Rectangle2D.Double	getDrawingArea() Returns the drawing area of the figure as a Rectangle.
double	getHeight()
java.lang.Object	getTransformRestoreData() Gets data which can be used to restore the transformation of the figure without loss of precision, after a transform has been applied to it.
double	getWidth()
double	getX()
double	getY()
void	invalidate() Invalidates cached data of the Figure.
boolean	isEmpty() Returns true, if this figure is empty for one of the following reasons: A group has no children A path has less than two points An ellipse or a rectangle has a width or a height of 0 A text has no characters
void	restoreTransformTo(java.lang.Object geometry) Restores the transform of the figure to a previously stored state.
void	setArc(Dimension2DDouble arc)
void	setArc(double w, double h)
void	setBounds(java.awt.geom.Point2D.Double anchor, java.awt.geom.Point2D.Double lead) Sets the logical and untransformed bounds of the figure.
void	transform(java.awt.geom.AffineTransform tx) Transforms the figure.

Methods inherited from class org.jhotdraw.samples.odg.figures.ODGAttributedFigure

draw, drawFigure, getActions, set

Methods inherited from class org.jhotdraw.draw.AbstractAttributedFigure

get, getAttributes, getAttributesRestoreData, getStroke, getStrokeMiterLimitFactor, hasAttribute, isAttributeEnabled, read, removeAttribute, restoreAttributesTo, setAttributeEnabled, setAttributes, write

Methods inherited from class org.jhotdraw.draw.AbstractFigure

addFigureListener, addNotify, changed, findFigureInside, fireAreaInvalidated, fireFigureChanged, getConnectors, getCursor, getDecomposition, getEndPoint, getLayer, getPreferredSize, getStartPoint, getTool, getToolTipText, handleDrop, handleMouseClick, includes, isConnectable, isRemovable, isSelectable, isTransformable, isVisible, remap, removeFigureListener, removeNotify, requestRemove, setBounds, setConnectable, setRemovable, setSelectable, setTransformable, setVisible, toString, willChange

Methods inherited from class org.jhotdraw.beans.AbstractBean

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jhotdraw.draw.Figure

addFigureListener, addNotify, addPropertyChangeListener, changed, draw, findFigureInside, get, getActions, getAttributes, getAttributesRestoreData, getConnectors, getCursor, getDecomposition, getEndPoint, getLayer, getPreferredSize, getStartPoint, getTool, getToolTipText, handleDrop, handleMouseClick, includes, isConnectable, isRemovable, isSelectable, isTransformable, isVisible, remap, removeFigureListener, removeNotify, removePropertyChangeListener, requestRemove, restoreAttributesTo, set, willChange

Constructor Detail

ODGRectFigure

public ODGRectFigure()

Creates a new instance.

ODGRectFigure

public ODGRectFigure(double x,
                     double y,
                     double width,
                     double height)

ODGRectFigure

public ODGRectFigure(double x,
                     double y,
                     double width,
                     double height,
                     double rx,
                     double ry)

Method Detail

getX

public double getX()

getY

public double getY()

getWidth

public double getWidth()

getHeight

public double getHeight()

getArcWidth

public double getArcWidth()

getArcHeight

public double getArcHeight()

getBounds

public java.awt.geom.Rectangle2D.Double getBounds()

Description copied from interface: Figure

Returns the untransformed logical bounds of the figure as a Rectangle.

The bounds are used by Handle objects for adjusting the figure and for aligning the figure on a grid.

Specified by:

getBounds in interface Figure

getDrawingArea

public java.awt.geom.Rectangle2D.Double getDrawingArea()

Description copied from interface: Figure

Returns the drawing area of the figure as a Rectangle.

The drawing area is used to inform DrawingView about the area that is needed to draw this figure.

The drawing area needs to be large enough, to take line width, line caps and other decorations into account that exceed the bounds of the Figure.

Specified by:

getDrawingArea in interface Figure

Overrides:

getDrawingArea in class AbstractAttributedFigure

contains

public boolean contains(java.awt.geom.Point2D.Double p)

Checks if a Point2D.Double is inside the figure.

Specified by:

contains in interface Figure

setBounds

public void setBounds(java.awt.geom.Point2D.Double anchor,
                      java.awt.geom.Point2D.Double lead)

Description copied from interface: Figure

Sets the logical and untransformed bounds of the figure.

This is used by Tool's which create a new Figure and by Tool's which connect a Figure to another Figure.

This is a basic operation which does not fire events. Use the following code sequence, if you need event firing:

 figure.willChange();
 figure.setBounds(...);
 figure.changed();
 

Specified by:

setBounds in interface Figure

Overrides:

setBounds in class AbstractFigure

Parameters:

anchor - the start point of the bounds

lead - the end point of the bounds

See Also:

Figure.getBounds()

transform

public void transform(java.awt.geom.AffineTransform tx)

Transforms the figure.

Specified by:

transform in interface Figure

Parameters:

tx - The transformation.

See Also:

Figure.getTransformRestoreData(), Figure.restoreTransformTo(java.lang.Object)

setArc

public void setArc(double w,
                   double h)

setArc

public void setArc(Dimension2DDouble arc)

getArc

public Dimension2DDouble getArc()

restoreTransformTo

public void restoreTransformTo(java.lang.Object geometry)

Description copied from interface: Figure

Restores the transform of the figure to a previously stored state.

Specified by:

restoreTransformTo in interface Figure

getTransformRestoreData

public java.lang.Object getTransformRestoreData()

Description copied from interface: Figure

Gets data which can be used to restore the transformation of the figure without loss of precision, after a transform has been applied to it.

Specified by:

getTransformRestoreData in interface Figure

See Also:

Figure.transform(AffineTransform)

createHandles

public java.util.Collection<Handle> createHandles(int detailLevel)

Description copied from interface: Figure

Creates handles used to manipulate the figure.

Specified by:

createHandles in interface Figure

Overrides:

createHandles in class AbstractFigure

Parameters:

detailLevel - The detail level of the handles. Usually this is 0 for bounding box handles and 1 for point handles. The value -1 is used by the SelectAreaTracker and the HandleTracker to highlight figures, over which the mouse pointer is hovering.

Returns:

a Collection of handles

See Also:

Handle

findConnector

public Connector findConnector(java.awt.geom.Point2D.Double p,
                               ConnectionFigure prototype)

Description copied from class: AbstractFigure

Returns the Figures connector for the specified location. By default a ChopBoxConnector is returned.

Specified by:

findConnector in interface Figure

Overrides:

findConnector in class AbstractFigure

Parameters:

p - the location of the connector.

prototype - The prototype used to create a connection or null if unknown. This allows for specific connectors for different connection figures.

See Also:

ChopRectangleConnector

findCompatibleConnector

public Connector findCompatibleConnector(Connector c,
                                         boolean isStartConnector)

Description copied from interface: Figure

Gets a compatible connector. If the provided connector is part of this figure, return the connector. If the provided connector is part of another figure, return a connector with the same semantics for this figure. Returns null, if no compatible connector is available.

Specified by:

findCompatibleConnector in interface Figure

Overrides:

findCompatibleConnector in class AbstractFigure

clone

public ODGRectFigure clone()

Description copied from interface: Figure

Returns a clone of the figure, with clones of all aggregated figures, such as children and decorators. The cloned figure does not clone the list of FigureListeners from its original.

Specified by:

clone in interface Figure

Overrides:

clone in class AbstractAttributedFigure

isEmpty

public boolean isEmpty()

Description copied from interface: ODGFigure

Returns true, if this figure is empty for one of the following reasons:

• A group has no children
• A path has less than two points
• An ellipse or a rectangle has a width or a height of 0
• A text has no characters

Specified by:

isEmpty in interface ODGFigure

invalidate

public void invalidate()

Description copied from class: AbstractFigure

Invalidates cached data of the Figure. This method must execute fast, because it can be called very often.