org.apache.fop.fo.pagination
Class Region

java.lang.Object
  extended byorg.apache.fop.fo.FONode
      extended byorg.apache.fop.fo.FObj
          extended byorg.apache.fop.fo.pagination.Region
Direct Known Subclasses:
RegionAfter, RegionBefore, RegionBody, RegionEnd, RegionStart

public abstract class Region
extends FObj

Abstract base class for pagination regions.


Nested Class Summary
 
Nested classes inherited from class org.apache.fop.fo.FObj
FObj.Maker
 
Field Summary
static String PROP_REGION_NAME
           
 
Fields inherited from class org.apache.fop.fo.FObj
column, line, properties, propMgr, systemId
 
Fields inherited from class org.apache.fop.fo.FONode
areaClass, areasGenerated, BREAK_AFTER, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, parent, START
 
Constructor Summary
protected Region(FObj parent, PropertyList propertyList, String systemId, int line, int column)
           
 
Method Summary
 boolean generatesReferenceAreas()
           
protected abstract  String getDefaultRegionName()
          Returns the default region name (xsl-region-before, xsl-region-start, etc.)
protected  SimplePageMaster getPageMaster()
           
abstract  String getRegionClass()
           
 String getRegionName()
          Returns the name of this region
protected  boolean isReserved(String name)
          Checks to see if a given region name is one of the reserved names
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, addMarker, end, getContentWidth, getName, getProperty, layout, makePropertyManager, removeID, setWritingMode
 
Methods inherited from class org.apache.fop.fo.FONode
addChild, forceStartOffset, forceWidth, getLinkSet, getMarkerSnapshot, getParent, mayPrecedeMarker, removeAreas, resetMarker, rollback, setIsInTableCell, setLinkSet, setLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROP_REGION_NAME

public static final String PROP_REGION_NAME
See Also:
Constant Field Values
Constructor Detail

Region

protected Region(FObj parent,
                 PropertyList propertyList,
                 String systemId,
                 int line,
                 int column)
          throws FOPException
Method Detail

getDefaultRegionName

protected abstract String getDefaultRegionName()
Returns the default region name (xsl-region-before, xsl-region-start, etc.)


getRegionClass

public abstract String getRegionClass()

getRegionName

public String getRegionName()
Returns the name of this region


getPageMaster

protected SimplePageMaster getPageMaster()

isReserved

protected boolean isReserved(String name)
                      throws FOPException
Checks to see if a given region name is one of the reserved names

Parameters:
name - a region name to check
Returns:
true if the name parameter is a reserved region name
Throws:
FOPException

generatesReferenceAreas

public boolean generatesReferenceAreas()
Overrides:
generatesReferenceAreas in class FObj


Copyright ? 1999-2003 Apache Software Foundation. All Rights Reserved.