Package org.geotools.api.style

Interface Halo

All Known Implementing Classes:
HaloImpl
public interface Halo
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.
Since:
GeoAPI 2.2
Author:
Open Geospatial Consortium, Johann Sorel (Geomatys), Chris Dillard (SYS Technologies)

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(StyleVisitor visitor)
     
    Object
    accept(TraversingStyleVisitor visitor, Object extraData)
    calls the visit method of a StyleVisitor
    Fill
    getFill()
    Returns the object that indicates how the halo area around the text should be filled.
    Expression
    getRadius()
    Returns the expression that will be evaluated to get the pixel radius of the halo around 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

  • Method Details

    • setRadius

      void setRadius(Expression radius)
      Expression that represents the the distance the halo extends from the text

    • getFill

      Fill getFill()
      Returns the object that indicates how the halo area around the text should be filled.

      The default halo fill is solid white (Color “#FFFFFF”). The glyph’s fill is plotted on top of the halo. The default font fill is solid black (Color “#000000”).

      Returns:
      Fill or null

    • getRadius

      Expression getRadius()
      Returns the expression that will be evaluated to get the pixel radius of the halo around the text.

      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:
      Expression or null

    • accept

      Object accept(TraversingStyleVisitor visitor, Object extraData)
      calls the visit method of a StyleVisitor
      Parameters:
      visitor - the style visitor

    • setFill

      void setFill(Fill fill)
      The fill (color) of the halo

    • accept

      void accept(StyleVisitor visitor)