类 java.awt.Rectangle

java.lang.Object
   |
   +----java.awt.Rectangle

public class Rectangle

extends Object

implements Shape, Serializable

指定坐标空间上的一个矩形区域类，通过左上顶点 (x, y)、宽和高来定义相应的矩形。

矩形的 宽 和 高 是公有属性。创建一个 rectangle 对象的构造子，和允许修改矩形的方法，都不禁止用户为这些特性设置负值。

宽和高为负值的矩形被当作空，类 Rectangle 定义的所有方法据此执行相应的行为。如果矩形为空，那么 isEmpty 方法返回 true。 一个空矩形不包含或其内部没有任何点，但是 宽 和 高 仍有效。一个空矩形在坐标空间上仍有一位置，改变它的尺寸和位置的方法保持有效。对多个矩形操作的方法的行为，如果这些矩形中的任一个均有一负的 宽 或 高，那么它们将无效。这些方法包括 intersects, intersection 和 union。

变量索引

height

矩形的高度。

width

矩形的宽度。

x

矩形的 x 坐标。

y

矩形的 y 坐标。

构造子索引

Rectangle()

创建一个新的矩形对象，它的左上顶点为 (0, 0)，宽和高为零。

Rectangle(Dimension)

创建一个新的矩形对象，它的左上顶点为 (0, 0)，宽和高为参数 dimension 的指定值。

Rectangle(int, int)

创建一个新的矩形对象，它的左上顶点为 (0, 0)，宽和高为参数指定值。

Rectangle(int, int, int, int)

创建一个新的矩形对象，它的左上顶点为 (x, y)，宽和高为参数指定值。

Rectangle(Point)

创建一个新的矩形对象，它的左上顶点为参数指定点，宽和高为零。

Rectangle(Point, Dimension)

创建一个新的矩形对象，它的左上顶点由 dimension 参数指定，宽和高由 dimension 参数指定。

Rectangle(Rectangle)

创建一个新的矩形对象，初始化为参数指定的矩形值。

方法索引

add(int, int)

向当前矩形，添加一个由参数 newx 和 newy 指定的点。

add(Point)

向当前矩形添加一个点 pt。

add(Rectangle)

向当前矩形添加一个矩形。

contains(int, int)

检查当前矩形是否包含给定点 (x, y)。

contains(Point)

判定当前矩形是否包含给定点。

equals(Object)

判断两个矩形是否等价。

getBounds()

获取当前矩形的边界矩形。

getLocation()

返回当前矩形的位置。

getSize()

获取当前矩形的尺寸(宽和高)。

grow(int, int)

水平和垂直增大矩形。

hashCode()

返回当前矩形的哈希码。

inside(int, int)

不推荐使用该方法。

intersection(Rectangle)

计算当前矩形与给定矩形的相交部分。

intersects(Rectangle)

判定当前矩形与给定矩形是否相交。

isEmpty()

判定当前矩形是否为空。

move(int, int)

不推荐使用该方法。

reshape(int, int, int, int)

不推荐使用该方法。

resize(int, int)

不推荐使用该方法。

setBounds(int, int, int, int)

将当前矩形的边界矩形设置为 x, y, width, 和 height。

setBounds(Rectangle)

将当前矩形的边界矩形设置为指定矩形。

setLocation(int, int)

将矩形移动到给定位置。

setLocation(Point)

将矩形移动到给定位置。

setSize(Dimension)

将当前矩形的尺寸设置为指定尺寸。

setSize(int, int)

将当前矩形的尺寸设置为指定的宽和高。

toString()

返回表示当前矩形及其值的串描述。

translate(int, int)

将该矩形沿 x 坐标轴向右，沿 y 坐标轴向下移动指定距离。

union(Rectangle)

计算当前矩形与给定矩形的并集。

变量

 public int x

矩形的 x 坐标。

 public int y

矩形的 y 坐标。

 public int width

矩形的宽度。

 public int height

矩形的高度。

构造子

 public Rectangle()

创建一个新的矩形对象，它的左上顶点为 (0, 0)，宽和高为零。

 public Rectangle(Rectangle r)

