Save This Page
Home » openjdk-7 » java » awt » geom » [javadoc | source]
java.awt.geom
abstract public class: Rectangle2D [javadoc | source]
java.lang.Object
   java.awt.geom.RectangularShape
      java.awt.geom.Rectangle2D

All Implemented Interfaces:
    Shape, Cloneable

Direct Known Subclasses:
    Double, ComposedTextCaret, DefaultCaret, Float, AWTCaret, Rectangle, BasicCaret

The Rectangle2D class describes a rectangle defined by a location {@code (x,y)} and dimension {@code (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.

Nested Class Summary:
public static class  Rectangle2D.Float  The Float class defines a rectangle specified in float coordinates. 
public static class  Rectangle2D.Double  The Double class defines a rectangle specified in double coordinates. 
Field Summary
public static final  int OUT_LEFT    The bitmask that indicates that a point lies to the left of this Rectangle2D.
    since: 1.2 -
 
public static final  int OUT_TOP    The bitmask that indicates that a point lies above this Rectangle2D.
    since: 1.2 -
 
public static final  int OUT_RIGHT    The bitmask that indicates that a point lies to the right of this Rectangle2D.
    since: 1.2 -
 
public static final  int OUT_BOTTOM    The bitmask that indicates that a point lies below this Rectangle2D.
    since: 1.2 -
 
Constructor:
 protected Rectangle2D() 
Method from java.awt.geom.Rectangle2D Summary:
add,   add,   add,   contains,   contains,   createIntersection,   createUnion,   equals,   getBounds2D,   getPathIterator,   getPathIterator,   hashCode,   intersect,   intersects,   intersectsLine,   intersectsLine,   outcode,   outcode,   setFrame,   setRect,   setRect,   union
Methods from java.awt.geom.RectangularShape:
clone,   contains,   contains,   getBounds,   getCenterX,   getCenterY,   getFrame,   getHeight,   getMaxX,   getMaxY,   getMinX,   getMinY,   getPathIterator,   getWidth,   getX,   getY,   intersects,   isEmpty,   setFrame,   setFrame,   setFrame,   setFrameFromCenter,   setFrameFromCenter,   setFrameFromDiagonal,   setFrameFromDiagonal
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.geom.Rectangle2D Detail:
 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.

 public  void add(Rectangle2D r) 
    Adds a Rectangle2D object to this Rectangle2D. The resulting Rectangle2D is the union of the two Rectangle2D objects.
 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.

 public boolean contains(double x,
    double y) 
    {@inheritDoc}
 public boolean contains(double x,
    double y,
    double w,
    double h) 
    {@inheritDoc}
 abstract public Rectangle2D createIntersection(Rectangle2D r)
    Returns a new Rectangle2D object representing the intersection of this Rectangle2D with the specified Rectangle2D.
 abstract public Rectangle2D createUnion(Rectangle2D r)
    Returns a new Rectangle2D object representing the union of this Rectangle2D with the specified 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.
 public Rectangle2D getBounds2D() 
    {@inheritDoc}
 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.
 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.
 public int hashCode() 
    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.
 public boolean intersects(double x,
    double y,
    double w,
    double h) 
    {@inheritDoc}
 public boolean intersectsLine(Line2D l) 
    Tests if the specified line segment intersects the interior of this Rectangle2D.
 public boolean intersectsLine(double x1,
    double y1,
    double x2,
    double y2) 
    Tests if the specified line segment intersects the interior of this Rectangle2D.
 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.
 abstract public 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.
 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.
 public  void setRect(Rectangle2D r) 
    Sets this Rectangle2D to be the same as the specified Rectangle2D.
 abstract public  void setRect(double x,
    double y,
    double w,
    double h)
    Sets the location and size of this Rectangle2D to the specified double values.
 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.