|
fop 1.0 | ||||||||||
| 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.Root
Class modeling the
fo:root formatting object.
Contains page masters, page-sequences.
| 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, FONode.GatherContextInfoFunction |
| 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 | |
Root(FONode parent)
Base constructor |
|
| Method Summary | |
void |
addDestination(Destination destination)
Add a Destination object to this FO |
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. |
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.
The default implementation simply calls FONode.finalizeNode(), without
sending any event to the FOEventHandler.
Note: the recommended way to override this method in subclasses is super.endOfNode(); // invoke finalizeNode()
|
BookmarkTree |
getBookmarkTree()
Public accessor for the BookmarkTree object for this FO |
FOTreeBuilderContext |
getBuilderContext()
Returns the context class providing information used during FO tree building. |
Declarations |
getDeclarations()
Returns the associated Declarations. |
java.util.List |
getDestinationList()
Public accessor for the list of Destination objects for this FO |
int |
getEndingPageNumberOfPreviousSequence()
Gets the last page number generated by the previous page-sequence |
FOEventHandler |
getFOEventHandler()
This method overrides the FONode version. |
LayoutMasterSet |
getLayoutMasterSet()
Returns the associated LayoutMasterSet. |
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 |
int |
getPageSequenceCount()
Returns the number of PageSequence instances. |
Root |
getRoot()
Returns the root node of this tree |
PageSequence |
getSucceedingPageSequence(PageSequence current)
Some properties, such as 'force-page-count', require a page-sequence to know about some properties of the next. |
int |
getTotalPagesGenerated()
Returns the total number of pages generated by FOP (May not equal endingPageNumberOfPreviousSequence due to initial-page-number property on fo:page-sequences.) |
void |
notifyPageSequenceFinished(int lastPageNumber,
int additionalPages)
Notify additional pages generated to increase the totalPagesGenerated counter |
void |
setBookmarkTree(BookmarkTree bookmarkTree)
Set the BookmarkTree object for this FO |
void |
setBuilderContext(FOTreeBuilderContext context)
Sets the builder context for this FO tree. |
void |
setDeclarations(Declarations declarations)
Sets the associated Declarations. |
void |
setFOEventHandler(FOEventHandler foEventHandler)
Sets the FOEventHandler object that this Root is attached to |
void |
setLayoutMasterSet(LayoutMasterSet layoutMasterSet)
Sets the associated LayoutMasterSet. |
protected void |
validateChildNode(org.xml.sax.Locator loc,
FONode child)
|
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.
XSL 1.0 Spec: (layout-master-set,declarations?,page-sequence+) FOP: (layout-master-set, declarations?, fox:bookmarks?, page-sequence+) |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
public Root(FONode parent)
parent - FONode that is the parent of this object
Note: parent should be null for the fo:root.| 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 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 parent
protected void validateChildNode(org.xml.sax.Locator loc,
FONode child)
throws ValidationException
ValidationExceptionpublic void setFOEventHandler(FOEventHandler foEventHandler)
foEventHandler - the FOEventHandler objectpublic FOEventHandler getFOEventHandler()
getFOEventHandler in class FONodepublic void setBuilderContext(FOTreeBuilderContext context)
context - the builder context to be usedpublic FOTreeBuilderContext getBuilderContext()
getBuilderContext in class FONodepublic int getEndingPageNumberOfPreviousSequence()
public int getTotalPagesGenerated()
public void notifyPageSequenceFinished(int lastPageNumber,
int additionalPages)
lastPageNumber - the last page number generated by the sequenceadditionalPages - the total pages generated by the sequence (for statistics)
java.lang.IllegalArgumentException - for negative additional page countspublic int getPageSequenceCount()
public PageSequence getSucceedingPageSequence(PageSequence current)
current - the current PageSequence
public LayoutMasterSet getLayoutMasterSet()
public void setLayoutMasterSet(LayoutMasterSet layoutMasterSet)
layoutMasterSet - the LayoutMasterSet to usepublic Declarations getDeclarations()
public void setDeclarations(Declarations declarations)
declarations - the Declarations to usepublic void setBookmarkTree(BookmarkTree bookmarkTree)
bookmarkTree - the BookmarkTree objectpublic void addDestination(Destination destination)
destination - the Destination object to addpublic java.util.List getDestinationList()
public BookmarkTree getBookmarkTree()
public Root getRoot()
getRoot in class FONodepublic java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_ROOT
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||