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$

Author:

Ian Turton, CCG

Method Summary

Modifier and Type	Method and Description
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.

Description copied from interface: LinePlacement

Labels can either be aligned to the line geometry if IsAligned is "true" (the default) or are drawn horizontally.

Specified by:

IsAligned in interface LinePlacement

Returns:

boolean

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)