org.pepstock.charba.client.options

Class Animation

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.commons.EventProvider

org.pepstock.charba.client.options.Animation

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

public final class Animation
extends EventProvider

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 <H extends com.google.gwt.event.shared.EventHandler> void	addHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type) Notifies the event provider when a new handler has been added.
int	getDuration() Returns the number of milliseconds an animation takes.
Easing	getEasing() Returns the animation easing.
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.
protected void	onComplete(GenericJavaScriptObject item) Callback called at the end of an animation.
protected void	onProgress(GenericJavaScriptObject item) Callback called on each step of an animation.
protected <H extends com.google.gwt.event.shared.EventHandler> void	removeHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type) Notifies the event provider when a new handler has been deregistered
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.
void	setDuration(int milliseconds) Sets the number of milliseconds an animation takes.
void	setEasing(Easing easing) Sets the animation easing.

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

onAdd, onRemove

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

getChart

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

setEasing

public void setEasing(Easing easing)

Sets the animation easing.

Parameters:

easing - animation easing.

See Also:

Easing

getEasing

public Easing getEasing()

Returns the animation easing.

Returns:

animation easing. For default value, see Options.getAnimation().

See Also:

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.

Returns:

the number of milliseconds an animation takes. For default value, see Options.getAnimation().

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.

Returns:

If true, the chart will animate in with a rotation animation. For default value, see Options.getAnimation().

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.

Returns:

If true, will animate scaling the chart from the center outwards. For default value, see Options.getAnimation().

addHandler

protected <H extends com.google.gwt.event.shared.EventHandler> void addHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type)

Description copied from class: EventProvider

Notifies the event provider when a new handler has been added.

Specified by:

addHandler in class EventProvider

Type Parameters:

H - type of event handler

Parameters:

type - type of event

removeHandler

protected <H extends com.google.gwt.event.shared.EventHandler> void removeHandler(com.google.gwt.event.shared.GwtEvent.Type<H> type)

Description copied from class: EventProvider

Notifies the event provider when a new handler has been deregistered

Specified by:

removeHandler in class EventProvider

Type Parameters:

H - type of event handler

Parameters:

type - type of event handler

onProgress

protected void onProgress(GenericJavaScriptObject item)

Callback called on each step of an animation.

Parameters:

item - animation item info.

onComplete

protected void onComplete(GenericJavaScriptObject item)

Callback called at the end of an animation.

Parameters:

item - animation item info.