Class RoundRectangle2D
- Direct Known Subclasses:
-
RoundRectangle2D.Double,RoundRectangle2D.Float
public abstract class RoundRectangle2D extends RectangularShape
RoundRectangle2D class defines a rectangle with rounded corners defined by a location (x,y), a dimension (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.
- Since:
- 1.2
Nested Class Summary
| Modifier and Type | Class | Description |
|---|---|---|
static class |
RoundRectangle2D.Double |
The Double class defines a rectangle with rounded corners all specified in double coordinates. |
static class |
RoundRectangle2D.Float |
The Float class defines a rectangle with rounded corners all specified in float coordinates. |
Constructor Summary
| Modifier | Constructor | Description |
|---|---|---|
protected |
This is an abstract class that cannot be instantiated directly. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
contains |
Tests if the specified coordinates are inside the boundary of the Shape, as described by the definition of insideness. |
boolean |
contains |
Tests if the interior of the Shape entirely contains the specified rectangular area. |
boolean |
equals |
Determines whether or not the specified Object is equal to this RoundRectangle2D. |
abstract double |
getArcHeight() |
Gets the height of the arc that rounds off the corners. |
abstract double |
getArcWidth() |
Gets the width of the arc that rounds off the corners. |
PathIterator |
getPathIterator |
Returns an iteration object that defines the boundary of this RoundRectangle2D. |
int |
hashCode() |
Returns the hashcode for this RoundRectangle2D. |
boolean |
intersects |
Tests if the interior of the Shape intersects the interior of a specified rectangular area. |
void |
setFrame |
Sets the location and size of the framing rectangle of this Shape to the specified rectangular values. |
abstract void |
setRoundRect |
Sets the location, size, and corner radii of this RoundRectangle2D to the specified double values. |
void |
setRoundRect |
Sets this RoundRectangle2D to be the same as the specified RoundRectangle2D. |
Methods declared in 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, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
Methods declared in class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface java.awt.Shape
getBounds2D
Constructor Details
RoundRectangle2D
protected RoundRectangle2D()
- Since:
- 1.2
- See Also:
Method Details
getArcWidth
public abstract double getArcWidth()
- Returns:
- the width of the arc that rounds off the corners of this
RoundRectangle2D. - Since:
- 1.2
getArcHeight
public abstract double getArcHeight()
- Returns:
- the height of the arc that rounds off the corners of this
RoundRectangle2D. - Since:
- 1.2
setRoundRect
public abstract void setRoundRect(double x, double y, double w, double h, double arcWidth, double arcHeight)
RoundRectangle2D to the specified double values.- Parameters:
-
x- the X coordinate to which to set the location of thisRoundRectangle2D -
y- the Y coordinate to which to set the location of thisRoundRectangle2D -
w- the width to which to set thisRoundRectangle2D -
h- the height to which to set thisRoundRectangle2D -
arcWidth- the width to which to set the arc of thisRoundRectangle2D -
arcHeight- the height to which to set the arc of thisRoundRectangle2D - Since:
- 1.2
setRoundRect
public void setRoundRect(RoundRectangle2D rr)
RoundRectangle2D to be the same as the specified RoundRectangle2D.- Parameters:
-
rr- the specifiedRoundRectangle2D - Since:
- 1.2
setFrame
public void setFrame(double x, double y, double w, double h)
Shape to the specified rectangular values.- Specified by:
-
setFramein classRectangularShape - Parameters:
-
x- the X coordinate of the upper-left corner of the specified rectangular shape -
y- the Y coordinate of the upper-left corner of the specified rectangular shape -
w- the width of the specified rectangular shape -
h- the height of the specified rectangular shape - Since:
- 1.2
- See Also:
contains
public boolean contains(double x, double y)
Shape, as described by the definition of insideness.- Parameters:
-
x- the specified X coordinate to be tested -
y- the specified Y coordinate to be tested - Returns:
-
trueif the specified coordinates are inside theShapeboundary;falseotherwise. - Since:
- 1.2
intersects
public boolean intersects(double x, double y, double w, double h)
Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area. The Shape.intersects() method allows a Shape implementation to conservatively return true when:
- there is a high probability that the rectangular area and the
Shapeintersect, but - the calculations to accurately determine this intersection are prohibitively expensive.
Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.- Parameters:
-
x- the X coordinate of the upper-left corner of the specified rectangular area -
y- the Y coordinate of the upper-left corner of the specified rectangular area -
w- the width of the specified rectangular area -
h- the height of the specified rectangular area - Returns:
-
trueif the interior of theShapeand the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform;falseotherwise. - Since:
- 1.2
- See Also:
contains
public boolean contains(double x, double y, double w, double h)
Shape entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within the Shape for the entire rectangular area to be considered contained within the Shape. The Shape.contains() method allows a Shape implementation to conservatively return false when:
- the
intersectmethod returnstrueand - the calculations to determine whether or not the
Shapeentirely contains the rectangular area are prohibitively expensive.
Shapes this method might return false even though the Shape contains the rectangular area. The Area class performs more accurate geometric computations than most Shape objects and therefore can be used if a more precise answer is required.- Parameters:
-
x- the X coordinate of the upper-left corner of the specified rectangular area -
y- the Y coordinate of the upper-left corner of the specified rectangular area -
w- the width of the specified rectangular area -
h- the height of the specified rectangular area - Returns:
-
trueif the interior of theShapeentirely contains the specified rectangular area;falseotherwise or, if theShapecontains the rectangular area and theintersectsmethod returnstrueand the containment calculations would be too expensive to perform. - Since:
- 1.2
- See Also:
getPathIterator
public PathIterator getPathIterator(AffineTransform at)
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 optionalAffineTransformto be applied to the coordinates as they are returned in the iteration, ornullif untransformed coordinates are desired - Returns:
- the
PathIteratorobject that returns the geometry of the outline of thisRoundRectangle2D, one segment at a time. - Since:
- 1.2
hashCode
public int hashCode()
RoundRectangle2D.equals
public boolean equals(Object obj)
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.
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/java/awt/geom/RoundRectangle2D.html