|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FoTree
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 | |
---|---|
FontConsumer |
getFontConsumer()
Return the FontConsumer for this tree. |
GraphicServer |
getGraphicServer()
Return the GraphicServer 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 |
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 |
---|
boolean hasData()
Root getRootFo()
void registerListener(FoTreeListener listener)
FoTreeEvent
firings.
listener
- The listener object which should be notified about
FoTreeEvent
firings.void setGraphicServer(GraphicServer graphicServer)
GraphicServer
which
should be used during FO tree parsing or building.
graphicServer
- The GraphicServer
which should be used
during FO tree parsing or building.GraphicServer getGraphicServer()
void setTextServer(TextServer textServer)
TextServer
which
should be used during FO tree parsing or building.
textServer
- The TextServer
which should be used
during FO tree parsing or building.TextServer getTextServer()
void setFontConsumer(FontConsumer consumer)
FontConsumer
which
should be used during FO tree parsing or building.
consumer
- The FontConsumer
which should be used
during FO tree parsing or building.FontConsumer getFontConsumer()
void setSpeechServer(SpeechServer server)
SpeechServer
which
should be used during FO tree parsing or building.
server
- The SpeechServer
which should be used
during FO tree parsing or building.SpeechServer getSpeechServer()
void setGraphicSearchPath(java.net.URL[] graphicSearchPath)
graphicSearchPath
- The array of URLs that should be searched when
looking for external graphic files during FO tree parsing or building.void setCachingGraphics(boolean cachingGraphics)
cachingGraphics
- Set to true iff caching should be enabled during
FO tree parsing or building.
|
aXSL API 0.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This documentation was created August 8 2007 by The aXSL Group and may be freely copied. See license for details.