org.apache.fop.render.afp.extensions
Class AbstractAFPExtensionObject

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.render.afp.extensions.AbstractAFPExtensionObject

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AFPElement, AFPPageSetupElement

public abstract class AbstractAFPExtensionObject

extends FONode

Base class for the AFP-specific extension elements.

Field Summary

Fields inherited from class org.apache.fop.fo.FONode

FO_URI, locator, log, parent

Constructor Summary

AbstractAFPExtensionObject(FONode parent, java.lang.String name)

Method Summary

protected void	addCharacters(char[] data, int start, int length, PropertyList pList, org.xml.sax.Locator locator) Adds characters (does nothing here)
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.
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.
java.lang.String	getLocalName() Returns the local name (i.e.
java.lang.String	getNamespaceURI()
java.lang.String	getNormalNamespacePrefix()
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 the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor

Methods inherited from class org.apache.fop.fo.FONode

addChildNode, attributeError, attributeWarning, canHaveMarkers, charIterator, clone, clone, createPropertyList, decorateWithContextInfo, errorText, gatherContextInfo, getChildNodes, getChildNodes, getContentHandlerFactory, getContextInfo, getFOEventHandler, getLocator, getLocatorString, getLogger, getName, getName, getNameId, getNodeString, getParent, getRoot, getUserAgent, inMarker, invalidChildError, invalidChildError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, removeChild, setLocator, startOfNode, tooManyNodesError, tooManyNodesError, warningText

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAFPExtensionObject

public AbstractAFPExtensionObject(FONode parent,
                                  java.lang.String name)

Parameters:

parent - the parent formatting object

name - the name of the afp element

See Also:

FONode.FONode(FONode)

Method Detail

validateChildNode

protected void validateChildNode(org.xml.sax.Locator loc,
                                 java.lang.String nsURI,
                                 java.lang.String localName)
                          throws ValidationException

Description copied from class: FONode

Checks to make sure, during SAX processing of input document, that the incoming node is valid for the this (parent) node (e.g., checking to see that fo:table is not an immediate child of fo:root) called within FObj constructor

Overrides:

validateChildNode in class FONode

Parameters:

loc - location in the FO source file

nsURI - namespace of incoming node

localName - (e.g. "table" for "fo:table")

Throws:

ValidationException - if incoming node not valid for parent

See Also:

here, blocks XSL FO's from having non-FO parents.

addCharacters

protected void addCharacters(char[] data,
                             int start,
                             int length,
                             PropertyList pList,
                             org.xml.sax.Locator locator)

Description copied from class: FONode

Adds characters (does nothing here)

Overrides:

addCharacters in class FONode

Parameters:

data - array of characters containing text to be added

start - starting array element to add

length - ending array element to add

pList - currently applicable PropertyList

locator - location in fo source file.

See Also:

FONode

getNamespaceURI

public java.lang.String getNamespaceURI()

Overrides:

getNamespaceURI in class FONode

Returns:

the namespace URI for this node

See Also:

FONode.getNamespaceURI()

getNormalNamespacePrefix

public java.lang.String getNormalNamespacePrefix()

Specified by:

getNormalNamespacePrefix in class FONode

Returns:

the normally ussed namespace prefix for this kind of node (ex. "fo" for XSL-FO)

See Also:

FONode.getNormalNamespacePrefix()

processNode

public void processNode(java.lang.String elementName,
                        org.xml.sax.Locator locator,
                        org.xml.sax.Attributes attlist,
                        PropertyList propertyList)
                 throws FOPException

Description copied from class: FONode

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.

Overrides:

processNode in class FONode

Parameters:

elementName - 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

Throws:

FOPException - for errors or inconsistencies in the attributes

See Also:

FONode.processNode(java.lang.String, org.xml.sax.Locator, org.xml.sax.Attributes, org.apache.fop.fo.PropertyList)

endOfNode

protected void endOfNode()
                  throws FOPException

Description copied from class: FONode

Primarily used for making final content model validation checks and/or informing the FOEventHandler that the end of this FO has been reached.

Overrides:

endOfNode in class FONode

Throws:

FOPException - if there's a problem during processing

See Also:

FONode.endOfNode()

getExtensionAttachment

public ExtensionAttachment getExtensionAttachment()

Description copied from class: FONode

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.

Overrides:

getExtensionAttachment in class FONode

Returns:

the extension attachment if one is created by the extension element, null otherwise.

See Also:

FONode.getExtensionAttachment()

getLocalName

public java.lang.String getLocalName()

Description copied from class: FONode

Returns the local name (i.e. without namespace prefix) of the node

Specified by:

getLocalName in class FONode

Returns:

the local name of this node

See Also:

FONode.getLocalName()