Package org.mapfish.print.attribute.map

Enum Class AreaOfInterest.AoiDisplay

java.lang.Object

java.lang.Enum<AreaOfInterest.AoiDisplay>

org.mapfish.print.attribute.map.AreaOfInterest.AoiDisplay

All Implemented Interfaces:

Serializable, Comparable<AreaOfInterest.AoiDisplay>, Constable

Enclosing class:

AreaOfInterest

public static enum AreaOfInterest.AoiDisplay
extends Enum<AreaOfInterest.AoiDisplay>

Represents the ways that the area of interest (aoi) can be rendered on the map.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIP	Set a clip for the area (IE only show the area of interest).
NONE	Do not show the Area of interest on the map.
RENDER	Draw the entire map and render the AOI polygon on the map.

Method Summary

Modifier and Type	Method	Description
static AreaOfInterest.AoiDisplay	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AreaOfInterest.AoiDisplay[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

RENDER

public static final AreaOfInterest.AoiDisplay RENDER

Draw the entire map and render the AOI polygon on the map. This is the default.

CLIP

public static final AreaOfInterest.AoiDisplay CLIP

Set a clip for the area (IE only show the area of interest).

NONE

public static final AreaOfInterest.AoiDisplay NONE

Do not show the Area of interest on the map. In this case another processor will likely make use of the AOI.

Method Details

values

public static AreaOfInterest.AoiDisplay[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AreaOfInterest.AoiDisplay valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null