org.pepstock.charba.client.enums

Enum LegendEventProperty

java.lang.Object

java.lang.Enum<LegendEventProperty>

org.pepstock.charba.client.enums.LegendEventProperty

All Implemented Interfaces:

Serializable, Comparable<LegendEventProperty>, Key

public enum LegendEventProperty
extends Enum<LegendEventProperty>
implements Key

Enumerates the name of options property to set the callbacks to legend events.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
ON_CLICK Property to set a callback to catch click events.
ON_HOVER Property to set a callback to catch mouse over events.
ON_LEAVE Property to set a callback to catch mouse out events.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static LegendEventProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static LegendEventProperty[]	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

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

ON_CLICK

public static final LegendEventProperty ON_CLICK

Property to set a callback to catch click events.

ON_HOVER

public static final LegendEventProperty ON_HOVER

Property to set a callback to catch mouse over events.

ON_LEAVE

public static final LegendEventProperty ON_LEAVE

Property to set a callback to catch mouse out events.

Method Detail

values

public static LegendEventProperty[] 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 (LegendEventProperty c : LegendEventProperty.values())
    System.out.println(c);

Returns:

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

valueOf

public static LegendEventProperty 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