org.pepstock.charba.client.defaults.globals

Class DefaultAnimationCollection

java.lang.Object

org.pepstock.charba.client.defaults.globals.DefaultAnimationCollection

All Implemented Interfaces:

IsDefaultAnimationCollection, IsDefaultBaseAnimation

public class DefaultAnimationCollection
extends Object
implements IsDefaultAnimationCollection

CHART.JS default values for animation collection.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
DefaultAnimationCollection(AnimationCollectionKey collection) Creates a default animation collection wrapping the AnimationCollectionKey.

Method Summary

Modifier and Type	Method and Description
int	getDelay() Returns the delay before starting the animations.
DelayCallback	getDelayCallback() Returns the callback to set the delay before starting the animations.
int	getDuration() Returns the number of milliseconds an animation takes.
DurationCallback	getDurationCallback() Returns the callback to set the number of milliseconds an animation takes.
Easing	getEasing() Returns the animation easing.
EasingCallback	getEasingCallback() Returns the callback to set the animation easing.
double	getFrom() Returns the start value for the animation as number.
boolean	getFromAsBoolean() Returns the start value for the animation as boolean.
String	getFromAsString() Returns the start value for the animation as color string.
FromCallback	getFromCallback() Returns the callback to set the start value for the animation.
LoopCallback	getLoopCallback() Returns the callback to loop the animations endlessly.
List<AnimationPropertyKey>	getProperties() Returns the properties defined in the the animation collection.
double	getTo() Returns the end value for the animation as number.
boolean	getToAsBoolean() Returns the end value for the animation as boolean.
String	getToAsString() Returns the end value for the animation as color string.
ToCallback	getToCallback() Returns the callback to set the end value for the animation.
AnimationType	getType() Returns the type of from property and determines the interpolator used.
boolean	isLoop() If set to true, loops the animations endlessly.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultBaseAnimation

getDelay, getDelayCallback, getDuration, getDurationCallback, getEasing, getEasingCallback, getLoopCallback, isLoop

Constructor Detail

DefaultAnimationCollection

public DefaultAnimationCollection(AnimationCollectionKey collection)

Creates a default animation collection wrapping the AnimationCollectionKey.

Parameters:

collection - a default animation collection to wrap

Method Detail

getProperties

public List<AnimationPropertyKey> getProperties()

Description copied from interface: IsDefaultAnimationCollection

Returns the properties defined in the the animation collection.

Specified by:

getProperties in interface IsDefaultAnimationCollection

Returns:

the properties defined in the the animation collection

getType

public AnimationType getType()

Description copied from interface: IsDefaultAnimationCollection

Returns the type of from property and determines the interpolator used.

Specified by:

getType in interface IsDefaultAnimationCollection

Returns:

the type of from property and determines the interpolator used.

getFrom

public double getFrom()

Description copied from interface: IsDefaultAnimationCollection

Returns the start value for the animation as number.

Specified by:

getFrom in interface IsDefaultAnimationCollection

Returns:

the start value for the animation as number.

getFromAsBoolean

public boolean getFromAsBoolean()

Description copied from interface: IsDefaultAnimationCollection

Returns the start value for the animation as boolean.

Specified by:

getFromAsBoolean in interface IsDefaultAnimationCollection

Returns:

the start value for the animation as boolean.

getFromAsString

public String getFromAsString()

Description copied from interface: IsDefaultAnimationCollection

Returns the start value for the animation as color string.

Specified by:

getFromAsString in interface IsDefaultAnimationCollection

Returns:

the start value for the animation as color string.

getTo

public double getTo()

Description copied from interface: IsDefaultAnimationCollection

Returns the end value for the animation as number.

Specified by:

getTo in interface IsDefaultAnimationCollection

Returns:

the end value for the animation as number.

getToAsBoolean

public boolean getToAsBoolean()

Description copied from interface: IsDefaultAnimationCollection

Returns the end value for the animation as boolean.

Specified by:

getToAsBoolean in interface IsDefaultAnimationCollection

Returns:

the end value for the animation as boolean.

getToAsString

public String getToAsString()

Description copied from interface: IsDefaultAnimationCollection

Returns the end value for the animation as color string.

Specified by:

getToAsString in interface IsDefaultAnimationCollection

Returns:

the end value for the animation as color string.

getFromCallback

public FromCallback getFromCallback()

Description copied from interface: IsDefaultAnimationCollection

Returns the callback to set the start value for the animation.

Specified by:

getFromCallback in interface IsDefaultAnimationCollection

Returns:

the callback instance to use to set the start value for the animation

getToCallback

public ToCallback getToCallback()

Description copied from interface: IsDefaultAnimationCollection

Returns the callback to set the end value for the animation.

Specified by:

getToCallback in interface IsDefaultAnimationCollection

Returns:

the callback instance to use to set the end value for the animation

getEasing

public Easing getEasing()

Description copied from interface: IsDefaultBaseAnimation

Returns the animation easing.

Specified by:

getEasing in interface IsDefaultBaseAnimation

Returns:

animation easing.

getDuration

public int getDuration()

Description copied from interface: IsDefaultBaseAnimation

Returns the number of milliseconds an animation takes.

Specified by:

getDuration in interface IsDefaultBaseAnimation

Returns:

the number of milliseconds an animation takes.

getDelay

public int getDelay()

Description copied from interface: IsDefaultBaseAnimation

Returns the delay before starting the animations.

Specified by:

getDelay in interface IsDefaultBaseAnimation

Returns:

the delay before starting the animations

isLoop

public boolean isLoop()

Description copied from interface: IsDefaultBaseAnimation

If set to true, loops the animations endlessly.

Specified by:

isLoop in interface IsDefaultBaseAnimation

Returns:

true if loops the animations endlessly.

getDurationCallback

public DurationCallback getDurationCallback()

Description copied from interface: IsDefaultBaseAnimation

Returns the callback to set the number of milliseconds an animation takes.

Specified by:

getDurationCallback in interface IsDefaultBaseAnimation

Returns:

the callback instance to use

getDelayCallback

public DelayCallback getDelayCallback()

Description copied from interface: IsDefaultBaseAnimation

Returns the callback to set the delay before starting the animations.

Specified by:

getDelayCallback in interface IsDefaultBaseAnimation

Returns:

the callback instance to use

getLoopCallback

public LoopCallback getLoopCallback()

Description copied from interface: IsDefaultBaseAnimation

Returns the callback to loop the animations endlessly.

Specified by:

getLoopCallback in interface IsDefaultBaseAnimation

Returns:

the callback instance to use

getEasingCallback

public EasingCallback getEasingCallback()

Description copied from interface: IsDefaultBaseAnimation

Returns the callback to set the animation easing.

Specified by:

getEasingCallback in interface IsDefaultBaseAnimation

Returns:

the callback instance to use