Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS    

java.awt
Class Rectangle

java.lang.Object
  |
  +--java.awt.geom.RectangularShape
        |
        +--java.awt.geom.Rectangle2D
              |
              +--java.awt.Rectangle
All Implemented Interfaces:
Cloneable, Serializable, Shape
Direct Known Subclasses:
DefaultCaret
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 top-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 negative is considered empty. If the Rectangle is empty, then the isEmpty method returns true. No point can be contained by or inside an empty Rectangle. The values of width and height, however, are still valid. An empty Rectangle still has a location in the coordinate space, and methods that change its size or location remain valid. The behavior of methods that operate on more than one Rectangle is undefined if any of the participating Rectangle objects has a negative width or height. These methods include intersects, intersection, and union.

Since:
JDK1.0
See Also:
Serialized Form

Inner classes inherited from class java.awt.geom.Rectangle2D
Rectangle2D.Double, Rectangle2D.Float
 
Field Summary
 int height
copy->  height
The height of the Rectangle.
See Also:
setSize(int, int), getSize()
 int width
copy->  width
The width of the Rectangle.
See Also:
setSize(int, int), getSize()
Since:
JDK1.0.
 int x
copy->  x
The x coordinate of the Rectangle.
See Also:
setLocation(int, int), getLocation()
 int y
copy->  y
The y coordinate of the Rectangle.
See Also:
setLocation(int, int), getLocation()
 
Fields inherited from class java.awt.geom.Rectangle2D
OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP
 
Constructor Summary
Rectangle
copy->  new Rectangle()
copy->  <Rectangle var> = new Rectangle();
Constructs a new Rectangle whose top-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero.
Rectangle
copy->  new Rectangle( )
copy->  <Rectangle var> = new 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 - a Dimension, specifying width and height
Rectangle
copy->  new Rectangle(, )
copy->  <Rectangle var> = new Rectangle(<int width>, <int height>);
Constructs a new Rectangle whose top-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 the Rectangle
height - the height of the Rectangle
Rectangle
copy->  new Rectangle(, , , )
copy->  <Rectangle var> = new Rectangle(<int x>, <int y>, <int width>, <int height>);
Constructs a new Rectangle whose top-left corner is specified as (x, y) and whose width and height are specified by the arguments of the same name.
Parameters:
x, y - the specified coordinates
width - the width of the Rectangle
height - the height of the Rectangle
Rectangle
copy->  new Rectangle( )
copy->  <Rectangle var> = new Rectangle(<Point p>);
Constructs a new Rectangle whose top-left corner is the specified Point, and whose width and height are both zero.
Parameters:
p - a Point that is the top left corner of the Rectangle
Rectangle
copy->  new Rectangle(, )
copy->  <Rectangle var> = new Rectangle(<Point p>, <Dimension d>);
Constructs a new Rectangle whose top-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument.
Parameters:
p - a Point that is the top-left corner of the Rectangle
d - a Dimension, representing the width and height of the Rectangle
Rectangle
copy->  new Rectangle( )
copy->  <Rectangle var> = new Rectangle(<Rectangle r>);
Constructs a new Rectangle, initialized to match the values of the specificed Rectangle.
Parameters:
r - the Rectangle from which to copy initial values to a newly constructed Rectangle
Since:
JDK1.1
 
Method Summary
 void add(int newx, int newy)
copy->  .add(, )
copy->  <Rectangle>.add(<int newx>, <int newy>);
Adds a point, specified by the integer arguments newx and newy, to this Rectangle. The resulting Rectangle is the smallest Rectangle that contains both the original Rectangle and the specified point.

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.

Parameters:
newx, newy - the coordinates of the new point
 void add(Point pt)
copy->  .add( )
copy->  <Rectangle>.add(<Point pt>);
Adds the specified Point to this Rectangle. The resulting Rectangle is the smallest Rectangle that contains both the original Rectangle and the specified Point.

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.

Parameters:
pt - the new Point to add to this Rectangle
 void add(Rectangle r)
copy->  .add( )
copy->  <Rectangle>.add(<Rectangle r>);
Adds a Rectangle to this Rectangle. The resulting Rectangle is the union of the two rectangles.
Parameters:
r - the specified Rectangle
 boolean contains(int x, int y)
copy->  .contains(, )
copy->  <boolean var>=<Rectangle>.contains(<int x>, <int y>);
Checks whether or not this Rectangle contains the point at the specified location (x, y).
Parameters:
x, y - the specified coordinates
Returns:
true if the point (x, y) is inside this Rectangle; false otherwise.
Since:
JDK1.1
 boolean contains(int X, int Y, int W, int H)
copy->  .contains(, , , )
copy->  <boolean var>=<Rectangle>.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, y - the specified coordinates
W - the width of the Rectangle
H - the height of the Rectangle
Returns:
true if the Rectangle specified by (X, Y, W, H) is entirely enclosed inside this Rectangle; false otherwise.
Since:
JDK1.1
 boolean contains(Point p)
copy->  .contains( )
copy->  <boolean var>=<Rectangle>.contains(<Point p>);
Checks whether or not this Rectangle contains the specified Point.
Parameters:
p - the Point to test
Returns:
true if the Point (x, y) is inside this Rectangle; false otherwise.
Since:
JDK1.1
 boolean contains(Rectangle r)
copy->  .contains( )
copy->  <boolean var>=<Rectangle>.contains(<Rectangle r>);
Checks whether or not this Rectangle entirely contains the specified Rectangle.
Parameters:
r - the specified Rectangle
Returns:
true if the Rectangle is contained entirely inside this Rectangle; false otherwise.
Since:
JDK1.1
 Rectangle2D createIntersection(Rectangle2D r)
copy->  .createIntersection( )
copy->  <Rectangle2D var>=<Rectangle>.createIntersection(<Rectangle2D r>);
Returns a new Rectangle2D object representing the intersection of this Rectangle with the specified Rectangle2D.
Overrides:
createIntersection in class Rectangle2D
Parameters:
r - the Rectangle2D to be intersected with this Rectangle
Returns:
the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle.
Since:
1.2
 Rectangle2D createUnion(Rectangle2D r)
copy->  .createUnion( )
copy->  <Rectangle2D var>=<Rectangle>.createUnion(<Rectangle2D r>);
Returns a new Rectangle2D object representing the union of this Rectangle with the specified Rectangle2D.
Overrides:
createUnion in class Rectangle2D
Parameters:
r - the Rectangle2D to be combined with this Rectangle
Returns:
the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle.
Since:
1.2
 boolean equals(Object obj)
