org.apache.fop.fo.pagination
Class PageMasterReference
java.lang.Object
|
+--org.apache.fop.fo.FONode
|
+--org.apache.fop.fo.FObj
|
+--org.apache.fop.fo.pagination.PageMasterReference
- All Implemented Interfaces:
- SubSequenceSpecifier
- Direct Known Subclasses:
- RepeatablePageMasterReference, SinglePageMasterReference
- public abstract class PageMasterReference
- extends FObj
- implements SubSequenceSpecifier
Base PageMasterReference class. Provides implementation for handling the
master-reference attribute and containment within a PageSequenceMaster
Fields inherited from class org.apache.fop.fo.FONode |
areaClass, areasGenerated, BREAK_AFTER, bufferManager, children, forcedStartOffset, forcedWidth, isInTableCell, linkSet, log, marker, markers, orphans, parent, START, widows |
Methods inherited from class org.apache.fop.fo.FObj |
addCharacters, end, generatesReferenceAreas, getContentWidth, getName, getProperty, layout, makePropertyManager, maker, removeID, setWritingMode, start |
Methods inherited from class org.apache.fop.fo.FONode |
addChild, addMarker, forceStartOffset, forceWidth, getBufferManager, getLinkSet, getMarkers, getMarkerSnapshot, getParent, hasMarkers, removeAreas, resetMarker, rollback, setBufferManager, setIsInTableCell, setLinkSet, setLogger, setOrphans, setWidows |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PageMasterReference
public PageMasterReference(FObj parent,
PropertyList propertyList)
throws FOPException
setMasterName
protected void setMasterName(java.lang.String masterName)
getMasterName
public java.lang.String getMasterName()
- Returns the "master-reference" attribute of this page master reference
setPageSequenceMaster
protected void setPageSequenceMaster(PageSequenceMaster pageSequenceMaster)
getPageSequenceMaster
protected PageSequenceMaster getPageSequenceMaster()
getNextPageMaster
public abstract java.lang.String getNextPageMaster(int currentPageNumber,
boolean thisIsFirstPage,
boolean isEmptyPage)
- Specified by:
getNextPageMaster
in interface SubSequenceSpecifier
getElementName
protected abstract java.lang.String getElementName()
- Gets the formating object name for this object. Subclasses must provide this.
- Returns:
- the element name of this reference. e.g. fo:repeatable-page-master-reference
validateParent
protected void validateParent(FObj parent)
throws FOPException
- Checks that the parent is the right element. The default implementation
checks for fo:page-sequence-master
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-2002 Apache Software Foundation. All Rights Reserved.