org.pepstock.charba.client.enums

Enum DefaultAnimationPropertyKey

java.lang.Object

java.lang.Enum<DefaultAnimationPropertyKey>

org.pepstock.charba.client.enums.DefaultAnimationPropertyKey

All Implemented Interfaces:

Serializable, Comparable<DefaultAnimationPropertyKey>, Key, AnimationCollectionKey, AnimationPropertyKey, IsTypedAnimationKey

public enum DefaultAnimationPropertyKey
extends Enum<DefaultAnimationPropertyKey>
implements AnimationPropertyKey

Cores animation properties, to use to animate, provided out of the box by CHART.JS.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACKGROUND_COLOR Uses to backgroundColor property to animate the element.
BORDER_COLOR Uses to borderColor property to animate the element.
BORDER_WIDTH Uses to borderWidth property to animate the element.
COLOR Uses to color property to animate the element.
RADIUS Uses to radius property to animate the element.
TENSION Uses to tension property to animate the element.
VISIBLE Uses to visible property to animate the element.
X Uses to x property to animate the element.
Y Uses to y property to animate the element.

Method Summary

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

checkAndGetIfValid, checkIfValid, create, isValid

Methods inherited from interface org.pepstock.charba.client.options.AnimationCollectionKey

checkAndGetIfValid, checkIfValid, create, isValid

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

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

Enum Constant Detail

X

public static final DefaultAnimationPropertyKey X

Uses to x property to animate the element.

Y

public static final DefaultAnimationPropertyKey Y

Uses to y property to animate the element.

BORDER_WIDTH

public static final DefaultAnimationPropertyKey BORDER_WIDTH

Uses to borderWidth property to animate the element.

RADIUS

public static final DefaultAnimationPropertyKey RADIUS

Uses to radius property to animate the element.

TENSION

public static final DefaultAnimationPropertyKey TENSION

Uses to tension property to animate the element.

BACKGROUND_COLOR

public static final DefaultAnimationPropertyKey BACKGROUND_COLOR

Uses to backgroundColor property to animate the element.

BORDER_COLOR

public static final DefaultAnimationPropertyKey BORDER_COLOR

Uses to borderColor property to animate the element.

COLOR

public static final DefaultAnimationPropertyKey COLOR

Uses to color property to animate the element.

VISIBLE

public static final DefaultAnimationPropertyKey VISIBLE

Uses to visible property to animate the element.

Method Detail

values

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

Returns:

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

valueOf

public static DefaultAnimationPropertyKey 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()

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(AnimationPropertyKey property)

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

Parameters:

property - the animation property to check

Returns:

true if the argument is equals to a default animation property

is

public static boolean is(String property)

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

Parameters:

property - the animation property to check

Returns:

true if the argument is equals to a default animation property