java.awt
クラス Rectangle

java.lang.Object
  java.awt.geom.RectangularShape
      java.awt.geom.Rectangle2D
          java.awt.Rectangle

すべての実装されたインタフェース:

Shape, Serializable, Cloneable

直系の既知のサブクラス:

DefaultCaret

public class Rectangle
extends Rectangle2D
implements Shape, Serializable

Rectangle は、Rectangle オブジェクトの座標空間での左上の点 (x、 y)、およびその幅と高さによって囲まれる座標空間内の領域を指定します。

Rectangle オブジェクトの width および height は public フィールドです。Rectangle を作成するコンストラクタ、および Rectangle を変更できるメソッドには、width や height の値として負の値を設定できます。

幅と高さが負の値の Rectangle は空であると見なされます。Rectangle が空の場合、isEmpty メソッドは true を返します。空の Rectangle には点を指定することはできません。ただし、width および height の値は有効です。空の Rectangle は座標空間において位置を持ち、空の Rectangle のサイズまたは位置を変更するメソッドも有効です。複数の Rectangle に対するメソッドは、これらの Rectangle オブジェクトの中に width または height の値として負の値を持つ Rectangle オブジェクトが 1 つでもある場合、動作が保証されません。このようなメソッドには、intersects、intersection、および union があります。

導入されたバージョン:

JDK1.0

関連項目:

直列化された形式

入れ子のクラスの概要

クラス java.awt.geom.Rectangle2D から継承された入れ子のクラス/インタフェース

Rectangle2D.Double, Rectangle2D.Float

フィールドの概要

int	height Rectangle の高さです。
int	width Rectangle の幅です。
int	x Rectangle の x 座標です。
int	y Rectangle の y 座標です。

クラス java.awt.geom.Rectangle2D から継承されたフィールド

OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP

コンストラクタの概要

Rectangle()
左上隅が座標空間の (0, 0) にあり、幅と高さが両方とも 0 の新しい Rectangle を構築します。

Rectangle(Dimension d)
左上隅が (0, 0) で、幅と高さが Dimension 引数で指定される新しい Rectangle を構築します。

Rectangle(int width, int height)
左上隅が座標空間の (0, 0) にあり、幅と高さが width 引数および height 引数で指定される新しい Rectangle を構築します。

Rectangle(int x, int y, int width, int height)
左上隅が (x, y) として指定され、幅と高さが width 引数および height 引数で指定される新しい Rectangle を構築します。

Rectangle(Point p)
左上隅が指定された Point で、幅と高さが両方とも 0 である新しい Rectangle を構築します。

Rectangle(Point p, Dimension d)
左上隅が Point 引数で指定され、幅と高さが Dimension 引数で指定される新しい Rectangle を構築します。

Rectangle(Rectangle r)
指定された Rectangle の値に一致するように初期化された新しい Rectangle を構築します。

メソッドの概要

