org.apache.fop.fo.pagination
Interface SubSequenceSpecifier
- RepeatablePageMasterAlternatives, RepeatablePageMasterReference, SinglePageMasterReference
public interface SubSequenceSpecifier
Classes that implement this interface can be added to a PageSequenceMaster,
and are capable of looking up an appropriate PageMaster.
String | getNextPageMasterName(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isOnlyPage, boolean isBlankPage) - Returns the name of the next page master.
|
boolean | goToPrevious() - Used to set the "cursor position" to the previous item.
|
boolean | hasPagePositionLast()
|
boolean | hasPagePositionOnly()
|
void | reset() - Called before a new page sequence is rendered so subsequences can reset
any state they keep during the formatting process.
|
getNextPageMasterName
public String getNextPageMasterName(boolean isOddPage,
boolean isFirstPage,
boolean isLastPage,
boolean isOnlyPage,
boolean isBlankPage)
throws FOPException
Returns the name of the next page master.
isOddPage
- True if the next page number is oddisFirstPage
- True if the next page is the firstisLastPage
- True if the next page is the lastisOnlyPage
- True if the next page is the only pageisBlankPage
- True if the next page is blank
FOPException
- if there's a problem determining the next page master
goToPrevious
public boolean goToPrevious()
Used to set the "cursor position" to the previous item.
- true if there is a previous item, false if the current one was the first one.
hasPagePositionLast
public boolean hasPagePositionLast()
- true if the subsequence has a page master for page-position "last"
hasPagePositionOnly
public boolean hasPagePositionOnly()
- true if the subsequence has a page master for page-position "only"
reset
public void reset()
Called before a new page sequence is rendered so subsequences can reset
any state they keep during the formatting process.
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.