Interface Halo

  • All Superinterfaces:
    Halo
    All Known Implementing Classes:
    HaloImpl

    public interface Halo
    extends Halo
    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$
    Author:
    Ian Turton, CCG
    • Method Detail

      • setRadius

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

        Fill getFill()
        The fill (color) of the halo
        Specified by:
        getFill in interface Halo
        Returns:
        fill (color) of the halo
      • setFill

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