Java Doc for Area.java in  » 6.0-JDK-Core » AWT » java » awt » geom » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » AWT » java.awt.geom 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.geom.Area

Area
public class Area implements Shape,Cloneable(Code)
An Area object stores and manipulates a resolution-independent description of an enclosed area of 2-dimensional space. Area objects can be transformed and can perform various Constructive Area Geometry (CAG) operations when combined with other Area objects. The CAG operations include area Area.add addition , Area.subtract subtraction , Area.intersect intersection , and Area.exclusiveOr exclusive or . See the linked method documentation for examples of the various operations.

The Area class implements the Shape interface and provides full support for all of its hit-testing and path iteration facilities, but an Area is more specific than a generalized path in a number of ways:

  • Only closed paths and sub-paths are stored. Area objects constructed from unclosed paths are implicitly closed during construction as if those paths had been filled by the Graphics2D.fill method.
  • The interiors of the individual stored sub-paths are all non-empty and non-overlapping. Paths are decomposed during construction into separate component non-overlapping parts, empty pieces of the path are discarded, and then these non-empty and non-overlapping properties are maintained through all subsequent CAG operations. Outlines of different component sub-paths may touch each other, as long as they do not cross so that their enclosed areas overlap.
  • The geometry of the path describing the outline of the Area resembles the path from which it was constructed only in that it describes the same enclosed 2-dimensional area, but may use entirely different types and ordering of the path segments to do so.
Interesting issues which are not always obvious when using the Area include:
  • Creating an Area from an unclosed (open) Shape results in a closed outline in the Area object.
  • Creating an Area from a Shape which encloses no area (even when "closed") produces an empty Area. A common example of this issue is that producing an Area from a line will be empty since the line encloses no area. An empty Area will iterate no geometry in its PathIterator objects.
  • A self-intersecting Shape may be split into two (or more) sub-paths each enclosing one of the non-intersecting portions of the original path.
  • An Area may take more path segments to describe the same geometry even when the original outline is simple and obvious. The analysis that the Area class must perform on the path may not reflect the same concepts of "simple and obvious" as a human being perceives.

since:
   1.2



Constructor Summary
public  Area()
     Default constructor which creates an empty area.
public  Area(Shape s)
     The Area class creates an area geometry from the specified Shape object.

Method Summary
public  voidadd(Area rhs)
     Adds the shape of the specified Area to the shape of this Area.
public  Objectclone()
     Returns an exact copy of this Area object.
public  booleancontains(double x, double y)
    
public  booleancontains(Point2D p)
    
public  booleancontains(double x, double y, double w, double h)
    
public  booleancontains(Rectangle2D r)
    
public  AreacreateTransformedArea(AffineTransform t)
     Creates a new Area object that contains the same geometry as this Area transformed by the specified AffineTransform.
public  booleanequals(Area other)
     Tests whether the geometries of the two Area objects are equal.
public  voidexclusiveOr(Area rhs)
     Sets the shape of this Area to be the combined area of its current shape and the shape of the specified Area, minus their intersection.
public  RectanglegetBounds()
     Returns a bounding Rectangle that completely encloses this Area.

The Area class will attempt to return the tightest bounding box possible for the Shape.

public  Rectangle2DgetBounds2D()
     Returns a high precision bounding Rectangle2D that completely encloses this Area.

The Area class will attempt to return the tightest bounding box possible for the Shape.

public  PathIteratorgetPathIterator(AffineTransform at)
     Creates a PathIterator for the outline of this Area object.
public  PathIteratorgetPathIterator(AffineTransform at, double flatness)
     Creates a PathIterator for the flattened outline of this Area object.
public  voidintersect(Area rhs)
     Sets the shape of this Area to the intersection of its current shape and the shape of the specified Area.
public  booleanintersects(double x, double y, double w, double h)
    
public  booleanintersects(Rectangle2D r)
    
public  booleanisEmpty()
     Tests whether this Area object encloses any area.
public  booleanisPolygonal()
     Tests whether this Area consists entirely of straight edged polygonal geometry.
