org.apache.fop.fo
Class FOTreeBuilder

java.lang.Object
  org.xml.sax.helpers.DefaultHandler
      org.apache.fop.fo.FOTreeBuilder

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class FOTreeBuilder
extends org.xml.sax.helpers.DefaultHandler

SAX Handler that passes parsed data to the various FO objects, where they can be used either to build an FO Tree, or used by Structure Renderers to build other data structures.

Field Summary

protected org.xml.sax.ContentHandler	delegate Current delegate ContentHandler to receive the SAX events
protected ElementMappingRegistry	elementMappingRegistry The registry for ElementMapping instances
protected org.apache.commons.logging.Log	log logging instance
protected org.apache.fop.fo.FOTreeBuilder.MainFOHandler	mainFOHandler Main DefaultHandler that handles the FO namespace.
protected Root	rootFObj The root of the formatting object tree

Constructor Summary

FOTreeBuilder(java.lang.String outputFormat, FOUserAgent foUserAgent, java.io.OutputStream stream)
FOTreeBuilder constructor

Method Summary

void	characters(char[] data, int start, int length) SAX Handler for characters
void	endDocument() SAX Handler for the end of the document
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String rawName) SAX Handler for the end of an element
void	error(org.xml.sax.SAXParseException e)
void	fatalError(org.xml.sax.SAXParseException e)
protected org.xml.sax.Locator	getEffectiveLocator()
FOEventHandler	getEventHandler() Provides access to the underlying FOEventHandler object.
FormattingResults	getResults() Returns the results of the rendering process.
protected boolean	isLocatorDisabled() Deprecated. Use FOUserAgent.isLocatorEnabled() instead.
void	setDocumentLocator(org.xml.sax.Locator locator) SAX Handler for locator
void	startDocument() SAX Handler for the start of the document
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attlist) SAX Handler for the start of an element
void	warning(org.xml.sax.SAXParseException e)

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

endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

logging instance

elementMappingRegistry

protected ElementMappingRegistry elementMappingRegistry

The registry for ElementMapping instances

rootFObj

protected Root rootFObj

The root of the formatting object tree

mainFOHandler

protected org.apache.fop.fo.FOTreeBuilder.MainFOHandler mainFOHandler

Main DefaultHandler that handles the FO namespace.

delegate

protected org.xml.sax.ContentHandler delegate

Current delegate ContentHandler to receive the SAX events

Constructor Detail

FOTreeBuilder

public FOTreeBuilder(java.lang.String outputFormat,
                     FOUserAgent foUserAgent,
                     java.io.OutputStream stream)
              throws FOPException

FOTreeBuilder constructor

Parameters:

outputFormat - the MIME type of the output format to use (ex. "application/pdf").

foUserAgent - in effect for this process

stream - OutputStream to direct results

Throws:

FOPException - if the FOTreeBuilder cannot be properly created

Method Detail

isLocatorDisabled

protected boolean isLocatorDisabled()

Deprecated. Use FOUserAgent.isLocatorEnabled() instead.

This method enables to reduce memory consumption of the FO tree slightly. When it returns true no Locator is passed to the FO tree nodes which would copy the information into a SAX LocatorImpl instance.

Returns:

true if no context information should be stored on each node in the FO tree.

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

SAX Handler for locator

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

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

See Also:

ContentHandler.setDocumentLocator(Locator)

getEffectiveLocator

protected org.xml.sax.Locator getEffectiveLocator()

Returns:

a Locator instance if it is available and not disabled

characters

public void characters(char[] data,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

SAX Handler for characters

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

See Also:

ContentHandler.characters(char[], int, int)

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

SAX Handler for the start of the document

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

See Also:

ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

SAX Handler for the end of the document

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

See Also:

ContentHandler.endDocument()

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attlist)
                  throws org.xml.sax.SAXException

SAX Handler for the start of an element

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

See Also:

ContentHandler.startElement(String, String, String, Attributes)

endElement

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

SAX Handler for the end of an element

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

See Also:

ContentHandler.endElement(String, String, String)

warning

public void warning(org.xml.sax.SAXParseException e)

Specified by:

warning in interface org.xml.sax.ErrorHandler

Overrides:

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

See Also:

ErrorHandler.warning(org.xml.sax.SAXParseException)

error

public void error(org.xml.sax.SAXParseException e)

Specified by:

error in interface org.xml.sax.ErrorHandler

Overrides:

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

See Also:

ErrorHandler.error(org.xml.sax.SAXParseException)

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Overrides:

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

Throws:

org.xml.sax.SAXException

See Also:

ErrorHandler.fatalError(org.xml.sax.SAXParseException)

getEventHandler

public FOEventHandler getEventHandler()

Provides access to the underlying FOEventHandler object.

Returns:

the FOEventHandler object

getResults

public FormattingResults getResults()

Returns the results of the rendering process. Information includes the total number of pages generated and the number of pages per page-sequence.

Returns:

the results of the rendering process.