org.apache.fop.fo.pagination
Class PageMasterReference

java.lang.Object
  extended by org.apache.fop.fo.FONode
      extended by org.apache.fop.fo.FObj
          extended by org.apache.fop.fo.pagination.PageMasterReference
All Implemented Interfaces:
SubSequenceSpecifier
Direct Known Subclasses:
RepeatablePageMasterReference, SinglePageMasterReference

public abstract class PageMasterReference
extends FObj
implements SubSequenceSpecifier

Abstract base class for PageMasterReference classes. Provides implementation for handling the master-reference attribute and containment within a PageSequenceMaster


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.fop.fo.FObj
FObj.Maker
 
Field Summary
protected  String masterName
           
 
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
PageMasterReference(FObj parent, PropertyList propertyList, String systemId, int line, int column)
           
 
Method Summary
 String getMasterName()
           
abstract  String getNextPageMasterName(boolean isOddPage, boolean isFirstPage, boolean isEmptyPage)
           
abstract  void reset()
          Called before a new page sequence is rendered so subsequences can reset any state they keep during the formatting process.
 
Methods inherited from class org.apache.fop.fo.FObj
addCharacters, addMarker, end, generatesReferenceAreas, 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

masterName

protected String masterName
Constructor Detail

PageMasterReference

public PageMasterReference(FObj parent,
                           PropertyList propertyList,
                           String systemId,
                           int line,
                           int column)
                    throws FOPException
Throws:
FOPException
Method Detail

getMasterName

public String getMasterName()

getNextPageMasterName

public abstract String getNextPageMasterName(boolean isOddPage,
                                             boolean isFirstPage,
                                             boolean isEmptyPage)
                                      throws FOPException
Specified by:
getNextPageMasterName in interface SubSequenceSpecifier
Throws:
FOPException

reset

public abstract void reset()
Description copied from interface: SubSequenceSpecifier
Called before a new page sequence is rendered so subsequences can reset any state they keep during the formatting process.

Specified by:
reset in interface SubSequenceSpecifier


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