APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt

public Class Rectangle

extends Rectangle2D
implements Shape, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.awt.Shape
Known Direct Subclasses
javax.swing.text.DefaultCaret
Imports
java.awt.geom.Rectangle2D, java.beans.Transient, java.io.Serial
A 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.

A Rectangle whose width or height is negative has neither location nor dimension along those axes with negative dimensions. Such a Rectangle is treated as non-existent along those axes. Such a Rectangle is also empty with respect to containment calculations and methods which test if it contains or intersects a point or rectangle will always return false. Methods which combine such a Rectangle with a point or rectangle will ignore the Rectangle entirely in generating the result. If two Rectangle objects are combined and each has a negative dimension, the result will have at least one negative dimension.

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.

Author
Sami Shaio
Since
1.0

Field Summary

Modifier and TypeField and Description
public int
height

The height of the Rectangle.

private static final long
serialVersionUID

Use serialVersionUID from JDK 1.1 for interoperability.

public int
width

The width of the Rectangle.

public int
x

The X coordinate of the upper-left corner of the Rectangle.

public int
y

The Y coordinate of the upper-left corner of the Rectangle.

Inherited from java.awt.geom.Rectangle2D:
OUT_BOTTOMOUT_LEFTOUT_RIGHTOUT_TOP

Constructor Summary

AccessConstructor and Description
public
Rectangle()

Constructs a new Rectangle whose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero.

public
Rectangle(Rectangle
the Rectangle from which to copy initial values to a newly constructed Rectangle
r)

Constructs a new Rectangle, initialized to match the values of the specified Rectangle.

public
Rectangle(int
the specified X coordinate
x, int
the specified Y coordinate
y, int
the width of the Rectangle
width, int
the height of the Rectangle
height)

Constructs a new Rectangle whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name.

public
Rectangle(int
the width of the Rectangle
width, int
the height of the Rectangle
height)

Constructs a new Rectangle whose 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.

public
Rectangle(Point
a Point that is the upper-left corner of the Rectangle
p, Dimension
a Dimension, representing the width and height of the Rectangle
d)

Constructs a new Rectangle whose upper-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument.

public
Rectangle(Point
a Point that is the top left corner of the Rectangle
p)

Constructs a new Rectangle whose upper-left corner is the specified Point, and whose width and height are both zero.

public
Rectangle(Dimension
a Dimension, specifying width and height
d)

Constructs a new Rectangle whose top left corner is (0, 0) and whose width and height are specified by the Dimension argument.

Method Summary

Modifier and TypeMethod and Description
public void
add(int
the X coordinate of the new point
newx, int
the Y coordinate of the new point
newy)

Adds a point, specified by the integer arguments newx,newy to the bounds of this Rectangle.

public void
add(Point
the new Point to add to this Rectangle
pt)

Adds the specified Point to the bounds of this Rectangle.

public void
add(Rectangle
the specified Rectangle
r)

Adds a Rectangle to this Rectangle.

private static int
clip(double v, boolean doceil)

public boolean

Returns:

true if the specified Point is inside this Rectangle; false otherwise.
contains(Point
the Point to test
p)

Checks whether or not this Rectangle contains the specified Point.

public boolean

Returns:

true if the point (x,y) is inside this Rectangle; false otherwise.
contains(int
the specified X coordinate
x, int
the specified Y coordinate
y)

Checks whether or not this Rectangle contains the point at the specified location (x,y).

public boolean

Returns:

true if the Rectangle is contained entirely inside this Rectangle; false otherwise
contains(Rectangle
the specified Rectangle
r)

Checks whether or not this Rectangle entirely contains the specified Rectangle.

public boolean

Returns:

true if the Rectangle specified by (X, Y, W, H) is entirely enclosed inside this Rectangle; false otherwise.
contains(int
the specified X coordinate
X, int
the specified Y coordinate
Y, int
the width of the Rectangle
W, int
the height of the Rectangle
H)

