org.foray.output
Class OutputTarget

java.lang.Object
  org.foray.output.OutputTarget

All Implemented Interfaces:

org.axsl.output.OutputTarget

Direct Known Subclasses:

Converter, Renderer

public abstract class OutputTarget
extends Object
implements org.axsl.output.OutputTarget

Abstract superclass for all Renderers and Converters.

Constructor Summary

OutputTarget(org.apache.commons.logging.Log logger)
Constructor.

Method Summary

String	getApplicationName() Returns the name of the application creating the output.
String	getApplicationNameShort() Returns the short name of the application creating the output.
String	getApplicationVersion() Returna the current version of the application that is creating the output.
String	getDeveloperURLShort() Returns a short version of the URL of the developer.
org.axsl.font.FontConsumer	getFontConsumer() Returns the FontConsumer.
org.apache.commons.logging.Log	getLogger() Returns the logger.
abstract org.axsl.output.OutputConfiguration	getOutputConfiguration() Returns the output configuration for this renderer.
OutputStream	getOutputStream() Returns the OutputStream.
boolean	getStrokeSVGText() Indicates whether SVG text should be converted to strokes.
boolean	outputStreamRequired() Subclasses that do not need an OutputStream should override this.
void	setApplicationName(String applicationName)
void	setApplicationNameShort(String applicationNameShort)
void	setApplicationVersion(String applicationVersion)
void	setDeveloperUrlShort(String developerURLShort)
void	setFontConsumer(org.axsl.font.FontConsumer fontConsumer)
void	setOutputStream(OutputStream stream)
void	setStrokeText(boolean stroke)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axsl.output.OutputTarget

getFontSources, startOutput, stopOutput

Constructor Detail

OutputTarget

public OutputTarget(org.apache.commons.logging.Log logger)

Constructor.

Parameters:

logger - The logger.

Method Detail

getLogger

public org.apache.commons.logging.Log getLogger()

Returns the logger.

Returns:

The logger.

getFontConsumer

public org.axsl.font.FontConsumer getFontConsumer()

Returns the FontConsumer.

Returns:

The FontConsumer implementation which should be used by this Renderer.

setOutputStream

public void setOutputStream(OutputStream stream)

Specified by:

setOutputStream in interface org.axsl.output.OutputTarget

getOutputStream

public OutputStream getOutputStream()

Returns the OutputStream.

Returns:

The OutputStream.

outputStreamRequired

public boolean outputStreamRequired()

Subclasses that do not need an OutputStream should override this.

Specified by:

outputStreamRequired in interface org.axsl.output.OutputTarget

getApplicationName

public String getApplicationName()

Returns the name of the application creating the output.

Returns:

The name of the application creating the output.

setApplicationName

public void setApplicationName(String applicationName)

Specified by:

setApplicationName in interface org.axsl.output.OutputTarget

getApplicationNameShort

public String getApplicationNameShort()

Returns the short name of the application creating the output.

Returns:

The "short" name of the application that is creating the output. For example, if the name of the application is "XYZ Document Processor", the short name might be "XYZ".

setApplicationNameShort

public void setApplicationNameShort(String applicationNameShort)

Specified by:

setApplicationNameShort in interface org.axsl.output.OutputTarget

getApplicationVersion

public String getApplicationVersion()

Returna the current version of the application that is creating the output.

Returns:

The current version of the application that is creating the output.

setApplicationVersion

public void setApplicationVersion(String applicationVersion)

Specified by:

setApplicationVersion in interface org.axsl.output.OutputTarget

getDeveloperURLShort

public String getDeveloperURLShort()

Returns a short version of the URL of the developer.

Returns:

The shortened version of the URL to the home-page of the developer. For example, if the URL is "http://www.xyz.com", return "www.xyz.com".

setDeveloperUrlShort

public void setDeveloperUrlShort(String developerURLShort)

Specified by:

setDeveloperUrlShort in interface org.axsl.output.OutputTarget

setStrokeText

public void setStrokeText(boolean stroke)

Specified by:

setStrokeText in interface org.axsl.output.OutputTarget

getStrokeSVGText

public boolean getStrokeSVGText()

Indicates whether SVG text should be converted to strokes.

Returns:

True if SVG text should be converted to strokes instead of rendered as characters of a Font.

setFontConsumer

public void setFontConsumer(org.axsl.font.FontConsumer fontConsumer)

Specified by:

setFontConsumer in interface org.axsl.output.OutputTarget

getOutputConfiguration

public abstract org.axsl.output.OutputConfiguration getOutputConfiguration()

Returns the output configuration for this renderer.

Returns:

The output configuration for this renderer.