org.pepstock.charba.client.enums

Enum DefaultAnimationCollectionKey

java.lang.Object

java.lang.Enum<DefaultAnimationCollectionKey>

org.pepstock.charba.client.enums.DefaultAnimationCollectionKey

All Implemented Interfaces:

Serializable, Comparable<DefaultAnimationCollectionKey>, Key, AnimationCollectionKey, IsTypedAnimationKey

public enum DefaultAnimationCollectionKey
extends Enum<DefaultAnimationCollectionKey>
implements AnimationCollectionKey

Cores animation collections names provided out of the box by CHART.JS.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLORS Defines the default animation collection for colors.
NUMBERS Defines the default animation collection for numbers.
VISIBLE Defines the default animation collection for visible property.

Method Summary

Modifier and Type	Method and Description
static boolean	is(AnimationCollectionKey collection) Returns true if the argument is equals to a default animation collection.
List<AnimationPropertyKey>	properties() Returns the animation properties related to the collection.
AnimationType	type() Returns the animation type related to the property.
String	value() Returns the name value of property
static DefaultAnimationCollectionKey	valueOf(String name) Returns the enum constant of this type with the specified name.
static DefaultAnimationCollectionKey[]	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.options.AnimationCollectionKey

checkAndGetIfValid, checkIfValid, create, create, isValid

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

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

Enum Constant Detail

COLORS

public static final DefaultAnimationCollectionKey COLORS

Defines the default animation collection for colors.

NUMBERS

public static final DefaultAnimationCollectionKey NUMBERS

Defines the default animation collection for numbers.

VISIBLE

public static final DefaultAnimationCollectionKey VISIBLE

Defines the default animation collection for visible property.

Method Detail

values

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

Returns:

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

valueOf

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

type

public AnimationType type()

Description copied from interface: IsTypedAnimationKey

Returns the animation type related to the property.

Specified by:

type in interface IsTypedAnimationKey

Returns:

the animation type related to the property

properties

public List<AnimationPropertyKey> properties()

Description copied from interface: AnimationCollectionKey

Returns the animation properties related to the collection.

Specified by:

properties in interface AnimationCollectionKey

Returns:

the animation properties related to the collection

is

public static boolean is(AnimationCollectionKey collection)

Returns true if the argument is equals to a default animation collection.

Parameters:

collection - the animation collection to check

Returns:

true if the argument is equals to a default animation collection