org.axsl.graphic.output

Interface GraphicOutputContext

public interface GraphicOutputContext

Provides contextual information to a GraphicOutput implementation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFontName(FontUse fontUse) For a given FontUse instance, returns the name by which the font is referred within the output document.
java.lang.String	getGradientName(Gradient gradient) For a given Gradient instance, returns the name by which the gradient is referred within the output document.

Method Detail

getFontName

java.lang.String getFontName(FontUse fontUse)

For a given FontUse instance, returns the name by which the font is referred within the output document. This is useful only in vector-based graphic formats, like SVG, where text can be written using fonts. For example, a PostScript or PDF document may name a given font something like "Fx", where "x" is a sequentially assigned number, perhaps "F2". Although the Graphic system has a handle to the FontUse instance itself, it has no way of knowing by what name it should refer to that font when using it to write text.

Parameters:

fontUse - The FontUse instance for which a name is needed.

Returns:

The font name to be used when writing content to the output document.

getGradientName

java.lang.String getGradientName(Gradient gradient)

For a given Gradient instance, returns the name by which the gradient is referred within the output document. The graphic system has no way of knowing what internal name a PostScript or PDF document has assigned to a given gradient, so this method is used to find out.

Parameters:

gradient - The Gradient instance for which a name is needed.

Returns:

The name to be used to describe gradient when writing content to the output document.