org.apache.fop.area

Class RegionReference

Implemented Interfaces:
Cloneable, Serializable
Known Direct Subclasses:
BodyRegion

public class RegionReference
extends Area
implements Cloneable

This is a region reference area for a page regions. This area is the direct child of a region-viewport-area. It is cloneable so the page master can make copies from the original page and regions.

Field Summary

protected RegionViewport
regionViewport
the parent RegionViewport for this object

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Constructor Summary

RegionReference(int regionClass, String regionName, RegionViewport parent)
Create a new region reference area.
RegionReference(Region regionFO, RegionViewport parent)
Create a new region reference area.

Method Summary

void
addBlock(Block block)
Add a block area to this region reference area.
void
addChildArea(Area child)
Object
clone()
Clone this region.
List
getBlocks()
Get the block in this region.
CTM
getCTM()
Get the current transform of this region.
int
getRegionClass()
Get the region class of this region.
String
getRegionName()
RegionViewport
getRegionViewport()
void
setCTM(CTM ctm)
Set the Coordinate Transformation Matrix which transforms content coordinates in this region reference area which are specified in terms of "start" and "before" into coordinates in a system which is positioned in "absolute" directions (with origin at lower left of the region reference area.

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Field Details

regionViewport

protected RegionViewport regionViewport
the parent RegionViewport for this object

Constructor Details

RegionReference

public RegionReference(int regionClass,
                       String regionName,
                       RegionViewport parent)
Create a new region reference area.
Parameters:
regionClass - the region class (as returned by Region.getNameId())
regionName - the name of the region (as returned by Region.getRegionName())
parent - the viewport for this region.

RegionReference

public RegionReference(Region regionFO,
                       RegionViewport parent)
Create a new region reference area.
Parameters:
regionFO - the region.
parent - the viewport for this region.

Method Details

addBlock

public void addBlock(Block block)
Add a block area to this region reference area.
Parameters:
block - the block area to add

addChildArea

public void addChildArea(Area child)
Overrides:
addChildArea in interface Area

clone

public Object clone()
Clone this region. This is used when cloning the page by the page master.
Returns:
a copy of this region reference area

getBlocks

public List getBlocks()
Get the block in this region.
Returns:
the list of blocks in this region

getCTM

public CTM getCTM()
Get the current transform of this region.
Returns:
ctm the current transform to position this region

getRegionClass

public int getRegionClass()
Get the region class of this region.
Returns:
the region class

getRegionName

public String getRegionName()
Returns:
the region name

getRegionViewport

public RegionViewport getRegionViewport()
Returns:
Returns the parent RegionViewport.

setCTM

public void setCTM(CTM ctm)
Set the Coordinate Transformation Matrix which transforms content coordinates in this region reference area which are specified in terms of "start" and "before" into coordinates in a system which is positioned in "absolute" directions (with origin at lower left of the region reference area.
Parameters:
ctm - the current transform to position this region

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.