org.dominokit.domino.ui.animations

Class Animation

java.lang.Object

org.dominokit.domino.ui.animations.Animation

public class Animation
extends Object

Animates an HTMLElement

This class is used to animate an HTMLElement and provide a set of method to configure the animation, also provide some method to add some callback during different animation phases

For example:

  Animation.create(htmlElement)
           .duration(1000)
           .transition(Transition.BOUNCE)
           .animate();

 

See Also:

Animation on MDN

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Animation.CompleteCallback An implementation of this interface will provide some logic to be executed right after the animation is completed
static interface	Animation.StartHandler An implementation of this interface will provide some logic to be executed right before the animation starts

Constructor Summary

Constructors

Constructor and Description
Animation(elemental2.dom.HTMLElement element)
Animation(elemental2.dom.HTMLElement element, int duration, int delay, boolean infinite)

Method Summary

Modifier and Type	Method and Description
Animation	animate() starts animating the element, if there is a delay the animation will start after the delay
Animation	beforeStart(Animation.StartHandler startHandler) sets some logic to be executed before the animation starts
Animation	callback(Animation.CompleteCallback callback) sets some logic to be executed when the animation is completed
static Animation	create(elemental2.dom.HTMLElement element) static factory method to create an animation for an HTMLElement
static Animation	create(org.jboss.elemento.IsElement<?> element) static factory method to create an animation for an IsElement this method will create an animation for the HTMLElement wrapped in the IsElement
Animation	delay(int delay) sets the time the animation should wait before actually animate the element after animate() is called
Animation	duration(int duration) sets the duration for this animation
Animation	infinite() sets the animation as infinite so once the animation starts it will repeat infinitely or until stop() is called
Animation	repeat(double repeatCount) sets the animation to repeat for a specific number of times or until stop() is called.
void	stop() stops the animation and calls the Animation.CompleteCallback if it is set.
Animation	transition(Transition transition) sets the transition type for this animation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Animation

public Animation(elemental2.dom.HTMLElement element)

Parameters:

element - an HTMLElement to be animated

Animation

public Animation(elemental2.dom.HTMLElement element,
                 int duration,
                 int delay,
                 boolean infinite)

Parameters:

element - an HTMLElement to be animated

duration - int duration of animation in milliseconds

delay - int delay in millisecond before the animation starts

infinite - boolean repeat this animation infinitely or until stop() is called

Method Detail

create

public static Animation create(elemental2.dom.HTMLElement element)

static factory method to create an animation for an HTMLElement

Parameters:

element - an HTMLElement to be animated

Returns:

an Animation instance

create

public static Animation create(org.jboss.elemento.IsElement<?> element)

static factory method to create an animation for an IsElement this method will create an animation for the HTMLElement wrapped in the IsElement

Parameters:

element - an IsElement to be animated

Returns:

an Animation instance

duration

public Animation duration(int duration)

sets the duration for this animation

Parameters:

duration - int duration in milliseconds

Returns:

same instance

delay

public Animation delay(int delay)

sets the time the animation should wait before actually animate the element after animate() is called

Parameters:

delay - in delay in milliseconds

Returns:

same instance

infinite

public Animation infinite()

sets the animation as infinite so once the animation starts it will repeat infinitely or until stop() is called

Returns:

same instance

transition

public Animation transition(Transition transition)

sets the transition type for this animation.

Parameters:

transition - a Transition value

Returns:

same instance

repeat

public Animation repeat(double repeatCount)

sets the animation to repeat for a specific number of times or until stop() is called.

Parameters:

repeatCount - double the number of times the animation to be repeated e.g

2.5

repeats the animation 2 times and a half

Returns:

same instance

callback

public Animation callback(Animation.CompleteCallback callback)

sets some logic to be executed when the animation is completed

Parameters:

callback - a Animation.CompleteCallback to be executed

Returns:

same instance

beforeStart

public Animation beforeStart(Animation.StartHandler startHandler)

sets some logic to be executed before the animation starts

Parameters:

startHandler - Animation.StartHandler to be executed

Returns:

same instance

animate

public Animation animate()

starts animating the element, if there is a delay the animation will start after the delay

Returns:

same instance

stop

public void stop()

stops the animation and calls the Animation.CompleteCallback if it is set.