|
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.FObjMixed
org.apache.fop.fo.flow.Marker
Class modelling the
fo:marker
object.
Nested Class Summary | |
static class |
Marker.MarkerAttribute
Convenience inner class |
protected class |
Marker.MarkerPropertyList
An implementation of PropertyList which only stores the explicitly
specified properties/attributes as bundles of name-value-namespace
strings |
Nested classes inherited from class org.apache.fop.fo.FObj |
FObj.FObjIterator |
Nested classes 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 |
Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, FOX_URI, locator, log, parent, siblings |
Constructor Summary | |
Marker(FONode parent)
Create a marker fo. |
Method Summary | |
void |
bind(PropertyList pList)
Bind property values from the property list to the FO node. Must be overridden in all FObj subclasses that have properties applying to it. |
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.
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()
|
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
java.lang.String |
getMarkerClassName()
|
int |
getNameId()
Returns the Constants class integer value of this node |
protected Marker.MarkerPropertyList |
getPropertyListFor(FONode foNode)
Retrieve the property list of the given FONode
descendant |
protected boolean |
inMarker()
Indicates whether this node is a child of an fo:marker. |
protected void |
startOfNode()
Called after processNode() is called. Subclasses can do additional processing. |
java.lang.String |
toString()
|
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 .
XSL Content Model: (#PCDATA|%inline;|%block;)* Additionally: "An fo:marker may contain any formatting objects that are permitted as a replacement of any fo:retrieve-marker that retrieves the fo:marker's children." |
Methods inherited from class org.apache.fop.fo.FObjMixed |
addChildNode, characters, charIterator, finalizeNode, handleWhiteSpaceFor |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Marker(FONode parent)
parent
- the parent FONode
Method 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 Marker.MarkerPropertyList getPropertyListFor(FONode foNode)
FONode
descendant
foNode
- the FONode
whose property list is requested
Marker.MarkerPropertyList
for the given nodeprotected void startOfNode()
startOfNode
in class FObj
protected 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 FObjMixed
FOPException
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
.
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 parentprotected boolean inMarker()
inMarker
in class FONode
public java.lang.String getMarkerClassName()
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_MARKER
public java.lang.String toString()
toString
in class FObj
|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |