DocumentNavigationHandler (Apache FOP 2.1 API)

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - org.apache.fop.render.intermediate.extensions.DocumentNavigationHandler

All Implemented Interfaces:

DocumentNavigationExtensionConstants, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
```
public class DocumentNavigationHandler
extends org.xml.sax.helpers.DefaultHandler
implements DocumentNavigationExtensionConstants
```
ContentHandler that handles the IF document navigation namespace.

Field Summary

Fields
Modifier and Type Field Description

protected static org.apache.commons.logging.Log log
Logger instance
- Fields inherited from interface org.apache.fop.render.intermediate.extensions.DocumentNavigationExtensionConstants
  BOOKMARK, BOOKMARK_TREE, GOTO_URI, GOTO_XY, LINK, NAMED_DESTINATION, NAMESPACE, PREFIX

Fields
Modifier and Type	Field	Description
`protected static org.apache.commons.logging.Log`	`log`	Logger instance

Constructor Summary

Constructors
Constructor	Description
`DocumentNavigationHandler(IFDocumentNavigationHandler navHandler, java.util.Map<java.lang.String,StructureTreeElement> structureTreeElements)`	Main constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`characters(char[] ch, int start, int length)`
`void`	`endDocument()`
`void`	`endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)`
`void`	`startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes)`

Methods inherited from class org.xml.sax.helpers.DefaultHandler
endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.apache.commons.logging.Log log

Logger instance

Constructor Detail
- DocumentNavigationHandler
```
public DocumentNavigationHandler(IFDocumentNavigationHandler navHandler,
                                 java.util.Map<java.lang.String,StructureTreeElement> structureTreeElements)
```
  Main constructor.
  
  Parameters:
  
  navHandler - the navigation handler that will receive the events
  
  structureTreeElements - the elements representing the structure of the document

Method Detail

startElement

public void startElement(java.lang.String uri,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attributes)
                  throws org.xml.sax.SAXException

Specified by:: startElement in interface org.xml.sax.ContentHandler
Overrides:: startElement in class org.xml.sax.helpers.DefaultHandler
Throws:: org.xml.sax.SAXException

endElement

public void endElement(java.lang.String uri,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

Specified by:: endElement in interface org.xml.sax.ContentHandler
Overrides:: endElement in class org.xml.sax.helpers.DefaultHandler
Throws:: org.xml.sax.SAXException

characters
```
public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
```
Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

endDocument
```
public void endDocument()
                 throws org.xml.sax.SAXException
```
Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

Throws:

org.xml.sax.SAXException

Class DocumentNavigationHandler

Field Summary

Fields inherited from interface org.apache.fop.render.intermediate.extensions.DocumentNavigationExtensionConstants

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.helpers.DefaultHandler

Methods inherited from class java.lang.Object

Field Detail

log

Constructor Detail

DocumentNavigationHandler

Method Detail

startElement

endElement

characters

endDocument