org.apache.fop.render.ps.extensions

Class AbstractPSExtensionElement

java.lang.Object

org.apache.fop.fo.FONode

org.apache.fop.render.ps.extensions.AbstractPSExtensionElement

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

AbstractPSCommentElement, PSSetPageDeviceElement

public abstract class AbstractPSExtensionElement
extends FONode

Base class for the PostScript-specific extension elements.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.fop.fo.FONode

FONode.FONodeIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected PSExtensionAttachment	attachment extension attachment

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

FO_URI, FOX_URI, locator, log, parent, siblings

Constructor Summary

Constructors

Constructor and Description
AbstractPSExtensionElement(FONode parent) Default constructor

Method Summary

Methods

Modifier and Type	Method and Description
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	getNamespaceURI()
java.lang.String	getNormalNamespacePrefix()
protected abstract ExtensionAttachment	instantiateExtensionAttachment() Instantiates extension attachment object
protected void	validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) Blocks XSL FO's from having non-FO parents.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

attachment

protected PSExtensionAttachment attachment

extension attachment

Constructor Detail

AbstractPSExtensionElement

public AbstractPSExtensionElement(FONode parent)

Default constructor

Parameters:

parent - parent of this node

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

Blocks XSL FO's from having non-FO parents.

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:

FONode.validateChildNode(Locator, String, String)

addCharacters

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

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 - of data array to add

pList - currently applicable PropertyList

locator - location in fo source file.

See Also:

FONode.addCharacters(char[], int, int, PropertyList, Locator)

getNamespaceURI

public java.lang.String getNamespaceURI()

Overrides:

getNamespaceURI in class FONode

Returns:

a String representation of this object

See Also:

FONode.getNamespaceURI()

getNormalNamespacePrefix

public java.lang.String getNormalNamespacePrefix()

Specified by:

getNormalNamespacePrefix in class FONode

Returns:

a String representation of this object

See Also:

FONode.getNormalNamespacePrefix()

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()

instantiateExtensionAttachment

protected abstract ExtensionAttachment instantiateExtensionAttachment()

Instantiates extension attachment object

Returns:

extension attachment