Checks whether this Rectangle entirely contains the Rectangle at the specified location (X,Y) with the specified dimensions (W,H).

public Rectangle2D
createIntersection(Rectangle2D r)

Implements abstract java.awt.geom.Rectangle2D.createIntersection.

Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.

public Rectangle2D
createUnion(Rectangle2D r)

Implements abstract java.awt.geom.Rectangle2D.createUnion.

Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

public boolean

Returns:

true if the objects are equal; false otherwise.
equals(Object
the Object to compare with this Rectangle
obj)

Overrides java.awt.geom.Rectangle2D.equals.

Checks whether two rectangles are equal.

public Rectangle

Returns:

a new Rectangle, equal to the bounding Rectangle for this Rectangle.
getBounds()

Overrides java.awt.geom.RectangularShape.getBounds.

Implements java.awt.Shape.getBounds.

Gets the bounding Rectangle of this Rectangle.

public Rectangle2D
getBounds2D()

Overrides java.awt.geom.Rectangle2D.getBounds2D.

Implements java.awt.Shape.getBounds2D.

Returns a high precision and more accurate bounding box of the Shape than the getBounds method.

public double

Returns:

the height of the bounding Rectangle.
getHeight()

Implements abstract java.awt.geom.RectangularShape.getHeight.

Returns the height of the bounding Rectangle in double precision.

public Point

Returns:

the Point that is the upper-left corner of this Rectangle.
getLocation()

Returns the location of this Rectangle.

public Dimension

Returns:

a Dimension, representing the size of this Rectangle.
getSize()

Gets the size of this Rectangle, represented by the returned Dimension.

public double

Returns:

the width of the bounding Rectangle.
getWidth()

Implements abstract java.awt.geom.RectangularShape.getWidth.

Returns the width of the bounding Rectangle in double precision.

public double

Returns:

the X coordinate of the bounding Rectangle.
getX()

Implements abstract java.awt.geom.RectangularShape.getX.

Returns the X coordinate of the bounding Rectangle in double precision.

public double

Returns:

the Y coordinate of the bounding Rectangle.
getY()

Implements abstract java.awt.geom.RectangularShape.getY.

Returns the Y coordinate of the bounding Rectangle in double precision.

public void
grow(int
the horizontal expansion
h, int
the vertical expansion
v)

Resizes the Rectangle both horizontally and vertically.

public boolean

Returns:

true if the point (X,Y) is inside this Rectangle; false otherwise.
inside(int
the specified X coordinate
X, int
the specified Y coordinate
Y)
Deprecated As of JDK version 1.1, replaced by contains(int, int).

Checks whether or not this Rectangle contains the point at the specified location (X,Y).

public Rectangle

Returns:

the largest Rectangle contained in both the specified Rectangle and in this Rectangle; or if the rectangles do not intersect, an empty rectangle.
intersection(Rectangle
the specified Rectangle
r)

Computes the intersection of this Rectangle with the specified Rectangle.

public boolean

Returns:

true if the specified Rectangle and this Rectangle intersect; false otherwise.
intersects(Rectangle
the specified Rectangle
r)

Determines whether or not this Rectangle and the specified Rectangle intersect.

public boolean
isEmpty()

Implements abstract java.awt.geom.RectangularShape.isEmpty.

Determines whether the RectangularShape is empty.

public void
move(int
the X coordinate of the new location
x, int
the Y coordinate of the new location
y)
Deprecated As of JDK version 1.1, replaced by setLocation(int, int).

Moves this Rectangle to the specified location.

public int
outcode(double x, double y)

Implements abstract java.awt.geom.Rectangle2D.outcode.

Determines where the specified coordinates lie with respect to this Rectangle2D.

public void
reshape(int
the new X coordinate for the upper-left corner of this Rectangle
x, int
the new Y coordinate for the upper-left corner of this Rectangle
y, int
the new width for this Rectangle
width, int
the new height for this Rectangle
height)
Deprecated As of JDK version 1.1, replaced by setBounds(int, int, int, int).

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

