|
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.SinglePageMasterReference
public class SinglePageMasterReference
Class modelling the
fo:single-page-master-reference
object.
This is a reference for a single page. It returns the
master name only once until reset.
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.FObj |
---|
firstChild, lastChild |
Fields inherited from class org.apache.fop.fo.FONode |
---|
FO_URI, FOX_URI, locator, log, parent, siblings |
Constructor Summary | |
---|---|
SinglePageMasterReference(FONode parent)
Creates a new SinglePageMasterReference instance that is a child of the given FONode . |
Method Summary | |
---|---|
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
boolean |
canProcess(java.lang.String flowName)
|
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
SimplePageMaster |
getNextPageMaster(boolean isOddPage,
boolean isFirstPage,
boolean isLastPage,
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()
|
boolean |
isInfinite()
Test that this is a finite sequence |
boolean |
isReusable()
Test if this can be reused when it is the last sub-sequence specifer, and has been exhausted |
void |
reset()
Called before a new page sequence is rendered so subsequences can reset any state they keep during the formatting process. |
void |
resolveReferences(LayoutMasterSet layoutMasterSet)
called by the parent LayoutMasterSet to resolve object references from simple page master reference names |
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 java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SinglePageMasterReference(FONode parent)
FONode
.
parent
- FONode
that is the parent of this objectMethod Detail |
---|
public void bind(PropertyList pList) throws FOPException
bind
in class FObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuesprotected void startOfNode() throws FOPException
startOfNode
in class FObj
FOPException
- FOP Exceptionprotected 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
.
validateChildNode
in class FONode
loc
- 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 parentpublic SimplePageMaster getNextPageMaster(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isBlankPage)
getNextPageMaster
in interface SubSequenceSpecifier
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
public void reset()
reset
in interface SubSequenceSpecifier
public boolean goToPrevious()
goToPrevious
in interface SubSequenceSpecifier
public boolean hasPagePositionLast()
hasPagePositionLast
in interface SubSequenceSpecifier
public boolean hasPagePositionOnly()
hasPagePositionOnly
in interface SubSequenceSpecifier
public java.lang.String getLocalName()
getLocalName
in class FONode
public int getNameId()
Constants
class integer value of this node
getNameId
in class FONode
Constants.FO_SINGLE_PAGE_MASTER_REFERENCE
public void resolveReferences(LayoutMasterSet layoutMasterSet) throws ValidationException
resolveReferences
in interface SubSequenceSpecifier
layoutMasterSet
- the layout-master-set
ValidationException
- when a named reference cannot be resolvedpublic boolean canProcess(java.lang.String flowName)
canProcess
in interface SubSequenceSpecifier
flowName
- name of the main flow
public boolean isInfinite()
isInfinite
in interface SubSequenceSpecifier
public boolean isReusable()
isReusable
in interface SubSequenceSpecifier
|
fop 1.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |