|
fop 2.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.LayoutMasterSet
public class LayoutMasterSet
Class modelling the
fo:layout-master-set object.
This class maintains the set of simple page master and
page sequence masters.
The masters are stored so that the page sequence can obtain
the required page master to create a page.
The page sequence masters can be reset as they hold state
information for a page sequence.
| 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 | |
|---|---|
LayoutMasterSet(FONode parent)
Create a LayoutMasterSet instance that is a child of the given parent FONode. |
|
| Method Summary | |
|---|---|
protected void |
addPageSequenceMaster(java.lang.String masterName,
PageSequenceMaster pSM)
Add a page sequence master. |
protected void |
addSimplePageMaster(SimplePageMaster sPM)
Add a simple page master. |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
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 |
getDefaultRegionNameFor(java.lang.String flowName)
Returns the default name of the region to which the flow or static-content having the given flow-name is assigned. |
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
PageSequenceMaster |
getPageSequenceMaster(java.lang.String masterName)
Get a page sequence master by name. |
SimplePageMaster |
getSimplePageMaster(java.lang.String masterName)
Get a simple page master by name. |
boolean |
regionNameExists(java.lang.String regionName)
Checks whether or not a region name exists in this master set. |
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 LayoutMasterSet(FONode parent)
FONode.
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
public void startOfNode()
throws FOPException
startOfNode in class FObjFOPException - FOP Exception
public 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.
Note: the recommended way to override this method in subclasses is
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 addSimplePageMaster(SimplePageMaster sPM)
throws ValidationException
sPM - simple-page-master to add
ValidationException - if there's a problem with name uniquenesspublic SimplePageMaster getSimplePageMaster(java.lang.String masterName)
masterName - the name of the page master
protected void addPageSequenceMaster(java.lang.String masterName,
PageSequenceMaster pSM)
throws ValidationException
masterName - name for the masterpSM - PageSequenceMaster instance
ValidationException - if there's a problem with name uniquenesspublic PageSequenceMaster getPageSequenceMaster(java.lang.String masterName)
masterName - name of the master
public boolean regionNameExists(java.lang.String regionName)
regionName - name of the region
public java.lang.String getLocalName()
getLocalName in class FONodepublic int getNameId()
Constants class integer value of this node
getNameId in class FONodeConstants.FO_LAYOUT_MASTER_SETpublic java.lang.String getDefaultRegionNameFor(java.lang.String flowName)
flowName - the value of the flow-name property
|
fop 2.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||