|
fop 2.2 | |||||||||
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.FObjMixed
org.apache.fop.fo.flow.AbstractRetrieveMarker
org.apache.fop.fo.flow.RetrieveTableMarker
public class RetrieveTableMarker
Class modelling the
fo:retrieve-table-marker
formatting 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.FObjMixed |
---|
currentTextNode, lastFOTextProcessed |
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 | |
---|---|
RetrieveTableMarker(FONode parent)
Create a new RetrieveTableMarker instance that is a child of the given FONode . |
Method Summary | |
---|---|
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. |
void |
clearChildNodes()
Clears the list 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. |
protected int |
findAncestor(int ancestorID)
Overridden to flag the ancestor table-cell. |
java.lang.String |
getLocalName()
Returns the local name (i.e. |
int |
getNameId()
Returns the Constants class integer value of this node |
int |
getRetrieveBoundaryWithinTable()
Return the value for the retrieve-boundary-within-table
property |
int |
getRetrievePositionWithinTable()
Return the value for the retrieve-position-within-table
property |
void |
processNode(java.lang.String elementName,
org.xml.sax.Locator locator,
org.xml.sax.Attributes attlist,
PropertyList pList)
Initialize the node with its name, location information, and attributes The attributes must be used immediately as the sax attributes will be altered for the next element. |
protected void |
restoreFOEventHandlerState()
|
void |
startOfNode()
Called after processNode() is called. |
Methods inherited from class org.apache.fop.fo.flow.AbstractRetrieveMarker |
---|
bindMarker, changePositionTo, getBoundary, getBoundaryLabel, getPosition, getPositionLabel, getRetrieveClassName, getStructureTreeElement, setBoundary, setBoundaryLabel, setPosition, setPositionLabel, setStructureTreeElement, validateChildNode |
Methods inherited from class org.apache.fop.fo.FObjMixed |
---|
addChildNode, characters, charIterator, clone, finalizeNode, handleWhiteSpaceFor, removeChild |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RetrieveTableMarker(FONode parent)
FONode
.
parent
- the parent FONode
Method Detail |
---|
public void processNode(java.lang.String elementName, org.xml.sax.Locator locator, org.xml.sax.Attributes attlist, PropertyList pList) throws FOPException
fo:retrieve-table-marker
is only permitted as a descendant
of an fo:table-header
or an fo:table-footer
.
processNode
in class FObj
elementName
- element name (e.g., "fo:block")locator
- Locator object (ignored by default)attlist
- Collection of attributes passed to us from the parser.pList
- the property list of the parent node
FOPException
- for errors or inconsistencies in the attributespublic void bind(PropertyList pList) throws FOPException
PropertyList
to be used when the retrieve-marker is resolved.
bind
in class AbstractRetrieveMarker
pList
- the PropertyList where the properties can be found.
FOPException
- if there is a problem binding the valuespublic void startOfNode() throws FOPException
FObj
startOfNode
in class FObj
FOPException
- FOP Exceptionpublic void endOfNode() throws FOPException
FObjMixed
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 FObjMixed
FOPException
- if there's a problem during processingprotected int findAncestor(int ancestorID)
findAncestor
in class FObj
ancestorID
- ID of node name to check for (e.g., FO_ROOT)
public int getRetrievePositionWithinTable()
retrieve-position-within-table
property
Constants.EN_FIRST_STARTING
,
Constants.EN_FIC
,
Constants.EN_LAST_STARTING
,
Constants.EN_LAST_ENDING
.public int getRetrieveBoundaryWithinTable()
retrieve-boundary-within-table
property
Constants.EN_TABLE
,
Constants.EN_TABLE_FRAGMENT
,
Constants.EN_PAGE
.public java.lang.String getLocalName()
getLocalName
in class AbstractRetrieveMarker
public int getNameId()
Constants
class integer value of this node
getNameId
in class AbstractRetrieveMarker
Constants.FO_RETRIEVE_TABLE_MARKER
public void clearChildNodes()
clearChildNodes
in class FObj
protected void restoreFOEventHandlerState()
restoreFOEventHandlerState
in class AbstractRetrieveMarker
|
fop 2.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |