|
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.RepeatablePageMasterAlternatives
public class RepeatablePageMasterAlternatives
Class modelling the
fo:repeatable-page-master-alternatives object.
This contains a list of conditional-page-master-reference
and the page master is found from the reference that
matches the page number and emptyness.
| 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 | |
|---|---|
RepeatablePageMasterAlternatives(FONode parent)
Base constructor |
|
| Method Summary | |
|---|---|
void |
addConditionalPageMasterReference(ConditionalPageMasterReference cpmr)
Adds a new conditional page master reference. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
boolean |
canProcess(java.lang.String flowName)
|
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 |
getLocalName()
Returns the local name (i.e. |
int |
getMaximumRepeats()
Get the value of the maximum-repeats property? |
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 RepeatablePageMasterAlternatives(FONode parent)
parent - FONode that is the parent of this object| Method Detail |
|---|
public void bind(PropertyList pList)
throws FOPException
bind in class FObjpList - 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 FObjFOPException - 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.
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 parentpublic int getMaximumRepeats()
maximum-repeats property?
public SimplePageMaster getNextPageMaster(boolean isOddPage,
boolean isFirstPage,
boolean isLastPage,
boolean isBlankPage)
getNextPageMaster in interface SubSequenceSpecifierisOddPage - 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 addConditionalPageMasterReference(ConditionalPageMasterReference cpmr)
cpmr - the new conditional referencepublic void reset()
reset in interface SubSequenceSpecifierpublic boolean goToPrevious()
goToPrevious in interface SubSequenceSpecifierpublic boolean hasPagePositionLast()
hasPagePositionLast in interface SubSequenceSpecifierpublic boolean hasPagePositionOnly()
hasPagePositionOnly in interface SubSequenceSpecifierpublic java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_REPEATABLE_PAGE_MASTER_ALTERNATIVES
public void resolveReferences(LayoutMasterSet layoutMasterSet)
throws ValidationException
resolveReferences in interface SubSequenceSpecifierlayoutMasterSet - the layout-master-set
ValidationException - when a named reference cannot be resolvedpublic boolean canProcess(java.lang.String flowName)
canProcess in interface SubSequenceSpecifierflowName - name of the main flow
public boolean isInfinite()
isInfinite in interface SubSequenceSpecifierpublic 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 | |||||||||