Prev Class | Next Class | Frames | No Frames |

Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |

`java.lang.Object`

`java.awt.geom.RectangularShape`

**Implemented Interfaces:**- Cloneable, Shape

**Known Direct Subclasses:**- Arc2D, Ellipse2D, Rectangle2D, RoundRectangle2D

This class provides a generic framework, and several helper methods, for
subclasses which represent geometric objects inside a rectangular frame.
This does not specify any geometry except for the bounding box.

**Since:**- 1.2

**See Also:**`Arc2D`

,`Ellipse2D`

,`Rectangle2D`

,`RoundRectangle2D`

## Constructor Summary

`RectangularShape()`

- Default constructor.

## Method Summary

`Object`

`clone()`

- Create a new shape of the same run-time type with the same contents as this one.

`boolean`

`boolean`

`contains(Rectangle2D r)`

- Tests if the shape completely contains the given rectangle.

`Rectangle`

`getBounds()`

- Returns a bounding box for this shape, in integer format.

`double`

`getCenterX()`

- Return the x coordinate of the center point of the framing rectangle.

`double`

`getCenterY()`

- Return the y coordinate of the center point of the framing rectangle.

`Rectangle2D`

`getFrame()`

- Return the frame around this object.

`abstract double`

`getHeight()`

- Get the height of the framing rectangle.

`double`

`getMaxX()`

- Get the maximum x coordinate in the frame.

`double`

`getMaxY()`

- Get the maximum y coordinate in the frame.

`double`

`getMinX()`

- Get the minimum x coordinate in the frame.

`double`

`getMinY()`

- Get the minimum y coordinate in the frame.

`PathIterator`

`getPathIterator(AffineTransform at, double flatness)`

- Return an iterator along the shape boundary.

`abstract double`

`getWidth()`

- Get the width of the framing rectangle.

`abstract double`

`getX()`

- Get the x coordinate of the upper-left corner of the framing rectangle.

`abstract double`

`getY()`

- Get the y coordinate of the upper-left corner of the framing rectangle.

`boolean`

`intersects(Rectangle2D r)`

- Tests if a rectangle and this shape share common internal points.

`abstract boolean`

`isEmpty()`

- Test if the shape is empty, meaning that no points are inside it.

`abstract void`

`setFrame(double x, double y, double w, double h)`

- Set the framing rectangle of this shape to the given coordinate and size.

`void`

`setFrame(Point2D p, Dimension2D d)`

- Set the framing rectangle of this shape to the given coordinate and size.

`void`

`setFrame(Rectangle2D r)`

- Set the framing rectangle of this shape to the given rectangle.

`void`

`setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY)`

- Set the framing rectangle of this shape using the center of the frame, and one of the four corners.

`void`

`setFrameFromCenter(Point2D center, Point2D corner)`

- Set the framing rectangle of this shape using the center of the frame, and one of the four corners.

`void`

`setFrameFromDiagonal(double x1, double y1, double x2, double y2)`

- Set the framing rectangle of this shape using two points on a diagonal.

`void`

`setFrameFromDiagonal(Point2D p1, Point2D p2)`

- Set the framing rectangle of this shape using two points on a diagonal.

### Methods inherited from class java.lang.Object

`clone`

,`equals`

,`extends Object> getClass`

,`finalize`

,`hashCode`

,`notify`

,`notifyAll`

,`toString`

,`wait`

,`wait`

,`wait`

public Object clone()

Create a new shape of the same run-time type with the same contents as this one.

Returns:- the clone

public boolean contains(Point2D p)

Tests if a point is inside the boundary of the shape.

Parameters:`p`

- the point to test

Returns:- true if the point is inside the shape

Throws:`NullPointerException`

- if p is null

See Also:`contains(double, double)`

public boolean contains(Rectangle2D r)

Tests if the shape completely contains the given rectangle.

Parameters:`r`

- the rectangle to test

Returns:- true if r is contained in this shape

Throws:`NullPointerException`

- if r is null

See Also:`contains(double, double, double, double)`

public Rectangle getBounds()

Returns a bounding box for this shape, in integer format. Notice that you may get a tighter bound with getBounds2D.

Returns:- a bounding box

public double getCenterX()

Return the x coordinate of the center point of the framing rectangle.

Returns:- the central x coordinate

public double getCenterY()

