javafx.animation

Class Timeline

java.lang.Object

javafx.animation.Animation

javafx.animation.Timeline

public final class Timeline
extends Animation

A Timeline can be used to define a free form animation of any javafx.beans.value.WritableValue, for example, all JavaFX Properties.

A Timeline, defined by one or more KeyFrames, processes individual KeyFrame sequentially, in the order specified by KeyFrame.time. The animated properties, defined as key values in KeyFrame.values, are interpolated to/from the targeted key values at the specified time of the KeyFrame to Timeline's initial position, depends on Timeline's direction.

Timeline processes individual KeyFrame at or after specified time interval elapsed, it does not guarantee the timing when KeyFrame is processed.

The Animation.cycleDurationProperty() will be set to the largest time value of Timeline's keyFrames.

If a KeyFrame is not provided for the time==0s instant, one will be synthesized using the target values that are current at the time Animation.play() or Animation.playFromStart() is called.

It is not possible to change the keyFrames of a running Timeline. If the value of keyFrames is changed for a running Timeline, it has to be stopped and started again to pick up the new value.

A simple Timeline can be created like this:

 final Timeline timeline = new Timeline();
 timeline.setCycleCount(2);
 timeline.setAutoReverse(true);
 timeline.getKeyFrames().add(new KeyFrame(Duration.millis(5000),
   new KeyValue (node.translateXProperty(), 25)));
 timeline.play();
 

This Timeline will run for 10s, animating the node by x axis to value 25 and then back to 0 on the second cycle.

Warning: A running Timeline is being referenced from the FX runtime. Infinite Timeline might result in a memory leak if not stopped properly. All the objects with animated properties would not be garbage collected.

Since:

JavaFX 2.0

See Also:

Animation, KeyFrame, KeyValue

Property Summary

Properties inherited from class javafx.animation.Animation

autoReverseProperty, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, onFinishedProperty, rateProperty, statusProperty, totalDurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class javafx.animation.Animation

Animation.Status

Field Summary

Fields

Modifier and Type	Field and Description
(package private) TimelineClipCore	clipCore
private <any>	keyFrames

Fields inherited from class javafx.animation.Animation

clipEnvelope, INDEFINITE, parent, pulseReceiver

Constructor Summary

Constructors

Constructor and Description
Timeline() The constructor of Timeline.
Timeline(AbstractMasterTimer timer)
Timeline(double targetFramerate) The constructor of Timeline.
Timeline(double targetFramerate, KeyFrame... keyFrames) The constructor of Timeline.
Timeline(KeyFrame... keyFrames) The constructor of Timeline.

Method Summary

Modifier and Type	Method and Description
(package private) void	doJumpTo(long currentTicks, long cycleTicks, boolean forceJump)
(package private) void	doPlayTo(long currentTicks, long cycleTicks)
(package private) void	doStart(boolean forceSync)
<any>	getKeyFrames() Returns the KeyFrames of this Timeline.
(package private) void	setCurrentRate(double currentRate)
void	stop() Stops the animation and resets the play head to its initial position.

Methods inherited from class javafx.animation.Animation

autoReverseProperty, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, doPause, doResume, doStop, doTimePulse, finished, getCuePoints, getCurrentRate, getCurrentTime, getCycleCount, getCycleDuration, getDelay, getOnFinished, getRate, getStatus, getTargetFramerate, getTotalDuration, isAutoReverse, jumpTo, onFinishedProperty, pause, pauseReceiver, play, playFrom, playFrom, playFromStart, rateProperty, resumeReceiver, setAutoReverse, setCurrentTicks, setCycleCount, setCycleDuration, setDelay, setOnFinished, setRate, setStatus, startable, startReceiver, statusProperty, sync, totalDurationProperty

Methods inherited from class java.lang.Object

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

Field Detail

clipCore

final TimelineClipCore clipCore

keyFrames

private final <any> keyFrames

Constructor Detail

Timeline

public Timeline(double targetFramerate,
                KeyFrame... keyFrames)

The constructor of Timeline. This constructor allows to define a Animation.targetFramerate.

Parameters:

targetFramerate - The custom target frame rate for this Timeline

keyFrames - The keyframes of this Timeline

Timeline

public Timeline(KeyFrame... keyFrames)

The constructor of Timeline.

Parameters:

keyFrames - The keyframes of this Timeline

Timeline

public Timeline(double targetFramerate)

The constructor of Timeline. This constructor allows to define a Animation.targetFramerate.

Parameters:

targetFramerate - The custom target frame rate for this Timeline

Timeline

public Timeline()

The constructor of Timeline.

Timeline

Timeline(AbstractMasterTimer timer)

Method Detail

getKeyFrames

public final <any> getKeyFrames()

Returns the KeyFrames of this Timeline.

Returns:

the KeyFrames

doPlayTo

void doPlayTo(long currentTicks,
              long cycleTicks)

Specified by:

doPlayTo in class Animation

doJumpTo

void doJumpTo(long currentTicks,
              long cycleTicks,
              boolean forceJump)

Specified by:

doJumpTo in class Animation

setCurrentRate

void setCurrentRate(double currentRate)

Overrides:

setCurrentRate in class Animation

doStart

void doStart(boolean forceSync)

Overrides:

doStart in class Animation

stop

public void stop()

Stops the animation and resets the play head to its initial position. If the animation is not currently running, this method has no effect.

Note:

• stop() is an asynchronous call, the Animation may not stop immediately.

Overrides:

stop in class Animation