java.lang.Object
java.awt.geom.RectangularShape
java.awt.geom.Rectangle2D
java.awt.Rectangle
public class Rectangle
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.
int height
Rectangle. int width
Rectangle. int x
Rectangle. int y
Rectangle. Constructor Summary Rectangle()
Rectangle whose top-left corner is at (0, 0) in the coordinate space, and whose width and height are both zero. Rectangle(Dimension d)
Rectangle whose top left corner is (0, 0) and whose width and height are specified by the Dimension argument. Rectangle(int width, int height)
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. Rectangle(int x, int y, int width, int height)
Rectangle whose top-left corner is specified as (x, y) and whose width and height are specified by the arguments of the same name. Rectangle(Point p)
Rectangle whose top-left corner is the specified Point, and whose width and height are both zero. Rectangle(Point p, Dimension d)
Rectangle whose top-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument. Rectangle(Rectangle r)
Rectangle, initialized to match the values of the specified Rectangle. Method Summary void add(int newx, int newy)
newx and newy, to this Rectangle. void add(Point pt)
Point to this Rectangle. void add(Rectangle r)
Rectangle to this Rectangle. boolean contains(int x, int y)
Rectangle contains the point at the specified location (x, y). boolean contains(int X, int Y, int W, int H)
Rectangle entirely contains the Rectangle at the specified location (X, Y) with the specified dimensions (W, H). boolean contains(Point p)
Rectangle contains the specified Point. boolean contains(Rectangle r)
Rectangle entirely contains the specified Rectangle. Rectangle2D createIntersection(Rectangle2D r)
Rectangle2D object representing the intersection of this Rectangle with the specified Rectangle2D. Rectangle2D createUnion(Rectangle2D r)
Rectangle2D object representing the union of this Rectangle with the specified Rectangle2D. boolean equals(Object obj)
Rectangle getBounds()
Rectangle of this Rectangle. Rectangle2D getBounds2D()
double getHeight()
Rectangle in double precision. Point getLocation()
Rectangle. Dimension getSize()
Rectangle, represented by the returned Dimension. double getWidth()
Rectangle in double precision. double getX()
Rectangle in double precision. double getY()
Rectangle in double precision. void grow(int h, int v)
Rectangle both horizontally and vertically. boolean inside(int X, int Y)
contains(int, int). Rectangle intersection(Rectangle r)
Rectangle with the specified Rectangle. boolean intersects(Rectangle r)
Rectangle and the specified Rectangle intersect. boolean isEmpty()
Rectangle is empty. void move(int x, int y)
setLocation(int, int). int outcode(double x, double y)
Rectangle. void reshape(int x, int y, int width, int height)
setBounds(int, int, int, int). void resize(int width, int height)
setSize(int, int). void setBounds(int x, int y, int width, int height)
Rectangle of this Rectangle to the specified x, y, width, and height. void setBounds(Rectangle r)
Rectangle of this Rectangle to match the specified Rectangle. void setLocation(int x, int y)
Rectangle to the specified location. void setLocation(Point p)
Rectangle to the specified location. void setRect(double x, double y, double width, double height)
Rectangle to the specified x, y, width, and height. void setSize(Dimension d)
Rectangle to match the specified Dimension. void setSize(int width, int height)
Rectangle to the specified width and height. String toString()
String representing this Rectangle and its values. void translate(int x, int y)
Rectangle the indicated distance, to the right along the x coordinate axis, and downward along the y coordinate axis. Rectangle union(Rectangle r)
Rectangle with the specified Rectangle. Methods inherited from class java.awt.geom.Rectangle2D add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union Methods inherited from class java.awt.geom.RectangularShape clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal x
public int x
Rectangle.
setLocation(int, int), getLocation()
public int y
Rectangle.
setLocation(int, int), getLocation()
public int width
Rectangle.
setSize(int, int), getSize()
public int height
Rectangle.
setSize(int, int), getSize()
public Rectangle()
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)
Rectangle, initialized to match the values of the specified Rectangle.
r - the Rectangle from which to copy initial values to a newly constructed Rectangle
public Rectangle(int x,
int y,
int width,
int height)
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 - the specified x coordinate
y - the specified y coordinate
width - the width of the Rectangle
height - the height of the Rectangle
public Rectangle(int width,
int height)
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.
width - the width of the Rectangle
height - the height of the Rectangle
public Rectangle(Point p,
Dimension d)
Rectangle whose top-left corner is specified by the Point argument, and whose width and height are specified by the Dimension argument.
p - a Point that is the top-left corner of the Rectangle
d - a Dimension, representing the width and height of the Rectangle
public Rectangle(Point p)
Rectangle whose top-left corner is the specified Point, and whose width and height are both zero.
p - a Point that is the top left corner of the Rectangle
public Rectangle(Dimension d)
Rectangle whose top left corner is (0, 0) and whose width and height are specified by the Dimension argument.
d - a Dimension, specifying width and height
public double getX()
Rectangle in double precision.
getX in class RectangularShape
Rectangle.
public double getY()
Rectangle in double precision.
getY in class RectangularShape
Rectangle.
public double getWidth()
Rectangle in double precision.
getWidth in class RectangularShape
Rectangle.
public double getHeight()
Rectangle in double precision.
getHeight in class RectangularShape
Rectangle.
public Rectangle getBounds()
Rectangle of this Rectangle.
This method is included for completeness, to parallel the getBounds method of Component.
getBounds in interface Shape
getBounds in class RectangularShape
Rectangle, equal to the bounding Rectangle for this Rectangle.
Component.getBounds(), setBounds(Rectangle), setBounds(int, int, int, int)
public Rectangle2D getBounds2D()
getBounds2D in interface Shape
getBounds2D in class Rectangle2D
Rectangle2D.
Shape.getBounds()
public void setBounds(Rectangle r)
Rectangle of this Rectangle to match the specified Rectangle.
This method is included for completeness, to parallel the setBounds method of Component.
r - the specified Rectangle
getBounds(), Component.setBounds(java.awt.Rectangle)
public void setBounds(int x,
int y,
int width,
int height)
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 - the new x coordinate for the top-left corner of this Rectangle
y - the new y coordinate for the top-left corner of this Rectangle
width - the new width for this Rectangle
height - the new height for this Rectangle
getBounds(), Component.setBounds(int, int, int, int)
public void setRect(double x,
double y,
double width,
double height)
Rectangle to the specified x, y, width, and height. This method is included for completeness, to parallel the setBounds method of Component.
setRect in class Rectangle2D
x - the x coordinate of the upper-left corner of the specified rectangle
y - the y coordinate of the upper-left corner of the specified rectangle
width - the new width for the Dimension object
height - the new height for the Dimension object
@Deprecated
public void reshape(int x,
int y,
int width,
int height)
setBounds(int, int, int, int).
Rectangle of this Rectangle to the specified x, y, width, and height.
x - the new x coordinate for the top-left corner of this Rectangle
y - the new y coordinate for the top-left corner of this Rectangle
width - the new width for this Rectangle
height - the new height for this Rectangle
public Point getLocation()
Rectangle.
This method is included for completeness, to parallel the getLocation method of Component.
Point that is the top-left corner of this Rectangle.
Component.getLocation(), setLocation(Point), setLocation(int, int)
public void setLocation(Point p)
Rectangle to the specified location.
This method is included for completeness, to parallel the setLocation method of Component.
p - the Point specifying the new location for this Rectangle
Component.setLocation(java.awt.Point), getLocation()
public void setLocation(int x,
int y)
Rectangle to the specified location.
This method is included for completeness, to parallel the setLocation method of Component.
x - the x coordinate of the new location
y - the y coordinate of the new location
getLocation(), Component.setLocation(int, int)
@Deprecated
public void move(int x,
int y)
setLocation(int, int).
Rectangle to the specified location.
x - the x coordinate of the new location
y - the y coordinate of the new location
public void translate(int x,
int y)
Rectangle the indicated distance, to the right along the x coordinate axis, and downward along the y coordinate axis.
x - the distance to move this Rectangle along the x axis
y - the distance to move this Rectangle along the y axis
setLocation(int, int), setLocation(java.awt.Point)
public Dimension getSize()
Rectangle, represented by the returned Dimension.
This method is included for completeness, to parallel the getSize method of Component.
Dimension, representing the size of this Rectangle.
Component.getSize(), setSize(Dimension), setSize(int, int)
public void setSize(Dimension d)
Rectangle to match the specified Dimension.
This method is included for completeness, to parallel the setSize method of Component.
d - the new size for the Dimension object
Component.setSize(java.awt.Dimension), getSize()
public void setSize(int width,
int height)
Rectangle to the specified width and height.
This method is included for completeness, to parallel the setSize method of Component.
width - the new width for this Rectangle
height - the new height for this Rectangle
Component.setSize(int, int), getSize()
@Deprecated
public void resize(int width,
int height)
setSize(int, int).
Rectangle to the specified width and height.
width - the new width for this Rectangle
height - the new height for this Rectangle
public boolean contains(Point p)
Rectangle contains the specified Point.
p - the Point to test
true if the Point (x, y) is inside this Rectangle; false otherwise.
public boolean contains(int x,
int y)
Rectangle contains the point at the specified location (x, y).
x - the specified x coordinate
y - the specified y coordinate
true if the point (x, y) is inside this Rectangle; false otherwise.
public boolean contains(Rectangle r)
Rectangle entirely contains the specified Rectangle.
r - the specified Rectangle
true if the Rectangle is contained entirely inside this Rectangle; false otherwise
public boolean contains(int X,
int Y,
int W,
int H)
Rectangle entirely contains the Rectangle at the specified location (X, Y) with the specified dimensions (W, H).
X - the specified x coordinate
Y - the specified y coordinate
W - the width of the Rectangle
H - the height of the Rectangle
true if the Rectangle specified by (X, Y, W, H) is entirely enclosed inside this Rectangle; false otherwise.
@Deprecated
public boolean inside(int X,
int Y)
contains(int, int).
Rectangle contains the point at the specified location (X, Y).
X - the specified x coordinate
Y - the specified y coordinate
true if the point (X, Y) is inside this Rectangle; false otherwise.
public boolean intersects(Rectangle r)
Rectangle and the specified Rectangle intersect. Two rectangles intersect if their intersection is nonempty.
r - the specified Rectangle
true if the specified Rectangle and this Rectangle intersect; false otherwise.
public Rectangle intersection(Rectangle r)
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.
r - the specified Rectangle
Rectangle contained in both the specified Rectangle and in this Rectangle; or if the rectangles do not intersect, an empty rectangle.
public Rectangle union(Rectangle r)
Rectangle with the specified Rectangle. Returns a new Rectangle that represents the union of the two rectangles
r - the specified Rectangle
Rectangle containing both the specified Rectangle and this Rectangle.
public void add(int newx,
int newy)
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 - the x coordinate of the new point
newy - the y coordinate of the new point
public void add(Point pt)
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.
pt - the new Point to add to this Rectangle
public void add(Rectangle r)
Rectangle to this Rectangle. The resulting Rectangle is the union of the two rectangles.
r - the specified Rectangle
public void grow(int h,
int v)
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.
h - the horizontal expansion
v - the vertical expansion
public boolean isEmpty()
Rectangle is empty. A Rectangle is empty if its width or its height is less than or equal to zero.
isEmpty in class RectangularShape
true if this Rectangle is empty; false otherwise.
public int outcode(double x,
double y)
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.
outcode in class Rectangle2D
x - the specified x coordinate
y - the specified y coordinate
Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM
public Rectangle2D createIntersection(Rectangle2D r)
Rectangle2D object representing the intersection of this Rectangle with the specified Rectangle2D.
createIntersection in class Rectangle2D
r - the Rectangle2D to be intersected with this Rectangle
Rectangle2D contained in both the specified Rectangle2D and in this Rectangle.
public Rectangle2D createUnion(Rectangle2D r)
Rectangle2D object representing the union of this Rectangle with the specified Rectangle2D.
createUnion in class Rectangle2D
r - the Rectangle2D to be combined with this Rectangle
Rectangle2D containing both the specified Rectangle2D and this Rectangle.
public boolean equals(Object obj)
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.
equals in class Rectangle2D
obj - the Object to compare with this Rectangle
true if the objects are equal; false otherwise.
Object.hashCode(), Hashtable
public String toString()
String representing this Rectangle and its values.
toString in class Object
String representing this Rectangle object's coordinate and size values.
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4