Class WAnimation
- java.lang.Object
-
- eu.webtoolkit.jwt.WAnimation
-
public class WAnimation extends java.lang.ObjectA value class that defines a transition effect.This class defines an animation used as a transition to show or hide a widget.
The animation can be defined as a motion effect (e.g. sliding in or out), optionally combined with a fade effect. A timing function defines how the effects(s) are animated during the total duration of the animation.
-
-
Constructor Summary
Constructors Constructor Description WAnimation()Default constructor.WAnimation(AnimationEffect effect)Creates an animation.WAnimation(AnimationEffect effect1, AnimationEffect effect2)Creates an animation.WAnimation(AnimationEffect effect1, AnimationEffect effect2, TimingFunction timing)Creates an animation.WAnimation(AnimationEffect effect1, AnimationEffect effect2, TimingFunction timing, int duration)Creates an animation.WAnimation(AnimationEffect effect, TimingFunction timing)Creates an animation.WAnimation(AnimationEffect effect, TimingFunction timing, int duration)Creates an animation.WAnimation(java.util.EnumSet<AnimationEffect> effects)Creates an animation.WAnimation(java.util.EnumSet<AnimationEffect> effects, TimingFunction timing)Creates an animation.WAnimation(java.util.EnumSet<AnimationEffect> effects, TimingFunction timing, int duration)Creates an animation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WAnimationclone()Clone method.booleanequals(WAnimation animation)Indicates whether some other object is "equal to" this one.intgetDuration()Returns the duration.java.util.EnumSet<AnimationEffect>getEffects()Returns animation effects.TimingFunctiongetTimingFunction()Returns the timing function.booleanisEmpty()Returns whether the animation is empty.voidsetDuration(int msecs)Sets the duration.voidsetEffects(AnimationEffect effect, AnimationEffect... effects)Sets the animation effects.voidsetEffects(java.util.EnumSet<AnimationEffect> effects)Sets the animation effects.voidsetTimingFunction(TimingFunction tf)Sets a timing function.
-
-
-
Constructor Detail
-
WAnimation
public WAnimation()
Default constructor.Creates an animation that actually represent no animation. (
getEffects()== 0).
-
WAnimation
public WAnimation(java.util.EnumSet<AnimationEffect> effects, TimingFunction timing, int duration)
Creates an animation.An animation is created with given effects, timing and duration.
-
WAnimation
public WAnimation(java.util.EnumSet<AnimationEffect> effects)
Creates an animation.
-
WAnimation
public WAnimation(java.util.EnumSet<AnimationEffect> effects, TimingFunction timing)
Creates an animation.
-
WAnimation
public WAnimation(AnimationEffect effect, TimingFunction timing, int duration)
Creates an animation.An animation is created with one effect, timing and duration.
-
WAnimation
public WAnimation(AnimationEffect effect)
Creates an animation.
-
WAnimation
public WAnimation(AnimationEffect effect, TimingFunction timing)
Creates an animation.
-
WAnimation
public WAnimation(AnimationEffect effect1, AnimationEffect effect2, TimingFunction timing, int duration)
Creates an animation.An animation is created with two effects (a motion and Fade).
-
WAnimation
public WAnimation(AnimationEffect effect1, AnimationEffect effect2)
Creates an animation.
-
WAnimation
public WAnimation(AnimationEffect effect1, AnimationEffect effect2, TimingFunction timing)
Creates an animation.
-
-
Method Detail
-
clone
public WAnimation clone()
Clone method.Clones this animation object.
- Overrides:
clonein classjava.lang.Object
-
setEffects
public void setEffects(java.util.EnumSet<AnimationEffect> effects)
Sets the animation effects.A motion effect (
AnimationEffect.SlideInFromLeft,AnimationEffect.SlideInFromRight,AnimationEffect.SlideInFromBottom,AnimationEffect.SlideInFromToporAnimationEffect.Pop) can be combined with a fade effect (AnimationEffect.Fade).When effects are 0, the animation does not actually specify an animation, but instead an instant transition.
-
setEffects
public final void setEffects(AnimationEffect effect, AnimationEffect... effects)
Sets the animation effects.
-
getEffects
public java.util.EnumSet<AnimationEffect> getEffects()
Returns animation effects.- See Also:
setEffects(EnumSet effects)
-
equals
public boolean equals(WAnimation animation)
Indicates whether some other object is "equal to" this one.Returns
trueif the transitions are exactly the same.
-
setDuration
public void setDuration(int msecs)
Sets the duration.The default animation duration is 250 ms.
- See Also:
getDuration()
-
getDuration
public int getDuration()
Returns the duration.- See Also:
setDuration(int msecs)
-
setTimingFunction
public void setTimingFunction(TimingFunction tf)
Sets a timing function.The default timinig function is
TimingFunction.Linear.
-
getTimingFunction
public TimingFunction getTimingFunction()
Returns the timing function.- See Also:
setTimingFunction(TimingFunction tf)
-
isEmpty
public boolean isEmpty()
Returns whether the animation is empty.An animation is empty (meaning the transition is instant), if the duration is 0, or if no effects are defined.
-
-