org.geotools.styling
Interface LinePlacement

All Superinterfaces:

GTComponent, 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 18021 2006-02-14 20:36:18Z jdeolive $

Author:

Ian Turton, CCG

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 org.geotools.styling.LabelPlacement

accept

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Method Detail

getPerpendicularOffset

public 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:

DOCUMENT ME!

setPerpendicularOffset

public 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 - DOCUMENT ME!