This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.awt.geom
class RoundRectangle2D

java.lang.Object extended by java.awt.geom.RectangularShape extended by java.awt.geom.RoundRectangle2D
All Implemented Interfaces:
Shape, Cloneable
Direct Known Subclasses:
RoundRectangle2D.Double, RoundRectangle2D.Float

public abstract class RoundRectangle2D
extends RectangularShape

The RoundRectangle2D class defines a rectangle with rounded corners defined by a location {@code (x,y)}, a dimension {@code (w x h)}, and the width and height of an arc with which to round the corners.

This class is the abstract superclass for all objects that store a 2D rounded rectangle. The actual storage representation of the coordinates is left to the subclass.


Nested Class Summary
static class

           The Double class defines a rectangle with rounded corners all specified in double coordinates.
static class

           The Float class defines a rectangle with rounded corners all specified in float coordinates.
 
Constructor Summary
protected

          This is an abstract class that cannot be instantiated directly.
 
Method Summary
 boolean
contains(double x, double y)

          
 boolean
contains(double x, double y, double w, double h)

          
 boolean

          Determines whether or not the specified Object is equal to this RoundRectangle2D.
abstract double

          Gets the height of the arc that rounds off the corners.
abstract double

          Gets the width of the arc that rounds off the corners.
 PathIterator

          Returns an iteration object that defines the boundary of this RoundRectangle2D.
 int

          Returns the hashcode for this RoundRectangle2D.
 boolean
intersects(double x, double y, double w, double h)

          
 void
setFrame(double x, double y, double w, double h)

          Sets the location and size of the framing rectangle of this Shape to the specified rectangular values.
abstract void
setRoundRect(double x, double y, double w, double h, double arcWidth, double arcHeight)

          Sets the location, size, and corner radii of this RoundRectangle2D to the specified double values.
 void

          Sets this RoundRectangle2D to be the same as the specified RoundRectangle2D.
 
Methods inherited from class java.awt.geom.RectangularShape
clone, contains, contains, getBounds, getCenterX, getCenterY, getFrame, getHeight, getMaxX, getMaxY, getMinX, getMinY, getPathIterator, getWidth, getX, getY, intersects, isEmpty, setFrame, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoundRectangle2D

protected RoundRectangle2D()
This is an abstract class that cannot be instantiated directly. Type-specific implementation subclasses are available for instantiation and provide a number of formats for storing the information necessary to satisfy the various accessor methods below.

Method Detail

contains

public boolean contains(double x,
                        double y)
{@inheritDoc}

Parameters:
x
y

contains

public boolean contains(double x,
                        double y,
                        double w,
                        double h)
{@inheritDoc}

Parameters:
x
y
w
h

equals

public boolean equals(Object obj)
Determines whether or not the specified Object is equal to this RoundRectangle2D. The specified Object is equal to this RoundRectangle2D if it is an instance of RoundRectangle2D and if its location, size, and corner arc dimensions are the same as this RoundRectangle2D.

Overrides:
equals in class Object
Parameters:
obj - an Object to be compared with this RoundRectangle2D.
Returns:
true if obj is an instance of RoundRectangle2D and has the same values; false otherwise.

getArcHeight

public abstract double getArcHeight()
Gets the height of the arc that rounds off the corners.

Returns:
the height of the arc that rounds off the corners of this RoundRectangle2D.

getArcWidth

public abstract double getArcWidth()
Gets the width of the arc that rounds off the corners.

Returns:
the width of the arc that rounds off the corners of this RoundRectangle2D.

getPathIterator

public PathIterator getPathIterator(AffineTransform at)
Returns an iteration object that defines the boundary of this RoundRectangle2D. The iterator for this class is multi-threaded safe, which means that this RoundRectangle2D class guarantees that modifications to the geometry of this RoundRectangle2D object do not affect any iterations of that geometry that are already in process.

Parameters:
at - an optional AffineTransform to be applied to the coordinates as they are returned in the iteration, or null if untransformed coordinates are desired
Returns:
the PathIterator object that returns the geometry of the outline of this RoundRectangle2D, one segment at a time.

hashCode

public int hashCode()
Returns the hashcode for this RoundRectangle2D.

Overrides:
hashCode in class Object
Returns:
the hashcode for this RoundRectangle2D.

intersects

public boolean intersects(double x,
                          double y,
                          double w,
                          double h)
{@inheritDoc}

Parameters:
x
y
w
h

setFrame

public void setFrame(double x,
                     double y,
                     double w,
                     double h)
{@inheritDoc}

Overrides:
setFrame in class RectangularShape
Parameters:
x
y
w
h

setRoundRect

public abstract void setRoundRect(double x,
                                  double y,
                                  double w,
                                  double h,
                                  double arcWidth,
                                  double arcHeight)
Sets the location, size, and corner radii of this RoundRectangle2D to the specified double values.

Parameters:
x - the X coordinate to which to set the location of this RoundRectangle2D
y - the Y coordinate to which to set the location of this RoundRectangle2D
w - the width to which to set this RoundRectangle2D
h - the height to which to set this RoundRectangle2D
arcWidth - the width to which to set the arc of this RoundRectangle2D
arcHeight - the height to which to set the arc of this RoundRectangle2D

setRoundRect

public void setRoundRect(RoundRectangle2D rr)
Sets this RoundRectangle2D to be the same as the specified RoundRectangle2D.

Parameters:
rr - the specified RoundRectangle2D


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.