void	add(int newx, int newy) 整数型の引数 newx および newy によって指定される点をこの Rectangle に追加します。
void	add(Point pt) この Rectangle に、指定された Point を追加します。
void	add(Rectangle r) Rectangle をこの Rectangle に追加します。
boolean	contains(int x, int y) この Rectangle が、指定された位置 (x, y) にある点を含むかどうかを判定します。
boolean	contains(int X, int Y, int W, int H) 指定された位置 (X, Y) にあり、指定されたサイズ (W, H) である Rectangle を、この Rectangle が完全に含むかどうかを判定します。
boolean	contains(Point p) この Rectangle が指定された Point を含むかどうかを判定します。
boolean	contains(Rectangle r) この Rectangle が、指定された Rectangle を完全に含むかどうかを判定します。
Rectangle2D	createIntersection(Rectangle2D r) この Rectangle と指定された Rectangle2D との共通部分を表す新しい Rectangle2D オブジェクトを返します。
Rectangle2D	createUnion(Rectangle2D r) この Rectangle と指定された Rectangle2D との結合部分を表す新しい Rectangle2D オブジェクトを返します。
boolean	equals(Object obj) 2 つの矩形が同じかどうかを判定します。
Rectangle	getBounds() この Rectangle の境界の Rectangle 領域を返します。
Rectangle2D	getBounds2D() この矩形の高精度バウンディングボックスを返します。
double	getHeight() 境界の Rectangle 領域の高さを double 精度で返します。
Point	getLocation() この Rectangle の位置を返します。
Dimension	getSize() 返された Dimension で表された、この Rectangle のサイズを返します。
double	getWidth() 境界の Rectangle 領域の幅を double 精度で返します。
double	getX() 境界の Rectangle 領域の X 座標を double 精度で返します。
double	getY() 境界の Rectangle 領域の Y 座標を double 精度で返します。
void	grow(int h, int v) Rectangle を水平方向と垂直方向の両方にサイズ変更します。
boolean	inside(int X, int Y) 推奨されていません。 JDK バージョン 1.1 以降は、contains(int, int) に置き換えられました。
Rectangle	intersection(Rectangle r) この Rectangle と指定された Rectangle との共通部分を算出します。
boolean	intersects(Rectangle r) この Rectangle と指定された Rectangle とが交差するかどうかを判定します。
boolean	isEmpty() この Rectangle が空であるかどうかを判定します。
void	move(int x, int y) 推奨されていません。 JDK バージョン 1.1 以降は、setLocation(int, int) を使用します。
int	outcode(double x, double y) 指定された座標がこの Rectangle に対する相対位置でどこに位置するかを判定します。
void	reshape(int x, int y, int width, int height) 推奨されていません。 JDK バージョン 1.1 以降は、setBounds(int, int, int, int) を使用します。
void	resize(int width, int height) 推奨されていません。 JDK バージョン 1.1 以降は、setSize(int, int) を使用します。
void	setBounds(int x, int y, int width, int height) この Rectangle の境界の Rectangle 領域を、x、y、width、および height で指定された値に設定します。
void	setBounds(Rectangle r) この Rectangle の境界の Rectangle 領域を、指定された Rectangle に一致するように設定します。
void	setLocation(int x, int y) この Rectangle を指定された位置に移動します。
void	setLocation(Point p) この Rectangle を指定された位置に移動します。
void	setRect(double x, double y, double width, double height) この Rectangle の境界を指定された x、y、width、および height に設定します。
void	setSize(Dimension d) この Rectangle のサイズを、指定された Dimension に一致するように設定します。
void	setSize(int width, int height) この Rectangle の大きさを指定された幅と高さに設定します。
String	toString() この Rectangle およびその値を表す String 表現を返します。
void	translate(int x, int y) x 座標軸に沿って右方向へ、y 座標軸に沿って下方向へ、指定された距離だけこの Rectangle を移動します。
Rectangle	union(Rectangle r) この Rectangle と指定された Rectangle との結合部分を算出します。

クラス java.awt.geom.Rectangle2D から継承されたメソッド

add, add, add, contains, contains, getPathIterator, getPathIterator, hashCode, intersect, intersects, intersectsLine, intersectsLine, outcode, setFrame, setRect, union

クラス java.awt.geom.RectangularShape から継承されたメソッド

clone, contains, contains, getCenterX, getCenterY, getFrame, getMaxX, getMaxY, getMinX, getMinY, intersects, setFrame, setFrame, setFrameFromCenter, setFrameFromCenter, setFrameFromDiagonal, setFrameFromDiagonal

クラス java.lang.Object から継承されたメソッド

finalize, getClass, notify, notifyAll, wait, wait, wait

インタフェース java.awt.Shape から継承されたメソッド

contains, contains, contains, contains, getPathIterator, getPathIterator, intersects, intersects

フィールドの詳細

x

public int x

Rectangle の x 座標です。

関連項目:

setLocation(int, int), getLocation()

y

public int y

Rectangle の y 座標です。

関連項目:

setLocation(int, int), getLocation()

width

public int width

Rectangle の幅です。

導入されたバージョン:

JDK1.0.

関連項目:

setSize(int, int), getSize()

height

public int height

Rectangle の高さです。

