RectangularShape

java.lang.Object
- com.sun.javafx.geom.Shape
- - com.sun.javafx.geom.RectangularShape

Direct Known Subclasses:

Arc2D, Ellipse2D, RoundRectangle2D
```
public abstract class RectangularShape
extends Shape
```
RectangularShape is the base class for a number of Shape objects whose geometry is defined by a rectangular frame. This class does not directly specify any specific geometry by itself, but merely provides manipulation methods inherited by a whole category of Shape objects. The manipulation methods provided by this class can be used to query and modify the rectangular frame, which provides a reference for the subclasses to define their geometry.

Version:

1.26, 05/05/07

Field Summary
- Fields inherited from class com.sun.javafx.geom.Shape
  OUT_BOTTOM, OUT_LEFT, OUT_RIGHT, OUT_TOP, RECT_INTERSECTS

Constructor Summary

Constructors
Modifier Constructor and Description

protected RectangularShape()
This is an abstract class that cannot be instantiated directly.

Constructors
Modifier	Constructor and Description
`protected`	`RectangularShape()` This is an abstract class that cannot be instantiated directly.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(Point2D p)` Tests if a specified `Point2D` is inside the boundary of the `Shape`.
`RectBounds`	`getBounds()` Note that there is no guarantee that the returned `RectBounds` is the smallest bounding box that encloses the `Shape`, only that the `Shape` lies entirely within the indicated `RectBounds`.
`float`	`getCenterX()` Returns the X coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
`float`	`getCenterY()` Returns the Y coordinate of the center of the framing rectangle of the `Shape` in `double` precision.
`abstract float`	`getHeight()` Returns the height of the framing rectangle in `double` precision.
`float`	`getMaxX()` Returns the largest X coordinate of the framing rectangle of the `Shape` in `double` precision.
`float`	`getMaxY()` Returns the largest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
`float`	`getMinX()` Returns the smallest X coordinate of the framing rectangle of the `Shape` in `double` precision.
`float`	`getMinY()` Returns the smallest Y coordinate of the framing rectangle of the `Shape` in `double` precision.
`PathIterator`	`getPathIterator(BaseTransform tx, float 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 float`	`getWidth()` Returns the width of the framing rectangle in `double` precision.
`abstract float`	`getX()` Returns the X coordinate of the upper-left corner of the framing rectangle in `double` precision.
`abstract float`	`getY()` Returns the Y coordinate of the upper-left corner of the framing rectangle in `double` precision.
`abstract boolean`	`isEmpty()` Determines whether the `RectangularShape` is empty.
`abstract void`	`setFrame(float x, float y, float w, float h)` Sets the location and size of the framing rectangle of this `Shape` to the specified rectangular values.
`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`	`setFrameFromCenter(float centerX, float centerY, float cornerX, float 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(float x1, float y1, float x2, float 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.
`java.lang.String`	`toString()`

Methods inherited from class com.sun.javafx.geom.Shape
accumulate, accumulateCubic, accumulateCubic, accumulateQuad, contains, contains, contains, copy, getPathIterator, intersects, intersects, intersectsLine, outcode, pointCrossingsForCubic, pointCrossingsForLine, pointCrossingsForPath, pointCrossingsForQuad, rectCrossingsForCubic, rectCrossingsForLine, rectCrossingsForPath, rectCrossingsForQuad

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RectangularShape
```
protected RectangularShape()
```
    This is an abstract class that cannot be instantiated directly.
    
    See Also:
    
    Arc2D, Ellipse2D, Rectangle2D, RoundRectangle2D
- Method Detail
  - getX
```
public abstract float getX()
```
    Returns the X coordinate of the upper-left corner of the framing rectangle in double precision.
    
    Returns:
    
    the X coordinate of the upper-left corner of the framing rectangle.
  - getY
```
public abstract float getY()
```
    Returns the Y coordinate of the upper-left corner of the framing rectangle in double precision.
    
    Returns:
    
    the Y coordinate of the upper-left corner of the framing rectangle.
  - getWidth
```
public abstract float getWidth()
```
    Returns the width of the framing rectangle in double precision.
    
    Returns:
    
    the width of the framing rectangle.
  - getHeight
```
public abstract float getHeight()
```
    Returns the height of the framing rectangle in double precision.
    
    Returns:
    
    the height of the framing rectangle.
  - getMinX
```
public float getMinX()
```
    Returns the smallest X coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the smallest X coordinate of the framing rectangle of the Shape.
  - getMinY
```
public float getMinY()
```
    Returns the smallest Y coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the smallest Y coordinate of the framing rectangle of the Shape.
  - getMaxX
```
public float getMaxX()
```
    Returns the largest X coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the largest X coordinate of the framing rectangle of the Shape.
  - getMaxY
```
public float getMaxY()
```
    Returns the largest Y coordinate of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the largest Y coordinate of the framing rectangle of the Shape.
  - getCenterX
```
public float getCenterX()
```
    Returns the X coordinate of the center of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the X coordinate of the center of the framing rectangle of the Shape.
  - getCenterY
```
public float getCenterY()
```
    Returns the Y coordinate of the center of the framing rectangle of the Shape in double precision.
    
    Returns:
    
    the Y coordinate of the center of the framing rectangle of the Shape.
  - isEmpty
```
public abstract boolean isEmpty()
```
    Determines whether the RectangularShape is empty. When the RectangularShape is empty, it encloses no area.
    
    Returns:
    
    true if the RectangularShape is empty; false otherwise.
  - setFrame
```
public abstract void setFrame(float x,
                              float y,
                              float w,
                              float h)
```
    Sets the location and size of the framing rectangle of this Shape to the specified rectangular values.
    
    Parameters:
    
    x - the X coordinate of the upper-left corner of the specified rectangular shape
    
    y - the Y coordinate of the upper-left corner of the specified rectangular shape
    
    w - the width of the specified rectangular shape
    
    h - the height of the specified rectangular shape
    
    See Also:
    
    #getFrame
  - setFrame
```
public 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. The framing rectangle is used by the subclasses of RectangularShape to define their geometry.
    
    Parameters:
    
    loc - the specified Point2D
    
    size - the specified Dimension2D
    
    See Also:
    
    #getFrame
  - setFrameFromDiagonal
```
public void setFrameFromDiagonal(float x1,
                                 float y1,
                                 float x2,
                                 float y2)
```
    Sets the diagonal of the framing rectangle of this Shape based on the two specified coordinates. The framing rectangle is used by the subclasses of RectangularShape to define their geometry.
    
    Parameters:
    
    x1 - the X coordinate of the start point of the specified diagonal
    
    y1 - the Y coordinate of the start point of the specified diagonal
    
    x2 - the X coordinate of the end point of the specified diagonal
    
    y2 - the Y coordinate of the end point of the specified diagonal
  - setFrameFromDiagonal
```
public void setFrameFromDiagonal(Point2D p1,
                                 Point2D p2)
```
    Sets the diagonal of the framing rectangle of this Shape based on two specified Point2D objects. The framing rectangle is used by the subclasses of RectangularShape to define their geometry.
    
    Parameters:
    
    p1 - the start Point2D of the specified diagonal
    
    p2 - the end Point2D of the specified diagonal
  - setFrameFromCenter
```
public void setFrameFromCenter(float centerX,
                               float centerY,
                               float cornerX,
                               float cornerY)
```
    Sets the framing rectangle of this Shape based on the specified center point coordinates and corner point coordinates. The framing rectangle is used by the subclasses of RectangularShape to define their geometry.
    
    Parameters:
    
    centerX - the X coordinate of the specified center point
    
    centerY - the Y coordinate of the specified center point
    
    cornerX - the X coordinate of the specified corner point
    
    cornerY - the Y coordinate of the specified corner point
  - setFrameFromCenter
```
public void setFrameFromCenter(Point2D center,
                               Point2D corner)
```
    Sets the framing rectangle of this Shape based on a specified center Point2D and corner Point2D. The framing rectangle is used by the subclasses of RectangularShape to define their geometry.
    
    Parameters:
    
    center - the specified center Point2D
    
    corner - the specified corner Point2D
  - contains
```
public boolean contains(Point2D p)
```
    Tests if a specified Point2D is inside the boundary of the Shape.
    
    Overrides:
    
    contains in class Shape
    
    Parameters:
    
    p - the specified Point2D to be tested
    
    Returns:
    
    true if the specified Point2D is inside the boundary of the Shape; false otherwise.
  - getBounds
```
public RectBounds getBounds()
```
    Note that there is no guarantee that the returned RectBounds is the smallest bounding box that encloses the Shape, only that the Shape lies entirely within the indicated RectBounds.
    
    Specified by:
    
    getBounds in class Shape
    
    Returns:
    
    an instance of RectBounds
  - getPathIterator
```
public PathIterator getPathIterator(BaseTransform tx,
                                    float 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.
    Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types will be returned by the iterator.
    The amount of subdivision of the curved segments is controlled by the flatness parameter, which specifies the maximum distance that any point on the unflattened transformed curve can deviate from the returned flattened path segments. An optional BaseTransform can be specified so that the coordinates returned in the iteration are transformed accordingly.
    
    Specified by:
    
    getPathIterator in class Shape
    
    Parameters:
    
    tx - an optional BaseTransform 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
    
    Returns:
    
    a PathIterator object that provides access to the Shape object's flattened geometry.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class RectangularShape

Field Summary

Fields inherited from class com.sun.javafx.geom.Shape

Constructor Summary

Method Summary

Methods inherited from class com.sun.javafx.geom.Shape

Methods inherited from class java.lang.Object

Constructor Detail

RectangularShape

Method Detail

getX

getY

getWidth

getHeight

getMinX

getMinY

getMaxX

getMaxY

getCenterX

getCenterY

isEmpty

setFrame

setFrame

setFrameFromDiagonal

setFrameFromDiagonal

setFrameFromCenter

setFrameFromCenter

contains

getBounds

getPathIterator

toString