org.deegree.graphics.sld
Interface TextSymbolizer

All Superinterfaces:

Symbolizer

All Known Implementing Classes:

TextSymbolizer_Impl

public interface TextSymbolizer

extends Symbolizer

Used to render a text label, according to the parameters. A missing Geometry, Label, Font, or LabelPlacement element selects the default value or behavior for the element. The default Label, Font, and LabelPlacement are system- dependent. Multiple Font elements may be used to specify alternate fonts in order of preference in case a map server does not support the first preference. A missing Halo or Fill element means that no halo or fill will be plotted, respectively. The Fill is rendered over top of the Halo, and the Halo includes the interiors of the font glyphs.

----------------------------------------------------------------------

Version:

$Revision: 1.6 $ $Date: 2004/01/26 08:15:37 $

Author:

Andreas Poth

Method Summary

Fill	getFill() A Fill allows area geometries to be filled.
Font	getFont() Identifies a Font of a certain family, style, and size.
Halo	getHalo() A Halo is an extension (sub-type) of a Fill and is applied to the backgrounds of font glyphs.
ParameterValueType	getLabel() returns the Label as a ParameterValueType to be renderd
LabelPlacement	getLabelPlacement() Used to position a label relative to a point or a line string.
void	setFill(Fill fill) Sets the Fill.
void	setFont(Font font) sets the Font
void	setHalo(Halo halo) Sets the Halo.
void	setLabel(ParameterValueType label) sets the Label as a ParameterValueType to be renderd
void	setLabelPlacement(LabelPlacement labelPlacement) Sets the LabelPlacement

Methods inherited from interface org.deegree.graphics.sld.Symbolizer

getGeometry, getMaxScaleDenominator, getMinScaleDenominator, setGeometry, setMaxScaleDenominator, setMinScaleDenominator

Method Detail

getLabel

public ParameterValueType getLabel()

returns the Label as a ParameterValueType to be renderd

Returns:

the label

setLabel

public void setLabel(ParameterValueType label)

sets the Label as a ParameterValueType to be renderd

Parameters:

label - the label

getFont

public Font getFont()

Identifies a Font of a certain family, style, and size.

Returns:

the font

setFont

public void setFont(Font font)

sets the Font

Parameters:

font - the font

getLabelPlacement

public LabelPlacement getLabelPlacement()

Used to position a label relative to a point or a line string. For a point, you can specify the anchor point of the label and a linear displacement from the point (so that you can also plot a graphic symbol at the point). For a line-string placement, you can specify a perpendicular offset (so you can draw a stroke on the line).

MORE PARAMETERS ARE PROBABLY NEEDED HERE.

Returns:

the labelPlacement

setLabelPlacement

public void setLabelPlacement(LabelPlacement labelPlacement)

Sets the LabelPlacement

Parameters:

labelPlacement - the labelPlacement

getHalo

public Halo getHalo()

A Halo is an extension (sub-type) of a Fill and is applied to the backgrounds of font glyphs. Either a Radius or a Block halo type can be used. The radius is computed from the outside edge of the font glyph (or inside of "holes"). The default is a Radius of 1.0 (pixels) but if no Halo is selected in a containing structure, no halo will be rendered. The default is a solid white (Color "#FFFFFF") opaque halo.

Returns:

the halo

setHalo

public void setHalo(Halo halo)

Sets the Halo.

Parameters:

halo - the halo

getFill

public Fill getFill()

A Fill allows area geometries to be filled. There are two types of fills: solid-color and repeated GraphicFill. In general, if a Fill element is omitted in its containing element, no fill will be rendered. The default is a solid 50%-gray (color "#808080") opaque fill.

Returns:

the fill

setFill

public void setFill(Fill fill)

Sets the Fill.

Parameters:

fill - the fill