org.apache.fop.fo.extensions.destination
Class Destination

java.lang.Object
  org.apache.fop.fo.FONode
      org.apache.fop.fo.extensions.destination.Destination

All Implemented Interfaces:

java.lang.Cloneable

public class Destination
extends FONode

Class for named destinations in PDF.

Nested Class Summary

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

FONode.FONodeIterator

Field Summary

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

FO_URI, FOX_URI, locator, log, parent, siblings

Constructor Summary

Destination(FONode parent)
Constructs a Destination object (called by Maker).

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.
java.lang.String	getInternalDestination() Returns the internal destination (an reference of the id property of any FO).
java.lang.String	getLocalName() Returns the local name (i.e. without namespace prefix) of the node
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 pList) 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

addCharacters, addChildNode, attachSiblings, attributeError, attributeWarning, bind, canHaveMarkers, charIterator, clone, clone, createPropertyList, decorateWithContextInfo, errorText, gatherContextInfo, getChildNodes, getChildNodes, getContentHandlerFactory, getContextInfo, getExtensionAttachment, 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

Destination

public Destination(FONode parent)

Constructs a Destination object (called by Maker).

Parameters:

parent - the parent formatting object

Method Detail

processNode

public void processNode(java.lang.String elementName,
                        org.xml.sax.Locator locator,
                        org.xml.sax.Attributes attlist,
                        PropertyList pList)
                 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.

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

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:

XSL/FOP: empty

getInternalDestination

public java.lang.String getInternalDestination()

Returns the internal destination (an reference of the id property of any FO).

Returns:

the internal destination

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

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