Class RoundRectangle2D
- java.lang.Object
-
- java.awt.geom.RectangularShape
-
- java.awt.geom.RoundRectangle2D
-
- Direct Known Subclasses:
- RoundRectangle2D.Double, RoundRectangle2D.Float
public abstract class RoundRectangle2D extends RectangularShape
TheRoundRectangle2D
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
Nested Classes Modifier and Type Class and Description static class
RoundRectangle2D.Double
TheDouble
class defines a rectangle with rounded corners all specified indouble
coordinates.static class
RoundRectangle2D.Float
TheFloat
class defines a rectangle with rounded corners all specified infloat
coordinates.
-
Constructor Summary
Constructors Modifier Constructor and Description protected
RoundRectangle2D()
This is an abstract class that cannot be instantiated directly.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description boolean
contains(double x, double y)
Tests if the specified coordinates are inside the boundary of theShape
, as described by the definition of insideness.boolean
contains(double x, double y, double w, double h)
Tests if the interior of theShape
entirely contains the specified rectangular area.boolean
equals(Object obj)
Determines whether or not the specifiedObject
is equal to thisRoundRectangle2D
.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(AffineTransform at)
Returns an iteration object that defines the boundary of thisRoundRectangle2D
.int
hashCode()
Returns the hashcode for thisRoundRectangle2D
.boolean
intersects(double x, double y, double w, double h)
Tests if the interior of theShape
intersects the interior of a specified rectangular area.void
setFrame(double x, double y, double w, double h)
Sets the location and size of the framing rectangle of thisShape
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 thisRoundRectangle2D
to the specifieddouble
values.void
setRoundRect(RoundRectangle2D rr)
Sets thisRoundRectangle2D
to be the same as the specifiedRoundRectangle2D
.-
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, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.awt.Shape
getBounds2D
-
-
-
-
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.- Since:
- 1.2
- See Also:
-
RoundRectangle2D.Float
,RoundRectangle2D.Double
-
Method Detail
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
. - Since:
- 1.2
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
. - Since:
- 1.2
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 thisRoundRectangle2D
to the specifieddouble
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)
Sets thisRoundRectangle2D
to be the same as the specifiedRoundRectangle2D
.- Parameters:
-
rr
- the specifiedRoundRectangle2D
- Since:
- 1.2
setFrame
public void setFrame(double x, double y, double w, double h)
Sets the location and size of the framing rectangle of thisShape
to the specified rectangular values.- Specified by:
-
setFrame
in 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:
-
RectangularShape.getFrame()
contains
public boolean contains(double x, double y)
Tests if the specified coordinates are inside the boundary of theShape
, 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:
-
true
if the specified coordinates are inside theShape
boundary;false
otherwise. - Since:
- 1.2
intersects
public boolean intersects(double x, double y, double w, double h)
Tests if the interior of theShape
intersects the interior of a specified rectangular area. The rectangular area is considered to intersect theShape
if any point is contained in both the interior of theShape
and the specified rectangular area.The
Shape.intersects()
method allows aShape
implementation to conservatively returntrue
when:- there is a high probability that the rectangular area and the
Shape
intersect, but - the calculations to accurately determine this intersection are prohibitively expensive.
Shapes
this method might returntrue
even though the rectangular area does not intersect theShape
. TheArea
class performs more accurate computations of geometric intersection than mostShape
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:
-
true
if the interior of theShape
and the interior of the rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform;false
otherwise. - Since:
- 1.2
- See Also:
-
Area
- there is a high probability that the rectangular area and the
contains
public boolean contains(double x, double y, double w, double h)
Tests if the interior of theShape
entirely contains the specified rectangular area. All coordinates that lie inside the rectangular area must lie within theShape
for the entire rectangular area to be considered contained within theShape
.The
Shape.contains()
method allows aShape
implementation to conservatively returnfalse
when:- the
intersect
method returnstrue
and - the calculations to determine whether or not the
Shape
entirely contains the rectangular area are prohibitively expensive.
Shapes
this method might returnfalse
even though theShape
contains the rectangular area. TheArea
class performs more accurate geometric computations than mostShape
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:
-
true
if the interior of theShape
entirely contains the specified rectangular area;false
otherwise or, if theShape
contains the rectangular area and theintersects
method returnstrue
and the containment calculations would be too expensive to perform. - Since:
- 1.2
- See Also:
-
Area
,Shape.intersects(double, double, double, double)
- the
getPathIterator
public PathIterator getPathIterator(AffineTransform at)
Returns an iteration object that defines the boundary of thisRoundRectangle2D
. The iterator for this class is multi-threaded safe, which means that thisRoundRectangle2D
class guarantees that modifications to the geometry of thisRoundRectangle2D
object do not affect any iterations of that geometry that are already in process.- Parameters:
-
at
- an optionalAffineTransform
to be applied to the coordinates as they are returned in the iteration, ornull
if untransformed coordinates are desired - Returns:
-
the
PathIterator
object that returns the geometry of the outline of thisRoundRectangle2D
, one segment at a time. - Since:
- 1.2
hashCode
public int hashCode()
Returns the hashcode for thisRoundRectangle2D
.- Overrides:
-
hashCode
in classObject
- Returns:
-
the hashcode for this
RoundRectangle2D
. - Since:
- 1.6
- See Also:
-
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
equals
public boolean equals(Object obj)
Determines whether or not the specifiedObject
is equal to thisRoundRectangle2D
. The specifiedObject
is equal to thisRoundRectangle2D
if it is an instance ofRoundRectangle2D
and if its location, size, and corner arc dimensions are the same as thisRoundRectangle2D
.- Overrides:
-
equals
in classObject
- Parameters:
-
obj
- anObject
to be compared with thisRoundRectangle2D
. - Returns:
-
true
ifobj
is an instance ofRoundRectangle2D
and has the same values;false
otherwise. - Since:
- 1.6
- See Also:
-
Object.hashCode()
,HashMap
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.