|
fop 0.90alpha1 | ||||||||||
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.Region
This is an abstract base class for pagination regions
Field Summary |
Fields inherited from class org.apache.fop.fo.FObj |
childNodes, markers |
Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, locator, log, parent |
Constructor Summary | |
protected |
Region(FONode parent)
|
Method Summary | |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
boolean |
generatesReferenceAreas()
Check if this formatting object generates reference areas. |
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
protected abstract java.lang.String |
getDefaultRegionName()
Returns the default region name (xsl-region-before, xsl-region-start, etc.) |
int |
getDisplayAlign()
|
int |
getOverflow()
|
int |
getReferenceOrientation()
|
java.lang.String |
getRegionName()
|
protected Region |
getSiblingRegion(int regionId)
Returns a sibling region for this region. |
abstract java.awt.Rectangle |
getViewportRectangle(FODimension pageRefRect,
SimplePageMaster spm)
|
int |
getWritingMode()
|
protected boolean |
isReserved(java.lang.String name)
Checks to see if a given region name is one of the reserved names |
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 within FObj constructor |
Methods inherited from class org.apache.fop.fo.FObj |
addChildNode, addExtensionAttachment, addMarker, checkId, clone, createPropertyList, findAncestor, findNearestAncestorFObj, getChildNodes, getChildNodes, getExtensionAttachments, getIsOutOfLineFODescendant, getMarkers, getNamespaceURI, getNormalNamespacePrefix, getPropertyMakerFor, hasMarkers, isBlockItem, isBlockOrInlineItem, isInlineItem, isNeutralItem, notifyChildRemoval, processNode, removeChild |
Methods inherited from class org.apache.fop.fo.FONode |
addCharacters, attributeError, attributeWarning, charIterator, clone, endOfNode, errorText, getExtensionAttachment, getFOEventHandler, getLocalName, getLocator, getLocatorString, getLogger, getName, getName, getNameId, getNodeString, getParent, getRoot, getUserAgent, invalidChildError, invalidChildError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, setLocator, startOfNode, tooManyNodesError, tooManyNodesError, warningText |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected Region(FONode parent)
FONode.FONode(FONode)
Method Detail |
public void bind(PropertyList pList) throws FOPException
FObj
bind
in class FObj
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuesFObj.bind(PropertyList)
protected void validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) throws ValidationException
FONode
validateChildNode
in class FONode
loc
- location in the FO source filensURI
- namespace of incoming nodelocalName
- (e.g. "table" for "fo:table")
ValidationException
- if incoming node not valid for parentXSL Content Model: empty
public abstract java.awt.Rectangle getViewportRectangle(FODimension pageRefRect, SimplePageMaster spm)
pageRefRect
- reference dimension of the page area.spm
- the simple page master this region belongs to.
protected abstract java.lang.String getDefaultRegionName()
protected boolean isReserved(java.lang.String name)
name
- a region name to check
public boolean generatesReferenceAreas()
FObj
generatesReferenceAreas
in class FObj
FObj.generatesReferenceAreas()
protected Region getSiblingRegion(int regionId)
regionId
- the Constants ID of the FO representing the region
public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
public java.lang.String getRegionName()
public int getWritingMode()
public int getOverflow()
public int getDisplayAlign()
public int getReferenceOrientation()
|
fop 0.90alpha1 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |