|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.fop.area.AreaTreeObject
org.apache.fop.area.Area
org.apache.fop.area.RegionReference
public class RegionReference
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 |
|---|
bidiLevel, bpd, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, ipd, log, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, traits |
| Fields inherited from class org.apache.fop.area.AreaTreeObject |
|---|
extensionAttachments, foreignAttributes |
| Constructor Summary | |
|---|---|
RegionReference(int regionClass,
java.lang.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)
Add a child to this area. |
java.lang.Object |
clone()
|
java.util.List<Area> |
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. |
java.lang.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. |
java.lang.String |
toString()
|
| Methods inherited from class org.apache.fop.area.Area |
|---|
addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBidiLevel, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsBoolean, getTraitAsInteger, getTraits, hasTrait, hasTraits, resetBidiLevel, setAreaClass, setBidiLevel, setBPD, setIPD, setTraits, setWritingModeTraits |
| Methods inherited from class org.apache.fop.area.AreaTreeObject |
|---|
addExtensionAttachment, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected RegionViewport regionViewport
RegionViewport for this object
| Constructor Detail |
|---|
public RegionReference(Region regionFO,
RegionViewport parent)
regionFO - the region.parent - the viewport for this region.
public RegionReference(int regionClass,
java.lang.String regionName,
RegionViewport parent)
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.| Method Detail |
|---|
public void addChildArea(Area child)
addChildArea in class Areachild - the child area to addpublic void setCTM(CTM ctm)
ctm - the current transform to position this regionpublic RegionViewport getRegionViewport()
public CTM getCTM()
public java.util.List<Area> getBlocks()
public int getRegionClass()
public java.lang.String getRegionName()
public void addBlock(Block block)
block - the block area to add
public java.lang.Object clone()
throws java.lang.CloneNotSupportedException
clone in class Areajava.lang.CloneNotSupportedExceptionpublic java.lang.String toString()
toString in class Area
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||