public void
resize(int
the new width for this Rectangle
width, int
the new height for this Rectangle
height)
Deprecated As of JDK version 1.1, replaced by setSize(int, int).

Sets the size of this Rectangle to the specified width and height.

public void
setBounds(Rectangle
the specified Rectangle
r)

Sets the bounding Rectangle of this Rectangle to match the specified Rectangle.

public void
setBounds(int
the new X coordinate for the upper-left corner of this Rectangle
x, int
the new Y coordinate for the upper-left corner of this Rectangle
y, int
the new width for this Rectangle
width, int
the new height for this Rectangle
height)

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

public void
setLocation(Point
the Point specifying the new location for this Rectangle
p)

Moves this Rectangle to the specified location.

public void
setLocation(int
the X coordinate of the new location
x, int
the Y coordinate of the new location
y)

Moves this Rectangle to the specified location.

public void
setRect(double
the X coordinate of the upper-left corner of the specified rectangle
x, double
the Y coordinate of the upper-left corner of the specified rectangle
y, double
the width of the specified rectangle
width, double
the new height of the specified rectangle
height)

Implements abstract java.awt.geom.Rectangle2D.setRect.

Sets the bounds of this Rectangle to the integer bounds which encompass the specified x, y, width, and height.

public void
setSize(Dimension
the new size for the Dimension object
d)

Sets the size of this Rectangle to match the specified Dimension.

public void
setSize(int
the new width for this Rectangle
width, int
the new height for this Rectangle
height)

Sets the size of this Rectangle to the specified width and height.

public String

Returns:

a String representing this Rectangle object's coordinate and size values.
toString()

Overrides java.lang.Object.toString.

Returns a String representing this Rectangle and its values.

public void
translate(int
the distance to move this Rectangle along the X axis
dx, int
the distance to move this Rectangle along the Y axis
dy)

Translates this Rectangle the indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.

public Rectangle

Returns:

the smallest Rectangle containing both the specified Rectangle and this Rectangle.
union(Rectangle
the specified Rectangle
r)

Computes the union of this Rectangle with the specified Rectangle.

Inherited from java.awt.geom.Rectangle2D:
addaddaddcontainscontainsgetPathIteratorgetPathIteratorhashCodeintersectintersectsintersectsLineintersectsLineoutcodesetFramesetRectunion

Field Detail

heightback to summary
public int height

The height of the Rectangle.

Since
1.0
See Also
setSize(int, int), getSize()
serialVersionUIDback to summary
private static final long serialVersionUID

Use serialVersionUID from JDK 1.1 for interoperability.

Annotations
@Serial
widthback to summary
public int width

The width of the Rectangle.

Since
1.0
See Also
setSize(int, int), getSize()
xback to summary
public int x

The X coordinate of the upper-left corner of the Rectangle.

Since
1.0
See Also
setLocation(int, int), getLocation()
yback to summary
public int y

The Y coordinate of the upper-left corner of the Rectangle.

Since
1.0
See Also
setLocation(int, int), getLocation()

Constructor Detail

Rectangleback to summary
public Rectangle()

Constructs a new Rectangle whose upper-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero.

Rectangleback to summary
public Rectangle(Rectangle r)

Constructs a new Rectangle, initialized to match the values of the specified Rectangle.

Parameters
r:Rectangle

the Rectangle from which to copy initial values to a newly constructed Rectangle

Since
1.1
Rectangleback to summary
public Rectangle(int x, int y, int width, int height)

Constructs a new Rectangle whose upper-left corner is specified as (x,y) and whose width and height are specified by the arguments of the same name.

Parameters
x:int

the specified X coordinate

y:int

the specified Y coordinate

width:int

the width of the Rectangle

height:int

the height of the Rectangle

