|
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.FObjMixed
org.apache.fop.fo.flow.AbstractRetrieveMarker
public abstract class AbstractRetrieveMarker
Abstract base class for the
fo:retrieve-marker and
fo:retrieve-table-marker formatting objects.
| 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 | |
|---|---|
AbstractRetrieveMarker(FONode parent)
Create a new AbstractRetrieveMarker 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 |
bindMarker(Marker marker)
Clone the subtree of the given marker |
void |
changePositionTo(int position)
|
int |
getBoundary()
|
java.lang.String |
getBoundaryLabel()
|
abstract java.lang.String |
getLocalName()
Returns the local name (i.e. |
abstract int |
getNameId()
Returns the Constants class integer value of this node |
int |
getPosition()
|
java.lang.String |
getPositionLabel()
|
java.lang.String |
getRetrieveClassName()
Return the value for the retrieve-class-name
property |
StructureTreeElement |
getStructureTreeElement()
Returns the structure tree element associated to this object. |
protected abstract void |
restoreFOEventHandlerState()
|
protected void |
setBoundary(int boundary)
|
protected void |
setBoundaryLabel(java.lang.String label)
|
protected void |
setPosition(int position)
|
protected void |
setPositionLabel(java.lang.String label)
|
void |
setStructureTreeElement(StructureTreeElement structureTreeElement)
Sets the structure tree element. |
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.FObjMixed |
|---|
addChildNode, characters, charIterator, clone, endOfNode, finalizeNode, handleWhiteSpaceFor, removeChild |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractRetrieveMarker(FONode parent)
FONode
parent - the parent FONode| Method Detail |
|---|
protected 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 Content Model: empty
validateChildNode in class FONodeloc - 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 parent
public void bind(PropertyList pList)
throws FOPException
PropertyList
to be used when the retrieve-marker is resolved.
bind in class FObjpList - the PropertyList where the properties can be found.
FOPException - if there is a problem binding the valuespublic void setStructureTreeElement(StructureTreeElement structureTreeElement)
FONode
setStructureTreeElement in class FONodestructureTreeElement - set.public StructureTreeElement getStructureTreeElement()
FONode
getStructureTreeElement in class FONodepublic void bindMarker(Marker marker)
marker - the marker that is to be clonedprotected abstract void restoreFOEventHandlerState()
public java.lang.String getRetrieveClassName()
retrieve-class-name
property
protected void setBoundaryLabel(java.lang.String label)
protected void setPositionLabel(java.lang.String label)
public java.lang.String getBoundaryLabel()
public java.lang.String getPositionLabel()
protected void setPosition(int position)
protected void setBoundary(int boundary)
public int getPosition()
public int getBoundary()
public abstract java.lang.String getLocalName()
FONode
getLocalName in class FONodepublic abstract int getNameId()
FONodeConstants class integer value of this node
getNameId in class FONodeConstants.FO_ROOT)
if a formatting object, Constants.FO_UNKNOWN_NODE otherwisepublic void changePositionTo(int position)
|
fop 2.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||