org.pepstock.charba.client.options

Interface IsAnimations

All Superinterfaces:

IsDefaultAnimations

All Known Implementing Classes:

Animations, Animations, UpdateConfiguration

public interface IsAnimations
extends IsDefaultAnimations

Interface to map a animations element where animation element properties can be set, ANIMATIONS name space.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
AnimationCollection	create(AnimationCollectionKey collection) Creates an animation collection instance and stores in the the animation options.
AnimationCollection	get(AnimationCollectionKey collection) Returns an animation collection instance if stored in the the animation options.
boolean	isEnabled(AnimationCollectionKey collection) Returns true if the animation collection is enabled, otherwise false.
void	remove(AnimationCollectionKey collection) Removes an animation collection previously added.
void	set(AnimationCollectionKey collection, AnimationCollection animationCollection) Sets an animation collection instance to store in the animation options.
void	setEnabled(AnimationCollectionKey collection, boolean enabled) Enables or disables an animation collection instance in the animation options.

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

has

Method Detail

setEnabled

void setEnabled(AnimationCollectionKey collection,
                boolean enabled)

Enables or disables an animation collection instance in the animation options.

Parameters:

collection - collection instance used to check in the animation options

enabled - if true it enables an animation collection

isEnabled

boolean isEnabled(AnimationCollectionKey collection)

Returns true if the animation collection is enabled, otherwise false.

Parameters:

collection - collection instance used to check in the animation options

Returns:

true if the animation collection is enabled, otherwise false

get

AnimationCollection get(AnimationCollectionKey collection)

Returns an animation collection instance if stored in the the animation options.

Specified by:

get in interface IsDefaultAnimations

Parameters:

collection - collection instance used to get for animation options

Returns:

an animation collection instance or null if does not exists

set

void set(AnimationCollectionKey collection,
         AnimationCollection animationCollection)

Sets an animation collection instance to store in the animation options.

Parameters:

collection - collection instance used to get for animation options

animationCollection - an animation collection instance to set

create

AnimationCollection create(AnimationCollectionKey collection)

Creates an animation collection instance and stores in the the animation options.

Parameters:

collection - collection key used to create the animation collections

Returns:

a collection animation options

remove

void remove(AnimationCollectionKey collection)

Removes an animation collection previously added.

Parameters:

collection - collection instance used to remove from animation options