Package org.apache.fop.area
Class RegionReference
java.lang.Object
org.apache.fop.area.AreaTreeObject
org.apache.fop.area.Area
org.apache.fop.area.RegionReference
- All Implemented Interfaces:
Serializable
,Cloneable
- Direct Known Subclasses:
BodyRegion
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.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected RegionViewport
the parentRegionViewport
for this objectFields 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, effectiveIPD, ipd, log, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, traits
Fields inherited from class org.apache.fop.area.AreaTreeObject
extensionAttachments, foreignAttributes
-
Constructor Summary
ConstructorDescriptionRegionReference
(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
Modifier and TypeMethodDescriptionvoid
Add a block area to this region reference area.void
addChildArea
(Area child) Add a child to this area.clone()
Get the block in this region.getCTM()
Get the current transform of this region.int
Get the region class of this region.boolean
isEmpty()
indicates whether the main reference area has any child areas added to itvoid
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.toString()
Methods inherited from class org.apache.fop.area.Area
activateEffectiveIPD, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBidiLevel, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getChangeBarList, getEffectiveAllocIPD, getEffectiveIPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsBoolean, getTraitAsInteger, getTraits, hasTrait, hasTraits, resetBidiLevel, setAreaClass, setBidiLevel, setBPD, setChangeBarList, setIPD, setTraits, setWritingModeTraits
Methods inherited from class org.apache.fop.area.AreaTreeObject
addExtensionAttachment, getExtensionAttachments, getForeignAttributes, getForeignAttributeValue, hasExtensionAttachments, setExtensionAttachments, setForeignAttribute, setForeignAttributes
-
Field Details
-
regionViewport
the parentRegionViewport
for this object
-
-
Constructor Details
-
RegionReference
Create a new region reference area.- Parameters:
regionFO
- the region.parent
- the viewport for this region.
-
RegionReference
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.
-
-
Method Details
-
addChildArea
Add a child to this area. The default is to do nothing. Subclasses must override to do something if they can have child areas.- Overrides:
addChildArea
in classArea
- Parameters:
child
- the child area to add
-
setCTM
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
-
getRegionViewport
- Returns:
- Returns the parent RegionViewport.
-
getCTM
Get the current transform of this region.- Returns:
- ctm the current transform to position this region
-
getBlocks
Get the block in this region.- Returns:
- the list of blocks in this region
-
getRegionClass
public int getRegionClass()Get the region class of this region.- Returns:
- the region class
-
getRegionName
- Returns:
- the region name
-
addBlock
Add a block area to this region reference area.- Parameters:
block
- the block area to add
-
isEmpty
public boolean isEmpty()indicates whether the main reference area has any child areas added to it- Returns:
- whether the main reference area has any child areas added to it
-
clone
- Overrides:
clone
in classArea
- Throws:
CloneNotSupportedException
-
toString
-