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 WritableValue, for example, all JavaFX Properties.

A Timeline, defined by one or more KeyFrames, processes individual KeyFrames 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 an individual KeyFrame at or after the specified time interval elapsed, it does not guarantee the exact time when a KeyFrame is processed.

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() are 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.

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

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

Nested Class Summary

Nested classes/interfaces declared in class Animation

Animation.Status

Modifier and Type	Class	Description
static enum	Animation.Status	The possible states for status.

Property Summary

Properties declared in class Animation

autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration

Type	Property	Description
final BooleanProperty	autoReverse	Defines whether this Animation reverses direction on alternating cycles.
final ReadOnlyDoubleProperty	currentRate	Read-only variable to indicate current direction/speed at which the Animation is being played.
final ReadOnlyObjectProperty<Duration>	currentTime	Defines the Animation's play head position.
final IntegerProperty	cycleCount	Defines the number of cycles in this animation.
final ReadOnlyObjectProperty<Duration>	cycleDuration	Read-only variable to indicate the duration of one cycle of this Animation: the time it takes to play from time 0 to the end of the Animation (at the default rate of 1.0).
final ObjectProperty<Duration>	delay	Delays the start of an animation.
final ObjectProperty<EventHandler<ActionEvent>>	onFinished	The action to be executed at the conclusion of this Animation.
final DoubleProperty	rate	Defines the direction/speed at which the Animation is expected to be played.
final ReadOnlyObjectProperty<Animation.Status>	status	The status of the Animation.
final ReadOnlyObjectProperty<Duration>	totalDuration	Read-only variable to indicate the total duration of this Animation, including repeats.

Field Summary

Fields declared in class Animation

INDEFINITE

Modifier and Type	Field	Description
static final int	INDEFINITE	Used as a value for cycleCount to specify an animation that repeats indefinitely, until the stop() method is called.

Constructor Summary

Constructors

Constructor	Description
Timeline()	Creates a Timeline with no key frames.
Timeline(double targetFramerate)	Creates a Timeline with no key frames and a target framerate.
Timeline(double targetFramerate, KeyFrame... keyFrames)	Creates a Timeline with the provided key frames and a target framerate.
Timeline(KeyFrame... keyFrames)	Creates a Timeline with the provided key frames.

Method Summary

Modifier and Type	Method	Description
final ObservableList<KeyFrame>	getKeyFrames()	Returns the KeyFrames of this Timeline.

Methods declared in class Animation

autoReverseProperty, currentRateProperty, currentTimeProperty, cycleCountProperty, cycleDurationProperty, delayProperty, getCuePoints, getCurrentRate, getCurrentTime, getCycleCount, getCycleDuration, getDelay, getOnFinished, getRate, getStatus, getTargetFramerate, getTotalDuration, isAutoReverse, jumpTo, jumpTo, onFinishedProperty, pause, play, playFrom, playFrom, playFromStart, rateProperty, setAutoReverse, setCycleCount, setCycleDuration, setDelay, setOnFinished, setRate, setStatus, statusProperty, stop, totalDurationProperty

Modifier and Type	Method	Description
final BooleanProperty	autoReverseProperty()	Defines whether this Animation reverses direction on alternating cycles.
final ReadOnlyDoubleProperty	currentRateProperty()	Read-only variable to indicate current direction/speed at which the Animation is being played.
final ReadOnlyObjectProperty<Duration>	currentTimeProperty()	Defines the Animation's play head position.
final IntegerProperty	cycleCountProperty()	Defines the number of cycles in this animation.
final ReadOnlyObjectProperty<Duration>	cycleDurationProperty()	Read-only variable to indicate the duration of one cycle of this Animation: the time it takes to play from time 0 to the end of the Animation (at the default rate of 1.0).
final ObjectProperty<Duration>	delayProperty()	Delays the start of an animation.
final ObservableMap<String,Duration>	getCuePoints()	The cue points can be used to mark important positions of the Animation.
final double	getCurrentRate()	Gets the value of the currentRate property.
final Duration	getCurrentTime()	Gets the value of the currentTime property.
final int	getCycleCount()	Gets the value of the cycleCount property.
final Duration	getCycleDuration()	Gets the value of the cycleDuration property.
final Duration	getDelay()	Gets the value of the delay property.
final EventHandler<ActionEvent>	getOnFinished()	Gets the value of the onFinished property.
final double	getRate()	Gets the value of the rate property.
final Animation.Status	getStatus()	Gets the value of the status property.
final double	getTargetFramerate()	The target framerate is the maximum framerate at which this Animation will run, in frames per second.
final Duration	getTotalDuration()	Gets the value of the totalDuration property.
final boolean	isAutoReverse()	Gets the value of the autoReverse property.
void	jumpTo(String cuePoint)	Jumps to a predefined position in this Animation.
void	jumpTo(Duration time)	Jumps to a given position in this Animation.
final ObjectProperty<EventHandler<ActionEvent>>	onFinishedProperty()	The action to be executed at the conclusion of this Animation.
void	pause()	Pauses the animation.
void	play()	Plays Animation from current position in the direction indicated by rate.
void	playFrom(String cuePoint)	A convenience method to play this Animation from a predefined position.
void	playFrom(Duration time)	A convenience method to play this Animation from a specific position.
void	playFromStart()	Plays an Animation from initial position in forward direction.
final DoubleProperty	rateProperty()	Defines the direction/speed at which the Animation is expected to be played.
final void	setAutoReverse(boolean value)	Sets the value of the autoReverse property.
final void	setCycleCount(int value)	Sets the value of the cycleCount property.
protected final void	setCycleDuration(Duration value)	Sets the value of the cycleDuration property.
final void	setDelay(Duration value)	Sets the value of the delay property.
final void	setOnFinished(EventHandler<ActionEvent> value)	Sets the value of the onFinished property.
final void	setRate(double value)	Sets the value of the rate property.
protected final void	setStatus(Animation.Status value)	Sets the value of the status property.
final ReadOnlyObjectProperty<Animation.Status>	statusProperty()	The status of the Animation.
void	stop()	Stops the animation and resets the play head to its initial position.
final ReadOnlyObjectProperty<Duration>	totalDurationProperty()	Read-only variable to indicate the total duration of this Animation, including repeats.

Methods declared in class Object

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

Constructor Details

Timeline

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

Creates a Timeline with the provided key frames and a target framerate. The key frames do not need to be ordered.

Parameters:

targetFramerate - the custom target frame rate for this Timeline

keyFrames - the keyframes of this Timeline

Timeline

public Timeline(KeyFrame... keyFrames)

Creates a Timeline with the provided key frames. The key frames do not need to be ordered.

Parameters:

keyFrames - the keyframes of this Timeline

Timeline

public Timeline(double targetFramerate)

Creates a Timeline with no key frames and a target framerate.

Parameters:

targetFramerate - the custom target frame rate for this Timeline

Timeline

public Timeline()

Creates a Timeline with no key frames.

Method Details

getKeyFrames

public final ObservableList<KeyFrame> getKeyFrames()

Returns the KeyFrames of this Timeline.

Returns:

the KeyFrames