org.axsl.output
Interface OutputTarget

All Known Subinterfaces:

Renderer

public interface OutputTarget

Interface for all output formats. This interface is sufficient for output targets that are really converters, i.e. that need no layout, that read directly from the FOTree. For output targets that require layout, i.e. that read from the AreaTree, see Renderer.

Method Summary

int[]	getFontSources() Indicates which font sources can be used by this OutputTarget.
boolean	outputStreamRequired() Indicates whether an OutputStream is required by this target.
void	setApplicationName(java.lang.String applicationName) Sets the application name meta-information item.
void	setApplicationNameShort(java.lang.String applicationNameShort) Sets a short version of the application name meta-information item.
void	setApplicationVersion(java.lang.String applicationVersion) Sets the application version meta-information item.
void	setDeveloperUrlShort(java.lang.String developerURLShort) Sets a short version of the developer's URL meta-information item.
void	setFontConsumer(FontConsumer fontConsumer) Sets the FontConsumer to be used for this output.
void	setOutputStream(java.io.OutputStream stream) Sets the OutputStream, if any, to which the output should be written.
void	setStrokeText(boolean stroke) Sets whether SVG Text should be stroked.
void	startOutput() Hook allowing the OutputTarget to initialize itself and prepare to render pages.
void	stopOutput() Hook allowing the OutputTarget to clean up.

Method Detail

outputStreamRequired

boolean outputStreamRequired()

Indicates whether an OutputStream is required by this target. Most targets write their output to a file, but others might print to a printer or display on screen.

Returns:

True iff an OutputStream is required by this target.

getFontSources

int[] getFontSources()

Indicates which font sources can be used by this OutputTarget.

Returns:

The array of valid font sources that can be used by this OutputTarget. Valid array values are FontConsumer.FONT_SOURCE_FREE_STANDING and FontConsumer.FONT_SOURCE_SYSTEM. The order of the array signifies the order of preference for selection purposes. For example, if both system fonts and free-standing fonts can be used, but free-standing fonts are preferred, the array should contain { FONT_SOURCE_FREE_STANDING, FONT_SOURCE_SYSTEM };

setOutputStream

void setOutputStream(java.io.OutputStream stream)

Sets the OutputStream, if any, to which the output should be written.

Parameters:

stream - The OutputStream to which the output should be written.

setApplicationName

void setApplicationName(java.lang.String applicationName)

Sets the application name meta-information item.

Parameters:

applicationName - The application name to set.

setApplicationNameShort

void setApplicationNameShort(java.lang.String applicationNameShort)

Sets a short version of the application name meta-information item.

Parameters:

applicationNameShort - The short application name to set.

setApplicationVersion

void setApplicationVersion(java.lang.String applicationVersion)

Sets the application version meta-information item.

Parameters:

applicationVersion - The application version to set.

setDeveloperUrlShort

void setDeveloperUrlShort(java.lang.String developerURLShort)

Sets a short version of the developer's URL meta-information item.

Parameters:

developerURLShort - The short developer URL to set.

setStrokeText

void setStrokeText(boolean stroke)

Sets whether SVG Text should be stroked.

Parameters:

stroke - Set to true for stroked text.

setFontConsumer

void setFontConsumer(FontConsumer fontConsumer)

Sets the FontConsumer to be used for this output.

Parameters:

fontConsumer - The FontConsumer to set.

startOutput

void startOutput()
                 throws OutputException

Hook allowing the OutputTarget to initialize itself and prepare to render pages.

Throws:

OutputException - For problems writing the output.

stopOutput

void stopOutput()
                throws OutputException

Hook allowing the OutputTarget to clean up.

Throws:

OutputException - For problems writing the output.