org.jhotdraw.draw
Class RectangleFigure

java.lang.Object
  org.jhotdraw.beans.AbstractBean
      org.jhotdraw.draw.AbstractFigure
          org.jhotdraw.draw.AbstractAttributedFigure
              org.jhotdraw.draw.RectangleFigure

All Implemented Interfaces:

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

Direct Known Subclasses:

BorderRectangleFigure

public class RectangleFigure
extends AbstractAttributedFigure

RectangleFigure.

Version:

2.3 2006-12-23 Made rectangle protected.
2.2 2006-03-23 Take stroke size into account in method contains.
2.1 2006-03-22 Method getFigureDrawBounds added.
2.0 2006-01-14 Changed to support double precison coordinates.
1.0 2003-12-01 Derived from JHotDraw 5.4b1.

Author:

Werner Randelshofer

See Also:

Serialized Form

Field Summary

protected java.awt.geom.Rectangle2D.Double

rectangle

Fields inherited from class org.jhotdraw.draw.AbstractFigure

changingDepth, listenerList

Fields inherited from class org.jhotdraw.beans.AbstractBean

propertySupport

Constructor Summary

RectangleFigure()
Creates a new instance.

RectangleFigure(double x, double y, double width, double height)

Method Summary

RectangleFigure	clone() Returns a clone of the figure, with clones of all aggregated figures, such as chilrend and decorators.
boolean	contains(java.awt.geom.Point2D.Double p) Checks if a Point2D.Double is inside the figure.
protected void	drawFill(java.awt.Graphics2D g) This method is called by method draw() to draw the fill area of the figure.
protected void	drawStroke(java.awt.Graphics2D g) This method is called by method draw() to draw the text of the figure .
java.awt.geom.Rectangle2D.Double	getBounds() Returns the untransformed logicalbounds of the figure as a Rectangle.
java.awt.geom.Rectangle2D.Double	getDrawingArea() Returns the drawing area of the figure as a Rectangle.
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.
void	restoreTransformTo(java.lang.Object geometry) Restores the transform of the figure to a previously stored state.
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) Moves the Figure to a new location.

Methods inherited from class org.jhotdraw.draw.AbstractAttributedFigure

applyAttributesTo, draw, drawText, getAttribute, getAttributeKey, getAttributes, getAttributesRestoreData, getStroke, getStrokeMiterLimitFactor, hasAttribute, isAttributeEnabled, read, readAttributes, removeAttribute, restoreAttributesTo, setAttribute, setAttributeEnabled, setAttributes, write, writeAttributes

Methods inherited from class org.jhotdraw.draw.AbstractFigure

addFigureListener, addNotify, basicClone, canConnect, changed, createHandles, findCompatibleConnector, findConnector, findFigureInside, fireAreaInvalidated, fireAreaInvalidated, fireAreaInvalidated, fireAttributeChanged, fireFigureAdded, fireFigureChanged, fireFigureChanged, fireFigureChanged, fireFigureHandlesChanged, fireFigureRemoved, fireFigureRequestRemove, fireUndoableEditHappened, getActions, getChangingDepth, getConnectors, getCursor, getDecomposition, getDrawing, getEndPoint, getFontRenderContext, getLayer, getLock, getPreferredSize, getStartPoint, getTool, getToolTipText, handleDrop, handleMouseClick, includes, invalidate, isChanging, isRemovable, isSelectable, isTransformable, isVisible, remap, remap, removeFigureListener, removeNotify, requestRemove, setBounds, setRemovable, setSelectable, setTransformable, setVisible, toString, validate, willChange

Methods inherited from class org.jhotdraw.beans.AbstractBean

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Detail

rectangle

protected java.awt.geom.Rectangle2D.Double rectangle

Constructor Detail

RectangleFigure

public RectangleFigure()

Creates a new instance.

RectangleFigure

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

Method Detail

drawFill

protected void drawFill(java.awt.Graphics2D g)

Description copied from class: AbstractAttributedFigure

This method is called by method draw() to draw the fill area of the figure. AbstractAttributedFigure configures the Graphics2D object with the FILL_COLOR attribute before calling this method. If the FILL_COLOR attribute is null, this method is not called.

Specified by:

drawFill in class AbstractAttributedFigure

drawStroke

protected void drawStroke(java.awt.Graphics2D g)

Description copied from class: AbstractAttributedFigure

This method is called by method draw() to draw the text of the figure . AbstractAttributedFigure configures the Graphics2D object with the TEXT_COLOR attribute before calling this method. If the TEXT_COLOR attribute is null, this method is not called.

Specified by:

drawStroke in class AbstractAttributedFigure

getBounds

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

Description copied from interface: Figure

Returns the untransformed logicalbounds of the figure as a Rectangle. The handle bounds are used by Handle objects for adjusting the figure and for aligning the figure on a grid.

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 improve the performance of GraphicView, for example for clipping of repaints and for clipping of mouse events.

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.

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:

 aFigure.willChange();
 aFigure.setBounds(...);
 aFigure.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)

Moves the Figure to a new location.

Parameters:

tx - the transformation matrix.

See Also:

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

restoreTransformTo

public void restoreTransformTo(java.lang.Object geometry)

Description copied from interface: Figure

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

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.

See Also:

Figure.transform(AffineTransform)

clone

public RectangleFigure clone()

Description copied from interface: Figure

Returns a clone of the figure, with clones of all aggregated figures, such as chilrend 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