org.axsl.foR
Interface FOTree

All Superinterfaces:

org.xml.sax.ContentHandler

public interface FOTree

extends org.xml.sax.ContentHandler

An FOTree is created for each document that is processed. Its purpose is to provide client applications with a means to set the various system components that should be used during FO tree parsing or building, and then to return the high-level parsed objects back to the client application.

To obtain an FOTree instance, first get an instance of FOTreeFactory, and then use its FOTreeFactory.makeFOTree() method.

Method Summary

Root	getRootFObj() Returns the fo:root that was parsed.
boolean	hasData() Indicates whether the document had any data in it.
void	registerListener(FOTreeListener listener) Registers a listener for notification of FOTreeEvent firings.
void	setCachingGraphics(boolean cachingGraphics) Allows the client application to set whether graphics should be cached during FO tree parsing or building.
void	setFontConsumer(FontConsumer consumer) Allows the client application to set the FontConsumer which should be used during FO tree parsing or building.
void	setGraphicSearchPath(java.net.URL[] graphicSearchPath) Allows the client application to set an array of URLs that should be searched when looking for external graphic files during FO tree parsing or building.
void	setGraphicServer(GraphicServer graphicServer) Allows the client application to set the GraphicServer which should be used during FO tree parsing or building.
void	setTextServer(TextServer textServer) Allows the client application to set the TextServer which should be used during FO tree parsing or building.

Methods inherited from interface org.xml.sax.ContentHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping

Method Detail

hasData

public boolean hasData()

Indicates whether the document had any data in it.

Returns:

True iff the document had any data in it.

getRootFObj

public Root getRootFObj()

Returns the fo:root that was parsed.

Returns:

The fo:root that was parsed.

registerListener

public void registerListener(FOTreeListener listener)

Registers a listener for notification of FOTreeEvent firings.

Parameters:

listener - The listener object which should be notified about FOTreeEvent firings.

setGraphicServer

public void setGraphicServer(GraphicServer graphicServer)

Allows the client application to set the GraphicServer which should be used during FO tree parsing or building.

Parameters:

graphicServer - The GraphicServer which should be used during FO tree parsing or building.

setTextServer

public void setTextServer(TextServer textServer)

Allows the client application to set the TextServer which should be used during FO tree parsing or building.

Parameters:

textServer - The TextServer which should be used during FO tree parsing or building.

setFontConsumer

public void setFontConsumer(FontConsumer consumer)

Allows the client application to set the FontConsumer which should be used during FO tree parsing or building.

Parameters:

consumer - The FontConsumer which should be used during FO tree parsing or building.

setGraphicSearchPath

public void setGraphicSearchPath(java.net.URL[] graphicSearchPath)

Allows the client application to set an array of URLs that should be searched when looking for external graphic files during FO tree parsing or building.

Parameters:

graphicSearchPath - The array of URLs that should be searched when looking for external graphic files during FO tree parsing or building.

setCachingGraphics

public void setCachingGraphics(boolean cachingGraphics)

Allows the client application to set whether graphics should be cached during FO tree parsing or building.

Parameters:

cachingGraphics - Set to true iff caching should be enabled during FO tree parsing or building.