Since
1.0
Rectangleback to summary
public Rectangle(int width, int height)

Constructs a new Rectangle whose 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:int

the width of the Rectangle

height:int

the height of the Rectangle

Rectangleback to summary
public Rectangle(Point p, Dimension d)

Constructs a new Rectangle whose upper-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument.

Parameters
p:Point

a Point that is the upper-left corner of the Rectangle

d:Dimension

a Dimension, representing the width and height of the Rectangle

Rectangleback to summary
public Rectangle(Point p)

Constructs a new Rectangle whose upper-left corner is the specified Point, and whose width and height are both zero.

Parameters
p:Point

a Point that is the top left corner of the Rectangle

Rectangleback to summary
public Rectangle(Dimension d)

Constructs a new Rectangle whose top left corner is (0, 0) and whose width and height are specified by the Dimension argument.

Parameters
d:Dimension

a Dimension, specifying width and height

Method Detail

addback to summary
public void add(int newx, int newy)

Adds a point, specified by the integer arguments newx,newy to the bounds of this Rectangle.

If this Rectangle has any dimension less than zero, the rules for non-existent rectangles apply. In that case, the new bounds of this Rectangle will have a location equal to the specified coordinates and width and height equal to zero.

After adding a point, a call to contains with the added point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a Rectangle. Therefore, if the added point falls on the right or bottom edge of the enlarged Rectangle, contains returns false for that point. If the specified point must be contained within the new Rectangle, a 1x1 rectangle should be added instead: 

    r.add(new Rectangle(newx, newy, 1, 1));
Parameters
newx:int

the X coordinate of the new point

newy:int

the Y coordinate of the new point

addback to summary
public void add(Point pt)

Adds the specified Point to the bounds of this Rectangle.

If this Rectangle has any dimension less than zero, the rules for non-existent rectangles apply. In that case, the new bounds of this Rectangle will have a location equal to the coordinates of the specified Point and width and height equal to zero.

After adding a Point, a call to contains with the added Point as an argument does not necessarily return true. The contains method does not return true for points on the right or bottom edges of a Rectangle. Therefore if the added Point falls on the right or bottom edge of the enlarged Rectangle, contains returns false for that Point. If the specified point must be contained within the new Rectangle, a 1x1 rectangle should be added instead: 

    r.add(new Rectangle(pt, new Dimension(1, 1)));
Parameters
pt:Point

the new Point to add to this Rectangle

addback to summary
public void add(Rectangle r)

Adds a Rectangle to this Rectangle. The resulting Rectangle is the union of the two rectangles.

If either Rectangle has any dimension less than 0, the result will have the dimensions of the other Rectangle. If both Rectangles have at least one dimension less than 0, the result will have at least one dimension less than 0.

If either Rectangle has 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 the add(Point) method, but contribute no further dimension beyond that.

If the resulting Rectangle would have a dimension too large to be expressed as an int, the result will have a dimension of Integer.MAX_VALUE along that dimension.

Parameters
r:Rectangle

the specified Rectangle

clipback to summary
private static int clip(double v, boolean doceil)
containsback to summary
public boolean contains(Point p)

Checks whether or not this Rectangle contains the specified Point.

Parameters
p:Point

the Point to test

Returns:boolean

true if the specified Point is inside this Rectangle; false otherwise.

Since
1.1
containsback to summary
public boolean contains(int x, int y)

Checks whether or not this Rectangle contains the point at the specified location (x,y).

Parameters
x:int

the specified X coordinate

y:int

the specified Y coordinate

Returns:boolean

true if the point (x,y) is inside this Rectangle; false otherwise.

Since
1.1
containsback to summary
public boolean contains(Rectangle r)

Checks whether or not this Rectangle entirely contains the specified Rectangle.

Parameters
r:Rectangle

the specified Rectangle

Returns:boolean

true if the Rectangle is contained entirely inside this Rectangle; false otherwise

