org.opengis.style
Interface TextSymbolizer

Show UML class diagram

All Superinterfaces:

Symbolizer

@XmlElement(value="TextSymbolizer")
public interface TextSymbolizer
extends Symbolizer

Indicates how text will be drawn.

Since:

GeoAPI 2.2

Version:

Symbology Encoding Implementation Specification 1.1.0

Method Summary

Object	accept(StyleVisitor visitor, Object extraData) calls the visit method of a StyleVisitor
Fill	getFill() Returns the object that indicates how the text will be filled.
Font	getFont() Returns the Font to apply on the text.
Halo	getHalo() Returns the object that indicates if a Halo will be drawn around the text.
Expression	getLabel() Returns the expression that will be evaluated to determine what text is displayed.
LabelPlacement	getLabelPlacement() Returns the object that indicates how the text should be placed with respect to the feature geometry.

Methods inherited from interface Symbolizer

getDescription, getGeometryPropertyName, getName, getUnitOfMeasure

Method Detail

getLabel

@XmlElement(value="Label")
Expression getLabel()

Returns the expression that will be evaluated to determine what text is displayed. If a Label element is not provided in a TextSymbolizer, then no text shall be rendered.

Returns:

Expression

getFont

@XmlElement(value="Font")
Font getFont()

Returns the Font to apply on the text.

Returns:

Font

getLabelPlacement

@XmlElement(value="LabelPlacement")
LabelPlacement getLabelPlacement()

Returns the object that indicates how the text should be placed with respect to the feature geometry. This object will either be an instance of LinePlacement or PointPlacement.

Returns:

LinePlacement or PointPlacement.

getHalo

@XmlElement(value="Halo")
Halo getHalo()

Returns the object that indicates if a Halo will be drawn around the text. If null, a halo will not be drawn.

Returns:

Halo

getFill

@XmlElement(value="Fill")
Fill getFill()

Returns the object that indicates how the text will be filled.

Returns:

Fill

accept

@Extension
Object accept(StyleVisitor visitor,
                        Object extraData)

calls the visit method of a StyleVisitor

Specified by:

accept in interface Symbolizer

Parameters:

visitor - the style visitor

Returns:

value produced