関連項目:

setSize(int, int), getSize()

コンストラクタの詳細

Rectangle

public Rectangle()

左上隅が座標空間の (0, 0) にあり、幅と高さが両方とも 0 の新しい Rectangle を構築します。

Rectangle

public Rectangle(Rectangle r)

指定された Rectangle の値に一致するように初期化された新しい Rectangle を構築します。

パラメータ:

r - 新しく構築される Rectangle の初期値のコピー元となる Rectangle

導入されたバージョン:

JDK1.1

Rectangle

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

左上隅が (x, y) として指定され、幅と高さが width 引数および height 引数で指定される新しい Rectangle を構築します。

パラメータ:

x - 指定された x 座標

y - 指定された y 座標

width - Rectangle の幅

height - Rectangle の高さ

Rectangle

public Rectangle(int width,
                 int height)

左上隅が座標空間の (0, 0) にあり、幅と高さが width 引数および height 引数で指定される新しい Rectangle を構築します。

パラメータ:

width - Rectangle の幅

height - Rectangle の高さ

Rectangle

public Rectangle(Point p,
                 Dimension d)

左上隅が Point 引数で指定され、幅と高さが Dimension 引数で指定される新しい Rectangle を構築します。

パラメータ:

p - Rectangle の左上隅となる Point

d - Rectangle の幅と高さを表す Dimension

Rectangle

public Rectangle(Point p)

左上隅が指定された Point で、幅と高さが両方とも 0 である新しい Rectangle を構築します。

パラメータ:

p - Rectangle の左上隅となる Point

Rectangle

public Rectangle(Dimension d)

左上隅が (0, 0) で、幅と高さが Dimension 引数で指定される新しい Rectangle を構築します。

パラメータ:

d - 幅と高さを指定する Dimension

メソッドの詳細

getX

public double getX()

境界の Rectangle 領域の X 座標を double 精度で返します。

定義:

クラス RectangularShape 内の getX

戻り値:

境界の Rectangle 領域の x 座標

getY

public double getY()

境界の Rectangle 領域の Y 座標を double 精度で返します。

定義:

クラス RectangularShape 内の getY

戻り値:

境界の Rectangle 領域の y 座標

getWidth

public double getWidth()

境界の Rectangle 領域の幅を double 精度で返します。

定義:

クラス RectangularShape 内の getWidth

戻り値:

境界の Rectangle 領域の幅

getHeight

public double getHeight()

境界の Rectangle 領域の高さを double 精度で返します。

定義:

クラス RectangularShape 内の getHeight

戻り値:

境界の Rectangle 領域の高さ

getBounds

public Rectangle getBounds()

この Rectangle の境界の Rectangle 領域を返します。

このメソッドは完全性のために用意されているもので、Component の getBounds メソッドに対応します。

定義:

インタフェース Shape 内の getBounds

オーバーライド:

クラス RectangularShape 内の getBounds

戻り値:

新しい Rectangle。この Rectangle の境界の Rectangle 領域に等しい

導入されたバージョン:

JDK1.1

関連項目:

Component.getBounds(), setBounds(Rectangle), setBounds(int, int, int, int)

getBounds2D

public Rectangle2D getBounds2D()

この矩形の高精度バウンディングボックスを返します。

定義:

インタフェース Shape 内の getBounds2D

オーバーライド:

クラス Rectangle2D 内の getBounds2D

戻り値:

この Rectangle2D のバウンディングボックス

導入されたバージョン:

1.2

関連項目:

Shape.getBounds()

setBounds

public void setBounds(Rectangle r)

この Rectangle の境界の Rectangle 領域を、指定された Rectangle に一致するように設定します。

このメソッドは完全性のために用意されているもので、Component の setBounds メソッドに対応します。

パラメータ:

r - 指定された Rectangle

導入されたバージョン:

JDK1.1

関連項目:

getBounds(), Component.setBounds(java.awt.Rectangle)

setBounds

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

この Rectangle の境界の Rectangle 領域を、x、y、width、および height で指定された値に設定します。

このメソッドは完全性のために用意されているもので、Component の setBounds メソッドに対応します。

パラメータ:

x - この Rectangle の左上隅の新しい x 座標

y - この Rectangle の左上隅の新しい y 座標

width - この Rectangle の新しい幅

height - この Rectangle の新しい高さ

導入されたバージョン:

JDK1.1

関連項目:

getBounds(), Component.setBounds(int, int, int, int)

setRect

public void setRect(double x,
                    double y,
                    double width,
                    double height)

この Rectangle の境界を指定された x、y、width、および height に設定します。このメソッドは完全性のために用意されているもので、Component の setBounds メソッドに対応します。

定義:

クラス Rectangle2D 内の setRect

パラメータ:

x - 指定された矩形の左上隅の x 座標

y - 指定された矩形の左上隅の y 座標

width - Dimension オブジェクトの新しい幅

height - Dimension オブジェクトの新しい高さ

reshape

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

推奨されていません。 JDK バージョン 1.1 以降は、setBounds(int, int, int, int) を使用します。

この Rectangle の境界の Rectangle 領域を、x、y、width、および height で指定された値に設定します。

パラメータ:

x - この Rectangle の左上隅の新しい x 座標

y - この Rectangle の左上隅の新しい y 座標

width - この Rectangle の新しい幅

height - この Rectangle の新しい高さ

getLocation

public Point getLocation()

この Rectangle の位置を返します。

このメソッドは完全性のために用意されているもので、Component の getLocation メソッドに対応します。

戻り値:

この Rectangle の左上隅の Point

導入されたバージョン:

JDK1.1

関連項目:

Component.getLocation(), setLocation(Point), setLocation(int, int)

setLocation

public void setLocation(Point p)

この Rectangle を指定された位置に移動します。

このメソッドは完全性のために用意されているもので、Component の setLocation メソッドに対応します。

パラメータ:

p - この Rectangle の新しい位置を指定する Point

導入されたバージョン:

JDK1.1

関連項目:

Component.setLocation(java.awt.Point), getLocation()

setLocation

public void setLocation(int x,
                        int y)

この Rectangle を指定された位置に移動します。

このメソッドは完全性のために用意されているもので、Component の setLocation メソッドに対応します。

パラメータ:

x - 新しい位置の x 座標

y - 新しい位置の y 座標

導入されたバージョン:

JDK1.1

関連項目:

getLocation(), Component.setLocation(int, int)

move

@Deprecated
public void move(int x,
                            int y)

推奨されていません。 JDK バージョン 1.1 以降は、setLocation(int, int) を使用します。

この Rectangle を指定された位置に移動します。

パラメータ:

x - 新しい位置の x 座標

y - 新しい位置の y 座標

translate

public void translate(int x,
                      int y)

x 座標軸に沿って右方向へ、y 座標軸に沿って下方向へ、指定された距離だけこの Rectangle を移動します。

パラメータ:

x - x 軸に沿ってこの Rectangle を移動する距離

y - y 軸に沿ってこの Rectangle を移動する距離

関連項目:

setLocation(int, int), setLocation(java.awt.Point)

getSize

public Dimension getSize()

返された Dimension で表された、この Rectangle のサイズを返します。

このメソッドは完全性のために用意されているもので、Component の getSize メソッドに対応します。

戻り値:

この Rectangle のサイズを表す Dimension

導入されたバージョン:

JDK1.1

関連項目:

Component.getSize(), setSize(Dimension), setSize(int, int)

setSize

public void setSize(Dimension d)

この Rectangle のサイズを、指定された Dimension に一致するように設定します。

このメソッドは完全性のために用意されているもので、Component の setSize メソッドに対応します。

パラメータ:

d - Dimension オブジェクトの新しいサイズ

導入されたバージョン:

JDK1.1

関連項目:

Component.setSize(java.awt.Dimension), getSize()

setSize

public void setSize(int width,
                    int height)

この Rectangle の大きさを指定された幅と高さに設定します。

このメソッドは完全性のために用意されているもので、Component の setSize メソッドに対応します。

パラメータ:

width - この Rectangle の新しい幅

height - この Rectangle の新しい高さ

導入されたバージョン:

JDK1.1

関連項目:

Component.setSize(int, int), getSize()

resize

@Deprecated
public void resize(int width,
                              int height)

推奨されていません。 JDK バージョン 1.1 以降は、setSize(int, int) を使用します。

この Rectangle の大きさを指定された幅と高さに設定します。

パラメータ:

width - この Rectangle の新しい幅

height - この Rectangle の新しい高さ

contains

public boolean contains(Point p)

この Rectangle が指定された Point を含むかどうかを判定します。

パラメータ:

p - 判定する対象となる Point

戻り値:

Point (x, y) がこの Rectangle の内部にある場合は true、そうでない場合は false

導入されたバージョン:

JDK1.1

contains

public boolean contains(int x,
                        int y)

この Rectangle が、指定された位置 (x, y) にある点を含むかどうかを判定します。

パラメータ:

x - 指定された x 座標

y - 指定された y 座標

戻り値:

点 (x, y) がこの Rectangle の内部にある場合は true、そうでない場合は false

導入されたバージョン:

JDK1.1

contains

public boolean contains(Rectangle r)

この Rectangle が、指定された Rectangle を完全に含むかどうかを判定します。

パラメータ:

r - 指定された Rectangle

戻り値:

Rectangle がこの Rectangle に完全に含まれる場合は true、そうでない場合は false

導入されたバージョン:

JDK1.2

contains

public boolean contains(int X,
                        int Y,
                        int W,
                        int H)

指定された位置 (X, Y) にあり、指定されたサイズ (W, H) である Rectangle を、この Rectangle が完全に含むかどうかを判定します。

パラメータ:

X - 指定された x 座標

Y - 指定された y 座標

W - Rectangle の幅

H - Rectangle の高さ

戻り値:

(X, Y, W, H) で指定される Rectangle が完全にこの Rectangle 内に収まる場合は true、そうでない場合は false

導入されたバージョン:

JDK1.1

inside

@Deprecated
public boolean inside(int X,
                                 int Y)

推奨されていません。 JDK バージョン 1.1 以降は、contains(int, int) に置き換えられました。

この Rectangle が、指定された位置 (X, Y) にある点を含むかどうかを判定します。

パラメータ:

X - 指定された x 座標

Y - 指定された y 座標

戻り値:

点 (X, Y) がこの Rectangle の内部にある場合は true、そうでない場合は false

intersects

public boolean intersects(Rectangle r)

この Rectangle と指定された Rectangle とが交差するかどうかを判定します。共通部分が空でない場合、2 つの矩形は交差します。

パラメータ:

r - 指定された Rectangle

戻り値:

指定された Rectangle とこの Rectangle とが重なり合う場合は true、そうでない場合は false

intersection

public Rectangle intersection(Rectangle r)

この Rectangle と指定された Rectangle との共通部分を算出します。2 つの矩形の共通部分を表す新しい Rectangle を返します。2 つの矩形が交差しない場合、空の矩形が返されます。

パラメータ:

r - 指定された Rectangle

戻り値:

指定された Rectangle とこの Rectangle の両方に含まれる最大の Rectangle、または矩形が交差しない場合は空の矩形

union

public Rectangle union(Rectangle r)

この Rectangle と指定された Rectangle との結合部分を算出します。2 つの矩形の結合部分を表す新しい Rectangle を返します。

パラメータ:

r - 指定された Rectangle

戻り値:

指定された Rectangle とこの Rectangle の両方に含まれる最小の Rectangle

add

public void add(int newx,
                int newy)

整数型の引数 newx および newy によって指定される点をこの Rectangle に追加します。この結果、元の Rectangle と指定された点の両方を含む最小の Rectangle が作成されます。

点を追加したあとで、追加された点を引数として指定して contains を呼び出した場合、必ず true が返されるとは限りません。contains メソッドは、Rectangle の右端または下端に位置する点の場合は true を返しません。そのため、追加された点が拡大後の Rectangle の右端または下端に位置する点である場合には、contains は false を返します。

