Animation (Charba - J2CL and GWT charts library based on CHART.JS)

java.lang.Object
- org.pepstock.charba.client.configuration.Animation

All Implemented Interfaces:

IsDefaultAnimation, IsDefaultBaseAnimation, IsAnimation
```
public class Animation
extends Object
implements IsAnimation
```
It animates charts out of the box.
A number of options are provided to configure how the animation looks and how long it takes.
This configuration item is configuring the common animation properties.

Author:

Andrea "Stock" Stocchero

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Default Methods
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.
`LoopCallback`	`getLoopCallback()` Returns the callback to loop the animations endlessly.
`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.
`boolean`	`isLoop()` If set to `true`, loops the animations endlessly.
`void`	`onAdd(AddHandlerEvent event)` Invoked when a new event handler is added.
`void`	`onRemove(RemoveHandlerEvent event)` Invoked when a chart event handler is removed.
`static void`	`register(IsChart chart, org.pepstock.charba.client.configuration.IsEventProvider provider)` Adds the event provider implementation as handlers of chart.
`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`	`setDelay(DelayCallback delayCallback)` Sets the delay before starting the animations by a callback.
`void`	`setDelay(int delay)` Sets the delay before starting the animations.
`void`	`setDelay(NativeCallback delayCallback)` Sets the delay before starting the animations by a callback.
`void`	`setDuration(DurationCallback durationCallback)` Sets the number of milliseconds an animation takes by a callback.
`void`	`setDuration(int milliseconds)` Sets the number of milliseconds an animation takes.
`void`	`setDuration(NativeCallback durationCallback)` Sets the number of milliseconds an animation takes by a callback.
`void`	`setEasing(Easing easing)` Sets the animation easing.
`void`	`setEasing(EasingCallback easingCallback)` Sets the animation easing by a callback.
`void`	`setEasing(NativeCallback easingCallback)` Sets the animation easing by a callback.
`void`	`setLoop(boolean loop)` If set to `true`, loops the animations endlessly.
`void`	`setLoop(LoopCallback loopCallback)` Sets to loop the animations endlessly by a callback.
`void`	`setLoop(NativeCallback loopCallback)` Sets to loop the animations endlessly by a callback.

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.
    
    Specified by:
    
    setEasing in interface IsAnimation
    
    Parameters:
    
    easing - animation easing.
  - getEasing
```
public Easing getEasing()
```
    Returns the animation easing.
    
    Specified by:
    
    getEasing in interface IsDefaultBaseAnimation
    
    Returns:
    
    animation easing.
  - setDuration
```
public void setDuration(int milliseconds)
```
    Sets the number of milliseconds an animation takes.
    
    Specified by:
    
    setDuration in interface IsAnimation
    
    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 IsDefaultBaseAnimation
    
    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.
    
    Specified by:
    
    setAnimateRotate in interface IsAnimation
    
    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.
    
    Specified by:
    
    setAnimateScale in interface IsAnimation
    
    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.
  - setDelay
```
public void setDelay(int delay)
```
    Sets the delay before starting the animations.
    
    Specified by:
    
    setDelay in interface IsAnimation
    
    Parameters:
    
    delay - the delay before starting the animations
  - getDelay
```
public int getDelay()
```
    Returns the delay before starting the animations.
    
    Specified by:
    
    getDelay in interface IsDefaultBaseAnimation
    
    Returns:
    
    the delay before starting the animations
  - setLoop
```
public void setLoop(boolean loop)
```
    If set to true, loops the animations endlessly.
    
    Specified by:
    
    setLoop in interface IsAnimation
    
    Parameters:
    
    loop - true if loops the animations endlessly.
  - isLoop
```
public boolean isLoop()
```
    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()
```
    Returns the callback to set the number of milliseconds an animation takes.
    
    Specified by:
    
    getDurationCallback in interface IsDefaultBaseAnimation
    
    Returns:
    
    the callback instance to use
  - setDuration
