|
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
org.apache.fop.area.BodyRegion
public class BodyRegion
This class is a container for the areas that may be generated by an fo:region-body. It extends the RegionReference that is used directly by the other region classes. See fo:region-body definition in the XSL Rec for more information.
Field Summary |
---|
Fields inherited from class org.apache.fop.area.RegionReference |
---|
regionViewport |
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 | |
---|---|
BodyRegion(int regionClass,
java.lang.String regionName,
RegionViewport parent,
int columnCount,
int columnGap)
Constructor which can read traits directly from an fo:region-body formatting object. |
|
BodyRegion(RegionBody rb,
RegionViewport parent)
Constructor which can read traits directly from an fo:region-body formatting object. |
Method Summary | |
---|---|
java.lang.Object |
clone()
|
BeforeFloat |
getBeforeFloat()
Get the before float area. |
int |
getColumnCount()
Get the number of columns when not spanning |
int |
getColumnGap()
|
Footnote |
getFootnote()
Get the footnote area. |
MainReference |
getMainReference()
Get the main reference area. |
int |
getRemainingBPD()
|
boolean |
isEmpty()
indicates whether the main reference area has any child areas added to it |
void |
setWritingModeTraits(WritingModeTraitsGetter wmtg)
Sets the writing mode traits for the main reference area of this body region area. |
Methods inherited from class org.apache.fop.area.RegionReference |
---|
addBlock, addChildArea, getBlocks, getCTM, getRegionClass, getRegionName, getRegionViewport, setCTM, 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 |
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 |
Constructor Detail |
---|
public BodyRegion(RegionBody rb, RegionViewport parent)
rb
- the region-body FO nodeparent
- the parent region viewportpublic BodyRegion(int regionClass, java.lang.String regionName, RegionViewport parent, int columnCount, int columnGap)
regionClass
- the region class (as returned by Region.getNameId())regionName
- the name of the region (as returned by Region.getRegionName())parent
- the parent region viewportcolumnCount
- the number of columnscolumnGap
- the gap between columnsMethod Detail |
---|
public int getColumnCount()
public int getColumnGap()
public MainReference getMainReference()
public boolean isEmpty()
public BeforeFloat getBeforeFloat()
public Footnote getFootnote()
public int getRemainingBPD()
public void setWritingModeTraits(WritingModeTraitsGetter wmtg)
setWritingModeTraits
in class Area
wmtg
- a WM traits getterpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class RegionReference
java.lang.CloneNotSupportedException
|
fop 1.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |