- All Implemented Interfaces:
Shape,Serializable,Cloneable
- Direct Known Subclasses:
DefaultCaret
Rectangle specifies an area in a coordinate space that is
enclosed by the Rectangle object's upper-left point
(x,y)
in the coordinate space, its width, and its height.
A Rectangle object's width and
height are public fields. The constructors
that create a Rectangle, and the methods that can modify
one, do not prevent setting a negative value for width or height.
A Rectangle whose width or height is exactly zero has location
along those axes with zero dimension, but is otherwise considered empty.
The isEmpty() method will return true for such a Rectangle.
Methods which test if an empty Rectangle contains or intersects
a point or rectangle will always return false if either dimension is zero.
Methods which combine such a Rectangle with a point or rectangle
will include the location of the Rectangle on that axis in the
result as if the add(Point) method were being called.
Methods which affect only the location of a Rectangle will
operate on its location regardless of whether or not it has a negative
or zero dimension along either axis.
Note that a Rectangle constructed with the default no-argument
constructor will have dimensions of 0x0 and therefore be empty.
That Rectangle will still have a location of (0,0) and
will contribute that location to the union and add operations.
Code attempting to accumulate the bounds of a set of points should
therefore initially construct the Rectangle with a specifically
negative width and height or it should use the first point in the set
to construct the Rectangle.
For example:
Rectangle bounds = new Rectangle(0, 0, -1, -1);
for (int i = 0; i < points.length; i++) {
bounds.add(points[i]);
}
or if we know that the points array contains at least one point:
Rectangle bounds = new Rectangle(points[0]);
for (int i = 1; i < points.length; i++) {
bounds.add(points[i]);
}
This class uses 32-bit integers to store its location and dimensions.
Frequently operations may produce a result that exceeds the range of
a 32-bit integer.
The methods will calculate their results in a way that avoids any
32-bit overflow for intermediate results and then choose the best
representation to store the final results back into the 32-bit fields
which hold the location and dimensions.
The location of the result will be stored into the x and
y fields by clipping the true result to the nearest 32-bit value.
The values stored into the width and height dimension
fields will be chosen as the 32-bit values that encompass the largest
part of the true result as possible.
Generally this means that the dimension will be clipped independently
to the range of 32-bit integers except that if the location had to be
moved to store it into its pair of 32-bit fields then the dimensions
will be adjusted relative to the "best representation" of the location.
If the true result had a negative dimension and was therefore
non-existent along one or both axes, the stored dimensions will be
negative numbers in those axes.
If the true result had a location that could be represented within
the range of 32-bit integers, but zero dimension along one or both
axes, then the stored dimensions will be zero in those axes.
- Since:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces declared in class java.awt.geom.Rectangle2D
Rectangle2D.Double, Rectangle2D.Float -
Field Summary
FieldsModifier and TypeFieldDescriptionintThe height of theRectangle.intThe width of theRectangle.intThe X coordinate of the upper-left corner of theRectangle.intThe Y coordinate of the upper-left corner of theRectangle.Fields declared in class java.awt.geom.Rectangle2D
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newRectanglewhose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero.Rectangle(int width, int height) Constructs a newRectanglewhose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are specified by the arguments of the same name.Rectangle(int x, int y, int width, int height) Constructs a newRectanglewhose upper-left corner is specified as(x,y)and whose width and height are specified by the arguments of the same name.Constructs a newRectanglewhose top left corner is (0, 0) and whose width and height are specified by theDimensionargument.Constructs a newRectanglewhose upper-left corner is the specifiedPoint, and whose width and height are both zero.Constructs a newRectangle, initialized to match the values of the specifiedRectangle. -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(int newx, int newy) Adds a point, specified by the integer argumentsnewx,newyto the bounds of thisRectangle.voidAdds the specifiedPointto the bounds of thisRectangle.voidAdds aRectangleto thisRectangle.booleancontains(int x, int y) Checks whether or not thisRectanglecontains the point at the specified location(x,y).booleancontains(int X, int Y, int W, int H) Checks whether thisRectangleentirely contains theRectangleat the specified location(X,Y)with the specified dimensions(W,H).booleanChecks whether or not thisRectanglecontains the specifiedPoint.booleanChecks whether or not thisRectangleentirely contains the specifiedRectangle.Returns a newRectangle2Dobject representing the intersection of thisRectangle2Dwith the specifiedRectangle2D.Returns a newRectangle2Dobject representing the union of thisRectangle2Dwith the specifiedRectangle2D.booleanChecks whether two rectangles are equal.Gets the boundingRectangleof thisRectangle.Returns a high precision and more accurate bounding box of theShapethan thegetBoundsmethod.doubleReturns the height of the boundingRectangleindoubleprecision.Returns the location of thisRectangle.getSize()Gets the size of thisRectangle, represented by the returnedDimension.doublegetWidth()Returns the width of the boundingRectangleindoubleprecision.doublegetX()Returns the X coordinate of the boundingRectangleindoubleprecision.doublegetY()Returns the Y coordinate of the boundingRectangleindoubleprecision.voidgrow(int h, int v) Resizes theRectangleboth horizontally and vertically.booleaninside(int X, int Y) Deprecated.Computes the intersection of thisRectanglewith the specifiedRectangle.booleanDetermines whether or not thisRectangleand the specifiedRectangleintersect.booleanisEmpty()Determines whether theRectangularShapeis empty.voidmove(int x, int y) Deprecated.As of JDK version 1.1, replaced bysetLocation(int, int).intoutcode(double x, double y) Determines where the specified coordinates lie with respect to thisRectangle2D.voidreshape(int x, int y, int width, int height) Deprecated.As of JDK version 1.1, replaced bysetBounds(int, int, int, int).voidresize(int width, int height) Deprecated.As of JDK version 1.1, replaced bysetSize(int, int).voidsetBounds(int x, int y, int width, int height) Sets the boundingRectangleof thisRectangleto the specifiedx,y,width, andheight.voidSets the boundingRectangleof thisRectangleto match the specifiedRectangle.voidsetLocation(int x, int y) Moves thisRectangleto the specified location.voidsetLocation(Point p) Moves thisRectangleto the specified location.voidsetRect(double x, double y, double width, double height) Sets the bounds of thisRectangleto the integer bounds which encompass the specifiedx,y,width, andheight.voidsetSize(int width, int height) Sets the size of thisRectangleto the specified width and height.voidSets the size of thisRectangleto match the specifiedDimension.toString()Returns aStringrepresenting thisRectangleand its values.voidtranslate(int dx, int dy) Translates thisRectanglethe indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.Computes the union of thisRectanglewith the specifiedRectangle.Methods declared in class java.awt.geom.Rectangle2D
add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, unionMethods declared in class java.awt.geom.RectangularShape
clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonalMethods declared in interface java.awt.Shape
contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects
-
Field Details
-
x
public int xThe X coordinate of the upper-left corner of theRectangle.- Since:
- 1.0
- See Also:
-
y
public int yThe Y coordinate of the upper-left corner of theRectangle.- Since:
- 1.0
- See Also:
-
width
public int widthThe width of theRectangle.- Since:
- 1.0
- See Also:
-
height
public int heightThe height of theRectangle.- Since:
- 1.0
- See Also:
-
-
Constructor Details
-
Rectangle
public Rectangle()Constructs a newRectanglewhose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero. -
Rectangle
Constructs a newRectangle, initialized to match the values of the specifiedRectangle.- Parameters:
r- theRectanglefrom which to copy initial values to a newly constructedRectangle- Since:
- 1.1
-
Rectangle
public Rectangle(int x, int y, int width, int height) Constructs a newRectanglewhose upper-left corner is specified as(x,y)and whose width and height are specified by the arguments of the same name.- Parameters:
x- the specified X coordinatey- the specified Y coordinatewidth- the width of theRectangleheight- the height of theRectangle- Since:
- 1.0
-
Rectangle
public Rectangle(int width, int height) Constructs a newRectanglewhose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are specified by the arguments of the same name.- Parameters:
width- the width of theRectangleheight- the height of theRectangle
-
Rectangle
Constructs a newRectanglewhose upper-left corner is specified by thePointargument, and whose width and height are specified by theDimensionargument.- Parameters:
p- aPointthat is the upper-left corner of theRectangled- aDimension, representing the width and height of theRectangle
-
Rectangle
Constructs a newRectanglewhose upper-left corner is the specifiedPoint, and whose width and height are both zero.- Parameters:
p- aPointthat is the top left corner of theRectangle
-
Rectangle
Constructs a newRectanglewhose top left corner is (0, 0) and whose width and height are specified by theDimensionargument.- Parameters:
d- aDimension, specifying width and height
-
-
Method Details
-
getX
public double getX()Returns the X coordinate of the boundingRectangleindoubleprecision.- Specified by:
getXin classRectangularShape- Returns:
- the X coordinate of the bounding
Rectangle.
-
getY
public double getY()Returns the Y coordinate of the boundingRectangleindoubleprecision.- Specified by:
getYin classRectangularShape- Returns:
- the Y coordinate of the bounding
Rectangle.
-
getWidth
public double getWidth()Returns the width of the boundingRectangleindoubleprecision.- Specified by:
getWidthin classRectangularShape- Returns:
- the width of the bounding
Rectangle.
-
getHeight
public double getHeight()Returns the height of the boundingRectangleindoubleprecision.- Specified by:
getHeightin classRectangularShape- Returns:
- the height of the bounding
Rectangle.
-
getBounds
Gets the boundingRectangleof thisRectangle.This method is included for completeness, to parallel the
getBoundsmethod ofComponent.- Specified by:
getBoundsin interfaceShape- Overrides:
getBoundsin classRectangularShape- Returns:
- a new
Rectangle, equal to the boundingRectanglefor thisRectangle. - Since:
- 1.1
- See Also:
-
getBounds2D
Returns a high precision and more accurate bounding box of theShapethan thegetBoundsmethod. Note that there is no guarantee that the returnedRectangle2Dis the smallest bounding box that encloses theShape, only that theShapelies entirely within the indicatedRectangle2D. The bounding box returned by this method is usually tighter than that returned by thegetBoundsmethod and never fails due to overflow problems since the return value can be an instance of theRectangle2Dthat uses double precision values to store the dimensions.Note that the definition of insideness can lead to situations where points on the defining outline of the
shapemay not be considered contained in the returnedboundsobject, but only in cases where those points are also not considered contained in the originalshape.If a
pointis inside theshapeaccording to thecontains(point)method, then it must be inside the returnedRectangle2Dbounds object according to thecontains(point)method of thebounds. Specifically:shape.contains(p)requiresbounds.contains(p)If a
pointis not inside theshape, then it might still be contained in theboundsobject:bounds.contains(p)does not implyshape.contains(p)- Specified by:
getBounds2Din interfaceShape- Overrides:
getBounds2Din classRectangle2D- Returns:
- an instance of
Rectangle2Dthat is a high-precision bounding box of theShape. - Since:
- 1.2
- See Also:
-
setBounds
Sets the boundingRectangleof thisRectangleto match the specifiedRectangle.This method is included for completeness, to parallel the
setBoundsmethod ofComponent.- Parameters:
r- the specifiedRectangle- Since:
- 1.1
- See Also:
-
setBounds
public void setBounds(int x, int y, int width, int height) Sets the boundingRectangleof thisRectangleto the specifiedx,y,width, andheight.This method is included for completeness, to parallel the
setBoundsmethod ofComponent.- Parameters:
x- the new X coordinate for the upper-left corner of thisRectangley- the new Y coordinate for the upper-left corner of thisRectanglewidth- the new width for thisRectangleheight- the new height for thisRectangle- Since:
- 1.1
- See Also:
-
setRect
public void setRect(double x, double y, double width, double height) Sets the bounds of thisRectangleto the integer bounds which encompass the specifiedx,y,width, andheight. If the parameters specify aRectanglethat exceeds the maximum range of integers, the result will be the best representation of the specifiedRectangleintersected with the maximum integer bounds.- Specified by:
setRectin classRectangle2D- Parameters:
x- the X coordinate of the upper-left corner of the specified rectangley- the Y coordinate of the upper-left corner of the specified rectanglewidth- the width of the specified rectangleheight- the new height of the specified rectangle
-
reshape
Deprecated.As of JDK version 1.1, replaced bysetBounds(int, int, int, int).Sets the boundingRectangleof thisRectangleto the specifiedx,y,width, andheight.- Parameters:
x- the new X coordinate for the upper-left corner of thisRectangley- the new Y coordinate for the upper-left corner of thisRectanglewidth- the new width for thisRectangleheight- the new height for thisRectangle
-
getLocation
Returns the location of thisRectangle.This method is included for completeness, to parallel the
getLocationmethod ofComponent.- Returns:
- the
Pointthat is the upper-left corner of thisRectangle. - Since:
- 1.1
- See Also:
-
setLocation
Moves thisRectangleto the specified location.This method is included for completeness, to parallel the
setLocationmethod ofComponent.- Parameters:
p- thePointspecifying the new location for thisRectangle- Since:
- 1.1
- See Also:
-
setLocation
public void setLocation(int x, int y) Moves thisRectangleto the specified location.This method is included for completeness, to parallel the
setLocationmethod ofComponent.- Parameters:
x- the X coordinate of the new locationy- the Y coordinate of the new location- Since:
- 1.1
- See Also:
-
move
Deprecated.As of JDK version 1.1, replaced bysetLocation(int, int).Moves thisRectangleto the specified location.- Parameters:
x- the X coordinate of the new locationy- the Y coordinate of the new location
-
translate
public void translate(int dx, int dy) Translates thisRectanglethe indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.- Parameters:
dx- the distance to move thisRectanglealong the X axisdy- the distance to move thisRectanglealong the Y axis- See Also:
-
getSize
Gets the size of thisRectangle, represented by the returnedDimension.This method is included for completeness, to parallel the
getSizemethod ofComponent.- Returns:
- a
Dimension, representing the size of thisRectangle. - Since:
- 1.1
- See Also:
-
setSize
Sets the size of thisRectangleto match the specifiedDimension.This method is included for completeness, to parallel the
setSizemethod ofComponent.- Parameters:
d- the new size for theDimensionobject- Since:
- 1.1
- See Also:
-
setSize
public void setSize(int width, int height) Sets the size of thisRectangleto the specified width and height.This method is included for completeness, to parallel the
setSizemethod ofComponent.- Parameters:
width- the new width for thisRectangleheight- the new height for thisRectangle- Since:
- 1.1
- See Also:
-
resize
Deprecated.As of JDK version 1.1, replaced bysetSize(int, int).Sets the size of thisRectangleto the specified width and height.- Parameters:
width- the new width for thisRectangleheight- the new height for thisRectangle
-
contains
Checks whether or not thisRectanglecontains the specifiedPoint.- Parameters:
p- thePointto test- Returns:
trueif the specifiedPointis inside thisRectangle;falseotherwise.- Since:
- 1.1
-
contains
public boolean contains(int x, int y) Checks whether or not thisRectanglecontains the point at the specified location(x,y).- Parameters:
x- the specified X coordinatey- the specified Y coordinate- Returns:
trueif the point(x,y)is inside thisRectangle;falseotherwise.- Since:
- 1.1
-
contains
Checks whether or not thisRectangleentirely contains the specifiedRectangle.- Parameters:
r- the specifiedRectangle- Returns:
trueif theRectangleis contained entirely inside thisRectangle;falseotherwise- Since:
- 1.2
-
contains
public boolean contains(int X, int Y, int W, int H) Checks whether thisRectangleentirely contains theRectangleat the specified location(X,Y)with the specified dimensions(W,H).- Parameters:
X- the specified X coordinateY- the specified Y coordinateW- the width of theRectangleH- the height of theRectangle- Returns:
trueif theRectanglespecified by(X, Y, W, H)is entirely enclosed inside thisRectangle;falseotherwise.- Since:
- 1.1
-
inside
Deprecated.As of JDK version 1.1, replaced bycontains(int, int).Checks whether or not thisRectanglecontains the point at the specified location(X,Y).- Parameters:
X- the specified X coordinateY- the specified Y coordinate- Returns:
trueif the point(X,Y)is inside thisRectangle;falseotherwise.
-
intersects
Determines whether or not thisRectangleand the specifiedRectangleintersect. Two rectangles intersect if their intersection is nonempty.- Parameters:
r- the specifiedRectangle- Returns:
trueif the specifiedRectangleand thisRectangleintersect;falseotherwise.
-
intersection
Computes the intersection of thisRectanglewith the specifiedRectangle. Returns a newRectanglethat represents the intersection of the two rectangles. If the two rectangles do not intersect, the result will be an empty rectangle.- Parameters:
r- the specifiedRectangle- Returns:
- the largest
Rectanglecontained in both the specifiedRectangleand in thisRectangle; or if the rectangles do not intersect, an empty rectangle.
-
union
Computes the union of thisRectanglewith the specifiedRectangle. Returns a newRectanglethat represents the union of the two rectangles.If either
Rectanglehas any dimension less than zero the rules for non-existent rectangles apply. If only one has a dimension less than zero, then the result will be a copy of the otherRectangle. If both have dimension less than zero, then the result will have at least one dimension less than zero.If the resulting
Rectanglewould have a dimension too large to be expressed as anint, the result will have a dimension ofInteger.MAX_VALUEalong that dimension.- Parameters:
r- the specifiedRectangle- Returns:
- the smallest
Rectanglecontaining both the specifiedRectangleand thisRectangle.
-
add
public void add(int newx, int newy) Adds a point, specified by the integer argumentsnewx,newyto the bounds of thisRectangle.If this
Rectanglehas any dimension less than zero, the rules for non-existent rectangles apply. In that case, the new bounds of thisRectanglewill have a location equal to the specified coordinates and width and height equal to zero.After adding a point, a call to
containswith the added point as an argument does not necessarily returntrue. Thecontainsmethod does not returntruefor points on the right or bottom edges of aRectangle. Therefore, if the added point falls on the right or bottom edge of the enlargedRectangle,containsreturnsfalsefor that point. If the specified point must be contained within the newRectangle, a 1x1 rectangle should be added instead:r.add(new Rectangle(newx, newy, 1, 1));- Parameters:
newx- the X coordinate of the new pointnewy- the Y coordinate of the new point
-
add
Adds the specifiedPointto the bounds of thisRectangle.If this
Rectanglehas any dimension less than zero, the rules for non-existent rectangles apply. In that case, the new bounds of thisRectanglewill have a location equal to the coordinates of the specifiedPointand width and height equal to zero.After adding a
Point, a call tocontainswith the addedPointas an argument does not necessarily returntrue. Thecontainsmethod does not returntruefor points on the right or bottom edges of aRectangle. Therefore if the addedPointfalls on the right or bottom edge of the enlargedRectangle,containsreturnsfalsefor thatPoint. If the specified point must be contained within the newRectangle, a 1x1 rectangle should be added instead:r.add(new Rectangle(pt, new Dimension(1, 1)));- Parameters:
pt- the newPointto add to thisRectangle
-
add
Adds aRectangleto thisRectangle. The resultingRectangleis the union of the two rectangles.If either
Rectanglehas any dimension less than 0, the result will have the dimensions of the otherRectangle. If bothRectangles have at least one dimension less than 0, the result will have at least one dimension less than 0.If either
Rectanglehas one or both dimensions equal to 0, the result along those axes with 0 dimensions will be equivalent to the results obtained by adding the corresponding origin coordinate to the result rectangle along that axis, similar to the operation of theadd(Point)method, but contribute no further dimension beyond that.If the resulting
Rectanglewould have a dimension too large to be expressed as anint, the result will have a dimension ofInteger.MAX_VALUEalong that dimension.- Parameters:
r- the specifiedRectangle
-
grow
public void grow(int h, int v) Resizes theRectangleboth horizontally and vertically.This method modifies the
Rectangleso that it ishunits larger on both the left and right side, andvunits larger at both the top and bottom.The new
Rectanglehas(x - h, y - v)as its upper-left corner, width of(width + 2h), and a height of(height + 2v).If negative values are supplied for
handv, the size of theRectangledecreases accordingly. Thegrowmethod will check for integer overflow and underflow, but does not check whether the resulting values ofwidthandheightgrow from negative to non-negative or shrink from non-negative to negative.- Parameters:
h- the horizontal expansionv- the vertical expansion
-
isEmpty
public boolean isEmpty()Determines whether theRectangularShapeis empty. When theRectangularShapeis empty, it encloses no area.- Specified by:
isEmptyin classRectangularShape- Returns:
trueif theRectangularShapeis empty;falseotherwise.- Since:
- 1.2
-
outcode
public int outcode(double x, double y) Determines where the specified coordinates lie with respect to thisRectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of thisRectangle2D, whether or not the specified coordinates are on the same side of the edge as the rest of thisRectangle2D.- Specified by:
outcodein classRectangle2D- Parameters:
x- the specified X coordinatey- the specified Y coordinate- Returns:
- the logical OR of all appropriate out codes.
- Since:
- 1.2
- See Also:
-
createIntersection
Returns a newRectangle2Dobject representing the intersection of thisRectangle2Dwith the specifiedRectangle2D.- Specified by:
createIntersectionin classRectangle2D- Parameters:
r- theRectangle2Dto be intersected with thisRectangle2D- Returns:
- the largest
Rectangle2Dcontained in both the specifiedRectangle2Dand in thisRectangle2D. - Since:
- 1.2
-
createUnion
Returns a newRectangle2Dobject representing the union of thisRectangle2Dwith the specifiedRectangle2D.- Specified by:
createUnionin classRectangle2D- Parameters:
r- theRectangle2Dto be combined with thisRectangle2D- Returns:
- the smallest
Rectangle2Dcontaining both the specifiedRectangle2Dand thisRectangle2D. - Since:
- 1.2
-
equals
Checks whether two rectangles are equal.The result is
trueif and only if the argument is notnulland is aRectangleobject that has the same upper-left corner, width, and height as thisRectangle.- Overrides:
equalsin classRectangle2D- Parameters:
obj- theObjectto compare with thisRectangle- Returns:
trueif the objects are equal;falseotherwise.- See Also:
-
toString
Returns aStringrepresenting thisRectangleand its values.
-
contains(int, int).