|
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.PageSequence
public class PageSequence
Implementation of the fo:page-sequence formatting object.
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 | |
---|---|
PageSequence(FONode parent)
Create a page sequence FO node. |
Method Summary | |
---|---|
void |
addChildNode(FONode child)
Adds a node as a child of this node. |
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 |
getCountry()
|
java.util.Map |
getFlowMap()
|
int |
getForcePageCount()
|
Numeric |
getInitialPageNumber()
|
java.lang.String |
getLanguage()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
Flow |
getMainFlow()
Public accessor for getting the MainFlow to which this PageSequence is attached. |
java.lang.String |
getMasterReference()
|
int |
getNameId()
Returns the Constants class integer value of this node |
SimplePageMaster |
getNextSimplePageMaster(int page,
boolean isFirstPage,
boolean isLastPage,
boolean isBlank)
Public accessor for determining the next page master to use within this page sequence. |
Root |
getRoot()
Public accessor for the ancestor Root. |
int |
getStartingPageNumber()
Get the starting page number for this page sequence. |
StaticContent |
getStaticContent(java.lang.String name)
Get the static content FO node from the flow map. |
Title |
getTitleFO()
Accessor method for titleFO |
boolean |
goToPreviousSimplePageMaster()
Used to set the "cursor position" for the page masters to the previous item. |
boolean |
hasFlowName(java.lang.String flowName)
Determine if this PageSequence already has a flow with the given flow-name Used for validation of incoming fo:flow or fo:static-content objects |
boolean |
hasPagePositionLast()
|
void |
initPageNumber()
Initialize the current page number for the start of the page sequence. |
java.lang.String |
makeFormattedPageNumber(int pageNumber)
Retrieves the string representation of a page number applicable for this page sequence |
void |
releasePageSequence()
Releases a page-sequence's children after the page-sequence has been fully processed. |
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 PageSequence(FONode parent)
parent
- the parent FO nodeMethod 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 Content Model: (title?,static-content*,flow)
public void addChildNode(FONode child) throws FOPException
FONode
addChildNode
in class FObj
child
- child node to be added to the childNodes of this node
FOPException
- if there's a problem during processingFONode.addChildNode(FONode)
public void initPageNumber()
public int getStartingPageNumber()
public StaticContent getStaticContent(java.lang.String name)
name
- the flow name to find
public Title getTitleFO()
public Flow getMainFlow()
public boolean hasFlowName(java.lang.String flowName)
flowName
- The flow-name to search for
public java.util.Map getFlowMap()
public SimplePageMaster getNextSimplePageMaster(int page, boolean isFirstPage, boolean isLastPage, boolean isBlank) throws FOPException
page
- the page number of the page to be createdisFirstPage
- indicator whether this page is the first page of the
page sequenceisLastPage
- indicator whether this page is the last page of the
page sequenceisBlank
- indicator whether the page will be blank
FOPException
- if there's a problem determining the page masterpublic boolean goToPreviousSimplePageMaster()
public boolean hasPagePositionLast()
public java.lang.String makeFormattedPageNumber(int pageNumber)
pageNumber
- the page number
public Root getRoot()
getRoot
in class FONode
public java.lang.String getMasterReference()
public java.lang.String getLocalName()
FONode
getLocalName
in class FONode
FONode.getLocalName()
public int getNameId()
FONode
getNameId
in class FONode
FONode.getNameId()
public int getForcePageCount()
public Numeric getInitialPageNumber()
public java.lang.String getCountry()
public java.lang.String getLanguage()
public void releasePageSequence()
|
fop 0.94 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |