com.luciad.ogc.sld.model

LuciadFusionClass TLcdSLDTextSymbolizer

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.ogc.sld.model.ALcdSLDSymbolizer

com.luciad.ogc.sld.model.TLcdSLDTextSymbolizer

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable

public class TLcdSLDTextSymbolizer
extends ALcdSLDSymbolizer

A TextSymbolizer contains styling information to render text labels according to various graphical parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdSLDTextSymbolizer.Builder<T> A builder for SLD text symbolizers.

Constructor Summary

Constructors

Constructor and Description
TLcdSLDTextSymbolizer() Empty constructor.
TLcdSLDTextSymbolizer(TLcdDataType aDataType) Empty constructor.
TLcdSLDTextSymbolizer(TLcdSLDGeometry aGeometry, TLcdSLDParameterValue aLabel, TLcdSLDFont aFont, TLcdSLDLabelPlacement aLabelPlacement, TLcdSLDHalo aHalo, TLcdSLDFill aFill) Constructor for given parameters.

Method Summary

Modifier and Type	Method and Description
TLcdSLDFill	getFill() Returns the value of the property that maps to the Fill element.
TLcdSLDFont	getFont() Returns the value of the property that maps to the Font element.
TLcdSLDGeometry	getGeometry() Returns the value of the property that maps to the Geometry element.
TLcdSLDGraphic	getGraphic() Returns the value of the property that maps to the Graphic element.
TLcdSLDHalo	getHalo() Returns the value of the property that maps to the Halo element.
TLcdSLDParameterValue	getLabel() Returns the value of the property that maps to the Label element.
TLcdSLDLabelPlacement	getLabelPlacement() Returns the value of the property that maps to the LabelPlacement element.
List<TLcdSLDVendorOption>	getVendorOptions() Returns the value of the property that maps to the VendorOption element.
static TLcdSLDTextSymbolizer.Builder<TLcdSLDTextSymbolizer>	newBuilder() Creates a new builder with the default values.
void	setFill(TLcdSLDFill aValue) Sets the value of the property that maps to the Fill element.
void	setFont(TLcdSLDFont aValue) Sets the value of the property that maps to the Font element.
void	setGeometry(TLcdSLDGeometry aValue) Sets the value of the property that maps to the Geometry element.
void	setGraphic(TLcdSLDGraphic aValue) Sets the value of the property that maps to the Graphic element.
void	setHalo(TLcdSLDHalo aValue) Sets the value of the property that maps to the Halo element.
void	setLabel(TLcdSLDParameterValue aValue) Sets the value of the property that maps to the Label element.
void	setLabelPlacement(TLcdSLDLabelPlacement aValue) Sets the value of the property that maps to the LabelPlacement element.

Methods inherited from class com.luciad.ogc.sld.model.ALcdSLDSymbolizer

getDescription, getName, getUom, getVersion, setDescription, setName, setUom, setVersion, toString

Methods inherited from class com.luciad.datamodel.TLcdDataObject

clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TLcdSLDTextSymbolizer

public TLcdSLDTextSymbolizer()

Empty constructor.

TLcdSLDTextSymbolizer

public TLcdSLDTextSymbolizer(TLcdSLDGeometry aGeometry,
                             TLcdSLDParameterValue aLabel,
                             TLcdSLDFont aFont,
                             TLcdSLDLabelPlacement aLabelPlacement,
                             TLcdSLDHalo aHalo,
                             TLcdSLDFill aFill)

Constructor for given parameters.

Parameters:

aGeometry - the given geometry.

aLabel - the given label.

aFont - the given font.

aLabelPlacement - the given label placement.

aHalo - the given halo.

aFill - the given fill.

TLcdSLDTextSymbolizer

public TLcdSLDTextSymbolizer(TLcdDataType aDataType)

Empty constructor.

Method Detail

newBuilder

public static TLcdSLDTextSymbolizer.Builder<TLcdSLDTextSymbolizer> newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

Since:

2012.1

getGeometry

public TLcdSLDGeometry getGeometry()

Returns the value of the property that maps to the Geometry element.

A Geometry gives reference to a (the) geometry property of a feature to be used for rendering. The geometry is optional and may thus be null. If null, the default geometry of an object should be rendered with a stroke. E.g. when a ILcdModel contains ILcdShape objects, the geometry may be null as the object itself is a geometry.

