Package org.pepstock.charba.client.geo.enums

Enum ClipMap

java.lang.Object

java.lang.Enum<ClipMap>

org.pepstock.charba.client.geo.enums.ClipMap

All Implemented Interfaces:

Serializable, Comparable<ClipMap>, Key

public enum ClipMap
extends Enum<ClipMap>
implements Key

Enumerates the possible values to clip the rendering to the chart area of the GEO graph.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	Does not clip the area.
GRATICULE	Clip the area to graticule.
ITEMS	Clip the area to the items.
OUTLINE	Clip the area to outline.
OUTLINE_GRATICULE	Clip the area to outline and graticule.
TRUE	Clip the area to the chart area.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OUTLINE

public static final ClipMap OUTLINE

Clip the area to outline.

GRATICULE

public static final ClipMap GRATICULE

Clip the area to graticule.

OUTLINE_GRATICULE

public static final ClipMap OUTLINE_GRATICULE

Clip the area to outline and graticule.

ITEMS

public static final ClipMap ITEMS

Clip the area to the items.

TRUE

public static final ClipMap TRUE

Clip the area to the chart area.

FALSE

public static final ClipMap FALSE

Does not clip the area.

Method Detail

values

public static ClipMap[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClipMap c : ClipMap.values())
    System.out.println(c);

Returns:

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

valueOf

public static ClipMap valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property