public abstract class

Rectangle2D

extends RectangularShape

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

Known Direct Subclasses

Rectangle, Rectangle2D.Double, Rectangle2D.Float

Known Indirect Subclasses

BasicTextUI.BasicCaret, DefaultCaret, MotifTextUI.MotifCaret

Class Overview

The Rectangle2D class describes a rectangle defined by a location (x,y) and dimension (w x h).

This class is only the abstract superclass for all objects that store a 2D rectangle. The actual storage representation of the coordinates is left to the subclass.

Summary

Nested Classes
class	Rectangle2D.Double	The `Double` class defines a rectangle specified in double coordinates.
class	Rectangle2D.Float	The `Float` class defines a rectangle specified in float coordinates.

Constants
int	OUT_BOTTOM	The bitmask that indicates that a point lies below this `Rectangle2D`.
int	OUT_LEFT	The bitmask that indicates that a point lies to the left of this `Rectangle2D`.
int	OUT_RIGHT	The bitmask that indicates that a point lies to the right of this `Rectangle2D`.
int	OUT_TOP	The bitmask that indicates that a point lies above this `Rectangle2D`.

Protected Constructors
	Rectangle2D() This is an abstract class that cannot be instantiated directly.

Public Methods
void	add(double newx, double newy) Adds a point, specified by the double precision arguments `newx` and `newy`, to this `Rectangle2D`.
void	add(Point2D pt) Adds the `Point2D` object `pt` to this `Rectangle2D`.
void	add(Rectangle2D r) Adds a `Rectangle2D` object to this `Rectangle2D`.
boolean	contains(double x, double y)
boolean	contains(double x, double y, double w, double h)
abstract Rectangle2D	createIntersection(Rectangle2D r) Returns a new `Rectangle2D` object representing the intersection of this `Rectangle2D` with the specified `Rectangle2D`.
abstract Rectangle2D	createUnion(Rectangle2D r) Returns a new `Rectangle2D` object representing the union of this `Rectangle2D` with the specified `Rectangle2D`.
boolean	equals(Object obj) Determines whether or not the specified `Object` is equal to this `Rectangle2D`.
Rectangle2D	getBounds2D()
PathIterator	getPathIterator(AffineTransform at) Returns an iteration object that defines the boundary of this `Rectangle2D`.
PathIterator	getPathIterator(AffineTransform at, double flatness) Returns an iteration object that defines the boundary of the flattened `Rectangle2D`.
int	hashCode() Returns the hashcode for this `Rectangle2D`.
static void	intersect(Rectangle2D src1, Rectangle2D src2, Rectangle2D dest) Intersects the pair of specified source `Rectangle2D` objects and puts the result into the specified destination `Rectangle2D` object.
boolean	intersects(double x, double y, double w, double h)
boolean	intersectsLine(Line2D l) Tests if the specified line segment intersects the interior of this `Rectangle2D`.
boolean	intersectsLine(double x1, double y1, double x2, double y2) Tests if the specified line segment intersects the interior of this `Rectangle2D`.
int	outcode(Point2D p) Determines where the specified `Point2D` lies with respect to this `Rectangle2D`.
abstract int	outcode(double x, double y) Determines where the specified coordinates lie with respect to this `Rectangle2D`.
void	setFrame(double x, double y, double w, double h) Sets the location and size of the outer bounds of this `Rectangle2D` to the specified rectangular values.
abstract void	setRect(double x, double y, double w, double h) Sets the location and size of this `Rectangle2D` to the specified `double` values.
void	setRect(Rectangle2D r) Sets this `Rectangle2D` to be the same as the specified `Rectangle2D`.
static void	union(Rectangle2D src1, Rectangle2D src2, Rectangle2D dest) Unions the pair of source `Rectangle2D` objects and puts the result into the specified destination `Rectangle2D` object.

[Expand]

Inherited Methods

From class java.awt.geom.RectangularShape

Object	clone() Creates a new object of the same class and with the same contents as this object.
boolean	contains(Point2D p) Tests if a specified `Point2D` is inside the boundary of the `Shape`.
boolean	contains(Rectangle2D r) Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`.
Rectangle	getBounds() Returns an integer `Rectangle` that completely encloses the `Shape`.
double	getCenterX() Returns the X coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
double	getCenterY() Returns the Y coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
Rectangle2D	getFrame() Returns the framing `Rectangle2D` that defines the overall shape of this object.
abstract double	getHeight() Returns the height of the framing rectangle in `double` precision.
double	getMaxX() Returns the largest X coordinate of the framing rectangle of the `Shape` in `double` precision.
double	getMaxY() Returns the largest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
double	getMinX() Returns the smallest X coordinate of the framing rectangle of the `Shape` in `double` precision.
double	getMinY() Returns the smallest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
PathIterator	getPathIterator(AffineTransform at, double flatness) Returns an iterator object that iterates along the `Shape` object's boundary and provides access to a flattened view of the outline of the `Shape` object's geometry.
abstract double	getWidth() Returns the width of the framing rectangle in `double` precision.
abstract double	getX() Returns the X coordinate of the upper-left corner of the framing rectangle in `double` precision.
abstract double	getY() Returns the Y coordinate of the upper-left corner of the framing rectangle in `double` precision.
boolean	intersects(Rectangle2D r) Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`.
abstract boolean	isEmpty() Determines whether the `RectangularShape` is empty.
void	setFrame(Point2D loc, Dimension2D size) Sets the location and size of the framing rectangle of this `Shape` to the specified `Point2D` and `Dimension2D`, respectively.
void	setFrame(Rectangle2D r) Sets the framing rectangle of this `Shape` to be the specified `Rectangle2D`.
abstract void	setFrame(double x, double y, double w, double h) Sets the location and size of the framing rectangle of this `Shape` to the specified rectangular values.
void	setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY) Sets the framing rectangle of this `Shape` based on the specified center point coordinates and corner point coordinates.
void	setFrameFromCenter(Point2D center, Point2D corner) Sets the framing rectangle of this `Shape` based on a specified center `Point2D` and corner `Point2D`.
void	setFrameFromDiagonal(double x1, double y1, double x2, double y2) Sets the diagonal of the framing rectangle of this `Shape` based on the two specified coordinates.
void	setFrameFromDiagonal(Point2D p1, Point2D p2) Sets the diagonal of the framing rectangle of this `Shape` based on two specified `Point2D` objects.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.Shape

abstract boolean	contains(double x, double y) Tests if the specified coordinates are inside the boundary of the `Shape`.
abstract boolean	contains(Point2D p) Tests if a specified `Point2D` is inside the boundary of the `Shape`.
abstract boolean	contains(double x, double y, double w, double h) Tests if the interior of the `Shape` entirely contains the specified rectangular area.
abstract boolean	contains(Rectangle2D r) Tests if the interior of the `Shape` entirely contains the specified `Rectangle2D`.
abstract Rectangle	getBounds() Returns an integer `Rectangle` that completely encloses the `Shape`.
abstract Rectangle2D	getBounds2D() Returns a high precision and more accurate bounding box of the `Shape` than the `getBounds` method.
abstract PathIterator	getPathIterator(AffineTransform at) Returns an iterator object that iterates along the `Shape` boundary and provides access to the geometry of the `Shape` outline.
abstract PathIterator	getPathIterator(AffineTransform at, double flatness) Returns an iterator object that iterates along the `Shape` boundary and provides access to a flattened view of the `Shape` outline geometry.
abstract boolean	intersects(double x, double y, double w, double h) Tests if the interior of the `Shape` intersects the interior of a specified rectangular area.
abstract boolean	intersects(Rectangle2D r) Tests if the interior of the `Shape` intersects the interior of a specified `Rectangle2D`.

Constants

public static final int OUT_BOTTOM

The bitmask that indicates that a point lies below this Rectangle2D.

Constant Value: 8 (0x00000008)

public static final int OUT_LEFT

The bitmask that indicates that a point lies to the left of this Rectangle2D.

Constant Value: 1 (0x00000001)

public static final int OUT_RIGHT

The bitmask that indicates that a point lies to the right of this Rectangle2D.

Constant Value: 4 (0x00000004)

public static final int OUT_TOP

The bitmask that indicates that a point lies above this Rectangle2D.

Constant Value: 2 (0x00000002)

Protected Constructors

protected Rectangle2D ()

