|
fop 0.95 | ||||||||||
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
A single-page-master-reference formatting object. This is a reference for a single page. It returns the master name only once until reset.
Nested Class Summary |
Nested classes inherited from class org.apache.fop.fo.FObj |
FObj.FObjIterator |
Nested classes 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 | |
SinglePageMasterReference(FONode parent)
|
Method Summary | |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it. |
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 |
java.lang.String |
getNextPageMasterName(boolean isOddPage,
boolean isFirstPage,
boolean isLastPage,
boolean isOnlyPage,
boolean isEmptyPage)
Returns the name of the next page master. |
boolean |
goToPrevious()
Used to set the "cursor position" to the previous item. |
boolean |
hasPagePositionLast()
|
boolean |
hasPagePositionOnly()
|
void |
reset()
Called before a new page sequence is rendered so subsequences can reset any state they keep during the formatting process. |
protected void |
startOfNode()
Called after processNode() is called. Subclasses can do additional processing. |
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 from FOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the child FObj .
XSL Content Model: empty |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public SinglePageMasterReference(FONode parent)
FONode.FONode(FONode)
Method 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
.
XSL Content Model: empty
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 java.lang.String getNextPageMasterName(boolean isOddPage, boolean isFirstPage, boolean isLastPage, boolean isOnlyPage, boolean isEmptyPage)
getNextPageMasterName
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 lastisOnlyPage
- True if the next page is the only pageisEmptyPage
- 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
|
fop 0.95 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |