Package org.apache.fop.area

Class BodyRegion

java.lang.Object
org.apache.fop.area.AreaTreeObject
org.apache.fop.area.Area
org.apache.fop.area.RegionReference
org.apache.fop.area.BodyRegion
All Implemented Interfaces:
Serializable, Cloneable
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.
See Also:

  • Constructor Details

    • 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

    • 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

  • Method Details

    • 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

    • getColumnIPD

      public int getColumnIPD()

    • getMainReference

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

    • isEmpty

      public boolean isEmpty()
      indicates whether the main reference area has any child areas added to it
      Overrides:
      isEmpty in class RegionReference
      Returns:
      whether the main reference area has any child areas added to it

    • getBeforeFloat

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

    • getFootnote

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

    • getRemainingBPD

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

    • setWritingModeTraits

      public void setWritingModeTraits(WritingModeTraitsGetter wmtg)
      Sets the writing mode traits for the main reference area of this body region area.
      Overrides:
      setWritingModeTraits in class Area
      Parameters:
      wmtg - a WM traits getter

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class RegionReference
      Throws:
      CloneNotSupportedException