org.pepstock.charba.client.options

Class Animation

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Animation

All Implemented Interfaces:

IsDefaultAnimation

public class Animation
extends NativeObjectContainer
implements IsDefaultAnimation

It animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
int	getDuration() Returns the number of milliseconds an animation takes.
Easing	getEasing() Returns the animation easing.
protected P	getParent() Returns the parent element.
boolean	isAnimateRotate() If true, the chart will animate in with a rotation animation.
boolean	isAnimateScale() If true, will animate scaling the chart from the center outwards.
void	setAnimateRotate(boolean animateRotate) If true, the chart will animate in with a rotation animation.
void	setAnimateScale(boolean animateScale) If true, will animate scaling the chart from the center outwards.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
void	setDuration(int milliseconds) Sets the number of milliseconds an animation takes.
void	setEasing(Easing easing) Sets the animation easing.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Method Detail

setEasing

public void setEasing(Easing easing)

Sets the animation easing.

Parameters:

easing - animation easing.

getEasing

public Easing getEasing()

Returns the animation easing.

Specified by:

getEasing in interface IsDefaultAnimation

Returns:

animation easing.

setDuration

public void setDuration(int milliseconds)

Sets the number of milliseconds an animation takes.

Parameters:

milliseconds - the number of milliseconds an animation takes.

getDuration

public int getDuration()

Returns the number of milliseconds an animation takes.

Specified by:

getDuration in interface IsDefaultAnimation

Returns:

the number of milliseconds an animation takes.

setAnimateRotate

public void setAnimateRotate(boolean animateRotate)

If true, the chart will animate in with a rotation animation.

Parameters:

animateRotate - If true, the chart will animate in with a rotation animation.

isAnimateRotate

public boolean isAnimateRotate()

If true, the chart will animate in with a rotation animation.

Specified by:

isAnimateRotate in interface IsDefaultAnimation

Returns:

If true, the chart will animate in with a rotation animation.

setAnimateScale

public void setAnimateScale(boolean animateScale)

If true, will animate scaling the chart from the center outwards.

Parameters:

animateScale - If true, will animate scaling the chart from the center outwards.

isAnimateScale

public boolean isAnimateScale()

If true, will animate scaling the chart from the center outwards.

Specified by:

isAnimateScale in interface IsDefaultAnimation

Returns:

If true, will animate scaling the chart from the center outwards.

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.