|
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.SimplePageMaster
public class SimplePageMaster
Class modelling the
fo:simple-page-master
object.
This creates a simple page from the specified regions
and attributes.
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 |
Fields inherited from class org.apache.fop.fo.FONode |
---|
FO_URI, FOX_URI, locator, log, parent, siblings |
Constructor Summary | |
---|---|
SimplePageMaster(FONode parent)
Base constructor |
Method Summary | |
---|---|
protected void |
addChildNode(FONode child)
Adds a node as a child of this node. |
protected void |
addRegion(Region region)
Adds a region to this 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. |
boolean |
generatesReferenceAreas()
Check if this formatting object generates reference areas. |
CommonMarginBlock |
getCommonMarginBlock()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. |
java.lang.String |
getMasterName()
|
int |
getNameId()
Returns the Constants class integer value of this node |
Length |
getPageHeight()
|
protected PercentBaseContext |
getPageHeightContext(int lengthBase)
Gets the context for the height of the page-reference-area, taking into account the reference-orientation. |
Length |
getPageWidth()
|
protected PercentBaseContext |
getPageWidthContext(int lengthBase)
Gets the context for the width of the page-reference-area, taking into account the reference-orientation. |
int |
getReferenceOrientation()
|
Region |
getRegion(int regionId)
Returns the region for a given region class. |
java.util.Map |
getRegions()
Returns a Map of regions associated with this simple-page-master |
int |
getWritingMode()
|
protected boolean |
regionNameExists(java.lang.String regionName)
Indicates if a region with a given name exists in this simple-page-master. |
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 org.apache.fop.fo.FObj |
---|
addChildTo, addForeignAttribute, addMarker, clearChildNodes, clone, createPropertyList, findAncestor, findNearestAncestorFObj, gatherContextInfo, getChildNodes, getChildNodes, getContextInfoAlt, getExtensionAttachments, getForeignAttributes, getId, getMarkers, getNamespaceURI, getNormalNamespacePrefix, getPropertyMakerFor, hasChildren, hasExtensionAttachments, hasId, hasMarkers, isBlockItem, isBlockOrInlineItem, isInlineItem, processNode, removeChild, toString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SimplePageMaster(FONode parent)
parent
- FONode
that is the parent of this objectMethod 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
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 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
.
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 boolean generatesReferenceAreas()
generatesReferenceAreas
in class FObj
protected void addChildNode(FONode child) throws FOPException
addChildNode
in class FObj
child
- child node to be added to the childNodes of this node
FOPException
- if there's a problem during processingprotected void addRegion(Region region)
region
- region to addprotected final PercentBaseContext getPageWidthContext(int lengthBase)
lengthBase
- the lengthBase to use to resolve percentages
protected final PercentBaseContext getPageHeightContext(int lengthBase)
lengthBase
- the lengthBase to use to resolve percentages
public Region getRegion(int regionId)
regionId
- Constants ID of the FO representing the region
public java.util.Map getRegions()
protected boolean regionNameExists(java.lang.String regionName)
regionName
- name of the region to lookup
public CommonMarginBlock getCommonMarginBlock()
public java.lang.String getMasterName()
public Length getPageWidth()
public Length getPageHeight()
public int getWritingMode()
public int getReferenceOrientation()
public java.lang.String getLocalName()
getLocalName
in class FONode
public int getNameId()
Constants
class integer value of this node
getNameId
in class FONode
Constants.FO_SIMPLE_PAGE_MASTER
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |