org.pepstock.charba.client.configuration

Class Animation

java.lang.Object

org.pepstock.charba.client.configuration.EventProvider<ExtendedOptions>

org.pepstock.charba.client.configuration.Animation

All Implemented Interfaces:

EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

public class Animation
extends EventProvider<ExtendedOptions>

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 EventHandler> void	addHandler(GwtEvent.Type<H> type) Notifies the event provider when a new handler has been added.
AbstractChart<?,?>	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
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 <H extends EventHandler> void	removeHandler(GwtEvent.Type<H> type) Notifies the event provider when a new handler has been unregistered
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	setConfiguration(T configuration)
void	setDuration(int milliseconds) Sets the number of milliseconds an animation takes.
void	setEasing(Easing easing) Sets the animation easing.
String	toJSON() Returns the JSON representation of the object.

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

onAdd, onRemove

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.

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.

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.

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.

Returns:

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

addHandler

protected final <H extends EventHandler> void addHandler(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<ExtendedOptions>

Type Parameters:

H - type of event handler

Parameters:

type - type of event

removeHandler

protected final <H extends EventHandler> void removeHandler(GwtEvent.Type<H> type)

Description copied from class: EventProvider

Notifies the event provider when a new handler has been unregistered

Specified by:

removeHandler in class EventProvider<ExtendedOptions>

Type Parameters:

H - type of event handler

Parameters:

type - type of event handler

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final AbstractChart<?,?> getChart()

Returns the chart instance

Returns:

the chart