public  booleanisRectangular()
     Tests whether this Area is rectangular in shape.
public  booleanisSingular()
     Tests whether this Area is comprised of a single closed subpath.
public  voidreset()
     Removes all of the geometry from this Area and restores it to an empty area.
public  voidsubtract(Area rhs)
     Subtracts the shape of the specified Area from the shape of this Area.
public  voidtransform(AffineTransform t)
     Transforms the geometry of this Area using the specified AffineTransform .


Constructor Detail
Area
public Area()(Code)
Default constructor which creates an empty area.
since:
   1.2



Area
public Area(Shape s)(Code)
The Area class creates an area geometry from the specified Shape object. The geometry is explicitly closed, if the Shape is not already closed. The fill rule (even-odd or winding) specified by the geometry of the Shape is used to determine the resulting enclosed area.
Parameters:
  s - the Shape from which the area is constructed
throws:
  NullPointerException - if s is null
since:
   1.2




Method Detail
add
public void add(Area rhs)(Code)
Adds the shape of the specified Area to the shape of this Area. The resulting shape of this Area will include the union of both shapes, or all areas that were contained in either this or the specified Area.
 // Example:
 Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
 Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
 a1.add(a2);
 a1(before)     +         a2         =     a1(after)
 ################     ################     ################
 ##############         ##############     ################
 ############             ############     ################
 ##########                 ##########     ################
 ########                     ########     ################
 ######                         ######     ######    ######
 ####                             ####     ####        ####
 ##                                 ##     ##            ##
 

Parameters:
  rhs - the Area to be added to thecurrent shape
throws:
  NullPointerException - if rhs is null
since:
   1.2



clone
public Object clone()(Code)
Returns an exact copy of this Area object. Created clone object
since:
   1.2



contains
public boolean contains(double x, double y)(Code)

since:
   1.2



contains
public boolean contains(Point2D p)(Code)

since:
   1.2



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

since:
   1.2



contains
public boolean contains(Rectangle2D r)(Code)

since:
   1.2



createTransformedArea
public Area createTransformedArea(AffineTransform t)(Code)
Creates a new Area object that contains the same geometry as this Area transformed by the specified AffineTransform. This Area object is unchanged.
Parameters:
  t - the specified AffineTransform used to transform the new Area
throws:
  NullPointerException - if t is null a new Area object representing the transformed geometry.
since:
   1.2



equals
public boolean equals(Area other)(Code)
Tests whether the geometries of the two Area objects are equal. This method will return false if the argument is null.
Parameters:
  other - the Area to be compared to thisArea true if the two geometries are equal;false otherwise.
since:
   1.2



exclusiveOr
public void exclusiveOr(Area rhs)(Code)
Sets the shape of this Area to be the combined area of its current shape and the shape of the specified Area, minus their intersection. The resulting shape of this Area will include only areas that were contained in either this Area or in the specified Area, but not in both.
 // Example:
 Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
 Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
 a1.exclusiveOr(a2);
 a1(before)    xor        a2         =     a1(after)
 ################     ################
 ##############         ##############     ##            ##
 ############             ############     ####        ####
 ##########                 ##########     ######    ######
 ########                     ########     ################
 ######                         ######     ######    ######
 ####                             ####     ####        ####
 ##                                 ##     ##            ##
 

Parameters:
  rhs - the Area to be exclusive ORed with this Area.
throws:
  NullPointerException - if rhs is null
since:
   1.2



getBounds
public Rectangle getBounds()(Code)
Returns a bounding Rectangle that completely encloses this Area.

The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself. Since the returned object represents the bounding box with integers, the bounding box can only be as tight as the nearest integer coordinates that encompass the geometry of the Shape. the bounding Rectangle for theArea.
since:
   1.2




getBounds2D
public Rectangle2D getBounds2D()(Code)
Returns a high precision bounding Rectangle2D that completely encloses this Area.