```
public void setDuration(DurationCallback durationCallback)
```
    Sets the number of milliseconds an animation takes by a callback.
    
    Specified by:
    
    setDuration in interface IsAnimation
    
    Parameters:
    
    durationCallback - the callback instance to use
  - setDuration
```
public void setDuration(NativeCallback durationCallback)
```
    Sets the number of milliseconds an animation takes by a callback.
    
    Specified by:
    
    setDuration in interface IsAnimation
    
    Parameters:
    
    durationCallback - the callback instance to use
  - getDelayCallback
```
public DelayCallback getDelayCallback()
```
    Returns the callback to set the delay before starting the animations.
    
    Specified by:
    
    getDelayCallback in interface IsDefaultBaseAnimation
    
    Returns:
    
    the callback instance to use
  - setDelay
```
public void setDelay(DelayCallback delayCallback)
```
    Sets the delay before starting the animations by a callback.
    
    Specified by:
    
    setDelay in interface IsAnimation
    
    Parameters:
    
    delayCallback - the callback instance to use
  - setDelay
```
public void setDelay(NativeCallback delayCallback)
```
    Sets the delay before starting the animations by a callback.
    
    Specified by:
    
    setDelay in interface IsAnimation
    
    Parameters:
    
    delayCallback - the callback instance to use
  - getLoopCallback
```
public LoopCallback getLoopCallback()
```
    Returns the callback to loop the animations endlessly.
    
    Specified by:
    
    getLoopCallback in interface IsDefaultBaseAnimation
    
    Returns:
    
    the callback instance to use
  - setLoop
```
public void setLoop(LoopCallback loopCallback)
```
    Sets to loop the animations endlessly by a callback.
    
    Specified by:
    
    setLoop in interface IsAnimation
    
    Parameters:
    
    loopCallback - the callback instance to use
  - setLoop
```
public void setLoop(NativeCallback loopCallback)
```
    Sets to loop the animations endlessly by a callback.
    
    Specified by:
    
    setLoop in interface IsAnimation
    
    Parameters:
    
    loopCallback - the callback instance to use
  - getEasingCallback
```
public EasingCallback getEasingCallback()
```
    Returns the callback to set the animation easing.
    
    Specified by:
    
    getEasingCallback in interface IsDefaultBaseAnimation
    
    Returns:
    
    the callback instance to use
  - setEasing
```
public void setEasing(EasingCallback easingCallback)
```
    Sets the animation easing by a callback.
    
    Specified by:
    
    setEasing in interface IsAnimation
    
    Parameters:
    
    easingCallback - the callback instance to use
  - setEasing
```
public void setEasing(NativeCallback easingCallback)
```
    Sets the animation easing by a callback.
    
    Specified by:
    
    setEasing in interface IsAnimation
    
    Parameters:
    
    easingCallback - the callback instance to use
  - onAdd
```
public final void onAdd(AddHandlerEvent event)
```
    Description copied from interface: AddHandlerEventHandler
    
    Invoked when a new event handler is added.
    
    Parameters:
    
    event - event to be consumed
  - onRemove
```
public final void onRemove(RemoveHandlerEvent event)
```
    Description copied from interface: RemoveHandlerEventHandler
    
    Invoked when a chart event handler is removed.
    
    Parameters:
    
    event - event to be consumed
  - register
```
public static void register(IsChart chart,
                            org.pepstock.charba.client.configuration.IsEventProvider provider)
```
    Adds the event provider implementation as handlers of chart.
    
    Parameters:
    
    chart - chart instance
    
    provider - event provider implmentation

Class Animation

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEasing

getEasing

setDuration

getDuration

setAnimateRotate

isAnimateRotate

setAnimateScale

isAnimateScale

setDelay

getDelay

setLoop

isLoop

getDurationCallback

setDuration

setDuration

getDelayCallback

setDelay

setDelay

getLoopCallback

setLoop

setLoop

getEasingCallback

setEasing

setEasing

onAdd

onRemove

register