org.geotools.styling

Interface PointPlacement

All Superinterfaces:

LabelPlacement, PointPlacement

public interface PointPlacement
extends PointPlacement, LabelPlacement

A PointPlacement specifies how a text label is positioned relative to a geometric point.

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

 <xsd:element name="PointPlacement">
   <xsd:annotation>
     <xsd:documentation>
       A "PointPlacement" specifies how a text label should be rendered
       relative to a geometric point.
     </xsd:documentation>
   </xsd:annotation>
   <xsd:complexType>
     <xsd:sequence>
       <xsd:element ref="sld:AnchorPoint" minOccurs="0"/>
       <xsd:element ref="sld:Displacement" minOccurs="0"/>
       <xsd:element ref="sld:Rotation" minOccurs="0"/>
     </xsd:sequence>
   </xsd:complexType>
 </xsd:element>
 

$Id$

Author:

Ian Turton

Field Summary

Fields

Modifier and Type	Field and Description
static AnchorPoint	DEFAULT_ANCHOR_POINT

Method Summary

Modifier and Type	Method and Description
AnchorPoint	getAnchorPoint() Returns the AnchorPoint which identifies the location inside a textlabel to use as an "anchor" for positioning it relative to a point geometry.
Displacement	getDisplacement() Returns the Displacement which gives X and Y offset displacements to use for rendering a text label near a point.
Expression	getRotation() Returns the rotation of the label.
void	setAnchorPoint(AnchorPoint anchorPoint) sets the AnchorPoint which identifies the location inside a textlabel to use as an "anchor" for positioning it relative to a point geometry.
void	setDisplacement(Displacement displacement) sets the Displacement which gives X and Y offset displacements to use for rendering a text label near a point.
void	setRotation(Expression rotation) sets the rotation of the label.

Methods inherited from interface PointPlacement

accept

Methods inherited from interface LabelPlacement

accept

Field Detail

DEFAULT_ANCHOR_POINT

static final AnchorPoint DEFAULT_ANCHOR_POINT

Method Detail

getAnchorPoint

AnchorPoint getAnchorPoint()

Returns the AnchorPoint which identifies the location inside a textlabel to use as an "anchor" for positioning it relative to a point geometry.

Specified by:

getAnchorPoint in interface PointPlacement

Returns:

acnchorPoint from the relative to the origional geometry

setAnchorPoint

void setAnchorPoint(AnchorPoint anchorPoint)

sets the AnchorPoint which identifies the location inside a textlabel to use as an "anchor" for positioning it relative to a point geometry.

Parameters:

anchorPoint - relative to the origional geometry

getDisplacement

Displacement getDisplacement()

Returns the Displacement which gives X and Y offset displacements to use for rendering a text label near a point.

Specified by:

getDisplacement in interface PointPlacement

Returns:

Offset to use when rendering text near a point

setDisplacement

void setDisplacement(Displacement displacement)

sets the Displacement which gives X and Y offset displacements to use for rendering a text label near a point.

getRotation

Expression getRotation()

Returns the rotation of the label.

Specified by:

getRotation in interface PointPlacement

Returns:

rotation of the label as a dynamic expression

setRotation

void setRotation(Expression rotation)

sets the rotation of the label.

Sets the rotation of the label.

Parameters:

rotation -