org.geotools.styling
Interface Halo

All Superinterfaces:

GTComponent

All Known Implementing Classes:

HaloImpl

public interface Halo

extends GTComponent

A Halo fills an extended area outside the glyphs of a rendered textlabel to make it easier to read over a background.

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

 <xsd:element name="Halo">
   <xsd:annotation>
     <xsd:documentation>
      A "Halo" fills an extended area outside the glyphs of a rendered
       text label to make the label easier to read over a background.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:Radius" minOccurs="0"/>
       <xsd:element ref="sld:Fill" minOccurs="0"/>
     </xsd:sequence>
   </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:

• The graphical parameters and their values are derived from SVG/CSS2 standards with names and semantics which are as close as possible.

$Id: Halo.java 18021 2006-02-14 20:36:18Z jdeolive $

Author:

Ian Turton, CCG

Method Summary

void	accept(StyleVisitor visitor)
Fill	getFill() The fill (color) of the halo
Expression	getRadius() Expression that represents the the distance the halo extends from the text
void	setFill(Fill fill) The fill (color) of the halo
void	setRadius(Expression radius) Expression that represents the the distance the halo extends from the text

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Method Detail

getRadius

public Expression getRadius()

Expression that represents the the distance the halo extends from the text

Returns:

DOCUMENT ME!

setRadius

public void setRadius(Expression radius)

Expression that represents the the distance the halo extends from the text

Parameters:

radius - DOCUMENT ME!

getFill

public Fill getFill()

The fill (color) of the halo

Returns:

DOCUMENT ME!

setFill

public void setFill(Fill fill)

The fill (color) of the halo

Parameters:

fill - DOCUMENT ME!

accept

public void accept(StyleVisitor visitor)