copy->  .equals( )
copy->  <boolean var>=<Rectangle>.equals(<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 top-left corner, width, and height as this Rectangle.

Overrides:
equals in class Rectangle2D
Parameters:
obj - the Object to compare with this Rectangle
Returns:
true if the objects are equal; false otherwise.
 Rectangle getBounds()
copy->  .getBounds()
copy->  <Rectangle var>=<Rectangle>.getBounds();
Gets the bounding Rectangle of this Rectangle.

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

Specified by:
getBounds in interface Shape
Overrides:
getBounds in class RectangularShape
Returns:
a new Rectangle, equal to the bounding Rectangle for this Rectangle.
Since:
JDK1.1
See Also:
Component.getBounds()
 Rectangle2D getBounds2D()
copy->  .getBounds2D()
copy->  <Rectangle2D var>=<Rectangle>.getBounds2D();
Return the high precision bounding box of this rectangle.
Specified by:
getBounds2D in interface Shape
Overrides:
getBounds2D in class Rectangle2D
Since:
1.2
 double getHeight()
copy->  .getHeight()
copy->  <double var>=<Rectangle>.getHeight();
Returns the height of the bounding Rectangle in double precision.
Overrides:
getHeight in class RectangularShape
Returns:
the height of the bounding Rectangle.
 Point getLocation()
copy->  .getLocation()
copy->  <Point var>=<Rectangle>.getLocation();
Returns the location of this Rectangle.

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

Returns:
the Point that is the top-left corner of this Rectangle.
Since:
JDK1.1
See Also:
Component.getLocation()
 Dimension getSize()
copy->  .getSize()
copy->  <Dimension var>=<Rectangle>.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:
a Dimension, representing the size of this Rectangle.
Since:
JDK1.1
See Also:
Component.getSize()
 double getWidth()
copy->  .getWidth()
copy->  <double var>=<Rectangle>.getWidth();
Returns the width of the bounding Rectangle in double precision.
Overrides:
getWidth in class RectangularShape
Returns:
the width of the bounding Rectangle.
 double getX()
copy->  .getX()
copy->  <double var>=<Rectangle>.getX();
Returns the X coordinate of the bounding Rectangle in double precision.
Overrides:
getX in class RectangularShape
Returns:
the x coordinate of the bounding Rectangle.
 double getY()
copy->  .getY()
copy->  <double var>=<Rectangle>.getY();
Returns the Y coordinate of the bounding Rectangle in double precision.
Overrides:
getY in class RectangularShape
Returns:
the y coordinate of the bounding Rectangle.
 void grow(int h, int v)
copy->  .grow(, )
copy->  <Rectangle>.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 top-left corner, a 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 does not check whether the resulting values of width and height are non-negative.

Parameters:
h - the horizontal expansion
v - the vertical expansion
 boolean inside(int x, int y)
copy->  .inside(, )
copy->  <boolean var>=<Rectangle>.inside(<int x>, <int y>);
Deprecated. As of JDK version 1.1, replaced by contains(int, int).

 Rectangle intersection(Rectangle r)
copy->  .intersection( )
copy->  <Rectangle var>=<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.
Parameters:
r - the specified Rectangle
Returns:
the largest Rectangle contained in both the specified Rectangle and in thisRectangle.
 boolean intersects(Rectangle r)
copy->  .intersects( )
copy->  <boolean var>=<Rectangle>.intersects(<Rectangle r>);
Determines whether or not this Rectangle and the specified Rectangle intersect. Two rectangles intersect if their intersection is nonempty.
Parameters:
r - the specified Rectangle
Returns:
true if the specified Rectangle and this Rectangle insersect; false otherwise.
 boolean isEmpty()
copy->  .isEmpty()
copy->  <boolean var>=<Rectangle>.isEmpty();
Determines whether or not this Rectangle is empty. A Rectangle is empty if its width or its height is less than or equal to zero.
Overrides:
isEmpty in class RectangularShape
Returns:
true if this Rectangle is empty; false otherwise.
 void move(int x, int y)
copy->  .move(, )
copy->  <Rectangle>.move(<int x>, <int y>);
Deprecated. As of JDK version 1.1, replaced by setLocation(int, int).

 int outcode(double x, double y)
copy->  .outcode(, )
copy->  <int var>=<Rectangle>.outcode(<double x>, <double y>);
Determines where the specified coordinates lie with respect to this Rectangle. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle, whether or not the specified coordinates are on the same side of the edge as the rest of this Rectangle.
Overrides:
outcode in class Rectangle2D
Parameters:
x, y - the specified coordinates
Returns:
the logical OR of all appropriate out codes.
Since:
1.2
See Also:
Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM
 void reshape(int x, int y, int width, int height)
copy->  .reshape(, , , )
copy->  <Rectangle>.reshape(<int x>, <int y>, <int width>, <int height>);
Deprecated. As of JDK version 1.1, replaced by setBounds(int, int, int, int).

 void resize(int width, int height)
copy->  .resize(, )
copy->  <Rectangle>.resize(<int width>, <int height>);
Deprecated. As of JDK version 1.1, replaced by setSize(int, int).

 void setBounds(int x, int y, int width, int height)
copy->  .setBounds(, , , )
copy->  <Rectangle>.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, y - the new coordinates for the top-left corner of this Rectangle
width - the new width for this Rectangle
height - the new height for this Rectangle
Since:
JDK1.1
See Also:
Component.setBounds(int, int, int, int)
 void setBounds(Rectangle r)
copy->  .setBounds( )
copy->  <Rectangle>.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 - the specified Rectangle
Since:
JDK1.1
See Also:
Component.setBounds(java.awt.Rectangle)
 void setLocation(int x, int y)
copy->  .setLocation(, )
copy->  <Rectangle>.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, y - the coordinates of the new location
Since:
JDK1.1
See Also:
Component.setLocation(int, int)
 void setLocation(Point p)
copy->  .setLocation( )
copy->  <Rectangle>.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 - the Point specifying the new location for this Rectangle
Since:
JDK1.1
See Also:
Component.setLocation(java.awt.Point)
 void setRect(double x, double y, double width, double height)
copy->  .setRect(, , , )
copy->  <Rectangle>.setRect(<double x>, <double y>, <double width>, <double height>);
Sets the bounds of this Rectangle to the specified x, y, width, and height. This method is included for completeness, to parallel the setBounds method of Component.
Overrides:
setRect in class Rectangle2D
Parameters:
width - the new width for the Dimension object
height - the new height for the Dimension object
 void setSize(Dimension d)
copy->  .setSize( )
copy->  <Rectangle>.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 - the new size for the Dimension object
Since:
JDK1.1
See Also:
Component.setSize(java.awt.Dimension)
 void setSize(int width,