akasha

Class Animation

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.Animation

Direct Known Subclasses:

ShadowAnimation

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class Animation
extends EventTarget

The Animation interface of the Web Animations API represents a single animation player and provides playback controls and a timeline for an animation node or source.

See Also:

Animation - MDN, (Web Animations 2) # the-animation-interface

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.Double	currentTime The Animation.currentTime property of the Web Animations API returns and sets the current time value of the animation in milliseconds, whether running or paused.
AnimationEffect	effect The Animation.effect property of the Web Animations API gets and sets the target effect of an animation.
java.lang.String	id The Animation.id property of the Web Animations API returns or sets a string used to identify the animation.
EventHandler	oncancel The oncancel property of the Web Animations API's Animation interface is the event handler for the cancel event.
EventHandler	onfinish The Animation interface's onfinish property (from the Web Animations API) is the event handler for the finish event.
EventHandler	onremove The Animation interface's onremove property (from the Web Animations API) is the event handler for the remove event.
double	playbackRate The Animation.playbackRate property of the Web Animations API returns or sets the playback rate of the animation.
java.lang.Double	startTime The Animation.startTime property of the Animation interface is a double-precision floating-point value which indicates the scheduled time when an animation's playback should begin.
AnimationTimeline	timeline The Animation.timeline property of the Animation interface returns or sets the timeline associated with this animation.

Constructor Summary

Constructors

Constructor and Description
Animation() The Animation() constructor of the Web Animations API returns a new Animation object instance.
Animation(AnimationEffect effect) The Animation() constructor of the Web Animations API returns a new Animation object instance.
Animation(AnimationEffect effect, AnimationTimeline timeline) The Animation() constructor of the Web Animations API returns a new Animation object instance.

Method Summary

Modifier and Type	Method and Description
void	cancel() The Web Animations API's cancel() method of the Animation interface clears all KeyframeEffects caused by this animation and aborts its playback.
void	commitStyles() None.
void	finish() The finish() method of the Web Animations API's Animation Interface sets the current playback time to the end of the animation corresponding to the current playback direction.
Promise<Animation>	finished() The Animation.finished read-only property of the Web Animations API returns a Promise which resolves once the animation has finished playing.
void	pause() The pause() method of the Web Animations API's Animation interface suspends playback of the animation.
boolean	pending() The read-only Animation.pending property of the Web Animations API indicates whether the animation is currently waiting for an asynchronous operation such as initiating playback or pausing a running animation.
void	persist() None.
void	play() The play() method of the Web Animations API's Animation Interface starts or resumes playing of an animation.
java.lang.String	playState() The Animation.playState property of the Web Animations API returns and sets an enumerated value describing the playback state of an animation.
Promise<Animation>	ready() The read-only Animation.ready property of the Web Animations API returns a Promise which resolves when the animation is ready to play.
java.lang.String	replaceState() The read-only Animation.replaceState property of the Web Animations API returns the replace state of the animation.
void	reverse() The Animation.reverse() method of the Animation Interface reverses the playback direction, meaning the animation ends at its beginning.
void	updatePlaybackRate(double playbackRate) The updatePlaybackRate() method of the Web Animations API's Animation Interface sets the speed of an animation after first synchronizing its playback position.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

currentTime

@Nullable
public java.lang.Double currentTime

The Animation.currentTime property of the Web Animations API returns and sets the current time value of the animation in milliseconds, whether running or paused.

See Also:

Animation.currentTime - MDN, currentTime - Web Animations

effect

@Nullable
public AnimationEffect effect

The Animation.effect property of the Web Animations API gets and sets the target effect of an animation. The target effect may be either an effect object of a type based on AnimationEffectReadOnly, such as KeyframeEffect, or null.

See Also:

Animation.effect - MDN, Animation.effect - Web Animations

id

@Nonnull
public java.lang.String id

The Animation.id property of the Web Animations API returns or sets a string used to identify the animation.

See Also:

Animation.id - MDN, Animation.id - Web Animations

oncancel

@Nullable
public EventHandler oncancel

The oncancel property of the Web Animations API's Animation interface is the event handler for the cancel event.

See Also:

Animation.oncancel - MDN, Animation.oncancel - Web Animations

onfinish

@Nullable
public EventHandler onfinish

The Animation interface's onfinish property (from the Web Animations API) is the event handler for the finish event. This event is sent when the animation finishes playing.

See Also:

Animation.onfinish - MDN, Animation.onfinish - Web Animations

onremove

@Nullable
public EventHandler onremove

The Animation interface's onremove property (from the Web Animations API) is the event handler for the remove event. This event is sent when the animation is removed (i.e., put into an active replace state).

See Also:

Animation.onremove - MDN, Animation.onremove - Web Animations

playbackRate

