org.geotools.styling
Interface LinePlacement

All Superinterfaces:
LabelPlacement
All Known Implementing Classes:
LinePlacementImpl

public interface LinePlacement
extends 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: LinePlacement.java 32906 2009-05-02 00:24:15Z jive $

Author:
Ian Turton, CCG
Module:

Method Summary
 Expression getPerpendicularOffset()
          Returns the expression that is used to compute how far from the lines the text will be drawn.
 void setPerpendicularOffset(Expression offset)
          Sets the expression that is used to compute how far from the lines the text will be drawn.
 
Methods inherited from interface LabelPlacement
accept
 

Method Detail

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.

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.

Parameters:
offset -


Copyright © 1996-2009 Geotools. All Rights Reserved.