Module MaterialFX

Package io.github.palexdev.materialfx.utils

Class AnimationUtils.TimelineBuilder

java.lang.Object

io.github.palexdev.materialfx.utils.AnimationUtils.TimelineBuilder

Enclosing class:

AnimationUtils

public static class AnimationUtils.TimelineBuilder
extends Object

Builder class to easily create a Timeline with fluent api.

Constructor Summary

Constructors

Constructor	Description
TimelineBuilder()

Method Summary

Modifier and Type	Method	Description
AnimationUtils.TimelineBuilder	add(KeyFrame... keyFrames)	Adds the specified KeyFrames to the timeline.
static AnimationUtils.TimelineBuilder	build()
Timeline	getAnimation()
AnimationUtils.TimelineBuilder	hide(double millis, Node node)	Calls hide(Duration, Node) by converting the given millis value with Duration.millis(double).
AnimationUtils.TimelineBuilder	hide(double millis, Window window)	Calls hide(Duration, Window) by converting the given millis value with Duration.millis(double).
final AnimationUtils.TimelineBuilder	hide(AnimationsData data)	Builds the KeyFrames to hide the specified node in the AnimationsData bean, by fading it out.
AnimationUtils.TimelineBuilder	hide(Duration duration, Node node)	Builds the KeyFrames to hide the given node by fading it out.
AnimationUtils.TimelineBuilder	hide(Duration duration, Window window)	Builds a KeyFrame to hide the given Window by fading it out.
AnimationUtils.TimelineBuilder	setCycleCount(int cycleCount)	Sets the timeline cycle count.
AnimationUtils.TimelineBuilder	setDelay(double millis)	Sets the timeline delay.
AnimationUtils.TimelineBuilder	setDelay(Duration delay)	Sets the timeline delay.
AnimationUtils.TimelineBuilder	setOnFinished(EventHandler<ActionEvent> onFinished)	Sets the action to perform when the timeline ends.
AnimationUtils.TimelineBuilder	setRate(double rate)	Sets the timeline rate/speed.
AnimationUtils.TimelineBuilder	show(double millis, Node node)	Calls show(Duration, Node) by converting the given millis value with Duration.millis(double).
AnimationUtils.TimelineBuilder	show(double millis, Window window)	Calls show(Duration, Window) by converting the given millis value with Duration.millis(double).
final AnimationUtils.TimelineBuilder	show(AnimationsData data)	Creates and adds a fade in animation for each given AnimationsData.
AnimationUtils.TimelineBuilder	show(Duration duration, Node node)	Builds the KeyFrames to show the given node by fading it in.
AnimationUtils.TimelineBuilder	show(Duration duration, Window window)	Builds a KeyFrame to show the given Window by fading it in.

Methods inherited from class java.lang.Object

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

Constructor Details

TimelineBuilder

public TimelineBuilder()

Method Details

build

public static AnimationUtils.TimelineBuilder build()

Returns:

a new TimelineBuilder instance. Equivalent to calling the constructor, it's just a way to omit the new keyword

add

public AnimationUtils.TimelineBuilder add(KeyFrame... keyFrames)

Adds the specified KeyFrames to the timeline.

hide

public AnimationUtils.TimelineBuilder hide(Duration duration,
 Window window)

Builds a KeyFrame to hide the given Window by fading it out.

Parameters:

duration - the fade animation speed

hide

public AnimationUtils.TimelineBuilder hide(double millis,
 Window window)

Calls hide(Duration, Window) by converting the given millis value with Duration.millis(double).

hide

public AnimationUtils.TimelineBuilder hide(Duration duration,
 Node node)

Builds the KeyFrames to hide the given node by fading it out.

Parameters:

duration - the fade animation speed

hide

public AnimationUtils.TimelineBuilder hide(double millis,
 Node node)

Calls hide(Duration, Node) by converting the given millis value with Duration.millis(double).

hide

public final AnimationUtils.TimelineBuilder hide(AnimationsData data)

Builds the KeyFrames to hide the specified node in the AnimationsData bean, by fading it out.

show

public AnimationUtils.TimelineBuilder show(Duration duration,
 Window window)

Builds a KeyFrame to show the given Window by fading it in.

Parameters:

duration - the fade animation speed

show

public AnimationUtils.TimelineBuilder show(double millis,
 Window window)

Calls show(Duration, Window) by converting the given millis value with Duration.millis(double).

show

public AnimationUtils.TimelineBuilder show(Duration duration,
 Node node)

Builds the KeyFrames to show the given node by fading it in.

Parameters:

duration - the fade animation speed

show

public AnimationUtils.TimelineBuilder show(double millis,
 Node node)

Calls show(Duration, Node) by converting the given millis value with Duration.millis(double).

show

public final AnimationUtils.TimelineBuilder show(AnimationsData data)

Creates and adds a fade in animation for each given AnimationsData.

setCycleCount

public AnimationUtils.TimelineBuilder setCycleCount(int cycleCount)

Sets the timeline cycle count.

setDelay

public AnimationUtils.TimelineBuilder setDelay(Duration delay)

Sets the timeline delay.

setDelay

public AnimationUtils.TimelineBuilder setDelay(double millis)

Sets the timeline delay.

setRate

public AnimationUtils.TimelineBuilder setRate(double rate)

Sets the timeline rate/speed.

setOnFinished

public AnimationUtils.TimelineBuilder setOnFinished(EventHandler<ActionEvent> onFinished)

Sets the action to perform when the timeline ends.

getAnimation

public Timeline getAnimation()

Returns:

the instance of the Timeline