This is an abstract class that cannot be instantiated directly. Type-specific implementation subclasses are available for instantiation and provide a number of formats for storing the information necessary to satisfy the various accessor methods below.

Public Methods

public void add (double newx, double newy)

Adds a point, specified by the double precision arguments newx and newy, to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D 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 left or bottom edge of the enlarged rectangle, contains returns false for that point.

Parameters

newx	the X coordinate of the new point
newy	the Y coordinate of the new point

public void add (Point2D pt)

Adds the Point2D object pt to this Rectangle2D. The resulting Rectangle2D is the smallest Rectangle2D that contains both the original Rectangle2D and the specified Point2D.

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 left or bottom edge of the enlarged rectangle, contains returns false for that point.

Parameters

pt	the new `Point2D` to add to this `Rectangle2D`.

public void add (Rectangle2D r)

Adds a Rectangle2D object to this Rectangle2D. The resulting Rectangle2D is the union of the two Rectangle2D objects.

Parameters

r	the `Rectangle2D` to add to this `Rectangle2D`.

public boolean contains (double x, double y)

public boolean contains (double x, double y, double w, double h)

public abstract Rectangle2D createIntersection (Rectangle2D r)

Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.

Parameters

r	the `Rectangle2D` to be intersected with this `Rectangle2D`

Returns

the largest Rectangle2D contained in both the specified Rectangle2D and in this Rectangle2D.

public abstract Rectangle2D createUnion (Rectangle2D r)

Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified Rectangle2D.

Parameters

r	the `Rectangle2D` to be combined with this `Rectangle2D`

Returns

the smallest Rectangle2D containing both the specified Rectangle2D and this Rectangle2D.

public boolean equals (Object obj)

Determines whether or not the specified Object is equal to this Rectangle2D. The specified Object is equal to this Rectangle2D if it is an instance of Rectangle2D and if its location and size are the same as this Rectangle2D.

Parameters

obj	an `Object` to be compared with this `Rectangle2D`.

Returns

true if obj is an instance of Rectangle2D and has the same values; false otherwise.

public Rectangle2D getBounds2D ()

public PathIterator getPathIterator (AffineTransform at)

Returns an iteration object that defines the boundary of this Rectangle2D. The iterator for this class is multi-threaded safe, which means that this Rectangle2D class guarantees that modifications to the geometry of this Rectangle2D object do not affect any iterations of that geometry that are already in process.

Parameters

