|
fop 0.94 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.fo.FONode
org.apache.fop.fo.FObj
org.apache.fop.fo.pagination.PageSequenceMaster
public class PageSequenceMaster
The page-sequence-master formatting object. This class handles a list of subsequence specifiers which are simple or complex references to page-masters.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.fop.fo.FObj |
---|
FObj.FObjIterator |
Nested classes/interfaces inherited from class org.apache.fop.fo.FONode |
---|
FONode.FONodeIterator |
Field Summary |
---|
Fields inherited from class org.apache.fop.fo.FObj |
---|
firstChild |
Fields inherited from class org.apache.fop.fo.FONode |
---|
FO_URI, FOX_URI, locator, log, parent, siblings |
Constructor Summary | |
---|---|
PageSequenceMaster(FONode parent)
|
Method Summary | |
---|---|
protected void |
addSubsequenceSpecifier(SubSequenceSpecifier pageMasterReference)
Adds a new suqsequence specifier to the page sequence master. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
protected void |
endOfNode()
Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached. |
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
int |
getNameId()
Returns the Constants class integer value of this node |
SimplePageMaster |
getNextSimplePageMaster(boolean isOddPage,
boolean isFirstPage,
boolean isLastPage,
boolean isBlankPage)
Returns the next simple-page-master. |
boolean |
goToPreviousSimplePageMaster()
Used to set the "cursor position" for the page masters to the previous item. |
boolean |
hasPagePositionLast()
|
void |
reset()
Resets the subsequence specifiers subsystem. |
protected void |
startOfNode()
Called after processNode() is called. |
protected void |
validateChildNode(org.xml.sax.Locator loc,
java.lang.String nsURI,
java.lang.String localName)
Checks to make sure, during SAX processing of input document, that the incoming node is valid for the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PageSequenceMaster(FONode parent)
FONode.FONode(FONode)
Method Detail |
---|
public void bind(PropertyList pList) throws FOPException
FObj
bind
in class FObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuesFObj.bind(PropertyList)
protected void startOfNode() throws FOPException
FONode
startOfNode
in class FObj
FOPException
- FOP ExceptionFONode.startOfNode()
protected void endOfNode() throws FOPException
FONode
endOfNode
in class FONode
FOPException
- if there's a problem during processingFONode.endOfNode()
protected void validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) throws ValidationException
FONode
validateChildNode
in class FONode
loc
- location in the FO source filensURI
- namespace of incoming nodelocalName
- (e.g. "table" for "fo:table")
ValidationException
- if incoming node not valid for parentXSL/FOP: (single-page-master-reference|repeatable-page-master-reference|
repeatable-page-master-alternatives)+
protected void addSubsequenceSpecifier(SubSequenceSpecifier pageMasterReference)
pageMasterReference
- the subsequence to addpublic void reset()
public boolean goToPreviousSimplePageMaster()
public boolean hasPagePositionLast()
public SimplePageMaster getNextSimplePageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isBlankPage) throws FOPException
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
FOPException
- if there's a problem determining the next page masterpublic java.lang.String getLocalName()
FONode
getLocalName
in class FONode
FONode.getLocalName()
public int getNameId()
FONode
getNameId
in class FONode
FONode.getNameId()
|
fop 0.94 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |