FileDocCategorySizeDatePackage
Rectangle.javaAPI DocJava SE 6 API42922Tue Jun 10 00:25:18 BST 2008java.awt

Rectangle

public class Rectangle extends Rectangle2D implements Shape, Serializable
A Rectangle specifies an area in a coordinate space that is enclosed by the Rectangle object's upper-left point {@code (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 {@code Rectangle} whose width or height is exactly zero has location along those axes with zero dimension, but is otherwise considered empty. The {@link #isEmpty} method will return true for such a {@code Rectangle}. Methods which test if an empty {@code Rectangle} contains or intersects a point or rectangle will always return false if either dimension is zero. Methods which combine such a {@code Rectangle} with a point or rectangle will include the location of the {@code Rectangle} on that axis in the result as if the {@link #add(Point)} method were being called.

A {@code Rectangle} whose width or height is negative has neither location nor dimension along those axes with negative dimensions. Such a {@code Rectangle} is treated as non-existant along those axes. Such a {@code 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 {@code Rectangle} with a point or rectangle will ignore the {@code Rectangle} entirely in generating the result. If two {@code 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 {@code Rectangle} will operate on its location regardless of whether or not it has a negative or zero dimension along either axis.

Note that a {@code Rectangle} constructed with the default no-argument constructor will have dimensions of {@code 0x0} and therefore be empty. That {@code Rectangle} will still have a location of {@code (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 {@code Rectangle} with a specifically negative width and height or it should use the first point in the set to construct the {@code 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 {@link #x} and {@link #y} fields by clipping the true result to the nearest 32-bit value. The values stored into the {@link #width} and {@link #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-existant 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.

version
1.73, 05/18/06
author
Sami Shaio
since
1.0

Fields Summary
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.
public int
width
The width of the Rectangle.
public int
height
The height of the Rectangle.
private static final long
serialVersionUID
Constructors 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.

       
               
        
    
     
        /* ensure that the necessary native libraries are loaded */
        Toolkit.loadLibraries();
        if (!GraphicsEnvironment.isHeadless()) {
            initIDs();
        }
    
    	this(0, 0, 0, 0);
    
public Rectangle(Rectangle r)
Constructs a new Rectangle, initialized to match the values of the specified Rectangle.

param
r the Rectangle from which to copy initial values to a newly constructed Rectangle
since
1.1

    	this(r.x, r.y, r.width, r.height);
    
public Rectangle(int x, int y, int width, int height)
Constructs a new Rectangle whose upper-left corner is specified as {@code (x,y)} and whose width and height are specified by the arguments of the same name.

param
x the specified X coordinate
param
y the specified Y coordinate
param
width the width of the Rectangle
param
height the height of the Rectangle
since
1.0

	this.x = x;
	this.y = y;
	this.width = width;
	this.height = height;
    
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.

param
width the width of the Rectangle
param
height the height of the Rectangle

	this(0, 0, width, height);
    
public Rectangle(Point p, Dimension d)
Constructs a new Rectangle whose upper-left corner is specified by the {@link Point} argument, and whose width and height are specified by the {@link Dimension} argument.

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

	this(p.x, p.y, d.width, d.height);
    
public Rectangle(Point p)
Constructs a new Rectangle whose upper-left corner is the specified Point, and whose width and height are both zero.

param
p a Point that is the top left corner of the Rectangle

	this(p.x, p.y, 0, 0);
    
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.

param
d a Dimension, specifying width and height

	this(0, 0, d.width, d.height);
    
Methods Summary
public voidadd(int newx, int newy)
Adds a point, specified by the integer arguments {@code newx,newy} to the bounds of this {@code Rectangle}.

If this {@code Rectangle} has any dimension less than zero, the rules for non-existant rectangles apply. In that case, the new bounds of this {@code 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 {@code Rectangle}, a 1x1 rectangle should be added instead:

r.add(newx, newy, 1, 1);

param
newx the X coordinate of the new point
param
newy the Y coordinate of the new point

        if ((width | height) < 0) {
            this.x = newx;
            this.y = newy;
            this.width = this.height = 0;
            return;
        }
        int x1 = this.x;
        int y1 = this.y;
        long x2 = this.width;
        long y2 = this.height;
        x2 += x1;
        y2 += y1;
        if (x1 > newx) x1 = newx;
        if (y1 > newy) y1 = newy;
        if (x2 < newx) x2 = newx;
        if (y2 < newy) y2 = newy;
        x2 -= x1;
        y2 -= y1;
        if (x2 > Integer.MAX_VALUE) x2 = Integer.MAX_VALUE;
        if (y2 > Integer.MAX_VALUE) y2 = Integer.MAX_VALUE;
        reshape(x1, y1, (int) x2, (int) y2);
    
public voidadd(java.awt.Point pt)
Adds the specified {@code Point} to the bounds of this {@code Rectangle}.

If this {@code Rectangle} has any dimension less than zero, the rules for non-existant rectangles apply. In that case, the new bounds of this {@code Rectangle} will have a location equal to the coordinates of the specified {@code 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 {@code Rectangle}, a 1x1 rectangle should be added instead:

r.add(pt.x, pt.y, 1, 1);

param
pt the new Point to add to this Rectangle

	add(pt.x, pt.y);
    
public voidadd(java.awt.Rectangle r)
Adds a Rectangle to this Rectangle. The resulting Rectangle is the union of the two rectangles.

If either {@code Rectangle} has any dimension less than 0, the result will have the dimensions of the other {@code Rectangle}. If both {@code Rectangle}s have at least one dimension less than 0, the result will have at least one dimension less than 0.

If either {@code 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 {@link #add(Point)} method, but contribute no further dimension beyond that.

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

param
r the specified Rectangle

        long tx2 = this.width;
        long ty2 = this.height;
        if ((tx2 | ty2) < 0) {
            reshape(r.x, r.y, r.width, r.height);
        }
        long rx2 = r.width;
        long ry2 = r.height;
        if ((rx2 | ry2) < 0) {
            return;
        }
        int tx1 = this.x;
        int ty1 = this.y;
        tx2 += tx1;
        ty2 += ty1;
        int rx1 = r.x;
        int ry1 = r.y;
        rx2 += rx1;
        ry2 += ry1;
        if (tx1 > rx1) tx1 = rx1;
        if (ty1 > ry1) ty1 = ry1;
        if (tx2 < rx2) tx2 = rx2;
        if (ty2 < ry2) ty2 = ry2;
        tx2 -= tx1;
        ty2 -= ty1;
        // tx2,ty2 will never underflow since both original
        // rectangles were non-empty
        // they might overflow, though...
	if (tx2 > Integer.MAX_VALUE) tx2 = Integer.MAX_VALUE;
	if (ty2 > Integer.MAX_VALUE) ty2 = Integer.MAX_VALUE;
	reshape(tx1, ty1, (int) tx2, (int) ty2);
    
private static intclip(double v, boolean doceil)

        if (v <= Integer.MIN_VALUE) {
            return Integer.MIN_VALUE;
        }
        if (v >= Integer.MAX_VALUE) {
            return Integer.MAX_VALUE;
        }
        return (int) (doceil ? Math.ceil(v) : Math.floor(v));
    
public booleancontains(java.awt.Point p)
Checks whether or not this Rectangle contains the specified Point.

param
p the Point to test
return
true if the specified Point is inside this Rectangle; false otherwise.
since
1.1

	return contains(p.x, p.y);
    
public booleancontains(int x, int y)
Checks whether or not this Rectangle contains the point at the specified location {@code (x,y)}.

param
x the specified X coordinate
param
y the specified Y coordinate
return
true if the point {@code (x,y)} is inside this Rectangle; false otherwise.
since
1.1

	return inside(x, y);
    
public booleancontains(java.awt.Rectangle r)
Checks whether or not this Rectangle entirely contains the specified Rectangle.

param
r the specified Rectangle
return
true if the Rectangle is contained entirely inside this Rectangle; false otherwise
since
1.2

	return contains(r.x, r.y, r.width, r.height);
    
public booleancontains(int X, int Y, int W, int H)
Checks whether this Rectangle entirely contains the Rectangle at the specified location {@code (X,Y)} with the specified dimensions {@code (W,H)}.

param
X the specified X coordinate
param
Y the specified Y coordinate
param
W the width of the Rectangle
param
H the height of the Rectangle
return
true if the Rectangle specified by {@code (X, Y, W, H)} is entirely enclosed inside this Rectangle; false otherwise.
since
1.1

	int w = this.width;
	int h = this.height;
	if ((w | h | W | H) < 0) {
	    // At least one of the dimensions is negative...
	    return false;
	}
	// Note: if any dimension is zero, tests below must return false...
	int x = this.x;
	int y = this.y;
	if (X < x || Y < y) {
	    return false;
	}
	w += x;
	W += X;
	if (W <= X) {
	    // X+W overflowed or W was zero, return false if...
	    // either original w or W was zero or
	    // x+w did not overflow or
	    // the overflowed x+w is smaller than the overflowed X+W
	    if (w >= x || W > w) return false;
	} else {
	    // X+W did not overflow and W was not zero, return false if...
	    // original w was zero or
	    // x+w did not overflow and x+w is smaller than X+W
	    if (w >= x && W > w) return false;
	}
	h += y;
	H += Y;
	if (H <= Y) {
	    if (h >= y || H > h) return false;
	} else {
	    if (h >= y && H > h) return false;
	}
	return true;
    
public java.awt.geom.Rectangle2DcreateIntersection(java.awt.geom.Rectangle2D r)
{@inheritDoc}

since
1.2

	if (r instanceof Rectangle) {
	    return intersection((Rectangle) r);
	}
	Rectangle2D dest = new Rectangle2D.Double();
	Rectangle2D.intersect(this, r, dest);
	return dest;
    
public java.awt.geom.Rectangle2DcreateUnion(java.awt.geom.Rectangle2D r)
{@inheritDoc}

since
1.2

	if (r instanceof Rectangle) {
	    return union((Rectangle) r);
	}
	Rectangle2D dest = new Rectangle2D.Double();
	Rectangle2D.union(this, r, dest);
	return dest;
    
public booleanequals(java.lang.Object obj)
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.

param
obj the Object to compare with this Rectangle
return
true if the objects are equal; false otherwise.

	if (obj instanceof Rectangle) {
	    Rectangle r = (Rectangle)obj;
	    return ((x == r.x) &&
		    (y == r.y) &&
		    (width == r.width) &&
		    (height == r.height));
	}
	return super.equals(obj);
    
public java.awt.RectanglegetBounds()
Gets the bounding Rectangle of this Rectangle.

This method is included for completeness, to parallel the getBounds method of {@link Component}.

return
a new Rectangle, equal to the bounding Rectangle for this Rectangle.
see
java.awt.Component#getBounds
see
#setBounds(Rectangle)
see
#setBounds(int, int, int, int)
since
1.1

	return new Rectangle(x, y, width, height);
    
public java.awt.geom.Rectangle2DgetBounds2D()
{@inheritDoc}

since
1.2

	return new Rectangle(x, y, width, height);
    
public doublegetHeight()
Returns the height of the bounding Rectangle in double precision.

return
the height of the bounding Rectangle.

	return height;
    
public java.awt.PointgetLocation()
Returns the location of this Rectangle.

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

return
the Point that is the upper-left corner of this Rectangle.
see
java.awt.Component#getLocation
see
#setLocation(Point)
see
#setLocation(int, int)
since
1.1

	return new Point(x, y);
    
public java.awt.DimensiongetSize()
Gets the size of this Rectangle, represented by the returned Dimension.

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

return
a Dimension, representing the size of this Rectangle.
see
java.awt.Component#getSize
see
#setSize(Dimension)
see
#setSize(int, int)
since
1.1

	return new Dimension(width, height);
    
public doublegetWidth()
Returns the width of the bounding Rectangle in double precision.

return
the width of the bounding Rectangle.

	return width;
    
public doublegetX()
Returns the X coordinate of the bounding Rectangle in double precision.

return
the X coordinate of the bounding Rectangle.

	return x;
    
public doublegetY()
Returns the Y coordinate of the bounding Rectangle in double precision.

return
the Y coordinate of the bounding Rectangle.

	return y;
    
public voidgrow(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 {@code (x - h, y - v)} as its upper-left corner, width of {@code (width + 2h)}, and a height of {@code (height + 2v)}.

If negative values are supplied for h and v, the size of the Rectangle decreases accordingly. The {@code grow} method will check for integer overflow and underflow, but does not check whether the resulting values of {@code width} and {@code height} grow from negative to non-negative or shrink from non-negative to negative.

param
h the horizontal expansion
param
v the vertical expansion

        long x0 = this.x;
        long y0 = this.y;
        long x1 = this.width;
        long y1 = this.height;
        x1 += x0;
        y1 += y0;

        x0 -= h;
        y0 -= v;
        x1 += h;
        y1 += v;

        if (x1 < x0) {
            // Non-existant in X direction
            // Final width must remain negative so subtract x0 before
            // it is clipped so that we avoid the risk that the clipping
            // of x0 will reverse the ordering of x0 and x1.
            x1 -= x0;
            if (x1 < Integer.MIN_VALUE) x1 = Integer.MIN_VALUE;
            if (x0 < Integer.MIN_VALUE) x0 = Integer.MIN_VALUE;
            else if (x0 > Integer.MAX_VALUE) x0 = Integer.MAX_VALUE;
        } else { // (x1 >= x0)
            // Clip x0 before we subtract it from x1 in case the clipping
            // affects the representable area of the rectangle.
            if (x0 < Integer.MIN_VALUE) x0 = Integer.MIN_VALUE;
            else if (x0 > Integer.MAX_VALUE) x0 = Integer.MAX_VALUE;
            x1 -= x0;
            // The only way x1 can be negative now is if we clipped
            // x0 against MIN and x1 is less than MIN - in which case
            // we want to leave the width negative since the result
            // did not intersect the representable area.
            if (x1 < Integer.MIN_VALUE) x1 = Integer.MIN_VALUE;
            else if (x1 > Integer.MAX_VALUE) x1 = Integer.MAX_VALUE;
        }

        if (y1 < y0) {
            // Non-existant in Y direction
            y1 -= y0;
            if (y1 < Integer.MIN_VALUE) y1 = Integer.MIN_VALUE;
            if (y0 < Integer.MIN_VALUE) y0 = Integer.MIN_VALUE;
            else if (y0 > Integer.MAX_VALUE) y0 = Integer.MAX_VALUE;
        } else { // (y1 >= y0)
            if (y0 < Integer.MIN_VALUE) y0 = Integer.MIN_VALUE;
            else if (y0 > Integer.MAX_VALUE) y0 = Integer.MAX_VALUE;
            y1 -= y0;
            if (y1 < Integer.MIN_VALUE) y1 = Integer.MIN_VALUE;
            else if (y1 > Integer.MAX_VALUE) y1 = Integer.MAX_VALUE;
        }

        reshape((int) x0, (int) y0, (int) x1, (int) y1);
    
private static native voidinitIDs()
Initialize JNI field and method IDs

public booleaninside(int X, int Y)
Checks whether or not this Rectangle contains the point at the specified location {@code (X,Y)}.

param
X the specified X coordinate
param
Y the specified Y coordinate
return
true if the point {@code (X,Y)} is inside this Rectangle; false otherwise.
deprecated
As of JDK version 1.1, replaced by contains(int, int).

	int w = this.width;
	int h = this.height;
	if ((w | h) < 0) {
	    // At least one of the dimensions is negative...
	    return false;
	}
	// Note: if either dimension is zero, tests below must return false...
	int x = this.x;
	int y = this.y;
	if (X < x || Y < y) {
	    return false;
	}
	w += x;
	h += y;
	//    overflow || intersect
	return ((w < x || w > X) &&
		(h < y || h > Y));
    
public java.awt.Rectangleintersection(java.awt.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.

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

	int tx1 = this.x;
	int ty1 = this.y;
	int rx1 = r.x;
	int ry1 = r.y;
	long tx2 = tx1; tx2 += this.width;
	long ty2 = ty1; ty2 += this.height;
	long rx2 = rx1; rx2 += r.width;
	long ry2 = ry1; ry2 += r.height;
	if (tx1 < rx1) tx1 = rx1;
	if (ty1 < ry1) ty1 = ry1;
	if (tx2 > rx2) tx2 = rx2;
	if (ty2 > ry2) ty2 = ry2;
	tx2 -= tx1;
	ty2 -= ty1;
	// tx2,ty2 will never overflow (they will never be
	// larger than the smallest of the two source w,h)
	// they might underflow, though...
	if (tx2 < Integer.MIN_VALUE) tx2 = Integer.MIN_VALUE;
	if (ty2 < Integer.MIN_VALUE) ty2 = Integer.MIN_VALUE;
	return new Rectangle(tx1, ty1, (int) tx2, (int) ty2);
    
public booleanintersects(java.awt.Rectangle r)
Determines whether or not this Rectangle and the specified Rectangle intersect. Two rectangles intersect if their intersection is nonempty.

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

	int tw = this.width;
	int th = this.height;
	int rw = r.width;
	int rh = r.height;
	if (rw <= 0 || rh <= 0 || tw <= 0 || th <= 0) {
	    return false;
	}
	int tx = this.x;
	int ty = this.y;
	int rx = r.x;
	int ry = r.y;
	rw += rx;
	rh += ry;
	tw += tx;
	th += ty;
	//      overflow || intersect
	return ((rw < rx || rw > tx) &&
		(rh < ry || rh > ty) &&
		(tw < tx || tw > rx) &&
		(th < ty || th > ry));
    
public booleanisEmpty()
{@inheritDoc}

since
1.2

	return (width <= 0) || (height <= 0);
    
public voidmove(int x, int y)
Moves this Rectangle to the specified location.

param
x the X coordinate of the new location
param
y the Y coordinate of the new location
deprecated
As of JDK version 1.1, replaced by setLocation(int, int).

	this.x = x;
	this.y = y;
    
public intoutcode(double x, double y)
{@inheritDoc}

since
1.2

	/*
	 * Note on casts to double below.  If the arithmetic of
	 * x+w or y+h is done in int, then we may get integer
	 * overflow. By converting to double before the addition
	 * we force the addition to be carried out in double to
	 * avoid overflow in the comparison.
	 *
	 * See bug 4320890 for problems that this can cause.
	 */
	int out = 0;
	if (this.width <= 0) {
	    out |= OUT_LEFT | OUT_RIGHT;
	} else if (x < this.x) {
	    out |= OUT_LEFT;
	} else if (x > this.x + (double) this.width) {
	    out |= OUT_RIGHT;
	}
	if (this.height <= 0) {
	    out |= OUT_TOP | OUT_BOTTOM;
	} else if (y < this.y) {
	    out |= OUT_TOP;
	} else if (y > this.y + (double) this.height) {
	    out |= OUT_BOTTOM;
	}
	return out;
    
public voidreshape(int x, int y, int width, int height)
Sets the bounding Rectangle of this Rectangle to the specified x, y, width, and height.

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

	this.x = x;
	this.y = y;
	this.width = width;
	this.height = height;
    
public voidresize(int width, int height)
Sets the size of this Rectangle to the specified width and height.

param
width the new width for this Rectangle
param
height the new height for this Rectangle
deprecated
As of JDK version 1.1, replaced by setSize(int, int).

	this.width = width;
	this.height = height;
    
public voidsetBounds(java.awt.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.

param
r the specified Rectangle
see
#getBounds
see
java.awt.Component#setBounds(java.awt.Rectangle)
since
1.1

	setBounds(r.x, r.y, r.width, r.height);
    
public voidsetBounds(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.

param
x the new X coordinate for the upper-left corner of this Rectangle
param
y the new Y coordinate for the upper-left corner of this Rectangle
param
width the new width for this Rectangle
param
height the new height for this Rectangle
see
#getBounds
see
java.awt.Component#setBounds(int, int, int, int)
since
1.1

    	reshape(x, y, width, height);
    
public voidsetLocation(java.awt.Point p)
Moves this Rectangle to the specified location.

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

param
p the Point specifying the new location for this Rectangle
see
java.awt.Component#setLocation(java.awt.Point)
see
#getLocation
since
1.1

	setLocation(p.x, p.y);
    
public voidsetLocation(int x, int y)
Moves this Rectangle to the specified location.

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

param
x the X coordinate of the new location
param
y the Y coordinate of the new location
see
#getLocation
see
java.awt.Component#setLocation(int, int)
since
1.1

	move(x, y);
    
public voidsetRect(double x, double y, double width, double height)
Sets the bounds of this {@code Rectangle} to the integer bounds which encompass the specified {@code x}, {@code y}, {@code width}, and {@code height}. If the parameters specify a {@code Rectangle} that exceeds the maximum range of integers, the result will be the best representation of the specified {@code Rectangle} intersected with the maximum integer bounds.

param
x the X coordinate of the upper-left corner of the specified rectangle
param
y the Y coordinate of the upper-left corner of the specified rectangle
param
width the width of the specified rectangle
param
height the new height of the specified rectangle

        int newx, newy, neww, newh;

        if (x > 2.0 * Integer.MAX_VALUE) {
            // Too far in positive X direction to represent...
            // We cannot even reach the left side of the specified
            // rectangle even with both x & width set to MAX_VALUE.
            // The intersection with the "maximal integer rectangle"
            // is non-existant so we should use a width < 0.
            // REMIND: Should we try to determine a more "meaningful"
            // adjusted value for neww than just "-1"?
            newx = Integer.MAX_VALUE;
            neww = -1;
        } else {
            newx = clip(x, false);
            if (width >= 0) width += x-newx;
            neww = clip(width, width >= 0);
        }

        if (y > 2.0 * Integer.MAX_VALUE) {
            // Too far in positive Y direction to represent...
            newy = Integer.MAX_VALUE;
            newh = -1;
        } else {
            newy = clip(y, false);
            if (height >= 0) height += y-newy;
            newh = clip(height, height >= 0);
        }

        reshape(newx, newy, neww, newh);
    
public voidsetSize(java.awt.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.

param
d the new size for the Dimension object
see
java.awt.Component#setSize(java.awt.Dimension)
see
#getSize
since
1.1

	setSize(d.width, d.height);
    
public voidsetSize(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.

param
width the new width for this Rectangle
param
height the new height for this Rectangle
see
java.awt.Component#setSize(int, int)
see
#getSize
since
1.1

    	resize(width, height);
    
public java.lang.StringtoString()
Returns a String representing this Rectangle and its values.

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

	return getClass().getName() + "[x=" + x + ",y=" + y + ",width=" + width + ",height=" + height + "]";
    
public voidtranslate(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.

param
dx the distance to move this Rectangle along the X axis
param
dy the distance to move this Rectangle along the Y axis
see
java.awt.Rectangle#setLocation(int, int)
see
java.awt.Rectangle#setLocation(java.awt.Point)

        int oldv = this.x;
        int newv = oldv + dx;
        if (dx < 0) {
            // moving leftward
            if (newv > oldv) {
                // negative overflow
                // Only adjust width if it was valid (>= 0).
                if (width >= 0) {
                    // The right edge is now conceptually at
                    // newv+width, but we may move newv to prevent
                    // overflow.  But we want the right edge to
                    // remain at its new location in spite of the
                    // clipping.  Think of the following adjustment
                    // conceptually the same as:
                    // width += newv; newv = MIN_VALUE; width -= newv;
                    width += newv - Integer.MIN_VALUE;
                    // width may go negative if the right edge went past
                    // MIN_VALUE, but it cannot overflow since it cannot
                    // have moved more than MIN_VALUE and any non-negative
                    // number + MIN_VALUE does not overflow.
                }
                newv = Integer.MIN_VALUE;
            }
        } else {
            // moving rightward (or staying still)
            if (newv < oldv) {
                // positive overflow
                if (width >= 0) {
                    // Conceptually the same as:
                    // width += newv; newv = MAX_VALUE; width -= newv;
                    width += newv - Integer.MAX_VALUE;
                    // With large widths and large displacements
                    // we may overflow so we need to check it.
                    if (width < 0) width = Integer.MAX_VALUE;
                }
                newv = Integer.MAX_VALUE;
            }
        }
        this.x = newv;

        oldv = this.y;
        newv = oldv + dy;
        if (dy < 0) {
            // moving upward
            if (newv > oldv) {
                // negative overflow
                if (height >= 0) {
                    height += newv - Integer.MIN_VALUE;
                    // See above comment about no overflow in this case
                }
                newv = Integer.MIN_VALUE;
            }
        } else {
            // moving downward (or staying still)
            if (newv < oldv) {
                // positive overflow
                if (height >= 0) {
                    height += newv - Integer.MAX_VALUE;
                    if (height < 0) height = Integer.MAX_VALUE;
                }
                newv = Integer.MAX_VALUE;
            }
        }
        this.y = newv;
    
public java.awt.Rectangleunion(java.awt.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 {@code Rectangle} has any dimension less than zero the rules for non-existant rectangles apply. If only one has a dimension less than zero, then the result will be a copy of the other {@code Rectangle}. If both have dimension less than zero, then the result will have at least one dimension less than zero.

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

param
r the specified Rectangle
return
the smallest Rectangle containing both the specified Rectangle and this Rectangle.

        long tx2 = this.width;
        long ty2 = this.height;
        if ((tx2 | ty2) < 0) {
            // This rectangle has negative dimensions...
            // If r has non-negative dimensions then it is the answer.
            // If r is non-existant (has a negative dimension), then both
            // are non-existant and we can return any non-existant rectangle
            // as an answer.  Thus, returning r meets that criterion.
            // Either way, r is our answer.
            return new Rectangle(r);
        }
        long rx2 = r.width;
        long ry2 = r.height;
        if ((rx2 | ry2) < 0) {
            return new Rectangle(this);
        }
        int tx1 = this.x;
        int ty1 = this.y;
        tx2 += tx1;
        ty2 += ty1;
        int rx1 = r.x;
        int ry1 = r.y;
        rx2 += rx1;
        ry2 += ry1;
        if (tx1 > rx1) tx1 = rx1;
        if (ty1 > ry1) ty1 = ry1;
        if (tx2 < rx2) tx2 = rx2;
        if (ty2 < ry2) ty2 = ry2;
        tx2 -= tx1;
        ty2 -= ty1;
        // tx2,ty2 will never underflow since both original rectangles
        // were already proven to be non-empty
        // they might overflow, though...
	if (tx2 > Integer.MAX_VALUE) tx2 = Integer.MAX_VALUE;
	if (ty2 > Integer.MAX_VALUE) ty2 = Integer.MAX_VALUE;
	return new Rectangle(tx1, ty1, (int) tx2, (int) ty2);