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