|
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.flow.PageNumber
public class PageNumber
Class modelling the
fo:page-number
object.
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 | |
---|---|
PageNumber(FONode parent)
Base constructor |
Method Summary | |
---|---|
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
protected java.util.Stack<DelimitedTextRange> |
collectDelimitedTextRanges(java.util.Stack<DelimitedTextRange> ranges,
DelimitedTextRange currentRange)
Collect the sequence of delimited text ranges, where each new range is pushed onto RANGES, where default implementation collects ranges of child nodes. |
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. |
Length |
getAlignmentAdjust()
|
int |
getAlignmentBaseline()
|
Length |
getBaselineShift()
|
java.awt.Color |
getColor()
|
CommonAccessibility |
getCommonAccessibility()
Returns the accessibility properties. |
CommonBorderPaddingBackground |
getCommonBorderPaddingBackground()
|
CommonFont |
getCommonFont()
|
int |
getDominantBaseline()
|
SpaceProperty |
getLineHeight()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
StructureTreeElement |
getStructureTreeElement()
Returns the structure tree element associated to this object. |
CommonTextDecoration |
getTextDecoration()
|
boolean |
isDelimitedTextRangeBoundary(int boundary)
Determine if node has a delimited text range boundary. |
void |
setStructureTreeElement(StructureTreeElement structureTreeElement)
Sets the structure tree element. |
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 PageNumber(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 valuespublic void startOfNode() throws FOPException
startOfNode
in class FObj
FOPException
- FOP Exceptionpublic 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 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 CommonAccessibility getCommonAccessibility()
getCommonAccessibility
in interface CommonAccessibilityHolder
public CommonFont getCommonFont()
public java.awt.Color getColor()
public CommonBorderPaddingBackground getCommonBorderPaddingBackground()
public CommonTextDecoration getTextDecoration()
public Length getAlignmentAdjust()
public int getAlignmentBaseline()
public Length getBaselineShift()
public int getDominantBaseline()
public SpaceProperty getLineHeight()
public void setStructureTreeElement(StructureTreeElement structureTreeElement)
FONode
setStructureTreeElement
in class FONode
structureTreeElement
- set.public StructureTreeElement getStructureTreeElement()
FONode
getStructureTreeElement
in interface StructureTreeElementHolder
getStructureTreeElement
in class FONode
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_PAGE_NUMBER
public boolean isDelimitedTextRangeBoundary(int boundary)
FONode
isDelimitedTextRangeBoundary
in class FONode
boundary
- one of {EN_BEFORE, EN_AFTER, or EN_BOTH} enumeration constants
protected java.util.Stack<DelimitedTextRange> collectDelimitedTextRanges(java.util.Stack<DelimitedTextRange> ranges, DelimitedTextRange currentRange)
FONode
collectDelimitedTextRanges
in class FONode
ranges
- a stack of delimited text rangescurrentRange
- the current range or null (if none)
|
fop 2.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |