| java.lang.Object
 org.awt.geom.Rectangle2D
org.awt.Rectangle
| Rectangle | | public class Rectangle extends Rectangle2D (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.
|
| 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 specified 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()
| | 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 Rectangle2D | createIntersection(Rectangle2D r)
Returns a new
Rectangle2D object
representing the intersection of this Rectangle with the
specified Rectangle2D. | | public Rectangle2D | createUnion(Rectangle2D r)
Returns a new Rectangle2D object representing the
union of this Rectangle with the specified
Rectangle2D. | | public boolean | 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. | | public Rectangle | getBounds()
Gets the bounding Rectangle of this Rectangle. | | public Rectangle2D | getBounds2D()
Return the high precision bounding box of this rectangle. | | public double | getHeight()
Returns the height of the bounding Rectangle in
double precision.
the height of the bounding Rectangle. | | public Point | getLocation()
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. | | public Dimension | getSize()
Gets the size of this Rectangle, represented by
the returned Dimension. | | public double | getWidth()
Returns the width of the bounding Rectangle in
double precision.
the width of the bounding Rectangle. | | public double | getX()
Returns the X coordinate of the bounding Rectangle in
double precision.
the x coordinate of the bounding Rectangle. | | public double | getY()
Returns the Y coordinate of the bounding Rectangle in
double precision.
the y coordinate of the bounding Rectangle. | | 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. | | public boolean | inside(int X, int Y)
Checks whether or not this Rectangle contains the
point at the specified location
(X, 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)
Moves this Rectangle to the specified location. | | public int | outcode(double x, double y)
Determines where the specified coordinates lie with respect
to this Rectangle. | | public void | reshape(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 | resize(int width, int height)
Sets the size of this Rectangle to the specified
width and 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 | setRect(double x, double y, double width, double height)
Sets the bounds of this Rectangle to the specified
x, y, width,
and height. | | 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 specified Rectangle.
Parameters:
r - the Rectangle from which to copy initial valuesto a newly constructed Rectangle |
| 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.
Parameters:
x - the specified x coordinate
Parameters:
y - the specified y coordinate
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 of the Rectangle
Parameters:
d - a Dimension, representing the width 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 corner of 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.
Parameters:
newx - the x coordinate of the new point
Parameters:
newy - the y coordinate 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 this Rectangle |
| 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 |
| 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 this Rectangle; false otherwise. |
| contains | | public boolean contains(int x, int y)(Code) | | Checks whether or not this Rectangle contains the
point at the specified location
(x, y).
Parameters:
x - the specified x coordinate
Parameters:
y - the specified y coordinate true if the point (x, y) is inside this Rectangle; false otherwise. |
| 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 Rectangle is contained entirely inside this Rectangle; false otherwise. |
| 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).
Parameters:
X - the specified x coordinate
Parameters:
Y - the specified y coordinate
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. |
| createIntersection | | public Rectangle2D createIntersection(Rectangle2D r)(Code) | | Returns a new
Rectangle2D object
representing the intersection of this Rectangle with the
specified Rectangle2D.
Parameters:
r - the Rectangle2D to be intersected with this Rectangle the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle. |
| createUnion | | public Rectangle2D createUnion(Rectangle2D r)(Code) | | Returns a new Rectangle2D object representing the
union of this Rectangle with the specified
Rectangle2D.
Parameters:
r - the Rectangle2D to be combined withthis Rectangle the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle. |
| 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. |
| getBounds2D | | public Rectangle2D getBounds2D()(Code) | | Return the high precision bounding box of this rectangle.
|
| getHeight | | public double getHeight()(Code) | | Returns the height of the bounding Rectangle in
double precision.
the height of the bounding Rectangle. |
| getWidth | | public double getWidth()(Code) | | Returns the width of the bounding Rectangle in
double precision.
the width of the bounding Rectangle. |
| getX | | public double getX()(Code) | | Returns the X coordinate of the bounding Rectangle in
double precision.
the x coordinate of the bounding Rectangle. |
| getY | | public double getY()(Code) | | Returns the Y coordinate of the bounding Rectangle in
double precision.
the y coordinate of the bounding Rectangle. |
| 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 |
| inside | | public boolean inside(int X, int Y)(Code) | | Checks whether or not this Rectangle contains the
point at the specified location
(X, Y).
Parameters:
X - the specified x coordinate
Parameters:
Y - the specified y coordinate true if the point (X, Y) is inside this Rectangle; false otherwise. |
| 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.
If the two rectangles do not intersect, the result will be
an empty rectangle.
Parameters:
r - the specified Rectangle the largest Rectangle contained in both the specified Rectangle and in this Rectangle; or if the rectanglesdo not intersect, an empty rectangle. |
| 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 Rectangle and this Rectangle intersect; 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) | | Moves this Rectangle to the specified location.
Parameters:
x - the x coordinate of the new location
Parameters:
y - the y coordinate of the new location |
| outcode | | public int outcode(double x, double y)(Code) | | 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.
Parameters:
x - the specified x coordinate
Parameters:
y - the specified y coordinate the logical OR of all appropriate out codes.
See Also: Rectangle.OUT_LEFT
See Also: Rectangle.OUT_TOP
See Also: Rectangle.OUT_RIGHT
See Also: Rectangle.OUT_BOTTOM |
| reshape | | public void reshape(int x, int y, int width, int height)(Code) | | Sets the bounding Rectangle of this
Rectangle to the specified
x, y, width,
and height.
Parameters:
x - the new x coordinate for the top-leftcorner of this Rectangle
Parameters:
y - the new y coordinate for the top-leftcorner of this Rectangle
Parameters:
width - the new width for this Rectangle
Parameters:
height - the new height for this Rectangle |
| resize | | public void resize(int width, int height)(Code) | | Sets the size of this Rectangle to the specified
width and height.
Parameters:
width - the new width for this Rectangle
Parameters:
height - the new height for this Rectangle |
| 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.
Parameters:
x - the new x coordinate for the top-leftcorner of this Rectangle
Parameters:
y - the new y coordinate 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: Rectangle.getBounds
See Also: java.awt.Component.setBounds(intintintint) |
| 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.
Parameters:
x - the x coordinate of the new location
Parameters:
y - the y coordinate of the new location
See Also: Rectangle.getLocation
See Also: java.awt.Component.setLocation(intint) |
| setRect | | public void setRect(double x, double y, double width, double height)(Code) | | 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.
Parameters:
x - the x coordinate of the upper-left corner of the specified rectangle
Parameters:
y - the y coordinate of the upper-left corner of the specified rectangle
Parameters:
width - the new width for the Dimension object
Parameters:
height - the new height for the Dimension object |
| 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)
See Also: Rectangle.getSize |
| toString | | public String toString()(Code) | | Returns a String representing this
Rectangle and its values.
a String representing this Rectangle 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 both the specified Rectangle and this Rectangle. |
| Methods inherited from org.awt.geom.Rectangle2D | public void add(double newx, double newy)(Code)(Java Doc)
public void add(Point2D pt)(Code)(Java Doc)
public void add(Rectangle2D r)(Code)(Java Doc)
public boolean contains(double x, double y)(Code)(Java Doc)
public boolean contains(double x, double y, double w, double h)(Code)(Java Doc)
abstract public Rectangle2D createIntersection(Rectangle2D r)(Code)(Java Doc)
abstract public Rectangle2D createUnion(Rectangle2D r)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public Rectangle2D getBounds2D()(Code)(Java Doc)
abstract public Rectangle2D getBounds2D()(Code)(Java Doc)
abstract public double getHeight()(Code)(Java Doc)
public double getMaxX()(Code)(Java Doc)
public double getMaxY()(Code)(Java Doc)
public double getMinX()(Code)(Java Doc)
public double getMinY()(Code)(Java Doc)
public PathIterator getPathIterator(AffineTransform at)(Code)(Java Doc)
public PathIterator getPathIterator(AffineTransform at, double flatness)(Code)(Java Doc)
abstract public double getWidth()(Code)(Java Doc)
abstract public double getX()(Code)(Java Doc)
abstract public double getY()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public static void intersect(Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)(Code)(Java Doc)
public boolean intersects(double x, double y, double w, double h)(Code)(Java Doc)
public boolean intersectsLine(double x1, double y1, double x2, double y2)(Code)(Java Doc)
public boolean intersectsLine(Line2D l)(Code)(Java Doc)
abstract public boolean isEmpty()(Code)(Java Doc)
abstract public int outcode(double x, double y)(Code)(Java Doc)
public int outcode(Point2D p)(Code)(Java Doc)
public void setFrame(double x, double y, double w, double h)(Code)(Java Doc)
public void setFrameFromDiagonal(double x1, double y1, double x2, double y2)(Code)(Java Doc)
abstract public void setRect(double x, double y, double w, double h)(Code)(Java Doc)
public void setRect(Rectangle2D r)(Code)(Java Doc)
public static void union(Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)(Code)(Java Doc)
|
|
|