org.apache.fop.area

Class BodyRegion

Implemented Interfaces:
Cloneable, Serializable

public class BodyRegion
extends RegionReference

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

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

BodyRegion(int regionClass, 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

Object
clone()
Clone this object.
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

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

addBlock, addChildArea, clone, getBlocks, getCTM, getRegionClass, getRegionName, getRegionViewport, setCTM

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

Constructor Details

BodyRegion

public BodyRegion(int regionClass,
                  String regionName,
                  RegionViewport parent,
                  int columnCount,
                  int columnGap)
Constructor which can read traits directly from an fo:region-body formatting object.
Parameters:
regionClass - the region class (as returned by Region.getNameId())
regionName - the name of the region (as returned by Region.getRegionName())
parent - the parent region viewport
columnCount - the number of columns
columnGap - the gap between columns

BodyRegion

public BodyRegion(RegionBody rb,
                  RegionViewport parent)
Constructor which can read traits directly from an fo:region-body formatting object.
Parameters:
rb - the region-body FO node
parent - the parent region viewport

Method Details

clone

public Object clone()
Clone this object.
Overrides:
clone in interface RegionReference
Returns:
a shallow copy of this object

getBeforeFloat

public BeforeFloat getBeforeFloat()
Get the before float area.
Returns:
the before float area

getColumnCount

public int getColumnCount()
Get the number of columns when not spanning
Returns:
the number of columns

getColumnGap

public int getColumnGap()
Returns:
the column-gap value

getFootnote

public Footnote getFootnote()
Get the footnote area.
Returns:
the footnote area

getMainReference

public MainReference getMainReference()
Get the main reference area.
Returns:
the main reference area

getRemainingBPD

public int getRemainingBPD()
Returns:
the available BPD in the main reference area after the previous span reference areas are subtracted.

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

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