org.geotools.styling
Interface Displacement

All Superinterfaces:

GTComponent

All Known Implementing Classes:

DisplacementImpl

public interface Displacement

extends GTComponent

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

Version:

$Id: Displacement.java 18021 2006-02-14 20:36:18Z jdeolive $

Author:

Ian Turton, CCG

Field Summary

static Displacement	DEFAULT Default Displacment instance.
static Displacement	NULL Null Displacement instance.

Method Summary

void	accept(StyleVisitor visitor)
Expression	getDisplacementX() Returns an expression that computes a pixel offset from the geometry point.
Expression	getDisplacementY() Returns an expression that computes a pixel offset from the geometry point.
void	setDisplacementX(Expression x) Sets the expression that computes a pixel offset from the geometry point.
void	setDisplacementY(Expression y) Sets the expression that computes a pixel offset from the geometry point.

Methods inherited from interface org.geotools.event.GTComponent

changed, getNote, getParent, removed, setNote

Field Detail

DEFAULT

public static final Displacement DEFAULT

Default Displacment instance.

NULL

public static final Displacement NULL

Null Displacement instance.

Method Detail

getDisplacementX

public Expression getDisplacementX()

Returns an expression that computes a pixel offset from the geometry point. This offset point is where the text's anchor point gets located. If this expression is null, the default offset of zero is used.

Returns:

DOCUMENT ME!

setDisplacementX

public void setDisplacementX(Expression x)

Sets the expression that computes a pixel offset from the geometry point.

Parameters:

x - DOCUMENT ME!

getDisplacementY

public Expression getDisplacementY()

Returns an expression that computes a pixel offset from the geometry point. This offset point is where the text's anchor point gets located. If this expression is null, the default offset of zero is used.

Returns:

DOCUMENT ME!

setDisplacementY

public void setDisplacementY(Expression y)

Sets the expression that computes a pixel offset from the geometry point.

Parameters:

y - DOCUMENT ME!

accept

public void accept(StyleVisitor visitor)