パラメータ:

newx - 新しい点の x 座標

newy - 新しい点の y 座標

add

public void add(Point pt)

この Rectangle に、指定された Point を追加します。この結果、元の Rectangle と指定された Point の両方を含む最小の Rectangle が作成されます。

Point を追加したあとで、追加された Point を引数として指定して contains を呼び出した場合、必ず true が返されるとは限りません。contains メソッドは、Rectangle の右端または下端に位置する点の場合は true を返しません。そのため、追加された Point が拡大後の Rectangle の右端または下端に位置する点である場合には、contains は Point に対して false を返します。

パラメータ:

pt - この Rectangle に追加される新しい Point

add

public void add(Rectangle r)

Rectangle をこの Rectangle に追加します。この結果、2 つの矩形の結合部分となる Rectangle が作成されます。

パラメータ:

r - 指定された Rectangle

grow

public void grow(int h,
                 int v)

Rectangle を水平方向と垂直方向の両方にサイズ変更します。

このメソッドは、左右にそれぞれ h 単位ずつ、上下にそれぞれ v 単位ずつ大きくなるように、Rectangle を変更します。

新しい Rectangle の左上隅は (x - h, y - v)、幅は width + 2h、高さは height + 2v になります。

h と v に負の値が指定された場合、Rectangle のサイズは小さくなります。grow メソッドは、結果の width および height の値が負でないかどうかを検査しません。

パラメータ:

h - 水平方向に拡大する量

v - 垂直方向に拡大する量

isEmpty

public boolean isEmpty()

この Rectangle が空であるかどうかを判定します。幅とサイズが 0 以下の場合、Rectangle は空になります。

定義:

クラス RectangularShape 内の isEmpty

戻り値:

この Rectangle が空である場合は true、そうでない場合は false

outcode

public int outcode(double x,
                   double y)

指定された座標がこの Rectangle に対する相対位置でどこに位置するかを判定します。このメソッドは、この Rectangle の各辺について、指定された点がこの Rectangle のほかの辺と同じ側にあるかを示す該当するマスク値のバイナリの論理和を計算します。

定義:

クラス Rectangle2D 内の outcode

パラメータ:

x - 指定された x 座標

y - 指定された y 座標

戻り値:

すべての適切な OUT コードの論理和

導入されたバージョン:

1.2

関連項目:

Rectangle2D.OUT_LEFT, Rectangle2D.OUT_TOP, Rectangle2D.OUT_RIGHT, Rectangle2D.OUT_BOTTOM

createIntersection

public Rectangle2D createIntersection(Rectangle2D r)

この Rectangle と指定された Rectangle2D との共通部分を表す新しい Rectangle2D オブジェクトを返します。

定義:

クラス Rectangle2D 内の createIntersection

パラメータ:

r - この Rectangle と重なり合う Rectangle2D

戻り値:

指定された Rectangle2D とこの Rectangle の両方に含まれる最大の Rectangle2D

導入されたバージョン:

1.2

createUnion

public Rectangle2D createUnion(Rectangle2D r)

この Rectangle と指定された Rectangle2D との結合部分を表す新しい Rectangle2D オブジェクトを返します。

定義:

クラス Rectangle2D 内の createUnion

パラメータ:

r - この Rectangle と結合される Rectangle2D

戻り値:

指定された Rectangle2D とこの Rectangle の両方を含む最小の Rectangle2D

導入されたバージョン:

1.2

equals

public boolean equals(Object obj)

2 つの矩形が同じかどうかを判定します。

引数が null でなく、この Rectangle と同じ左上隅、高さ、および幅を持つ Rectangle オブジェクトである場合にだけ、結果は true になります。

オーバーライド:

クラス Rectangle2D 内の equals

パラメータ:

obj - この Rectangle と比較する Object

戻り値:

オブジェクトが等しい場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

toString

public String toString()

この Rectangle およびその値を表す String 表現を返します。

オーバーライド:

クラス Object 内の toString

戻り値:

この Rectangle オブジェクトの座標とサイズの値を表す String