Package org.apache.fop.fo.pagination

Class RegionBody

java.lang.Object
org.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.pagination.Region
org.apache.fop.fo.pagination.RegionBody
All Implemented Interfaces:
Cloneable, Constants
public class RegionBody extends Region
Class modelling the fo:region-body object.

  • Constructor Details

    • RegionBody

      public RegionBody(FONode parent)
      Create a RegionBody instance that is a child of the given parent FONode.
      Parameters:
      parent - the FONode that is to be the parent

  • Method Details

    • bind

      public void bind(PropertyList pList) throws FOPException
      Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it.
      Overrides:
      bind in class Region
      Parameters:
      pList - the PropertyList where the properties can be found.
      Throws:
      FOPException - if there is a problem binding the values

    • getCommonMarginBlock

      public CommonMarginBlock getCommonMarginBlock()
      Return the CommonMarginBlock instance attached to this instance.
      Returns:
      the CommonMarginBlock instance

    • getColumnCount

      public int getColumnCount()
      Return the value of the column-count property.
      Returns:
      the "column-count" property.

    • getColumnGap

      public int getColumnGap()
      Return the value of the column-gap property.
      Returns:
      the "column-gap" property.

    • getViewportRectangle

      public Rectangle getViewportRectangle(FODimension reldims)
      Specified by:
      getViewportRectangle in class Region
      Parameters:
      reldims - reference dimension of the page area.
      Returns:
      the rectangle for the viewport area

    • getDefaultRegionName

      public String getDefaultRegionName()
      Returns the default region name (xsl-region-before, xsl-region-start, etc.)
      Specified by:
      getDefaultRegionName in class Region
      Returns:
      the default region name

    • getLocalName

      public String getLocalName()
      Returns the local name (i.e. without namespace prefix) of the node
      Specified by:
      getLocalName in class FONode
      Returns:
      the local name of this node

    • getNameId

      public int getNameId()
      Returns the Constants class integer value of this node
      Overrides:
      getNameId in class FONode
      Returns:
      Constants.FO_REGION_BODY