|
fop 1.1 | |||||||||
| 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.AbstractPageSequence
org.apache.fop.fo.pagination.PageSequence
public class PageSequence
Class modelling the
fo:page-sequence 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, FONode.GatherContextInfoFunction |
| Field Summary |
|---|
| Fields inherited from class org.apache.fop.fo.pagination.AbstractPageSequence |
|---|
forcePageCount, initialPageNumber, startingPageNumber |
| Fields inherited from class org.apache.fop.fo.FObj |
|---|
firstChild, lastChild |
| Fields inherited from class org.apache.fop.fo.FONode |
|---|
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
|---|---|
PageSequence(FONode parent)
Create a PageSequence instance that is a child of the given FONode. |
|
| 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 java.util.Stack |
collectDelimitedTextRanges(java.util.Stack ranges,
DelimitedTextRange currentRange)
Collect the sequence of delimited text ranges, where each new range is pushed onto RANGES, where default implementation collects ranges of child nodes. |
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. |
Direction |
getBlockProgressionDirection()
|
Direction |
getColumnProgressionDirection()
|
java.lang.String |
getCountry()
Get the value of the country trait. |
java.util.Map<java.lang.String,FONode> |
getFlowMap()
|
Direction |
getInlineProgressionDirection()
|
java.lang.String |
getLanguage()
Get the value of the language trait. |
java.lang.String |
getLocalName()
Returns the local name (i.e. |
Flow |
getMainFlow()
Public accessor for getting the MainFlow to which this PageSequence is attached. |
java.lang.String |
getMasterReference()
Get the value of the master-reference trait. |
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. |
int |
getReferenceOrientation()
Get the value of the reference-orientation trait. |
Direction |
getRowProgressionDirection()
|
Direction |
getShiftDirection()
|
StaticContent |
getStaticContent(java.lang.String name)
Get the static content FO node from the flow map. |
Title |
getTitleFO()
Accessor method for the fo:title associated with this fo:page-sequence |
WritingMode |
getWritingMode()
|
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()
|
boolean |
hasPagePositionOnly()
|
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 this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root)
called from FOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the child FObj. |
| Methods inherited from class org.apache.fop.fo.pagination.AbstractPageSequence |
|---|
getCommonAccessibility, getForcePageCount, getInitialPageNumber, getRoot, getStartingPageNumber, initPageNumber, makeFormattedPageNumber |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public PageSequence(FONode parent)
FONode.
parent - the parent FONode| Method Detail |
|---|
public void bind(PropertyList pList)
throws FOPException
bind in class AbstractPageSequencepList - the PropertyList where the properties can be found.
FOPException - if there is a problem binding the values
protected void startOfNode()
throws FOPException
startOfNode in class AbstractPageSequenceFOPException - FOP Exception
protected void endOfNode()
throws FOPException
FOEventHandler that the end of this FO
has been reached.
The default implementation simply calls FONode.finalizeNode(), without
sending any event to the FOEventHandler.
super.endOfNode(); // invoke finalizeNode()
getFOEventHandler().endXXX(); // send endOfNode() notification
endOfNode in class FONodeFOPException - if there's a problem during processing
protected void validateChildNode(org.xml.sax.Locator loc,
java.lang.String nsURI,
java.lang.String localName)
throws ValidationException
fo:table is not an immediate child of fo:root)
called from FOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the child FObj.
XSL Content Model: (title?,static-content*,flow)
validateChildNode in class FONodeloc - location in the FO source filensURI - namespace of incoming nodelocalName - name of the incoming node (without namespace prefix)
ValidationException - if incoming node not valid for parent
public void addChildNode(FONode child)
throws FOPException
addChildNode in class FObjchild - child node to be added to the childNodes of this node
FOPException - if there's a problem during processingpublic 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<java.lang.String,FONode> getFlowMap()
public SimplePageMaster getNextSimplePageMaster(int page,
boolean isFirstPage,
boolean isLastPage,
boolean isBlank)
throws PageProductionException
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
PageProductionException - if there's a problem determining the page masterpublic boolean goToPreviousSimplePageMaster()
public boolean hasPagePositionLast()
public boolean hasPagePositionOnly()
public java.lang.String getMasterReference()
master-reference trait.
public java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_PAGE_SEQUENCEpublic java.lang.String getCountry()
country trait.
public java.lang.String getLanguage()
language trait.
public int getReferenceOrientation()
reference-orientation trait.
getReferenceOrientation in class AbstractPageSequencepublic Direction getInlineProgressionDirection()
getInlineProgressionDirection in interface WritingModeTraitsGetterpublic Direction getBlockProgressionDirection()
getBlockProgressionDirection in interface WritingModeTraitsGetterpublic Direction getColumnProgressionDirection()
getColumnProgressionDirection in interface WritingModeTraitsGetterpublic Direction getRowProgressionDirection()
getRowProgressionDirection in interface WritingModeTraitsGetterpublic Direction getShiftDirection()
getShiftDirection in interface WritingModeTraitsGetterpublic WritingMode getWritingMode()
getWritingMode in interface WritingModeTraitsGetter
protected java.util.Stack collectDelimitedTextRanges(java.util.Stack ranges,
DelimitedTextRange currentRange)
FONode
collectDelimitedTextRanges in class FONoderanges - a stack of delimited text rangescurrentRange - the current range or null (if none)
public void releasePageSequence()
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||