org.geotools.renderer.j2d
Class LegendPosition

java.lang.Object
  javax.media.jai.EnumeratedParameter
      org.geotools.renderer.j2d.LegendPosition

All Implemented Interfaces:

java.io.Serializable

public final class LegendPosition

extends javax.media.jai.EnumeratedParameter

Position of a legend relative to the widget's bounds. The position may be one of the following constants:

NORTH_WEST	NORTH	NORTH_EAST
WEST	CENTER	EAST
SOUTH_WEST	SOUTH	SOUTH_EAST

Version:

$Id: LegendPosition.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

static LegendPosition	CENTER The central position in an area.
static LegendPosition	EAST Compass-direction east (right).
static LegendPosition	NORTH Compass-direction North (up).
static LegendPosition	NORTH_EAST Compass-direction north-east (upper right).
static LegendPosition	NORTH_WEST Compass-direction north west (upper left).
static LegendPosition	SOUTH Compass-direction south (down).
static LegendPosition	SOUTH_EAST Compass-direction south-east (lower right).
static LegendPosition	SOUTH_WEST Compass-direction south-west (lower left).
static LegendPosition	WEST Compass-direction west (left).

Method Summary

static LegendPosition

getEnum(int value) Returns the enum for the specified value.

Methods inherited from class javax.media.jai.EnumeratedParameter

equals, getName, getValue, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CENTER

public static final LegendPosition CENTER

The central position in an area.

NORTH

public static final LegendPosition NORTH

Compass-direction North (up).

NORTH_EAST

public static final LegendPosition NORTH_EAST

Compass-direction north-east (upper right).

EAST

public static final LegendPosition EAST

Compass-direction east (right).

SOUTH_EAST

public static final LegendPosition SOUTH_EAST

Compass-direction south-east (lower right).

SOUTH

public static final LegendPosition SOUTH

Compass-direction south (down).

SOUTH_WEST

public static final LegendPosition SOUTH_WEST

Compass-direction south-west (lower left).

WEST

public static final LegendPosition WEST

Compass-direction west (left).

NORTH_WEST

public static final LegendPosition NORTH_WEST

Compass-direction north west (upper left).

Method Detail

getEnum

public static LegendPosition getEnum(int value)
                              throws java.util.NoSuchElementException

Returns the enum for the specified value. This method is provided for compatibility with SwingConstants.

Parameters:

value - The enum value.

Returns:

The enum for the specified value.

Throws:

java.util.NoSuchElementException - if there is no enum for the specified value.