Since
1.2
containsback to summary
public boolean contains(int X, int Y, int W, int H)

Checks whether this Rectangle entirely contains the Rectangle at the specified location (X,Y) with the specified dimensions (W,H).

Parameters
X:int

the specified X coordinate

Y:int

the specified Y coordinate

W:int

the width of the Rectangle

H:int

the height of the Rectangle

Returns:boolean

true if the Rectangle specified by (X, Y, W, H) is entirely enclosed inside this Rectangle; false otherwise.

Since
1.1
createIntersectionback to summary
public Rectangle2D createIntersection(Rectangle2D r)

Implements abstract java.awt.geom.Rectangle2D.createIntersection.

Doc from java.awt.geom.Rectangle2D.createIntersection.

Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.

Since
1.2
createUnionback to summary
public Rectangle2D createUnion(Rectangle2D r)

Implements abstract java.awt.geom.Rectangle2D.createUnion.

Doc from java.awt.geom.Rectangle2D.createUnion.

Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

Since
1.2
equalsback to summary
public boolean equals(Object obj)

Overrides java.awt.geom.Rectangle2D.equals.

Checks whether two rectangles are equal.

The result is true if and only if the argument is not null and is a Rectangle object that has the same upper-left corner, width, and height as this Rectangle.

Parameters
obj:Object

the Object to compare with this Rectangle

Returns:boolean

true if the objects are equal; false otherwise.

getBoundsback to summary
public Rectangle getBounds()

Overrides java.awt.geom.RectangularShape.getBounds.

Implements java.awt.Shape.getBounds.

Gets the bounding Rectangle of this Rectangle.

This method is included for completeness, to parallel the getBounds method of Component.

Returns:Rectangle

a new Rectangle, equal to the bounding Rectangle for this Rectangle.

Annotations
@Transient
Since
1.1
See Also
java.awt.Component#getBounds, setBounds(Rectangle), setBounds(int, int, int, int)
getBounds2Dback to summary
public Rectangle2D getBounds2D()

Overrides java.awt.geom.Rectangle2D.getBounds2D.

Implements java.awt.Shape.getBounds2D.

Doc from java.awt.Shape.getBounds2D.

Returns a high precision and more accurate bounding box of the Shape than the getBounds method. Note that there is no guarantee that the returned Rectangle2D is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated Rectangle2D. The bounding box returned by this method is usually tighter than that returned by the getBounds method and never fails due to overflow problems since the return value can be an instance of the Rectangle2D that 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 shape may not be considered contained in the returned bounds object, but only in cases where those points are also not considered contained in the original shape.

If a point is inside the shape according to the contains(point) method, then it must be inside the returned Rectangle2D bounds object according to the contains(point) method of the bounds. Specifically:

shape.contains(p) requires bounds.contains(p)

If a point is not inside the shape, then it might still be contained in the bounds object:

bounds.contains(p) does not imply shape.contains(p)

Since
1.2
getHeightback to summary
public double getHeight()

Implements abstract java.awt.geom.RectangularShape.getHeight.

Returns the height of the bounding Rectangle in double precision.

Returns:double

the height of the bounding Rectangle.

getLocationback to summary
public Point getLocation()

Returns the location of this Rectangle.

This method is included for completeness, to parallel the getLocation method of Component.

Returns:Point

the Point that is the upper-left corner of this Rectangle.

Since
1.1
See Also
java.awt.Component#getLocation, setLocation(Point), setLocation(int, int)
getSizeback to summary
public Dimension getSize()

Gets the size of this Rectangle, represented by the returned Dimension.

This method is included for completeness, to parallel the getSize method of Component.

Returns:Dimension

a Dimension, representing the size of this Rectangle.

Since
1.1
See Also
java.awt.Component#getSize, setSize(Dimension), setSize(int, int)
getWidthback to summary
public double getWidth()

Implements abstract java.awt.geom.RectangularShape.getWidth.

