edu.stanford.hci.r3.paper.layout
Class RegionGroup

java.lang.Object
  extended by edu.stanford.hci.r3.paper.layout.RegionGroup

public class RegionGroup
extends java.lang.Object

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.


Constructor Summary
RegionGroup(java.lang.String rgName, Units xOrigin, Units yOrigin)
           
 
Method Summary
 void addRegion(Region childRegion, Coordinates relativeCoord)
           
 Units getHeight()
           
 java.lang.String getName()
           
 Coordinates getRegionOffset(Region child)
           
 java.util.List<Region> getRegions()
           
 Units getWidth()
           
 double getXOffsetInInches()
           
 double getYOffsetInInches()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RegionGroup

public RegionGroup(java.lang.String rgName,
                   Units xOrigin,
                   Units yOrigin)
Method Detail

addRegion

public void addRegion(Region childRegion,
                      Coordinates relativeCoord)
Parameters:
childRegion - a child region
relativeCoord -

getHeight

public Units getHeight()

getName

public java.lang.String getName()
Returns:

getRegionOffset

public Coordinates getRegionOffset(Region child)
Parameters:
child -
Returns:

getRegions

public java.util.List<Region> getRegions()
Returns:

getWidth

public Units getWidth()
Returns:

getXOffsetInInches

public double getXOffsetInInches()
Returns:

getYOffsetInInches

public double getYOffsetInInches()
Returns:

Copyright 2006 Stanford University