|
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.LayoutMasterSet
public class LayoutMasterSet
The layout-master-set formatting 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 |
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 | |
---|---|
LayoutMasterSet(FONode parent)
|
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. |
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 |
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. |
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 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 . |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public LayoutMasterSet(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 endOfNode() throws FOPException
endOfNode
in class FONode
FOPException
- if there's a problem during processingprotected 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/FOP: (simple-page-master|page-sequence-master)+
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 parentprotected 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 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 |