Return the y coordinate of the center point of the framing rectangle.

Returns:- the central y coordinate

public Rectangle2D getFrame()

Return the frame around this object. Note that this may be a looser bounding box than getBounds2D.

Returns:- the frame, in double precision

public abstract double getHeight()

Get the height of the framing rectangle.

Returns:- the height

public double getMaxX()

Get the maximum x coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getX()+getWidth() even when getWidth() is negative.

Returns:- the maximum x coordinate

public double getMaxY()

Get the maximum y coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getY()+getHeight() even when getHeight() is negative.

Returns:- the maximum y coordinate

public double getMinX()

Get the minimum x coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getX() even when getWidth() is negative.

Returns:- the minimum x coordinate

public double getMinY()

Get the minimum y coordinate in the frame. This is misnamed, or else Sun has a bug, because the implementation returns getY() even when getHeight() is negative.

Returns:- the minimum y coordinate

public PathIterator getPathIterator(AffineTransform at, double flatness)

Return an iterator along the shape boundary. If the optional transform is provided, the iterator is transformed accordingly. The path is flattened until all segments differ from the curve by at most the value of the flatness parameter, within the limits of the default interpolation recursion limit of 1024 segments between actual points. Each call returns a new object, independent from others in use. The result is threadsafe if and only if the iterator returned by`getPathIterator(AffineTransform)`

is as well.

Specified by:- getPathIterator in interface Shape

Parameters:`at`

- an optional transform to apply to the iterator`flatness`

- the desired flatness

Returns:- a new iterator over the boundary

Throws:`IllegalArgumentException`

- if flatness is invalid

Since:- 1.2

public abstract double getX()

Get the x coordinate of the upper-left corner of the framing rectangle.

Returns:- the x coordinate

public abstract double getY()

Get the y coordinate of the upper-left corner of the framing rectangle.

Returns:- the y coordinate

public boolean intersects(Rectangle2D r)

Tests if a rectangle and this shape share common internal points.

Specified by:- intersects in interface Shape

Parameters:`r`

- the rectangle to test

Returns:- true if the rectangle intersects this shpae

Throws:`NullPointerException`

- if r is null

See Also:`intersects(double, double, double, double)`

public abstract boolean isEmpty()

Test if the shape is empty, meaning that no points are inside it.

Returns:- true if the shape is empty

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

Set the framing rectangle of this shape to the given coordinate and size.

Parameters:`x`

- the new x coordinate`y`

- the new y coordinate`w`

- the new width`h`

- the new height

See Also:`getFrame()`

public void setFrame(Point2D p, Dimension2D d)

Set the framing rectangle of this shape to the given coordinate and size.

Parameters:`p`

- the new point`d`

- the new dimension

Throws:`NullPointerException`

- if p or d is null

See Also:`getFrame()`

public void setFrame(Rectangle2D r)

Set the framing rectangle of this shape to the given rectangle.

Parameters:`r`

- the new framing rectangle

Throws:`NullPointerException`

- if r is null

See Also:`getFrame()`

public void setFrameFromCenter(double centerX, double centerY, double cornerX, double cornerY)

Set the framing rectangle of this shape using the center of the frame, and one of the four corners. The area will be positive.

Parameters:`centerX`

- the x coordinate at the center`centerY`

- the y coordinate at the center`cornerX`

- the x coordinate at a corner`cornerY`

- the y coordinate at a corner

public void setFrameFromCenter(Point2D center, Point2D corner)

Set the framing rectangle of this shape using the center of the frame, and one of the four corners. The area will be positive.

Parameters:`center`

- the center point`corner`

- a corner point

Throws:`NullPointerException`

- if either point is null

public void setFrameFromDiagonal(double x1, double y1, double x2, double y2)

Set the framing rectangle of this shape using two points on a diagonal. The area will be positive.

Parameters:`x1`

- the first x coordinate`y1`

- the first y coordinate`x2`

- the second x coordinate`y2`

- the second y coordinate

public void setFrameFromDiagonal(Point2D p1, Point2D p2)

Set the framing rectangle of this shape using two points on a diagonal. The area will be positive.

Parameters:`p1`

- the first point`p2`

- the second point

Throws:`NullPointerException`

- if either point is null

RectangularShape.java -- a rectangular frame for several generic shapes
Copyright (C) 2000, 2002 Free Software Foundation
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version.