public double playbackRate

The Animation.playbackRate property of the Web Animations API returns or sets the playback rate of the animation.

See Also:

Animation.playbackRate - MDN, Animation.playbackRate - Web Animations

startTime

@Nullable
public java.lang.Double startTime

The Animation.startTime property of the Animation interface is a double-precision floating-point value which indicates the scheduled time when an animation's playback should begin.

See Also:

Animation.startTime - MDN, Animation.startTime - Web Animations

timeline

@Nullable
public AnimationTimeline timeline

The Animation.timeline property of the Animation interface returns or sets the timeline associated with this animation. A timeline is a source of time values for synchronization purposes, and is an AnimationTimeline-based object. By default, the animation's timeline and the Document's timeline are the same.

See Also:

Animation.timeline - MDN, Animation.timeline - Web Animations

Constructor Detail

Animation

public Animation(@Nullable
                 AnimationEffect effect,
                 @Nullable
                 AnimationTimeline timeline)

The Animation() constructor of the Web Animations API returns a new Animation object instance.

See Also:

Animation.Animation - MDN, Animation() - Web Animations

Animation

public Animation(@Nullable
                 AnimationEffect effect)

The Animation() constructor of the Web Animations API returns a new Animation object instance.

See Also:

Animation.Animation - MDN, Animation() - Web Animations

Animation

public Animation()

The Animation() constructor of the Web Animations API returns a new Animation object instance.

See Also:

Animation.Animation - MDN, Animation() - Web Animations

Method Detail

finished

@JsProperty(name="finished")
 @Nonnull
public Promise<Animation> finished()

The Animation.finished read-only property of the Web Animations API returns a Promise which resolves once the animation has finished playing.

See Also:

Animation.finished - MDN, Animation.finished - Web Animations

pending

@JsProperty(name="pending")
public boolean pending()

The read-only Animation.pending property of the Web Animations API indicates whether the animation is currently waiting for an asynchronous operation such as initiating playback or pausing a running animation.

See Also:

Animation.pending - MDN, pending - Web Animations

playState

@JsProperty(name="playState")
 @Nonnull
 @AnimationPlayState
public java.lang.String playState()

The Animation.playState property of the Web Animations API returns and sets an enumerated value describing the playback state of an animation.

See Also:

Animation.playState - MDN, playState - Web Animations

ready

@JsProperty(name="ready")
 @Nonnull
public Promise<Animation> ready()

The read-only Animation.ready property of the Web Animations API returns a Promise which resolves when the animation is ready to play. A new promise is created every time the animation enters the "pending" play state as well as when the animation is canceled, since in both of those scenarios, the animation is ready to be started again.

See Also:

Animation.ready - MDN, Animation.ready - Web Animations

replaceState

@JsProperty(name="replaceState")
 @Nonnull
 @AnimationReplaceState
public java.lang.String replaceState()

The read-only Animation.replaceState property of the Web Animations API returns the replace state of the animation. This will be active if the animation has been removed, or persisted if Animation.persist() has been invoked on it.

See Also:

Animation.replaceState - MDN, Animation.replaceState - Web Animations

cancel

public void cancel()

The Web Animations API's cancel() method of the Animation interface clears all KeyframeEffects caused by this animation and aborts its playback.

See Also:

Animation.cancel - MDN, Animation.cancel() - Web Animations

commitStyles

public void commitStyles()

None.

See Also:

Animation.commitStyles - MDN, commitStyles() - Web Animations

finish

public void finish()

The finish() method of the Web Animations API's Animation Interface sets the current playback time to the end of the animation corresponding to the current playback direction.

See Also:

Animation.finish - MDN, finish() - Web Animations

pause

public void pause()

The pause() method of the Web Animations API's Animation interface suspends playback of the animation.

See Also:

Animation.pause - MDN, play() - Web Animations

persist

public void persist()

None.

See Also:

Animation.persist - MDN, persist() - Web Animations

play

public void play()

The play() method of the Web Animations API's Animation Interface starts or resumes playing of an animation. If the animation is finished, calling play() restarts the animation, playing it from the beginning.

See Also:

Animation.play - MDN, play() - Web Animations

reverse

public void reverse()

The Animation.reverse() method of the Animation Interface reverses the playback direction, meaning the animation ends at its beginning. If called on an unplayed animation, the whole animation is played backwards. If called on a paused animation, the animation will continue in reverse.

See Also:

Animation.reverse - MDN, reverse() - Web Animations

updatePlaybackRate

public void updatePlaybackRate(double playbackRate)

The updatePlaybackRate() method of the Web Animations API's Animation Interface sets the speed of an animation after first synchronizing its playback position.

See Also:

Animation.updatePlaybackRate - MDN, updatePlaybackRate() - Web Animations