Class ParallelTransition

java.lang.Object

javafx.animation.Animation

javafx.animation.Transition

javafx.animation.ParallelTransition

public final class ParallelTransition
extends Transition

This Transition plays a list of Animations in parallel.

Children of this Transition inherit node, if their node property is not specified.

Code Segment Example:

    Rectangle rect = new Rectangle (100, 40, 100, 100);
    rect.setArcHeight(50);
    rect.setArcWidth(50);
    rect.setFill(Color.VIOLET);

    final Duration SEC_2 = Duration.millis(2000);
    final Duration SEC_3 = Duration.millis(3000);

    FadeTransition ft = new FadeTransition(SEC_3);
    ft.setFromValue(1.0f);
    ft.setToValue(0.3f);
    ft.setCycleCount(2f);
    ft.setAutoReverse(true);
    TranslateTransition tt = new TranslateTransition(SEC_2);
    tt.setFromX(-100f);
    tt.setToX(100f);
    tt.setCycleCount(2f);
    tt.setAutoReverse(true);
    RotateTransition rt = new RotateTransition(SEC_3);
    rt.setByAngle(180f);
    rt.setCycleCount(4f);
    rt.setAutoReverse(true);
    ScaleTransition st = new ScaleTransition(SEC_2);
    st.setByX(1.5f);
    st.setByY(1.5f);
    st.setCycleCount(2f);
    st.setAutoReverse(true);

    ParallelTransition pt = new ParallelTransition(rect, ft, tt, rt, st);
    pt.play();

Since:

JavaFX 2.0

See Also:

• Transition
• Animation

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

Type	Property	Description
final ObjectProperty<Node>	node	This Node is used in all child Transitions, that do not define a target Node themselves.

Properties declared in class Transition

interpolator

Type	Property	Description
final ObjectProperty<Interpolator>	interpolator	Controls the timing for acceleration and deceleration at each Transition cycle.

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
ParallelTransition()	The constructor of ParallelTransition.
ParallelTransition(Animation... children)	The constructor of ParallelTransition.
ParallelTransition(Node node)	The constructor of ParallelTransition.
ParallelTransition(Node node, Animation... children)	The constructor of ParallelTransition.

Method Summary

Modifier and Type	Method	Description
final ObservableList<Animation>	getChildren()	A list of Animations that will be played sequentially.
final Node	getNode()	Gets the value of the node property.
protected void	interpolate(double frac)	The method interpolate() has to be provided by implementations of Transition.
final ObjectProperty<Node>	nodeProperty()	This Node is used in all child Transitions, that do not define a target Node themselves.
final void	setNode(Node value)	Sets the value of the node property.

Methods declared in class Transition

getCachedInterpolator, getInterpolator, getParentTargetNode, interpolatorProperty, setInterpolator

Modifier and Type	Method	Description
protected Interpolator	getCachedInterpolator()	Returns the Interpolator, that was set when the Transition was started.
final Interpolator	getInterpolator()	Gets the value of the interpolator property.
protected Node	getParentTargetNode()	Returns the first non-null target Node in the parent hierarchy of this Transition, or null if such a node is not found.
final ObjectProperty<Interpolator>	interpolatorProperty()	Controls the timing for acceleration and deceleration at each Transition cycle.
final void	setInterpolator(Interpolator value)	Sets the value of the interpolator property.

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

Property Details

node

public final ObjectProperty<Node> nodeProperty

This Node is used in all child Transitions, that do not define a target Node themselves. This can be used if a number of Transitions should be applied to a single Node.

It is not possible to change the target node of a running Transition. If the value of node is changed for a running Transition, the animation has to be stopped and started again to pick up the new value.

See Also:

• getNode()
• setNode(Node)
• nodeProperty()

Constructor Details

ParallelTransition

public ParallelTransition(Node node,
 Animation... children)

The constructor of ParallelTransition.

Parameters:

node - The target Node to be used in child Transitions that have no Node specified themselves

children - The child Animations of this ParallelTransition

ParallelTransition

public ParallelTransition(Animation... children)

The constructor of ParallelTransition.

Parameters:

children - The child Animations of this ParallelTransition

ParallelTransition

public ParallelTransition(Node node)

The constructor of ParallelTransition.

Parameters:

node - The target Node to be used in child Transitions that have no Node specified themselves

ParallelTransition

public ParallelTransition()

The constructor of ParallelTransition.

Method Details

setNode

public final void setNode(Node value)

Sets the value of the node property.

Property description:

This Node is used in all child Transitions, that do not define a target Node themselves. This can be used if a number of Transitions should be applied to a single Node.

It is not possible to change the target node of a running Transition. If the value of node is changed for a running Transition, the animation has to be stopped and started again to pick up the new value.

Parameters:

value - the value for the node property

See Also:

• getNode()
• nodeProperty()

getNode

public final Node getNode()

Gets the value of the node property.

Property description:

This Node is used in all child Transitions, that do not define a target Node themselves. This can be used if a number of Transitions should be applied to a single Node.

It is not possible to change the target node of a running Transition. If the value of node is changed for a running Transition, the animation has to be stopped and started again to pick up the new value.

Returns:

the value of the node property

See Also:

• setNode(Node)
• nodeProperty()

nodeProperty

public final ObjectProperty<Node> nodeProperty()

This Node is used in all child Transitions, that do not define a target Node themselves. This can be used if a number of Transitions should be applied to a single Node.

It is not possible to change the target node of a running Transition. If the value of node is changed for a running Transition, the animation has to be stopped and started again to pick up the new value.

Returns:

the node property

See Also:

• getNode()
• setNode(Node)

getChildren

public final ObservableList<Animation> getChildren()

A list of Animations that will be played sequentially.

It is not possible to change the children of a running ParallelTransition. If the children are changed for a running ParallelTransition, the animation has to be stopped and started again to pick up the new value.

Returns:

the list of Animations

interpolate

protected void interpolate(double frac)

The method interpolate() has to be provided by implementations of Transition. While a Transition is running, this method is called in every frame. The parameter defines the current position with the animation. At the start, the fraction will be 0.0 and at the end it will be 1.0. How the parameter increases, depends on the interpolator, e.g. if the interpolator is Interpolator.LINEAR, the fraction will increase linear. This method must not be called by the user directly.

Specified by:

interpolate in class Transition

Parameters:

frac - The relative position