org.geotools.styling
Interface PointPlacement

All Superinterfaces:
LabelPlacement
All Known Implementing Classes:
PointPlacementImpl

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

Author:
Ian Turton
Module:

Method Summary
 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 LabelPlacement
accept
 

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.

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.

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.

Returns:
rotation of the label as a dynamic expression

setRotation

void setRotation(Expression rotation)
Sets the rotation of the label.

Parameters:
rotation -


Copyright © 1996-2009 Geotools. All Rights Reserved.