Package org.geotools.styling

Interface LinePlacement

  • All Superinterfaces:
    LabelPlacement, LabelPlacement, LinePlacement
    All Known Implementing Classes:
    LinePlacementImpl
    public interface LinePlacement
extends LinePlacement, LabelPlacement
    The "LinePlacement" specifies where and how a text label should be rendered relative to a line.

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

    
 <xsd:element name="LinePlacement">
   <xsd:annotation>
     <xsd:documentation>
       A "LinePlacement" specifies how a text label should be rendered
       relative to a linear geometry.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:PerpendicularOffset" minOccurs="0"/>
     </xsd:sequence>
   </xsd:complexType>
 </xsd:element>

    $Id$

    Author:
    Ian Turton, CCG

    • Method Detail

      • isAligned

        boolean isAligned()
        Correct method name violation from GeoAPI.
        Specified by:
        isAligned in interface LinePlacement
        Returns:
        boolean

      • getPerpendicularOffset

        Expression getPerpendicularOffset()
        Returns the expression that is used to compute how far from the lines the text will be drawn. The distance must evaluate to a non-negative number.
        Specified by:
        getPerpendicularOffset in interface LinePlacement
        Returns:
        compute how far from the line the text will be drawn

      • setPerpendicularOffset

        void setPerpendicularOffset​(Expression offset)
        Sets the expression that is used to compute how far from the lines the text will be drawn. See getPerpendicularOffset() for details.

      • setRepeated

        void setRepeated​(boolean repeated)

      • setGeneralized

        void setGeneralized​(boolean generalized)

      • setAligned

        void setAligned​(boolean aligned)

      • setInitialGap

        void setInitialGap​(Expression initialGap)