at	an optional `AffineTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired

Returns

the PathIterator object that returns the geometry of the outline of this Rectangle2D, one segment at a time.

public PathIterator getPathIterator (AffineTransform at, double flatness)

Returns an iteration object that defines the boundary of the flattened Rectangle2D. Since rectangles are already flat, the flatness parameter is ignored. The iterator for this class is multi-threaded safe, which means that this Rectangle2D class guarantees that modifications to the geometry of this Rectangle2D object do not affect any iterations of that geometry that are already in process.

Parameters

at	an optional `AffineTransform` to be applied to the coordinates as they are returned in the iteration, or `null` if untransformed coordinates are desired
flatness	the maximum distance that the line segments used to approximate the curved segments are allowed to deviate from any point on the original curve. Since rectangles are already flat, the `flatness` parameter is ignored.

Returns

the PathIterator object that returns the geometry of the outline of this Rectangle2D, one segment at a time.

public int hashCode ()

Returns the hashcode for this Rectangle2D.

Returns

the hashcode for this Rectangle2D.

public static void intersect (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)

Intersects the pair of specified source Rectangle2D objects and puts the result into the specified destination Rectangle2D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle2D object, but in this case the original points of this source rectangle will be overwritten by this method.

Parameters

src1	the first of a pair of `Rectangle2D` objects to be intersected with each other
src2	the second of a pair of `Rectangle2D` objects to be intersected with each other
dest	the `Rectangle2D` that holds the results of the intersection of `src1` and `src2`

public boolean intersects (double x, double y, double w, double h)

public boolean intersectsLine (Line2D l)

Tests if the specified line segment intersects the interior of this Rectangle2D.

Parameters

l	the specified `Line2D` to test for intersection with the interior of this `Rectangle2D`

Returns

true if the specified Line2D intersects the interior of this Rectangle2D; false otherwise.

public boolean intersectsLine (double x1, double y1, double x2, double y2)

Tests if the specified line segment intersects the interior of this Rectangle2D.

Parameters

x1	the X coordinate of the start point of the specified line segment
y1	the Y coordinate of the start point of the specified line segment
x2	the X coordinate of the end point of the specified line segment
y2	the Y coordinate of the end point of the specified line segment

Returns

true if the specified line segment intersects the interior of this Rectangle2D; false otherwise.

public int outcode (Point2D p)

Determines where the specified Point2D lies with respect to this Rectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle2D, whether or not the specified Point2D is on the same side of the edge as the rest of this Rectangle2D.

Parameters

p	the specified `Point2D`

Returns

the logical OR of all appropriate out codes.

public abstract int outcode (double x, double y)

Determines where the specified coordinates lie with respect to this Rectangle2D. This method computes a binary OR of the appropriate mask values indicating, for each side of this Rectangle2D, whether or not the specified coordinates are on the same side of the edge as the rest of this Rectangle2D.

Parameters

x	the specified X coordinate
y	the specified Y coordinate

Returns

the logical OR of all appropriate out codes.

public void setFrame (double x, double y, double w, double h)

Sets the location and size of the outer bounds of this Rectangle2D to the specified rectangular values.

Parameters

x	the X coordinate of the upper-left corner of this `Rectangle2D`
y	the Y coordinate of the upper-left corner of this `Rectangle2D`
w	the width of this `Rectangle2D`
h	the height of this `Rectangle2D`

public abstract void setRect (double x, double y, double w, double h)

Sets the location and size of this Rectangle2D to the specified double values.

Parameters

x	the X coordinate of the upper-left corner of this `Rectangle2D`
y	the Y coordinate of the upper-left corner of this `Rectangle2D`
w	the width of this `Rectangle2D`
h	the height of this `Rectangle2D`

public void setRect (Rectangle2D r)

Sets this Rectangle2D to be the same as the specified Rectangle2D.

Parameters

r	the specified `Rectangle2D`

public static void union (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)

Unions the pair of source Rectangle2D objects and puts the result into the specified destination Rectangle2D object. One of the source rectangles can also be the destination to avoid creating a third Rectangle2D object, but in this case the original points of this source rectangle will be overwritten by this method.

Parameters

src1	the first of a pair of `Rectangle2D` objects to be combined with each other
src2	the second of a pair of `Rectangle2D` objects to be combined with each other
dest	the `Rectangle2D` that holds the results of the union of `src1` and `src2`

Interfaces

Classes

Exceptions

Rectangle2D

Class Overview

Summary

Constants

public static final int OUT_BOTTOM

public static final int OUT_LEFT

public static final int OUT_RIGHT

public static final int OUT_TOP

Protected Constructors

protected Rectangle2D ()

See Also

Public Methods

public void add (double newx, double newy)

Parameters

public void add (Point2D pt)

Parameters

public void add (Rectangle2D r)

Parameters

public boolean contains (double x, double y)

public boolean contains (double x, double y, double w, double h)

public abstract Rectangle2D createIntersection (Rectangle2D r)

Parameters

Returns

public abstract Rectangle2D createUnion (Rectangle2D r)

Parameters

Returns

public boolean equals (Object obj)

Parameters

Returns

public Rectangle2D getBounds2D ()

public PathIterator getPathIterator (AffineTransform at)

Parameters

Returns

public PathIterator getPathIterator (AffineTransform at, double flatness)

Parameters

Returns

public int hashCode ()

Returns

public static void intersect (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)

Parameters

public boolean intersects (double x, double y, double w, double h)

public boolean intersectsLine (Line2D l)

Parameters

Returns

public boolean intersectsLine (double x1, double y1, double x2, double y2)

Parameters

Returns

public int outcode (Point2D p)

Parameters

Returns

See Also

public abstract int outcode (double x, double y)

Parameters

Returns

See Also

public void setFrame (double x, double y, double w, double h)

Parameters

public abstract void setRect (double x, double y, double w, double h)

Parameters

public void setRect (Rectangle2D r)

Parameters

public static void union (Rectangle2D src1, Rectangle2D src2, Rectangle2D dest)

Parameters