Package org.geotools.styling

Class TextSymbolizerImpl

Object

AbstractSymbolizer

TextSymbolizerImpl

All Implemented Interfaces:

Cloneable, Symbolizer, TextSymbolizer, Cloneable

public class TextSymbolizerImpl
extends AbstractSymbolizer
implements TextSymbolizer, Cloneable

Provides a Java representation of an SLD TextSymbolizer that defines how text symbols should be rendered.

Author:

Ian Turton, CCG, Johann Sorel (Geomatys)

Nested Class Summary

Nested classes/interfaces inherited from interface TextSymbolizer

TextSymbolizer.DisplacementMode, TextSymbolizer.GraphicPlacement, TextSymbolizer.PolygonAlignOptions

Field Summary

Fields inherited from class AbstractSymbolizer

geometry, name, options, unitOfMeasure

Fields inherited from interface TextSymbolizer

ALLOW_OVERRUNS_KEY, AUTO_WRAP_KEY, CHAR_SPACING_KEY, CONFLICT_RESOLUTION_KEY, DEFAULT_ALLOW_OVERRUNS, DEFAULT_AUTO_WRAP, DEFAULT_CHAR_SPACING, DEFAULT_CONFLICT_RESOLUTION, DEFAULT_FOLLOW_LINE, DEFAULT_FONT_SHRINK_SIZE_MIN, DEFAULT_FORCE_LEFT_TO_RIGHT, DEFAULT_GOODNESS_OF_FIT, DEFAULT_GROUP, DEFAULT_KERNING, DEFAULT_LABEL_ALL_GROUP, DEFAULT_LABEL_REPEAT, DEFAULT_MAX_ANGLE_DELTA, DEFAULT_MAX_DISPLACEMENT, DEFAULT_MIN_GROUP_DISTANCE, DEFAULT_PARTIALS, DEFAULT_POLYGONALIGN, DEFAULT_REMOVE_OVERLAPS, DEFAULT_SPACE_AROUND, DEFAULT_STRIKETHROUGH_TEXT, DEFAULT_UNDERLINE_TEXT, DEFAULT_WORD_SPACING, DISPLACEMENT_MODE_KEY, FOLLOW_LINE_KEY, FONT_SHRINK_SIZE_MIN, FORCE_LEFT_TO_RIGHT_KEY, GOODNESS_OF_FIT_KEY, GRAPHIC_MARGIN_KEY, GRAPHIC_PLACEMENT_KEY, GRAPHIC_RESIZE_KEY, GROUP_KEY, KERNING_KEY, LABEL_ALL_GROUP_KEY, LABEL_REPEAT_KEY, MAX_ANGLE_DELTA_KEY, MAX_DISPLACEMENT_KEY, MIN_GROUP_DISTANCE_KEY, PARTIALS_KEY, POLYGONALIGN_KEY, REMOVE_OVERLAPS_KEY, SPACE_AROUND_KEY, STRIKETHROUGH_TEXT_KEY, UNDERLINE_TEXT_KEY, WORD_SPACING_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextSymbolizerImpl()
protected	TextSymbolizerImpl(FilterFactory factory)	Creates a new instance of DefaultTextSymbolizer
protected	TextSymbolizerImpl(FilterFactory factory, Description desc, String name, Unit<Length> uom)

Method Summary