Returns the width of the bounding Rectangle in double precision.

Returns:double

the width of the bounding Rectangle.

getXback to summary
public double getX()

Implements abstract java.awt.geom.RectangularShape.getX.

Returns the X coordinate of the bounding Rectangle in double precision.

Returns:double

the X coordinate of the bounding Rectangle.

getYback to summary
public double getY()

Implements abstract java.awt.geom.RectangularShape.getY.

Returns the Y coordinate of the bounding Rectangle in double precision.

Returns:double

the Y coordinate of the bounding Rectangle.

growback to summary
public void grow(int h, int v)

Resizes the Rectangle both horizontally and vertically.

This method modifies the Rectangle so that it is h units larger on both the left and right side, and v units larger at both the top and bottom.

The new Rectangle has (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 h and v, the size of the Rectangle decreases accordingly. The grow method will check for integer overflow and underflow, but does not check whether the resulting values of width and height grow from negative to non-negative or shrink from non-negative to negative.

Parameters
h:int

the horizontal expansion

v:int

the vertical expansion

insideback to summary
public boolean inside(int X, int Y)

Deprecated

As of JDK version 1.1, replaced by contains(int, int).

Checks whether or not this Rectangle contains the point at the specified location (X,Y).

Parameters
X:int

the specified X coordinate

Y:int

the specified Y coordinate

Returns:boolean

true if the point (X,Y) is inside this Rectangle; false otherwise.

Annotations
@Deprecated
intersectionback to summary
public Rectangle intersection(Rectangle r)

Computes the intersection of this Rectangle with the specified Rectangle. Returns a new Rectangle that represents the intersection of the two rectangles. If the two rectangles do not intersect, the result will be an empty rectangle.

Parameters
r:Rectangle

the specified Rectangle

Returns:Rectangle

the largest Rectangle contained in both the specified Rectangle and in this Rectangle; or if the rectangles do not intersect, an empty rectangle.

intersectsback to summary
public boolean intersects(Rectangle r)

Determines whether or not this Rectangle and the specified Rectangle intersect. Two rectangles intersect if their intersection is nonempty.

Parameters
r:Rectangle

the specified Rectangle

Returns:boolean

true if the specified Rectangle and this Rectangle intersect; false otherwise.

isEmptyback to summary
public boolean isEmpty()

Implements abstract java.awt.geom.RectangularShape.isEmpty.

Doc from java.awt.geom.RectangularShape.isEmpty.

Determines whether the RectangularShape is empty. When the RectangularShape is empty, it encloses no area.

Since
1.2
moveback to summary
public void move(int x, int y)

Deprecated

As of JDK version 1.1, replaced by setLocation(int, int).

Moves this Rectangle to the specified location.

Parameters
x:int

the X coordinate of the new location

y:int

the Y coordinate of the new location

Annotations
@Deprecated
outcodeback to summary
public int outcode(double x, double y)

Implements abstract java.awt.geom.Rectangle2D.outcode.

Doc from java.awt.geom.Rectangle2D.outcode.

Determines where the specified coordinates lie with respect to this Rectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle2D, whether or not the specified coordinates are on the same side of the edge as the rest of this Rectangle2D.

Since
1.2
reshapeback to summary
public void reshape(int x, int y, int width, int height)

Deprecated

As of JDK version 1.1, replaced by setBounds(int, int, int, int).

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

Parameters
x:int

the new X coordinate for the upper-left corner of this Rectangle

y:int

the new Y coordinate for the upper-left corner of this Rectangle

width:int

the new width for this Rectangle

height:int

the new height for this Rectangle

Annotations
@Deprecated
resizeback to summary
public void resize(int width, int height)

Deprecated

As of JDK version 1.1, replaced by setSize(int, int).

Sets the size of this Rectangle to the specified width and height.

Parameters
width:int

the new width for this Rectangle

height:int

the new height for this Rectangle

Annotations
@Deprecated
setBoundsback to summary
public void setBounds(Rectangle r)

Sets the bounding Rectangle of this Rectangle to match the specified Rectangle.

This method is included for completeness, to parallel the setBounds method of Component.

Parameters
r:Rectangle

the specified Rectangle

Since
1.1
See Also
getBounds, java.awt.Component#setBounds(java.awt.Rectangle)
setBoundsback to summary
public void setBounds(int x, int y, int width, int height)

Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

This method is included for completeness, to parallel the setBounds method of Component.

Parameters
x:int

the new X coordinate for the upper-left corner of this Rectangle

y:int

the new Y coordinate for the upper-left corner of this Rectangle

width:int

the new width for this Rectangle

height:int

the new height for this Rectangle

Since
1.1
See Also
getBounds, java.awt.Component#setBounds(int, int, int, int)
setLocationback to summary
public void setLocation(Point p)

Moves this Rectangle to the specified location.

This method is included for completeness, to parallel the setLocation method of Component.

Parameters
p:Point

the Point specifying the new location for this Rectangle

Since
1.1
See Also
java.awt.Component#setLocation(java.awt.Point), getLocation
setLocationback to summary
public void setLocation(int x, int y)

Moves this Rectangle to the specified location.

This method is included for completeness, to parallel the setLocation method of Component.

Parameters
x:int

the X coordinate of the new location

y:int

the Y coordinate of the new location

Since
1.1
See Also
getLocation, java.awt.Component#setLocation(int, int)
setRectback to summary
public void setRect(double x, double y, double width, double height)

Implements abstract java.awt.geom.Rectangle2D.setRect.

Sets the bounds of this Rectangle to the integer bounds which encompass the specified x, y, width, and height. If the parameters specify a Rectangle that exceeds the maximum range of integers, the result will be the best representation of the specified Rectangle intersected with the maximum integer bounds.

Parameters
x:double

the X coordinate of the upper-left corner of the specified rectangle

y:double

the Y coordinate of the upper-left corner of the specified rectangle

width:double

the width of the specified rectangle

height:double

the new height of the specified rectangle

setSizeback to summary
public void setSize(Dimension d)

Sets the size of this Rectangle to match the specified Dimension.

This method is included for completeness, to parallel the setSize method of Component.

Parameters
d:Dimension

the new size for the Dimension object

Since
1.1
See Also
java.awt.Component#setSize(java.awt.Dimension), getSize
setSizeback to summary
public void setSize(int width, int height)

Sets the size of this Rectangle to the specified width and height.

This method is included for completeness, to parallel the setSize method of Component.

Parameters
width:int

the new width for this Rectangle

height:int

the new height for this Rectangle

Since
1.1
See Also
java.awt.Component#setSize(int, int), getSize
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns a String representing this Rectangle and its values.

Returns:String

a String representing this Rectangle object's coordinate and size values.

translateback to summary
public void translate(int dx, int dy)

Translates this Rectangle the indicated distance, to the right along the X coordinate axis, and downward along the Y coordinate axis.

Parameters
dx:int

the distance to move this Rectangle along the X axis

dy:int

the distance to move this Rectangle along the Y axis

See Also
java.awt.Rectangle#setLocation(int, int), java.awt.Rectangle#setLocation(java.awt.Point)
unionback to summary
public Rectangle union(Rectangle r)

Computes the union of this Rectangle with the specified Rectangle. Returns a new Rectangle that represents the union of the two rectangles.

If either Rectangle has 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 other Rectangle. If both have dimension less than zero, then the result will have at least one dimension less than zero.

If the resulting Rectangle would have a dimension too large to be expressed as an int, the result will have a dimension of Integer.MAX_VALUE along that dimension.

Parameters
r:Rectangle

the specified Rectangle

Returns:Rectangle

the smallest Rectangle containing both the specified Rectangle and this Rectangle.