RegionGroup Class Reference

List of all members.

Public Member Functions

 RegionGroup (String rgName, Units xOrigin, Units yOrigin)
void addRegion (Region childRegion, Coordinates relativeCoord)
Units getHeight ()
String getName ()
Coordinates getRegionOffset (Region child)
List< RegiongetRegions ()
Units getWidth ()
double getXOffsetInInches ()
double getYOffsetInInches ()

Detailed Description

Essentially, a stupid version of CompoundRegion. It is a collection of Regions that will share a single offset relative to their parent sheet. They also have offsets within this RegionGroup. However, you cannot put RegionGroups within RegionGroups. It's just a flat list of Regions, to assist with layout.

Internally, everything is computed in Inches.

This software is distributed under the BSD License.

Ron B Yeh (ronyeh(AT)

Definition at line 30 of file

Member Function Documentation

void addRegion ( Region  childRegion,
Coordinates  relativeCoord 

childRegion a child region

Definition at line 69 of file

References Units.getConversionTo(), Region.getScaleX(), Region.getScaleY(), Region.getShape(), Region.getUnits(), Units.getValueIn(), Coordinates.getX(), and Coordinates.getY().

String getName (  ) 


Definition at line 111 of file

Coordinates getRegionOffset ( Region  child  ) 


Definition at line 119 of file

List<Region> getRegions (  ) 


Definition at line 126 of file

Units getWidth (  ) 


Definition at line 133 of file

Referenced by FlowPaperLayout.layoutRegionGroups().

double getXOffsetInInches (  ) 


Definition at line 140 of file

References Units.getValueInInches().

double getYOffsetInInches (  ) 


Definition at line 147 of file

References Units.getValueInInches().

The documentation for this class was generated from the following file:
Generated on Sat Apr 14 18:21:42 2007 for R3 Paper Toolkit by  doxygen 1.4.7