Class FadeTransition
Transition
creates a fade effect animation that spans its
duration
. This is done by updating the opacity
variable of
the node
at regular interval.
It starts from the fromValue
if provided else uses the node
's
opacity
value.
It stops at the toValue
value if provided else it will use start
value plus byValue
.
The toValue
takes precedence if both toValue
and
byValue
are specified.
Code Segment Example:
import javafx.scene.shape.*;
import javafx.animation.*;
...
Rectangle rect = new Rectangle (100, 40, 100, 100);
rect.setArcHeight(50);
rect.setArcWidth(50);
rect.setFill(Color.VIOLET);
FadeTransition ft = new FadeTransition(Duration.millis(3000), rect);
ft.setFromValue(1.0);
ft.setToValue(0.3);
ft.setCycleCount(4);
ft.setAutoReverse(true);
ft.play();
...
- Since:
- JavaFX 2.0
- See Also:
-
Property Summary
TypePropertyDescriptionfinal DoubleProperty
Specifies the incremented stop opacity value, from the start, of thisFadeTransition
.final ObjectProperty<Duration>
The duration of thisFadeTransition
.final DoubleProperty
Specifies the start opacity value for thisFadeTransition
.final ObjectProperty<Node>
The target node of thisTransition
.final DoubleProperty
Specifies the stop opacity value for thisFadeTransition
.Properties inherited from class javafx.animation.Transition
interpolator
Properties inherited from class javafx.animation.Animation
autoReverse, currentRate, currentTime, cycleCount, cycleDuration, delay, onFinished, rate, status, totalDuration
-
Nested Class Summary
Nested classes/interfaces inherited from class javafx.animation.Animation
Animation.Status
-
Field Summary
Fields inherited from class javafx.animation.Animation
INDEFINITE, INDEFINITE_DURATION
-
Constructor Summary
ConstructorDescriptionThe constructor ofFadeTransition
FadeTransition
(Duration duration) The constructor ofFadeTransition
FadeTransition
(Duration duration, Node node) The constructor ofFadeTransition
-
Method Summary
Modifier and TypeMethodDescriptionfinal DoubleProperty
Specifies the incremented stop opacity value, from the start, of thisFadeTransition
.final ObjectProperty<Duration>
The duration of thisFadeTransition
.final DoubleProperty
Specifies the start opacity value for thisFadeTransition
.final double
Gets the value of thebyValue
property.final Duration
Gets the value of theduration
property.final double
Gets the value of thefromValue
property.final Node
getNode()
Gets the value of thenode
property.final double
Gets the value of thetoValue
property.protected void
interpolate
(double frac) The methodinterpolate()
has to be provided by implementations ofTransition
.final ObjectProperty<Node>
The target node of thisTransition
.final void
setByValue
(double value) Sets the value of thebyValue
property.final void
setDuration
(Duration value) Sets the value of theduration
property.final void
setFromValue
(double value) Sets the value of thefromValue
property.final void
Sets the value of thenode
property.final void
setToValue
(double value) Sets the value of thetoValue
property.final DoubleProperty
Specifies the stop opacity value for thisFadeTransition
.Methods inherited from class javafx.animation.Transition
getCachedInterpolator, getInterpolator, getParentTargetNode, interpolatorProperty, setInterpolator
Methods inherited from class javafx.animation.Animation
autoReverseProperty, callOnFinishedHandler, 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
-
Property Details
-
node
The target node of thisTransition
.It is not possible to change the target
node
of a runningFadeTransition
. If the value ofnode
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- See Also:
-
duration
The duration of thisFadeTransition
.It is not possible to change the
duration
of a runningFadeTransition
. If the value ofduration
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
.- Default value:
- 400ms
- See Also:
-
fromValue
Specifies the start opacity value for thisFadeTransition
.It is not possible to change
fromValue
of a runningFadeTransition
. If the value offromValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
toValue
Specifies the stop opacity value for thisFadeTransition
.It is not possible to change
toValue
of a runningFadeTransition
. If the value oftoValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- See Also:
-
byValue
Specifies the incremented stop opacity value, from the start, of thisFadeTransition
.It is not possible to change
byValue
of a runningFadeTransition
. If the value ofbyValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- See Also:
-
-
Constructor Details
-
FadeTransition
The constructor ofFadeTransition
- Parameters:
duration
- The duration of theFadeTransition
node
- Thenode
which opacity will be animated
-
FadeTransition
The constructor ofFadeTransition
- Parameters:
duration
- The duration of theFadeTransition
-
FadeTransition
public FadeTransition()The constructor ofFadeTransition
-
-
Method Details
-
setNode
Sets the value of thenode
property.- Property description:
- The target node of this
Transition
.It is not possible to change the target
node
of a runningFadeTransition
. If the value ofnode
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Parameters:
value
- the value for thenode
property- See Also:
-
getNode
Gets the value of thenode
property.- Property description:
- The target node of this
Transition
.It is not possible to change the target
node
of a runningFadeTransition
. If the value ofnode
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
node
property - See Also:
-
nodeProperty
The target node of thisTransition
.It is not possible to change the target
node
of a runningFadeTransition
. If the value ofnode
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- Returns:
- the
node
property - See Also:
-
setDuration
Sets the value of theduration
property.- Property description:
- The duration of this
FadeTransition
.It is not possible to change the
duration
of a runningFadeTransition
. If the value ofduration
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
. - Default value:
- 400ms
- Parameters:
value
- the value for theduration
property- See Also:
-
getDuration
Gets the value of theduration
property.- Property description:
- The duration of this
FadeTransition
.It is not possible to change the
duration
of a runningFadeTransition
. If the value ofduration
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
. - Default value:
- 400ms
- Returns:
- the value of the
duration
property - See Also:
-
durationProperty
The duration of thisFadeTransition
.It is not possible to change the
duration
of a runningFadeTransition
. If the value ofduration
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.Note: While the unit of
duration
is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms. Setting duration to value lower thanDuration.ZERO
will result inIllegalArgumentException
.- Default value:
- 400ms
- Returns:
- the
duration
property - See Also:
-
setFromValue
public final void setFromValue(double value) Sets the value of thefromValue
property.- Property description:
- Specifies the start opacity value for this
FadeTransition
.It is not possible to change
fromValue
of a runningFadeTransition
. If the value offromValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thefromValue
property- See Also:
-
getFromValue
public final double getFromValue()Gets the value of thefromValue
property.- Property description:
- Specifies the start opacity value for this
FadeTransition
.It is not possible to change
fromValue
of a runningFadeTransition
. If the value offromValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
fromValue
property - See Also:
-
fromValueProperty
Specifies the start opacity value for thisFadeTransition
.It is not possible to change
fromValue
of a runningFadeTransition
. If the value offromValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
fromValue
property - See Also:
-
setToValue
public final void setToValue(double value) Sets the value of thetoValue
property.- Property description:
- Specifies the stop opacity value for this
FadeTransition
.It is not possible to change
toValue
of a runningFadeTransition
. If the value oftoValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Parameters:
value
- the value for thetoValue
property- See Also:
-
getToValue
public final double getToValue()Gets the value of thetoValue
property.- Property description:
- Specifies the stop opacity value for this
FadeTransition
.It is not possible to change
toValue
of a runningFadeTransition
. If the value oftoValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Default value:
Double.NaN
- Returns:
- the value of the
toValue
property - See Also:
-
toValueProperty
Specifies the stop opacity value for thisFadeTransition
.It is not possible to change
toValue
of a runningFadeTransition
. If the value oftoValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- Default value:
Double.NaN
- Returns:
- the
toValue
property - See Also:
-
setByValue
public final void setByValue(double value) Sets the value of thebyValue
property.- Property description:
- Specifies the incremented stop opacity value, from the start, of this
FadeTransition
.It is not possible to change
byValue
of a runningFadeTransition
. If the value ofbyValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Parameters:
value
- the value for thebyValue
property- See Also:
-
getByValue
public final double getByValue()Gets the value of thebyValue
property.- Property description:
- Specifies the incremented stop opacity value, from the start, of this
FadeTransition
.It is not possible to change
byValue
of a runningFadeTransition
. If the value ofbyValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value. - Returns:
- the value of the
byValue
property - See Also:
-
byValueProperty
Specifies the incremented stop opacity value, from the start, of thisFadeTransition
.It is not possible to change
byValue
of a runningFadeTransition
. If the value ofbyValue
is changed for a runningFadeTransition
, the animation has to be stopped and started again to pick up the new value.- Returns:
- the
byValue
property - See Also:
-
interpolate
protected void interpolate(double frac) The methodinterpolate()
has to be provided by implementations ofTransition
. While aTransition
is running, this method is called in every frame. The parameter defines the current position with the animation. At the start, the fraction will be0.0
and at the end it will be1.0
. How the parameter increases, depends on theinterpolator
, e.g. if theinterpolator
isInterpolator.LINEAR
, the fraction will increase linear. This method must not be called by the user directly.- Specified by:
interpolate
in classTransition
- Parameters:
frac
- The relative position
-