创建一个新的矩形对象，初始化为参数指定的矩形值。

参数：

r - 初始化新矩形的矩形。

 public Rectangle(int x,
                       int y,
                                int width,
                       int height)

创建一个新的矩形对象，它的左上顶点为 (x, y)，宽和高为参数指定值。

参数：

x - x 坐标。

y - y 坐标。

width - 矩形宽。

height - 矩形高。

 public Rectangle(int width,
                       int height)

创建一个新的矩形对象，它的左上顶点为 (0, 0)，宽和高为参数指定值。

参数：

width - 矩形宽。

height - 矩形高。

 public Rectangle(Point p,
                  Dimension d)

创建一个新的矩形对象，它的左上顶点由 point 参数指定，宽和高由 dimension 参数指定。

参数：

p - 一个点，矩形的左上顶点。

d - 尺寸，表示宽和高。

 public Rectangle(Point p)

创建一个新的矩形对象，它的左上顶点为参数指定点，宽和高为零。

参数：

p - 矩形的左上顶点。

 public Rectangle(Dimension d)

创建一个新的矩形对象，它的左上顶点为 (0, 0)，宽和高为参数 dimension 的指定值。

参数：

d - 尺寸，表示宽和高。

方法

 public Rectangle getBounds()

获取当前矩形的边界矩形。

为使功能完整包含此方法，它与 Component 定义的 getBounds 方法平行。

返回值：

一个新矩形，与当前矩形的边界矩形等价。

参见：

getBounds

 public void setBounds(Rectangle r)

将当前矩形的边界矩形设置为指定矩形。

为使功能完整包含此方法，它与 Component 定义的 setBounds 方法平行。

参数：

r - 一个矩形。

参见：

setBounds

 public void setBounds(int x,
                       int y,
                                int width,
                       int height)

将当前矩形的边界矩形设置为 x, y, width, 和 height。

为使功能完整包含此方法，它与 Component 定义的 setBounds 方法平行。

参数：

x - 当前矩形左上顶点的新 x 坐标。

y - 当前矩形左上顶点的新 y 坐标。

width - 当前矩形的新的宽度。

height - 当前矩形的新的高度。

参见：

setBounds

 public void reshape(int x,
                       int y,
                                int width,
                       int height)

注释：不推荐使用 reshape() 方法。 同 JDK 1.1 版类似, 用 setBounds(int, int, int, int) 方法替换。

 public Point getLocation()

返回当前矩形的位置。

为使功能完整包含此方法，它与 Component 定义的 getLocation 方法平行。

参见：

getLocation

 public void setLocation(Point p)

将矩形移动到给定位置。

为使功能完整包含此方法，它与 Component 定义的 setLocation 方法平行。

参数：

p - 点的新位置。

参见：

setLocation

 public void setLocation(int x,
                       int y)

将矩形移动到给定位置。

为使功能完整包含此方法，它与 Component 定义的 setLocation 方法平行。

参数：

x - 新位置的 x 坐标。

y - 新位置的 y 坐标。

参见：

setLocation

 public void move(int x,
                       int y)

注释：不推荐使用 move() 方法。 同 JDK 1.1 版类似, 用 setLocation(int, int) 方法替换。

 public void translate(int x,
                       int y)

将该矩形沿 x 坐标轴向右，沿 y 坐标轴向下移动指定距离。

参数：

dx - 将矩形沿 x 轴移动的距离。

dy - 将矩形沿 y 轴移动的距离。

参见：

setLocation, setLocation

 public Dimension getSize()

获取当前矩形的尺寸(宽和高)。

为使功能完整包含此方法，它与 Component 定义的 getSize 方法平行。

返回值：

尺寸，表示矩形大小。

参见：

getSize

 public void setSize(Dimension d)

将当前矩形的尺寸设置为指定尺寸。

为使功能完整包含此方法，它与 Component 定义的 setSize 方法平行。

参数：

d - Dimension 对象的新尺寸。

参见：

setSize

 public void setSize(int width,
                       int height)

将当前矩形的尺寸设置为指定的宽和高。

