| java.lang.Object
 java.awt.Rectangle
All known Subclasses: sun.porting.utils.Rectangle,
| Rectangle | | public class Rectangle implements Shape,Cloneable,java.io.Serializable(Code) | | 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.
version:
1.52, 02/02/00
author:
Sami Shaio
since:
JDK1.0 |
| Field Summary | |
| public int | height
The height of the Rectangle. | | public int | width
The width of the Rectangle. | | public int | x
The x coordinate of the Rectangle. | | public int | y
The y coordinate of the Rectangle. |
| Constructor Summary | |
| public | 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. | | public | Rectangle(Rectangle r)
Constructs a new Rectangle, initialized to match
the values of the specificed Rectangle. | | public | 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. | | public | 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. | | public | 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. | | public | Rectangle(Point p)
Constructs a new Rectangle whose top-left corner is the
specified Point, and whose width and height are both zero. | | 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. |
| Method Summary | |
| public void | add(int newx, int newy)
Adds a point, specified by the integer arguments newx
and newy, to this Rectangle. | | public void | add(Point pt)
Adds the specified Point to this
Rectangle. | | public void | add(Rectangle r)
Adds a Rectangle to this Rectangle. | | public Object | clone()
Creates a new object of the same class and with the same
contents as this object. | | boolean | contains(double x, double y)
| | public boolean | contains(Point p)
Checks whether or not this Rectangle contains the
specified Point. | | public boolean | contains(int x, int y)
Checks whether or not this Rectangle contains the
point at the specified location
(x, y). | | public boolean | contains(Rectangle r)
Checks whether or not this Rectangle entirely contains
the specified Rectangle. | | 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). | | public boolean | equals(Object obj)
Checks whether two rectangles are equal. | | public Rectangle | getBounds()
Gets the bounding Rectangle of this Rectangle. | | public Point | getLocation()
Returns the location of this Rectangle. | | public Dimension | getSize()
Gets the size of this Rectangle, represented by
the returned Dimension. | | public void | grow(int h, int v)
Resizes the Rectangle both horizontally and vertically. | | public int | hashCode()
Returns the hashcode for this Rectangle2D. | | public boolean | inside(int x, int y)
| | public Rectangle | intersection(Rectangle r)
Computes the intersection of this Rectangle with the
specified Rectangle. | | public boolean | intersects(Rectangle r)
Determines whether or not this Rectangle and the specified
Rectangle intersect. | | public boolean | isEmpty()
Determines whether or not this Rectangle is empty. | | public void | move(int x, int y)
| | public void | reshape(int x, int y, int width, int height)
| | public void | resize(int width, int height)
| | public void | setBounds(Rectangle r)
Sets the bounding Rectangle of this Rectangle
to match the specified Rectangle. | | 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. | | public void | setLocation(Point p)
Moves this Rectangle to the specified location. | | public void | setLocation(int x, int y)
Moves this Rectangle to the specified location. | | public void | setSize(Dimension d)
Sets the size of this Rectangle to match the
specified Dimension. | | public void | setSize(int width, int height)
Sets the size of this Rectangle to the specified
width and height. | | public String | toString()
Returns a String representing this
Rectangle and its values. | | public void | translate(int x, int y)
Translates this Rectangle the indicated distance,
to the right along the x coordinate axis, and
downward along the y coordinate axis. | | public Rectangle | union(Rectangle r)
Computes the union of this Rectangle with the
specified Rectangle. |
| Rectangle | | public Rectangle()(Code) | | 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 | | public Rectangle(Rectangle r)(Code) | | Constructs a new Rectangle, initialized to match
the values of the specificed Rectangle.
Parameters:
r - the Rectangle from which to copy initial valuesto a newly constructed Rectangle
since:
JDK1.1 |
| Rectangle | | public Rectangle(int x, int y, int width, int height)(Code) | | 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.
x, y the specified coordinates
Parameters:
width - the width of the Rectangle
Parameters:
height - the height of the Rectangle |
| Rectangle | | public Rectangle(int width, int height)(Code) | | 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
Parameters:
height - the height of the Rectangle |
| Rectangle | | public Rectangle(Point p, Dimension d)(Code) | | 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 ofthe Rectangle
Parameters:
d - a Dimension, representing thewidth and height of the Rectangle |
| Rectangle | | public Rectangle(Point p)(Code) | | 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 cornerof the Rectangle |
| Rectangle | | public Rectangle(Dimension d)(Code) | | 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 |
| add | | public void add(int newx, int newy)(Code) | | 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.
newx, newy the coordinates of the new point |
| add | | public void add(Point pt)(Code) | | 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 thisRectangle |
| add | | public void add(Rectangle r)(Code) | | Adds a Rectangle to this Rectangle.
The resulting Rectangle is the union of the two
rectangles.
Parameters:
r - the specified Rectangle |
| clone | | public Object clone()(Code) | | Creates a new object of the same class and with the same
contents as this object.
a clone of this instance.
exception:
OutOfMemoryError - if there is not enough memory.
See Also: java.lang.Cloneable
since:
1.2 |
| contains | | boolean contains(double x, double y)(Code) | | |
| contains | | public boolean contains(Point p)(Code) | | Checks whether or not this Rectangle contains the
specified Point.
Parameters:
p - the Point to test true if the Point(x, y) is inside thisRectangle;false otherwise.
since:
JDK1.1 |
| contains | | public boolean contains(int x, int y)(Code) | | Checks whether or not this Rectangle contains the
point at the specified location
(x, y).
x, y the specified coordinates true if the point(x, y) is inside thisRectangle;false otherwise.
since:
JDK1.1 |
| contains | | public boolean contains(Rectangle r)(Code) | | Checks whether or not this Rectangle entirely contains
the specified Rectangle.
Parameters:
r - the specified Rectangle true if the Rectangleis contained entirely inside this Rectangle;false otherwise.
since:
JDK1.1 |
| contains | | public boolean contains(int X, int Y, int W, int H)(Code) | | Checks whether this Rectangle entirely contains
the Rectangle
at the specified location (X, Y) with the
specified dimensions (W, H).
x, y the specified coordinates
Parameters:
W - the width of the Rectangle
Parameters:
H - the height of the Rectangle true if the Rectangle specified by(X, Y, W, H)is entirely enclosed inside this Rectangle;false otherwise.
since:
JDK1.1 |
| equals | | public boolean equals(Object obj)(Code) | | 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.
Parameters:
obj - the Object to compare withthis Rectangle true if the objects are equal;false otherwise. |
| getBounds | | public Rectangle getBounds()(Code) | | Gets the bounding Rectangle of this Rectangle.
This method is included for completeness, to parallel the
getBounds method of
Component .
a new Rectangle, equal to thebounding Rectangle for this Rectangle.
See Also: java.awt.Component.getBounds
since:
JDK1.1 |
| getLocation | | public Point getLocation()(Code) | | Returns the location of this Rectangle.
This method is included for completeness, to parallel the
getLocation method of Component.
the Point that is the top-left corner ofthis Rectangle.
See Also: java.awt.Component.getLocation
since:
JDK1.1 |
| getSize | | public Dimension getSize()(Code) | | Gets the size of this Rectangle, represented by
the returned Dimension.
This method is included for completeness, to parallel the
getSize method of Component.
a Dimension, representing the size ofthis Rectangle.
See Also: java.awt.Component.getSize
since:
JDK1.1 |
| grow | | public void grow(int h, int v)(Code) | | 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
Parameters:
v - the vertical expansion |
| hashCode | | public int hashCode()(Code) | | Returns the hashcode for this Rectangle2D.
the hashcode for this Rectangle2D. |
| inside | | public boolean inside(int x, int y)(Code) | | |
| intersection | | public Rectangle intersection(Rectangle r)(Code) | | 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 the largest Rectangle contained in both thespecified Rectangle and inthisRectangle. |
| intersects | | public boolean intersects(Rectangle r)(Code) | | Determines whether or not this Rectangle and the specified
Rectangle intersect. Two rectangles intersect if
their intersection is nonempty.
Parameters:
r - the specified Rectangle true if the specified Rectangleand this Rectangle insersect;false otherwise. |
| isEmpty | | public boolean isEmpty()(Code) | | 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.
true if this Rectangle is empty;false otherwise. |
| move | | public void move(int x, int y)(Code) | | |
| reshape | | public void reshape(int x, int y, int width, int height)(Code) | | |
| resize | | public void resize(int width, int height)(Code) | | |
| setBounds | | public void setBounds(Rectangle r)(Code) | | 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
See Also: java.awt.Component.setBounds(java.awt.Rectangle)
since:
JDK1.1 |
| setBounds | | public void setBounds(int x, int y, int width, int height)(Code) | | 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.
x, y the new coordinates for the top-leftcorner of this Rectangle
Parameters:
width - the new width for this Rectangle
Parameters:
height - the new height for this Rectangle
See Also: java.awt.Component.setBounds(intintintint)
since:
JDK1.1 |
| setLocation | | public void setLocation(Point p)(Code) | | 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 locationfor this Rectangle
See Also: java.awt.Component.setLocation(java.awt.Point)
since:
JDK1.1 |
| setLocation | | public void setLocation(int x, int y)(Code) | | Moves this Rectangle to the specified location.
This method is included for completeness, to parallel the
setLocation method of Component.
x, y the coordinates of the new location
See Also: java.awt.Component.setLocation(intint)
since:
JDK1.1 |
| setSize | | public void setSize(Dimension d)(Code) | | 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
See Also: java.awt.Component.setSize(java.awt.Dimension)
since:
JDK1.1 |
| setSize | | public void setSize(int width, int height)(Code) | | 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 - the new width for this Rectangle
Parameters:
height - the new height for this Rectangle
See Also: java.awt.Component.setSize(intint)
since:
JDK1.1 |
| toString | | public String toString()(Code) | | Returns a String representing this
Rectangle and its values.
a String representing thisRectangle object's coordinate and size values. |
| union | | public Rectangle union(Rectangle r)(Code) | | Computes the union of this Rectangle with the
specified Rectangle. Returns a new
Rectangle that
represents the union of the two rectangles
Parameters:
r - the specified Rectangle the smallest Rectangle containing boththe specified Rectangle and thisRectangle. |
|
|