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, FONode.GatherContextInfoFunction
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
internalDestination
private Root
root
-
Fields inherited from class org.apache.fop.fo.FONode
FO_URI, FOX_URI, locator, log, nodeChangeBarList, parent, siblings, startOfNodeChangeBarList
-
-
Constructor Summary
Constructors Constructor Description Destination(FONode parent)
Constructs a Destination object (called by Maker).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
endOfNode()
Primarily used for making final content model validation checks and/or informing theFOEventHandler
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.java.lang.String
getNamespaceURI()
Returns the namespace URI for this nodejava.lang.String
getNormalNamespacePrefix()
Returns the normally used namespace prefix for this nodevoid
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 this (parent) node (e.g., checking to see thatfo:table
is not an immediate child offo:root
) called fromFOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the childFObj
.-
Methods inherited from class org.apache.fop.fo.FONode
addCharacters, addChildNode, attachSiblings, bind, canHaveMarkers, characters, charIterator, clone, clone, collectDelimitedTextRanges, collectDelimitedTextRanges, createPropertyList, decorateWithContextInfo, errorText, finalizeNode, gatherContextInfo, getBuilderContext, getChangeBarList, getChildNodes, getChildNodes, getContentHandlerFactory, getContextInfo, getContextInfoAlt, getExtensionAttachment, getFOEventHandler, getFOValidationEventProducer, getLocator, getLocatorString, getLogger, getName, getName, getNameId, getNodePrefix, getNodeString, getParent, getRoot, getStructureTreeElement, getUserAgent, inMarker, invalidChildError, invalidChildError, invalidPropertyValueError, isBidiRangeBlockItem, isChangeBarElement, isDelimitedTextRangeBoundary, missingChildElementError, missingChildElementError, missingPropertyError, nodesOutOfOrderError, nodesOutOfOrderError, notSupportedChildError, removeChild, setLocator, setStructureTreeElement, startOfNode, tooManyNodesError, tooManyNodesError, tooManyNodesError, validateChildNode, warningText
-
-
-
-
Field Detail
-
internalDestination
private java.lang.String internalDestination
-
root
private Root root
-
-
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
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 classFONode
- 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
-
endOfNode
public void endOfNode() throws FOPException
Primarily used for making final content model validation checks and/or informing theFOEventHandler
that the end of this FO has been reached. The default implementation simply callsFONode.finalizeNode()
, without sending any event to theFOEventHandler
.Note: the recommended way to override this method in subclasses is
super.endOfNode(); // invoke finalizeNode()
getFOEventHandler().endXXX(); // send endOfNode() notification
- Overrides:
endOfNode
in classFONode
- Throws:
FOPException
- if there's a problem during processing
-
validateChildNode
protected void validateChildNode(org.xml.sax.Locator loc, java.lang.String nsURI, java.lang.String localName) throws ValidationException
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 thatfo:table
is not an immediate child offo:root
) called fromFOTreeBuilder.startElement(String, String, String, Attributes)
before constructing the childFObj
. XSL/FOP: empty- Overrides:
validateChildNode
in classFONode
- Parameters:
loc
- location in the FO source filensURI
- namespace of incoming nodelocalName
- name of the incoming node (without namespace prefix)- Throws:
ValidationException
- if incoming node not valid for parent
-
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()
Returns the namespace URI for this node- Overrides:
getNamespaceURI
in classFONode
- Returns:
- the namespace URI for this node
-
getNormalNamespacePrefix
public java.lang.String getNormalNamespacePrefix()
Returns the normally used namespace prefix for this node- Specified by:
getNormalNamespacePrefix
in classFONode
- Returns:
- the normally used namespace prefix for this kind of node (ex. "fo" for XSL-FO)
-
getLocalName
public java.lang.String getLocalName()
Returns the local name (i.e. without namespace prefix) of the node- Specified by:
getLocalName
in classFONode
- Returns:
- the local name of this node
-
-