|
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.render.afp.extensions.AbstractAFPExtensionObject
Base class for the AFP-specific extension elements.
| Nested Class Summary |
| Nested classes inherited from class org.apache.fop.fo.FONode |
FONode.FONodeIterator, FONode.GatherContextInfoFunction |
| Field Summary | |
protected AFPExtensionAttachment |
extensionAttachment
the AFP extension attachment |
protected java.lang.String |
name
the element name of this extension |
| Fields inherited from class org.apache.fop.fo.FONode |
FO_URI, FOX_URI, locator, log, parent, siblings |
| Constructor Summary | |
AbstractAFPExtensionObject(FONode parent,
java.lang.String name)
|
|
| Method Summary | |
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()
|
ExtensionAttachment |
getExtensionAttachment()
This method is overridden by extension elements and allows the extension element to return a pass-through attachment which the parent formatting objects should simply carry with them but otherwise ignore. This mechanism is used to pass non-standard information from the FO tree through to the layout engine and the renderers. |
java.lang.String |
getLocalName()
Returns the local name (i.e. without namespace prefix) of the node |
java.lang.String |
getNamespaceURI()
Returns the namespace URI for this node |
java.lang.String |
getNormalNamespacePrefix()
Returns the normally used namespace prefix for this node |
protected abstract ExtensionAttachment |
instantiateExtensionAttachment()
Instantiates extension attachment object |
void |
processNode(java.lang.String elementName,
org.xml.sax.Locator locator,
org.xml.sax.Attributes attlist,
PropertyList propertyList)
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 |
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, toString, wait, wait, wait |
| Field Detail |
protected AFPExtensionAttachment extensionAttachment
protected java.lang.String name
| Constructor Detail |
public AbstractAFPExtensionObject(FONode parent,
java.lang.String name)
parent - the parent formatting objectname - the name of the afp elementFONode.FONode(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.
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 parentpublic java.lang.String getNamespaceURI()
getNamespaceURI in class FONodepublic java.lang.String getNormalNamespacePrefix()
getNormalNamespacePrefix in class FONode
public void processNode(java.lang.String elementName,
org.xml.sax.Locator locator,
org.xml.sax.Attributes attlist,
PropertyList propertyList)
throws FOPException
processNode in class FONodeelementName - element name (e.g., "fo:block")locator - Locator object (ignored by default)attlist - Collection of attributes passed to us from the parser.propertyList - the property list of the parent node
FOPException - for errors or inconsistencies in the attributes
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 FONodeFOPException - if there's a problem during processingprotected abstract ExtensionAttachment instantiateExtensionAttachment()
public ExtensionAttachment getExtensionAttachment()
getExtensionAttachment in class FONodepublic java.lang.String getLocalName()
getLocalName in class FONode
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||