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< Region >	getRegions ()
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.

Author:

Ron B Yeh (ronyeh(AT)cs.stanford.edu)

Definition at line 30 of file RegionGroup.java.

---

Member Function Documentation

void addRegion	(	Region	childRegion,
		Coordinates	relativeCoord
	)

Parameters:

	childRegion	a child region
	relativeCoord

Definition at line 69 of file RegionGroup.java.

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

String getName

(

)

Returns:

Definition at line 111 of file RegionGroup.java.

Coordinates getRegionOffset

(

Region

child

)

Parameters:

child

Returns:

Definition at line 119 of file RegionGroup.java.

List<Region> getRegions

(

)

Returns:

Definition at line 126 of file RegionGroup.java.

Units getWidth

(

)

Returns:

Definition at line 133 of file RegionGroup.java.

Referenced by FlowPaperLayout.layoutRegionGroups().

double getXOffsetInInches

(

)

Returns:

Definition at line 140 of file RegionGroup.java.

References Units.getValueInInches().

double getYOffsetInInches

(

)

Returns:

Definition at line 147 of file RegionGroup.java.

References Units.getValueInInches().

---

The documentation for this class was generated from the following file:

• RegionGroup.java

---