org.pepstock.charba.client.options

Interface AnimationPropertyKey

All Superinterfaces:

AnimationCollectionKey, IsTypedAnimationKey, Key

All Known Implementing Classes:

DefaultAnimationPropertyKey, StandardAnimationProperty

public interface AnimationPropertyKey
extends AnimationCollectionKey

Represents the property id to set to the configure animation collection items.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
static AnimationPropertyKey	checkAndGetIfValid(AnimationPropertyKey property) Checks if property passed as argument is not null and its value is not null as well. If not, throw a IllegalArgumentException, otherwise it returns the key.
static void	checkIfValid(AnimationPropertyKey property) Checks if type passed as argument is not null and its type is not null as well. If not, throw a IllegalArgumentException.
static AnimationPropertyKey	create(String property, AnimationType type) Returns a animation property instance by its string value.
static boolean	isValid(AnimationPropertyKey property) Returns true if type passed as argument is not null and its type is not null as well.

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

checkAndGetIfValid, checkIfValid, create, isValid, properties

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

type

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

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

Method Detail

create

static AnimationPropertyKey create(String property,
                                   AnimationType type)

Returns a animation property instance by its string value.

Specified by:

create in interface AnimationCollectionKey

Parameters:

property - string value to use

type - type related to the typeof property

Returns:

new property instance

isValid

static boolean isValid(AnimationPropertyKey property)

Returns true if type passed as argument is not null and its type is not null as well.

Parameters:

property - animation property to be checked

Returns:

true if type passed as argument is not null and its type is not null as well.

checkIfValid

static void checkIfValid(AnimationPropertyKey property)

Checks if type passed as argument is not null and its type is not null as well.
If not, throw a IllegalArgumentException.

Parameters:

property - animation property to be checked

checkAndGetIfValid

static AnimationPropertyKey checkAndGetIfValid(AnimationPropertyKey property)

Checks if property passed as argument is not null and its value is not null as well.
If not, throw a IllegalArgumentException, otherwise it returns the key.

Specified by:

checkAndGetIfValid in interface Key

Parameters:

property - property to be checked

Returns:

the same property passed as argument