为使功能完整包含此方法，它与 Component 定义的 setSize 方法平行。

参数：

width - 当前矩形对象的新的宽度。

height - 当前矩形对象的新的高度。

参见：

setSize

 public void resize(int width,
                       int height)

注释：不推荐使用 resize() 方法。 同 JDK 1.1 版类似, 用 setSize(int, int) 方法替换。

 public boolean contains(Point p)

判定当前矩形是否包含给定点。

参数：

p - 测试点(位置)。

返回值：

如果点(x, y)在当前矩形内则为 true；否则为 false。

 public boolean contains(int x,
                       int y)

检查当前矩形是否包含给定点 (x, y)。

参数：

x - x 坐标。

y - y 坐标。

返回值：

如果点(x, y)在当前矩形内则为 true；否则为 false。

 public boolean inside(int x,
                       int y)

注释：不推荐使用 inside() 方法。 如同 JDK 1.1 版，用contains() 方法替换。

 public boolean intersects(Rectangle r)

判定当前矩形与给定矩形是否相交。 如果它们的交集非空则它们是相交的。

参数：

r - 一个矩形。

返回值：

如果指定矩形与当前矩形相交则为 true；否则为 false 。

 public Rectangle intersection(Rectangle r)

计算当前矩形与给定矩形的相交部分。 返回表示两矩形相交部分的一个新矩形。

参数：

r - 一个矩形。

返回值：

当前矩形和给定矩形同时包含的最大矩形。

 public Rectangle union(Rectangle r)

计算当前矩形与给定矩形的并集。 返回表示两矩形并集的一个新矩形。

参数：

r - 一个矩形。

返回值：

包含当前矩形和指定矩形的最小矩形。

 public void add(int newx,
                 int newy)

向当前矩形，添加一个由参数 newx 和 newy指定的点。 结果是包含源矩形和指定点的最小矩形。

添加一个点后，用此点作参数调用 contains 方法不一定返回 true。 contains 方法对矩形右边和下边的点不返回 true。因此如果添加的点落在扩大矩形的左边和下边，那么 contains 方法对此点返回 false。

参数：

newx - 新点的 x 坐标。

newy - 新点的 y 坐标。

 public void add(Point pt)

向当前矩形添加一个点 pt。 结果是包含源矩形和指定点的最小矩形。

添加一个点后，用此点作参数调用 contains 方法不一定返回 true。 contains 方法对矩形右边和下边的点不返回 true。因此如果添加的点落在扩大矩形的左边和下边，那么 contains 方法对此点返回 false。

参数：

pt - 添加到此矩形的新点。

 public void add(Rectangle r)

向当前矩形添加一个矩形。 结果矩形是表示两矩形的并集。

参数：

a - 矩形。

 public void grow(int h,
                  int v)

水平和垂直增大矩形。

该方法修改矩形，使它的左边和右边加大到 h 倍，上边和下边加大到 v 倍。

新矩形的左上顶点为(x - h, y - v)，宽度为 width + 2h, 高度为 height + 2v。

如果 h 和 v 的值为负, 那么矩形尺寸将相应减小。 grow 方法不检测 width 和 height 的结果值是否为非负。

参数：

h - 水平扩展倍数。

v - 垂直扩展倍数。

 public boolean isEmpty()

判定当前矩形是否为空。 如果矩形的宽或高小于等于零，那么此矩形为空。

返回值：

如果当前矩形为空则为 true；否则为 false。

 public int hashCode()

返回当前矩形的哈希码。

返回值：

当前矩形的哈希码。

覆盖：

类 Object 中的 hashCode

 public boolean equals(Object obj)

判断两个矩形是否等价。

当且仅当参数非 null ，且是与当前矩形具有同样的左上顶点，宽和高的 Rectangle 对象，那么此方法的结果为 true 。

参数：

obj - 比较的对象。

返回值：

如果对象相等则为 true ，否则为 false 。

覆盖：

类 Object 中的 equals

 public String toString()

返回表示当前矩形及其值的串描述。

返回值：

表示当前矩形的串表示。

覆盖：

类 Object 中的 toString