|
fop 0.90alpha1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.fop.fo.FONode | +--org.apache.fop.fo.FObj | +--org.apache.fop.fo.pagination.PageSequence
Implementation of the fo:page-sequence formatting object.
Field Summary | |
java.util.HashMap |
flowMap
Map of flows to their flow name (flow-name, Flow) |
PageSequenceMaster |
pageSequenceMaster
|
SimplePageMaster |
simplePageMaster
The currentSimplePageMaster is either the page master for the whole page sequence if master-reference refers to a simple-page-master, or the simple page master produced by the page sequence master otherwise. |
int |
startingPageNumber
|
Fields inherited from class org.apache.fop.fo.FObj |
childNodes, markers |
Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, locator, log, parent |
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()
Signal end of this xml element. |
java.lang.String |
getId()
|
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()
Return the "master-reference" property. |
int |
getNameId()
Returns the Constants class integer value of this node |
SimplePageMaster |
getNextSimplePageMaster(int page,
boolean bIsFirstPage,
boolean bIsBlank)
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 |
java.lang.String |
makeFormattedPageNumber(int pageNumber)
Retrieves the string representation of a page number applicable for this page sequence |
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 org.apache.fop.fo.FObj |
addExtensionAttachment, addMarker, checkId, clone, createPropertyList, findAncestor, findNearestAncestorFObj, generatesReferenceAreas, getChildNodes, getChildNodes, getExtensionAttachments, getIsOutOfLineFODescendant, getMarkers, getNamespaceURI, getNormalNamespacePrefix, getPropertyMakerFor, hasMarkers, isBlockItem, isBlockOrInlineItem, isInlineItem, isNeutralItem, notifyChildRemoval, processNode, removeChild |
Methods inherited from class org.apache.fop.fo.FONode |
addCharacters, attributeError, attributeWarning, charIterator, clone, errorText, getExtensionAttachment, getFOEventHandler, getLocator, getLocatorString, getLogger, getName, getName, getNodeString, getParent, getUserAgent, invalidChildError, invalidChildError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, setLocator, tooManyNodesError, tooManyNodesError, warningText |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public java.util.HashMap flowMap
public int startingPageNumber
public SimplePageMaster simplePageMaster
public PageSequenceMaster pageSequenceMaster
Constructor Detail |
public PageSequence(FONode parent)
parent
- the parent FO nodeMethod Detail |
public void bind(PropertyList pList) throws FOPException
FObj
bind
in class FObj
FObj.bind(PropertyList)
protected void startOfNode() throws FOPException
FONode
startOfNode
in class FONode
FONode.startOfNode()
protected void endOfNode() throws FOPException
endOfNode
in class FONode
org.apache.fop.fo.FONode
FOPException
- if there's a problem during processingprotected void validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) throws ValidationException
FONode
validateChildNode
in class FONode
XSL Content Model: (title?,static-content*,flow)
public void addChildNode(FONode child) throws FOPException
FONode
addChildNode
in class FObj
FONode.addChildNode(FONode)
public int getStartingPageNumber()
public StaticContent getStaticContent(java.lang.String name)
name
- the flow name to findpublic java.lang.String getId()
public Title getTitleFO()
public Flow getMainFlow()
public boolean hasFlowName(java.lang.String flowName)
flowName
- The flow-name to search forpublic SimplePageMaster getNextSimplePageMaster(int page, boolean bIsFirstPage, boolean bIsBlank) throws FOPException
page
- the page number of the page to be createdbIsFirstPage
- indicator whether this page is the first page of the
page sequencebIsBlank
- indicator whether the page will be blankFOPException
- if there's a problem determining the page masterpublic boolean goToPreviousSimplePageMaster()
public java.lang.String makeFormattedPageNumber(int pageNumber)
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()
|
fop 0.90alpha1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |