org.axsl.fo

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

Modifier and Type	Method and Description
FontConsumer	getFontConsumer() Return the FontConsumer for this tree.
GraphicServer	getGraphicServer() Return the GraphicServer for this tree.
HyphenationConsumer	getHyphenationConsumer() Return the HyphenationConsumer for this tree.
Root	getRootFo() Returns the fo:root that was parsed.
SpeechServer	getSpeechServer() Return the SpeechServer for this tree.
TextServer	getTextServer() Return the TextServer for this tree.
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	setHyphenationConsumer(HyphenationConsumer hyphenationConsumer) Allows the client application to set the HyphenationConsumer which may be used during FO tree parsing or building.
void	setSpeechServer(SpeechServer server) Allows the client application to set the SpeechServer 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

boolean hasData()

Indicates whether the document had any data in it.

Returns:

True iff the document had any data in it.

getRootFo

Root getRootFo()

Returns the fo:root that was parsed.

Returns:

The fo:root that was parsed.

registerListener

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

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.

getGraphicServer

GraphicServer getGraphicServer()

Return the GraphicServer for this tree.

Returns:

The GraphicServer for this tree.

setTextServer

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.

getTextServer

TextServer getTextServer()

Return the TextServer for this tree.

Returns:

The TextServer for this tree.

setFontConsumer

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.

getFontConsumer

FontConsumer getFontConsumer()

Return the FontConsumer for this tree.

Returns:

The FontConsumer for this tree.

setSpeechServer

void setSpeechServer(SpeechServer server)

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

Parameters:

server - The SpeechServer which should be used during FO tree parsing or building.

getSpeechServer

SpeechServer getSpeechServer()

Return the SpeechServer for this tree.

Returns:

The SpeechServer for this tree.

setHyphenationConsumer

void setHyphenationConsumer(HyphenationConsumer hyphenationConsumer)

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

Parameters:

hyphenationConsumer - The HyphenationConsumer which should be used during FO tree parsing or building.

getHyphenationConsumer

HyphenationConsumer getHyphenationConsumer()

Return the HyphenationConsumer for this tree.

Returns:

The HyphenationConsumer for this tree.

setGraphicSearchPath

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

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.