org.geotools.styling
Interface LinePlacement

All Superinterfaces:
LabelPlacement, LinePlacement

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: LinePlacement.java 33813 2009-08-28 14:45:11Z jive $

Author:
Ian Turton, CCG
Module:
modules/library/api (gt-api.jar)

Method Summary
 Expression getPerpendicularOffset()
          Returns the expression that is used to compute how far from the lines the text will be drawn.
 boolean isAligned()
          Correct method name violation from GeoAPI.
 boolean IsAligned()
          Deprecated.  
 void setAligned(boolean aligned)
           
 void setGap(Expression gap)
           
 void setGeneralized(boolean generalized)
           
 void setInitialGap(Expression initialGap)
           
 void setPerpendicularOffset(Expression offset)
          Sets the expression that is used to compute how far from the lines the text will be drawn.
 void setRepeated(boolean repeated)
           
 
Methods inherited from interface LinePlacement
accept, getGap, getInitialGap, isGeneralizeLine, isRepeated
 
Methods inherited from interface LabelPlacement
accept
 

Method Detail

IsAligned

boolean IsAligned()
Deprecated. 

Specified by:
IsAligned in interface LinePlacement

isAligned

boolean isAligned()
Correct method name violation from GeoAPI.

Returns:

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.

Parameters:
offset -

setRepeated

void setRepeated(boolean repeated)

setGeneralized

void setGeneralized(boolean generalized)

setAligned

void setAligned(boolean aligned)

setGap

void setGap(Expression gap)

setInitialGap

void setInitialGap(Expression initialGap)


Copyright © 1996-2009 Geotools. All Rights Reserved.