The Area class will attempt to return the tightest bounding box possible for the Shape. The bounding box will not be padded to include the control points of curves in the outline of the Shape, but should tightly fit the actual geometry of the outline itself. the bounding Rectangle2D for theArea.
since:
   1.2




getPathIterator
public PathIterator getPathIterator(AffineTransform at)(Code)
Creates a PathIterator for the outline of this Area object. This Area object is unchanged.
Parameters:
  at - an optional AffineTransform to be applied tothe coordinates as they are returned in the iteration, ornull if untransformed coordinates are desired the PathIterator object that returns the geometry of the outline of this Area, one segment at a time.
since:
   1.2



getPathIterator
public PathIterator getPathIterator(AffineTransform at, double flatness)(Code)
Creates a PathIterator for the flattened outline of this Area object. Only uncurved path segments represented by the SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types are returned by the iterator. This Area object is unchanged.
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
Parameters:
  flatness - the maximum amount that the control pointsfor a given curve can vary from colinear before a subdividedcurve is replaced by a straight line connecting the end points the PathIterator object that returns the geometry of the outline of this Area, one segmentat a time.
since:
   1.2



intersect
public void intersect(Area rhs)(Code)
Sets the shape of this Area to the intersection of its current shape and the shape of the specified Area. The resulting shape of this Area will include only areas that were contained in both this Area and also in the specified Area.
 // Example:
 Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
 Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
 a1.intersect(a2);
 a1(before)   intersect     a2         =     a1(after)
 ################     ################     ################
 ##############         ##############       ############
 ############             ############         ########
 ##########                 ##########           ####
 ########                     ########
 ######                         ######
 ####                             ####
 ##                                 ##
 

Parameters:
  rhs - the Area to be intersected with thisArea
throws:
  NullPointerException - if rhs is null
since:
   1.2



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

since:
   1.2



intersects
public boolean intersects(Rectangle2D r)(Code)

since:
   1.2



isEmpty
public boolean isEmpty()(Code)
Tests whether this Area object encloses any area. true if this Area objectrepresents an empty area; false otherwise.
since:
   1.2



isPolygonal
public boolean isPolygonal()(Code)
Tests whether this Area consists entirely of straight edged polygonal geometry. true if the geometry of thisArea consists entirely of line segments;false otherwise.
since:
   1.2



isRectangular
public boolean isRectangular()(Code)
Tests whether this Area is rectangular in shape. true if the geometry of thisArea is rectangular in shape; falseotherwise.
since:
   1.2



isSingular
public boolean isSingular()(Code)
Tests whether this Area is comprised of a single closed subpath. This method returns true if the path contains 0 or 1 subpaths, or false if the path contains more than 1 subpath. The subpaths are counted by the number of PathIterator.SEG_MOVETO SEG_MOVETO segments that appear in the path. true if the Area is comprisedof a single basic geometry; false otherwise.
since:
   1.2



reset
public void reset()(Code)
Removes all of the geometry from this Area and restores it to an empty area.
since:
   1.2



subtract
public void subtract(Area rhs)(Code)
Subtracts the shape of the specified Area from the shape of this Area. The resulting shape of this Area will include areas that were contained only in this Area and not in the specified Area.
 // Example:
 Area a1 = new Area([triangle 0,0 => 8,0 => 0,8]);
 Area a2 = new Area([triangle 0,0 => 8,0 => 8,8]);
 a1.subtract(a2);
 a1(before)     -         a2         =     a1(after)
 ################     ################
 ##############         ##############     ##
 ############             ############     ####
 ##########                 ##########     ######
 ########                     ########     ########
 ######                         ######     ######
 ####                             ####     ####
 ##                                 ##     ##
 

Parameters:
  rhs - the Area to be subtracted from the current shape
throws:
  NullPointerException - if rhs is null
since:
   1.2



transform
public void transform(AffineTransform t)(Code)
Transforms the geometry of this Area using the specified AffineTransform . The geometry is transformed in place, which permanently changes the enclosed area defined by this object.
Parameters:
  t - the transformation used to transform the area
throws:
  NullPointerException - if t is null
since:
   1.2



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.