Modifier and Type	Method	Description
void	accept(StyleVisitor visitor)
Object	accept(TraversingStyleVisitor visitor, Object data)	Accept a StyleVisitor to perform an operation on this symbolizer.
void	addFont(Font font)	Setter for property font.
Object	clone()	Creates a deep copy clone.
boolean	equals(Object obj)
List<Font>	fonts()	Direct access to device independent Fonts used to render the label.
Expression	getFeatureDescription()	Description is used by text oriented renders such as KML and RSS to specify a feature's description
Fill	getFill()	Returns the fill to be used to fill the text when rendered.
Font	getFont()	Returns the Font to apply on the text.
Graphic	getGraphic()	The nonstandard-SLD graphic element supports putting little graphical-bits onto labels.
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.
OtherText	getOtherText()	Other text can be used to allow open ended extensions on text oriented output formats
Expression	getPriority()	Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
Expression	getSnippet()	Abstract is used by text oriented renderers such as KML and RSS to specify an abstract (RSS) or a snippet (KML)
int	hashCode()
void	setFeatureDescription(Expression description)
void	setFill(Fill fill)	Setter for property fill.
void	setFont(Font font)	Set initial font used to render label.
void	setGraphic(Graphic graphic)	The nonstandard-SLD graphic element supports putting little graphical-bits onto labels.
void	setHalo(Halo halo)	Setter for property halo.
void	setLabel(Expression label)	Setter for property label.
void	setLabelPlacement(LabelPlacement labelPlacement)	Setter for property labelPlacement.
void	setOtherText(OtherText otherText)
void	setPriority(Expression priority)	Priority -- null = use the default labeling priority Expression = an expression that evaluates to a number (ie.
void	setSnippet(Expression abxtract)
String	toString()

Methods inherited from class AbstractSymbolizer

getDescription, getGeometry, getGeometryPropertyName, getName, getOptions, getUnitOfMeasure, hasOption, setDescription, setGeometry, setGeometryPropertyName, setName, setUnitOfMeasure

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Symbolizer

getDescription, getGeometry, getGeometryPropertyName, getName, getUnitOfMeasure, hasOption, setDescription, setGeometry, setGeometryPropertyName, setName, setUnitOfMeasure

Methods inherited from interface TextSymbolizer

getOptions

Constructor Detail

TextSymbolizerImpl

protected TextSymbolizerImpl()

TextSymbolizerImpl

protected TextSymbolizerImpl(FilterFactory factory)

Creates a new instance of DefaultTextSymbolizer

TextSymbolizerImpl

protected TextSymbolizerImpl(FilterFactory factory,
                             Description desc,
                             String name,
                             Unit<Length> uom)

Method Detail

getFill

public Fill getFill()

Returns the fill to be used to fill the text when rendered.

Specified by:

getFill in interface TextSymbolizer

Returns:

The fill to be used.

setFill

public void setFill(Fill fill)

Setter for property fill.

Specified by:

setFill in interface TextSymbolizer

Parameters:

fill - New value of property fill.

fonts

public List<Font> fonts()

Description copied from interface: TextSymbolizer

Direct access to device independent Fonts used to render the label. Fonts are used in order of priority given.

Specified by:

fonts in interface TextSymbolizer

Returns:

device independent Font used to render the label.

getFont

public Font getFont()

Description copied from interface: TextSymbolizer

Returns the Font to apply on the text.

Specified by:

getFont in interface TextSymbolizer

Returns:

Font

setFont

public void setFont(Font font)

Description copied from interface: TextSymbolizer

Set initial font used to render label. This will replace the initial entry in the TextSymbolizer.fonts() list.

Specified by:

setFont in interface TextSymbolizer

addFont

public void addFont(Font font)

Setter for property font.

Parameters:

font - New value of property font.

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.

Specified by:

getHalo in interface TextSymbolizer

setHalo

public void setHalo(Halo halo)

Setter for property halo.

Specified by:

setHalo in interface TextSymbolizer

Parameters:

halo - New value of property halo.

getLabel

public Expression getLabel()

Returns the label expression.

Specified by:

getLabel in interface TextSymbolizer

Returns:

Label expression.

setLabel

public void setLabel(Expression label)

Setter for property label.

Specified by:

setLabel in interface TextSymbolizer

Parameters:

label - New value of property label.

getLabelPlacement

public LabelPlacement getLabelPlacement()

A pointPlacement specifies how a text element should be rendered relative to its geometric point.

Specified by:

getLabelPlacement in interface TextSymbolizer

Returns:

Value of property labelPlacement.

setLabelPlacement

public void setLabelPlacement(LabelPlacement labelPlacement)

Setter for property labelPlacement.

Specified by:

setLabelPlacement in interface TextSymbolizer

Parameters:

labelPlacement - New value of property labelPlacement.

accept

public Object accept(TraversingStyleVisitor visitor,
                     Object data)

Accept a StyleVisitor to perform an operation on this symbolizer.

Specified by:

accept in interface Symbolizer

Specified by:

accept in interface TextSymbolizer

Parameters:

visitor - The StyleVisitor to accept.

Returns:

value produced

accept

public void accept(StyleVisitor visitor)

Specified by:

accept in interface Symbolizer

clone

public Object clone()

Creates a deep copy clone. TODO: Need to complete the deep copy, currently only shallow copy.

Specified by:

clone in interface Cloneable

Overrides:

clone in class Object

Returns:

The deep copy clone.

See Also:

Object.clone()

setPriority

public void setPriority(Expression priority)

Description copied from interface: TextSymbolizer

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

Specified by:

setPriority in interface TextSymbolizer

getPriority

public Expression getPriority()

Description copied from interface: TextSymbolizer

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

Specified by:

getPriority in interface TextSymbolizer

getGraphic

public Graphic getGraphic()

Description copied from interface: TextSymbolizer

The nonstandard-SLD graphic element supports putting little graphical-bits onto labels. Useful for things like interstate road shields or labeled logos

Specified by:

getGraphic in interface TextSymbolizer

Returns:

- the Graphic object to be rendered under the label text

setGraphic

public void setGraphic(Graphic graphic)

Description copied from interface: TextSymbolizer

The nonstandard-SLD graphic element supports putting little graphical-bits onto labels. Useful for things like interstate road shields or labeled logos

Specified by:

setGraphic in interface TextSymbolizer

Parameters:

graphic - - the Graphic object which will be rendered under the label text

toString

public String toString()

Overrides:

toString in class Object

getSnippet

public Expression getSnippet()

Description copied from interface: TextSymbolizer

Abstract is used by text oriented renderers such as KML and RSS to specify an abstract (RSS) or a snippet (KML)

Specified by:

getSnippet in interface TextSymbolizer

setSnippet

public void setSnippet(Expression abxtract)

Specified by:

setSnippet in interface TextSymbolizer

getFeatureDescription

public Expression getFeatureDescription()

Description copied from interface: TextSymbolizer

Description is used by text oriented renders such as KML and RSS to specify a feature's description

Specified by:

getFeatureDescription in interface TextSymbolizer

setFeatureDescription

public void setFeatureDescription(Expression description)

Specified by:

setFeatureDescription in interface TextSymbolizer

getOtherText

public OtherText getOtherText()

Description copied from interface: TextSymbolizer

Other text can be used to allow open ended extensions on text oriented output formats

Specified by:

getOtherText in interface TextSymbolizer

setOtherText

public void setOtherText(OtherText otherText)

Specified by:

setOtherText in interface TextSymbolizer

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSymbolizer

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSymbolizer