org.deegree.graphics.sld
Interface Halo

All Known Implementing Classes:

Halo_Impl

public interface Halo

Incarnation of a sld:Halo-element. A Halo is a type of Fill that is applied to the backgrounds of font glyphs. The use of halos greatly improves the readability of text labels.

Version:

$Revision: 1.6 $ $Date: 2004/04/27 15:40:16 $

Author:

Andreas Poth, Markus Schneider

Method Summary

Fill	getFill() A Fill allows area geometries to be filled.
ParameterValueType	getRadius() The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number.
double	getRadius(Feature feature) The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number.
Stroke	getStroke() Returns the underlying Stroke-instance used to draw the boundary of the halo.
void	setFill(Fill fill) Sets the Fill for the Halo.
void	setRadius(double radius)
void	setRadius(ParameterValueType radius) Sets the Radius for the Halo.
void	setStroke(Stroke stroke) Sets the Stroke for the Halo.

Method Detail

getFill

public Fill getFill()

A Fill allows area geometries to be filled. There are two types of fills: solid-color and repeated GraphicFill. In general, if a Fill element is omitted in its containing element, no fill will be rendered. The default is a solid 50%-gray (color "#808080") opaque fill.

Returns:

the underlying Fill-object, or null

setFill

public void setFill(Fill fill)

Sets the Fill for the Halo.

Parameters:

fill - defines the fill color and pattern

getStroke

public Stroke getStroke()

Returns the underlying Stroke-instance used to draw the boundary of the halo.

Returns:

the underlying Stroke-object, or null

setStroke

public void setStroke(Stroke stroke)

Sets the Stroke for the Halo.

Parameters:

stroke - defines the stroke color and pattern

getRadius

public ParameterValueType getRadius()

The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number. The radius is taken from the outside edge of a font glyph to extend the area of coverage of the glyph (and the inside edge of holes in the glyphs). The halo of a text label is considered to be a single shape. The default radius is one pixel. Negative values are not allowed.

Returns:

the radius definition as ParameterValueType, or null if it has not been specified

setRadius

public void setRadius(ParameterValueType radius)

Sets the Radius for the Halo.

Parameters:

radius - radius to be used for the halo, use null for a rectangle styled halo

getRadius

public double getRadius(Feature feature)
                 throws FilterEvaluationException

The Radius element gives the absolute size of a halo radius in pixels encoded as a floating-point number. The radius is taken from the outside edge of a font glyph to extend the area of coverage of the glyph (and the inside edge of holes in the glyphs). The halo of a text label is considered to be a single shape. The default radius is one pixel. Negative values are not allowed.

Parameters:

feature - specifies the Feature to be used for evaluation of the underlying 'sld:ParameterValueType'

Returns:

the radius value, or -1 if it has not been specified

Throws:

FilterEvaluationException - if the evaluation fails

setRadius

public void setRadius(double radius)

Parameters:

radius - radius to be set for the halo

See Also: