org.geotools.styling
Interface TextSymbolizer

All Superinterfaces:
Symbolizer, TextSymbolizer
All Known Subinterfaces:
TextSymbolizer2
All Known Implementing Classes:
TextSymbolizerImpl

public interface TextSymbolizer
extends TextSymbolizer, Symbolizer

A symbolizer describes how a feature should appear on a map.

A symbolizer is obtained by specifying one of a small number of different types of symbolizer and then supplying parameters to override its default behaviour.

The text symbolizer describes how to display text labels and the like.

The details of this object are taken from the OGC Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.:


 <xsd:element name="TextSymbolizer" substitutionGroup="sld:Symbolizer">
   <xsd:annotation>
     <xsd:documentation>
       A "TextSymbolizer" is used to render text labels according to
       various graphical parameters.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:complexContent>
       <xsd:extension base="sld:SymbolizerType">
         <xsd:sequence>
           <xsd:element ref="sld:Geometry" minOccurs="0"/>
           <xsd:element ref="sld:Label" minOccurs="0"/>
           <xsd:element ref="sld:Font" minOccurs="0"/>
           <xsd:element ref="sld:LabelPlacement" minOccurs="0"/>
           <xsd:element ref="sld:Halo" minOccurs="0"/>
           <xsd:element ref="sld:Fill" minOccurs="0"/>
         </xsd:sequence>
       </xsd:extension>
     </xsd:complexContent>
   </xsd:complexType>
 </xsd:element>
 

Renderers can use this information when displaying styled features, though it must be remembered that not all renderers will be able to fully represent strokes as set out by this interface. For example, opacity may not be supported.

Notes:

$Id: TextSymbolizer.java 33833 2009-09-04 12:26:28Z jive $

Author:
Ian Turton, CCG
Module:
modules/library/api (gt-api.jar)

Method Summary
 void addToOptions(String key, String value)
          Deprecated. Please use getOptions().put( key, value )
 Fill getFill()
          Returns the object that indicates how the text will be filled.
 Font getFont()
          Font to use when rendering this symbolizer.
 Font[] getFonts()
          Deprecated. use getFont()
 Halo getHalo()
          A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background.
 Expression getLabel()
          Returns the expression that will be evaluated to determine what text is displayed.
 LabelPlacement getLabelPlacement()
          A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.
 String getOption(String key)
          Deprecated. Please use getOptions.get( key )
 Map<String,String> getOptions()
          return the map of option
 LabelPlacement getPlacement()
          Deprecated. Please use getLabelPlacement()
 Expression getPriority()
          Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
 void setFill(Fill fill)
          Sets the object that indicates how the text will be filled.
 void setFont(Font font)
          Font used when rendering this symbolizer.
 void setFonts(Font[] fonts)
          Deprecated. use getFont() setters to modify the set of font faces used
 void setGeometryPropertyName(String name)
          This property defines the geometry to be used for styling.
 void setHalo(Halo halo)
          A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background.
 void setLabel(Expression label)
          Sets the expression that will be evaluated to determine what text is displayed.
 void setLabelPlacement(LabelPlacement labelPlacement)
          A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.
 void setPlacement(LabelPlacement labelPlacement)
          Deprecated. Please use setLabelPlacement
 void setPriority(Expression e)
          Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
 
Methods inherited from interface TextSymbolizer
accept
 
Methods inherited from interface Symbolizer
getGeometryPropertyName, getName, getUnitOfMeasure
 
Methods inherited from interface Symbolizer
accept, getDescription, setDescription, setName, setUnitOfMeasure
 
Methods inherited from interface Symbolizer
getGeometryPropertyName, getName, getUnitOfMeasure
 

Method Detail

getLabel

Expression getLabel()
Returns the expression that will be evaluated to determine what text is displayed.

Specified by:
getLabel in interface TextSymbolizer
Returns:
Expression that will be evaulated as a String to display on screen

setLabel

void setLabel(Expression label)
Sets the expression that will be evaluated to determine what text is displayed. See getLabel() for details.


getFonts

Font[] getFonts()
Deprecated. use getFont()

Returns a device independent Font object that is to be used to render the label.


getFont

Font getFont()
Font to use when rendering this symbolizer.

Specified by:
getFont in interface TextSymbolizer
Returns:
Font to use when rendering this symbolizer

setFont

void setFont(Font font)
Font used when rendering this symbolizer.

Parameters:
font -

setFonts

void setFonts(Font[] fonts)
Deprecated. use getFont() setters to modify the set of font faces used

sets a list of device independent Font objects to be used to render the label.


getLabelPlacement

LabelPlacement getLabelPlacement()
A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.

Specified by:
getLabelPlacement in interface TextSymbolizer

setLabelPlacement

void setLabelPlacement(LabelPlacement labelPlacement)
A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.


setPlacement

void setPlacement(LabelPlacement labelPlacement)
Deprecated. Please use setLabelPlacement

A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.


getPlacement

LabelPlacement getPlacement()
Deprecated. Please use getLabelPlacement()

A LabelPlacement specifies how a text element should be rendered relative to its geometric point or line.


getHalo

Halo getHalo()
A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background.

Specified by:
getHalo in interface TextSymbolizer

setHalo

void setHalo(Halo halo)
A halo fills an extended area outside the glyphs of a rendered text label to make the label easier to read over a background.


getFill

Fill getFill()
Returns the object that indicates how the text will be filled.

Specified by:
getFill in interface TextSymbolizer

setFill

void setFill(Fill fill)
Sets the object that indicates how the text will be filled. See getFill() for details.


setGeometryPropertyName

void setGeometryPropertyName(String name)
This property defines the geometry to be used for styling.
The property is optional and if it is absent (null) then the "default" geometry property of the feature should be used. Geometry types other than inherently point types can be used. The geometryPropertyName is the name of a geometry property in the Feature being styled. Typically, features only have one geometry so, in general, the need to select one is not required. Note: this moves a little away from the SLD spec which provides an XPath reference to a Geometry object, but does follow it in spirit.

Parameters:
name - The name of the attribute in the feature being styled that should be used. If null then the default geometry should be used.

setPriority

void setPriority(Expression e)
Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie. Integer, Long, Double...) Larger = more likely to be rendered


getPriority

Expression getPriority()
Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie. Integer, Long, Double...) Larger = more likely to be rendered


addToOptions

void addToOptions(String key,
                  String value)
Deprecated. Please use getOptions().put( key, value )

Adds a parameter value to the options map


getOption

String getOption(String key)
Deprecated. Please use getOptions.get( key )

Find the value of a key in the map (may return null)

Parameters:
key -

getOptions

Map<String,String> getOptions()
return the map of option

Returns:
null - no options set


Copyright © 1996-2009 Geotools. All Rights Reserved.