org.geotools.styling
Interface TextSymbolizer

All Superinterfaces:
Symbolizer
All Known Implementing Classes:
TextSymbolizerImpl

public interface TextSymbolizer
extends Symbolizer

$Id: TextSymbolizer.java,v 1.7 2003/08/06 18:11:24 desruisseaux Exp $

Author:
Ian Turton, CCG

Method Summary
 void accept(StyleVisitor visitor)
           
 void addToOptions(java.lang.String key, java.lang.String value)
          adds a parameter value to the options map
 Fill getFill()
          Returns the fill to be used to fill the text when rendered.
 Font[] getFonts()
          Returns a device independent Font object that is to be used to render the label.
 java.lang.String getGeometryPropertyName()
          This property defines the geometry to be used for styling.
 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 label expression.
 LabelPlacement getLabelPlacement()
          A pointPlacement specifies how a text element should be rendered relative to its geometric point.
 java.lang.String getOption(java.lang.String key)
          Find the value of a key in the map (may return null)
 java.util.Map getOptions()
          return the map of option
 Expression getPriority()
          Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
 void setFill(Fill fill)
          sets the fill to be used to fill the text when rendered.
 void setFonts(Font[] fonts)
          sets a list of device independent Font objects to be used to render the label.
 void setGeometryPropertyName(java.lang.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 label expression.
 void setLabelPlacement(LabelPlacement labelPlacement)
          A pointPlacement specifies how a text element should be rendered relative to its geometric point.
 void setPriority(Expression e)
          Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
 

Method Detail

getLabel

public Expression getLabel()
Returns the label expression.


setLabel

public void setLabel(Expression label)
sets the label expression.


getFonts

public Font[] getFonts()
Returns a device independent Font object that is to be used to render the label.


setFonts

public void setFonts(Font[] fonts)
sets a list of device independent Font objects to be used to render the label.


getLabelPlacement

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


setLabelPlacement

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


getHalo

public 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.


setHalo

public 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

public Fill getFill()
Returns the fill to be used to fill the text when rendered.


setFill

public void setFill(Fill fill)
sets the fill to be used to fill the text when rendered.


getGeometryPropertyName

public java.lang.String getGeometryPropertyName()
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.

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

setGeometryPropertyName

public void setGeometryPropertyName(java.lang.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

public 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

Parameters:
e -

getPriority

public 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

public void addToOptions(java.lang.String key,
                         java.lang.String value)
adds a parameter value to the options map

Parameters:
key -
value -

getOption

public java.lang.String getOption(java.lang.String key)
Find the value of a key in the map (may return null)

Parameters:
key -
Returns:

getOptions

public java.util.Map getOptions()
return the map of option

Returns:
null - no options set

accept

public void accept(StyleVisitor visitor)
Specified by:
accept in interface Symbolizer


Copyright © GeoTools. All Rights Reserved.