Returns:

the value of the GEOMETRY_PROPERTY property.

setGeometry

public void setGeometry(TLcdSLDGeometry aValue)

Sets the value of the property that maps to the Geometry element.

A Geometry gives reference to a (the) geometry property of a feature to be used for rendering. The geometry is optional and may thus be null. If null, the default geometry of an object should be rendered with a stroke. E.g. when a ILcdModel contains ILcdShape objects, the geometry may be null as the object itself is a geometry.

Parameters:

aValue - the value to set for the GEOMETRY_PROPERTY property.

getLabel

public TLcdSLDParameterValue getLabel()

Returns the value of the property that maps to the Label element.

A "Label" specifies the textual content to be rendered. Null is allowed.

Returns:

the value of the LABEL_PROPERTY property.

setLabel

public void setLabel(TLcdSLDParameterValue aValue)

Sets the value of the property that maps to the Label element.

A "Label" specifies the textual content to be rendered. Null is allowed.

Parameters:

aValue - the value to set for the LABEL_PROPERTY property.

getFont

public TLcdSLDFont getFont()

Returns the value of the property that maps to the Font element.

A "Font" element specifies the text font to use. The allowed CssParameters are: "font-family", "font-style", "font-weight", and "font-size".

Returns:

the value of the FONT_PROPERTY property.

setFont

public void setFont(TLcdSLDFont aValue)

Sets the value of the property that maps to the Font element.

A "Font" element specifies the text font to use. The allowed CssParameters are: "font-family", "font-style", "font-weight", and "font-size".

Parameters:

aValue - the value to set for the FONT_PROPERTY property.

getLabelPlacement

public TLcdSLDLabelPlacement getLabelPlacement()

Returns the value of the property that maps to the LabelPlacement element.

The "LabelPlacement" specifies where and how a text label should be rendered relative to a geometry. The present mechanism is poorly aligned with CSS/SVG.

Returns:

the value of the LABEL_PLACEMENT_PROPERTY property.

setLabelPlacement

public void setLabelPlacement(TLcdSLDLabelPlacement aValue)

Sets the value of the property that maps to the LabelPlacement element.

The "LabelPlacement" specifies where and how a text label should be rendered relative to a geometry. The present mechanism is poorly aligned with CSS/SVG.

Parameters:

aValue - the value to set for the LABEL_PLACEMENT_PROPERTY property.

getHalo

public TLcdSLDHalo getHalo()

Returns the value of the property that maps to the Halo element.

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

Returns:

the value of the HALO_PROPERTY property.

setHalo

public void setHalo(TLcdSLDHalo aValue)

Sets the value of the property that maps to the Halo element.

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

Parameters:

aValue - the value to set for the HALO_PROPERTY property.

getFill

public TLcdSLDFill getFill()

Returns the value of the property that maps to the Fill element.

A "Fill" specifies the pattern for filling an area geometry. The allowed CssParameters are: "fill" (color) and "fill-opacity".

Returns:

the value of the FILL_PROPERTY property.

setFill

public void setFill(TLcdSLDFill aValue)

Sets the value of the property that maps to the Fill element.

A "Fill" specifies the pattern for filling an area geometry. The allowed CssParameters are: "fill" (color) and "fill-opacity".

Parameters:

aValue - the value to set for the FILL_PROPERTY property.

getGraphic

public TLcdSLDGraphic getGraphic()

Returns the value of the property that maps to the Graphic element.

A "Graphic" specifies or refers to a "graphic symbol" with inherent shape, size, and coloring.

Returns:

the value of the GRAPHIC_PROPERTY property.

setGraphic

public void setGraphic(TLcdSLDGraphic aValue)

Sets the value of the property that maps to the Graphic element.

A "Graphic" specifies or refers to a "graphic symbol" with inherent shape, size, and coloring.

Parameters:

aValue - the value to set for the GRAPHIC_PROPERTY property.

getVendorOptions

public List<TLcdSLDVendorOption> getVendorOptions()

Returns the value of the property that maps to the VendorOption element.

Returns:

the value of the VENDOR_OPTION_PROPERTY property.