edu.umd.cs.jazz.component
Class ZRectangle

java.lang.Object
  |
  +--edu.umd.cs.jazz.ZSceneGraphObject
        |
        +--edu.umd.cs.jazz.ZVisualComponent
              |
              +--edu.umd.cs.jazz.component.ZRectangle

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, ZAppearance, ZFillColor, ZPenColor, ZSerializable, ZStroke

public class ZRectangle

extends ZVisualComponent

implements ZPenColor, ZFillColor, ZStroke, java.io.Serializable

ZRectangle is a graphic object that represents a hard-cornered or rounded rectangle.

Warning: Serialized and ZSerialized objects of this class will not be compatible with future Jazz releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Jazz. A future release of Jazz will provide support for long term persistence.

See Also:

Serialized Form

Field Summary

static boolean	absPenWidth_DEFAULT
static java.awt.Color	fillColor_DEFAULT
static java.awt.Color	penColor_DEFAULT
static double	penWidth_DEFAULT

Fields inherited from class edu.umd.cs.jazz.ZSceneGraphObject

bounds, volatileBounds, volatileBounds_DEFAULT

Constructor Summary

ZRectangle()
Constructs a new Rectangle.

ZRectangle(double x, double y)
Constructs a new Rectangle at the specified location, with dimensions of zero.

ZRectangle(double x, double y, double width, double height)
Constructs a new Rectangle at the specified location, with the given dimensions.

ZRectangle(java.awt.geom.Rectangle2D r)
Constructs a new Rectangle based on the geometry of the one passed in.

Method Summary

protected void	computeBounds() Notifies this object that it has changed and that it should update its notion of its bounding box.
protected java.lang.Object	duplicateObject() Returns a clone of this object.
double	getAbsPenWidth() Get the absolute width of the pen used to draw the line around the perimeter of this rectangle.
java.awt.Color	getFillColor() Get the fill color of this rectangle.
double	getHeight() Return height of rectangle.
java.awt.Color	getPenColor() Get the pen color of this rectangle.
double	getPenWidth() Get the width of the pen used to draw the perimeter of this rectangle.
java.awt.geom.Rectangle2D	getRect() Return rectangle.
java.awt.Stroke	getStroke() Get the stroke used to draw the visual component.
double	getWidth() Return width of rectangle.
double	getX() Return x-coord of rectangle.
double	getY() Return y-coord of rectangle.
boolean	pick(java.awt.geom.Rectangle2D pickRect, ZSceneGraphPath path) Determines if the specified rectangle overlaps this rectangle.
void	render(ZRenderContext renderContext) Paints this object.
void	setAbsPenWidth(double width) Set the absolute width of the pen used to draw the line around the perimeter of this rectangle.
void	setFillColor(java.awt.Color color) Set the fill color of this rectangle.
void	setPenColor(java.awt.Color color) Set the pen color of this rectangle.
void	setPenWidth(double width) Set the width of the pen used to draw the perimeter of this rectangle.
void	setRect(double x, double y, double width, double height) Sets location and size of the rectangle.
void	setRect(java.awt.geom.Rectangle2D r) Sets coordinates of rectangle.
void	setState(java.lang.String fieldType, java.lang.String fieldName, java.lang.Object fieldValue) Set some state of this object as it gets read back in.
void	setStroke(java.awt.Stroke stroke) Set the stroke used to draw the visual component.
void	writeObject(ZObjectOutputStream out) Write out all of this object's state.

Methods inherited from class edu.umd.cs.jazz.ZVisualComponent

addParent, getParents, getRoot, paint, pickBounds, removeParent, repaint, repaint, trimToSize, updateBounds, updateObjectReferences, updateParentBounds, updateVolatility, writeObjectRecurse

Methods inherited from class edu.umd.cs.jazz.ZSceneGraphObject

clone, dump, getBounds, getBoundsReference, getVolatileBounds, reshape, setBounds, setVolatileBounds

Methods inherited from class java.lang.Object

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

Field Detail

penColor_DEFAULT

public static final java.awt.Color penColor_DEFAULT

fillColor_DEFAULT

public static final java.awt.Color fillColor_DEFAULT

penWidth_DEFAULT

public static final double penWidth_DEFAULT

absPenWidth_DEFAULT

public static final boolean absPenWidth_DEFAULT

Constructor Detail

ZRectangle

public ZRectangle()

Constructs a new Rectangle.

ZRectangle

public ZRectangle(double x,
                  double y)

Constructs a new Rectangle at the specified location, with dimensions of zero.

Parameters:

x - X-coord of top-left corner

y - Y-coord of top-left corner

ZRectangle

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

Constructs a new Rectangle at the specified location, with the given dimensions.

Parameters:

x - X-coord of top-left corner

y - Y-coord of top-left corner

width - Width of rectangle

height - Height of rectangle

ZRectangle

public ZRectangle(java.awt.geom.Rectangle2D r)

Constructs a new Rectangle based on the geometry of the one passed in.

Parameters:

r - A rectangle to get the geometry from

Method Detail

duplicateObject

protected java.lang.Object duplicateObject()

Returns a clone of this object.

Overrides:

duplicateObject in class ZVisualComponent

See Also:

ZSceneGraphObject.duplicateObject()

getPenWidth

public double getPenWidth()

Get the width of the pen used to draw the perimeter of this rectangle. The pen is drawn centered around the rectangle vertices, so if the pen width is thick, the bounds of the rectangle will grow. If the pen width is absolute (independent of magnification), then this returns 0.

Specified by:

getPenWidth in interface ZStroke

Returns:

the pen width.

See Also:

getAbsPenWidth()

setPenWidth

public void setPenWidth(double width)

Set the width of the pen used to draw the perimeter of this rectangle. The pen is drawn centered around the rectangle vertices, so if the pen width is thick, the bounds of the rectangle will grow.

Specified by:

setPenWidth in interface ZStroke

Parameters:

width - the pen width.

setAbsPenWidth

public void setAbsPenWidth(double width)

Set the absolute width of the pen used to draw the line around the perimeter of this rectangle. The pen is drawn centered around the rectangle vertices, so if the pen width is thick, the bounds of the rectangle will grow.

Specified by:

setAbsPenWidth in interface ZStroke

Parameters:

width - the pen width.

getAbsPenWidth

public double getAbsPenWidth()

Get the absolute width of the pen used to draw the line around the perimeter of this rectangle. The pen is drawn centered around the rectangle vertices, so if the pen width is thick, the bounds of the rectangle will grow. If the pen width is not absolute (dependent on magnification), then this returns 0.

Specified by:

getAbsPenWidth in interface ZStroke

Returns:

the pen width.

See Also:

getPenWidth()

getStroke

public java.awt.Stroke getStroke()

Get the stroke used to draw the visual component.

Specified by:

getStroke in interface ZStroke

Returns:

the stroke.

setStroke

public void setStroke(java.awt.Stroke stroke)

Set the stroke used to draw the visual component.

Specified by:

setStroke in interface ZStroke

Parameters:

stroke - the stroke.

getPenColor

public java.awt.Color getPenColor()

Get the pen color of this rectangle.

Specified by:

getPenColor in interface ZPenColor

Returns:

the pen color.

setPenColor

public void setPenColor(java.awt.Color color)

Set the pen color of this rectangle.

Specified by:

setPenColor in interface ZPenColor

Parameters:

color - the pen color, or null if none.

getFillColor

public java.awt.Color getFillColor()

Get the fill color of this rectangle.

Specified by:

getFillColor in interface ZFillColor

Returns:

the fill color.

setFillColor

public void setFillColor(java.awt.Color color)

Set the fill color of this rectangle.

Specified by:

setFillColor in interface ZFillColor

Parameters:

color - the fill color, or null if none.

pick

public boolean pick(java.awt.geom.Rectangle2D pickRect,
                    ZSceneGraphPath path)

Determines if the specified rectangle overlaps this rectangle.

Overrides:

pick in class ZVisualComponent

Parameters:

pickRect - The rectangle that is picking this rectangle

path - The path through the scenegraph to the picked node. Modified by this call.

Returns:

true if the rectangle picks this visual component

See Also:

ZDrawingSurface.pick(int, int)

render

public void render(ZRenderContext renderContext)

Paints this object.

The transform, clip, and composite will be set appropriately when this object is rendered. It is up to this object to restore the transform, clip, and composite of the Graphics2D if this node changes any of them. However, the color, font, and stroke are unspecified by Jazz. This object should set those things if they are used, but they do not need to be restored.

Overrides:

render in class ZVisualComponent

Parameters:

renderContext - The graphics context to paint into.

computeBounds

protected void computeBounds()

Notifies this object that it has changed and that it should update its notion of its bounding box. Note that this should not be called directly. Instead, it is called by updateBounds when needed.

Overrides:

computeBounds in class ZSceneGraphObject

getX

public double getX()

Return x-coord of rectangle.

Returns:

x-coord.

getY

public double getY()

Return y-coord of rectangle.

Returns:

y-coord.

getWidth

public double getWidth()

Return width of rectangle.

Returns:

width.

getHeight

public double getHeight()

Return height of rectangle.

Returns:

height.

getRect

public java.awt.geom.Rectangle2D getRect()

Return rectangle.

Returns:

rectangle.

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)

Sets location and size of the rectangle.

Parameters:

x - X-coord of top-left corner

y - Y-coord of top-left corner

width - Width of rectangle

height - Height of rectangle

setRect

public void setRect(java.awt.geom.Rectangle2D r)

Sets coordinates of rectangle.

Parameters:

r - The new rectangle coordinates

writeObject

public void writeObject(ZObjectOutputStream out)
                 throws java.io.IOException

Write out all of this object's state.

Overrides:

writeObject in class ZVisualComponent

Parameters:

out - The stream that this object writes into

setState

public void setState(java.lang.String fieldType,
                     java.lang.String fieldName,
                     java.lang.Object fieldValue)

Set some state of this object as it gets read back in. After the object is created with its default no-arg constructor, this method will be called on the object once for each bit of state that was written out through calls to ZObjectOutputStream.writeState() within the writeObject method.

Overrides:

setState in class ZVisualComponent

Parameters:

fieldType - The fully qualified type of the field

fieldName - The name of the field

fieldValue - The value of the field