org.apache.fop.fo.pagination

Interface SubSequenceSpecifier

All Known Implementing Classes:

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.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.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.

Method Detail

getNextPageMasterName

java.lang.String getNextPageMasterName(boolean isOddPage,
                                     boolean isFirstPage,
                                     boolean isLastPage,
                                     boolean isOnlyPage,
                                     boolean isBlankPage)
                                       throws FOPException

Returns the name of the next page master.

Parameters:

isOddPage - True if the next page number is odd

isFirstPage - True if the next page is the first

isLastPage - True if the next page is the last

isOnlyPage - True if the next page is the only page

isBlankPage - 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

void reset()

Called before a new page sequence is rendered so subsequences can reset any state they keep during the formatting process.

goToPrevious

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

boolean hasPagePositionLast()

Returns:

true if the subsequence has a page master for page-position "last"

hasPagePositionOnly

boolean hasPagePositionOnly()

Returns:

true if the subsequence has a page master for page-position "only"