Module MaterialFX

Package io.github.palexdev.materialfx.utils

Class AnimationUtils.AbstractBuilder

java.lang.Object

io.github.palexdev.materialfx.utils.AnimationUtils.AbstractBuilder

Direct Known Subclasses:

AnimationUtils.ParallelBuilder, AnimationUtils.SequentialBuilder

Enclosing class:

AnimationUtils

public abstract static class AnimationUtils.AbstractBuilder
extends Object

Common base class for AnimationUtils.ParallelBuilder and AnimationUtils.SequentialBuilder.

This builder, designed with fluent api, allows you to create simple and complex animations with just a few lines of code.

The builder keeps the reference of the "main" animation (depending on the subclass can be ParallelTransition or SequentialTransition, in the AbstractBuilder the type is a generic Animation), and defines and abstract method that subclasses must implement to properly add animations to the "main".

Field Summary

Fields

Modifier and Type	Field	Description
protected Animation	animation

Constructor Summary

Constructors

Constructor	Description
AbstractBuilder()

Method Summary

Modifier and Type	Method	Description
AnimationUtils.AbstractBuilder	add(Supplier<Animation> animationSupplier)	Gets the animation from the supplier and adds it to the "main" animation by calling addAnimation(Animation).
AnimationUtils.AbstractBuilder	add(Supplier<Animation> animationSupplier, EventHandler<ActionEvent> onFinished)	Gets the animation from the supplier, sets the given onFinished action to it and then adds it to the "main" animation by calling addAnimation(Animation).
AnimationUtils.AbstractBuilder	add(Animation animation)	Adds the given animation to the "main" animation by calling addAnimation(Animation).
AnimationUtils.AbstractBuilder	add(Animation animation, EventHandler<ActionEvent> onFinished)	Sets the given onFinished action to the given animation and then adds it to the "main" animation by calling addAnimation(Animation).
AnimationUtils.AbstractBuilder	add(KeyFrame... keyFrames)	Builds a Timeline with the given keyframes and adds it to the "main" animation by calling addAnimation(Animation).
AnimationUtils.AbstractBuilder	add(EventHandler<ActionEvent> onFinished, KeyFrame... keyFrames)	Builds a Timeline with the given keyframes, sets the given onFinished action to it and then adds it to the "main" animation by calling addAnimation(Animation).
protected abstract void	addAnimation(Animation animation)	Adds the given animation to the "main" animation.
AnimationUtils.AbstractBuilder	disable(Duration duration, Node... nodes)	For each given node builds and adds an animation that disables the node after the given duration of time.
AnimationUtils.AbstractBuilder	enable(Duration duration, Node... nodes)	For each given node builds and adds an animation that enables the node after the given duration of time.
abstract Animation	getAnimation()
AnimationUtils.AbstractBuilder	hide(double millis, Node... nodes)	Calls hide(Duration, Node...) by converting the given millis value with Duration.millis(double).
AnimationUtils.AbstractBuilder	hide(double millis, Window... windows)	Calls hide(Duration, Window...) by converting the given millis value with Duration.millis(double).
final AnimationUtils.AbstractBuilder	hide(AnimationsData... data)	Creates and adds a fade out animation for each given AnimationsData.
AnimationUtils.AbstractBuilder	hide(Duration duration, Node... nodes)	For each given node builds and adds an animation that hides the node by fading it out.
AnimationUtils.AbstractBuilder	hide(Duration duration, Window... windows)	For each given window builds and adds an animation that hides the window by fading it out.
protected void	init(Animation animation)
AnimationUtils.AbstractBuilder	setCycleCount(int cycleCount)	Sets the "main" animation cycle count.
AnimationUtils.AbstractBuilder	setDelay(double millis)	Sets the "main" animation delay.
AnimationUtils.AbstractBuilder	setDelay(Duration delay)	Sets the "main" animation delay.
AnimationUtils.AbstractBuilder	setOnFinished(EventHandler<ActionEvent> onFinished)	Sets the action to perform when the "main" animation ends.
AnimationUtils.AbstractBuilder	setRate(double rate)	Sets the "main" animation rate/speed.
AnimationUtils.AbstractBuilder	show(double millis, Node... nodes)	Calls show(Duration, Node...) by converting the given millis value with Duration.millis(double).
AnimationUtils.AbstractBuilder	show(double millis, Window... windows)	Calls show(Duration, Window...) by converting the given millis value with Duration.millis(double).
final AnimationUtils.AbstractBuilder	show(AnimationsData... data)	Creates and adds a fade in animation for each given AnimationsData.
AnimationUtils.AbstractBuilder	show(Duration duration, Node... nodes)	For each given node builds and adds an animation that shows the node by fading it in.
AnimationUtils.AbstractBuilder	show(Duration duration, Window... windows)	For each given window builds and adds an animation that shows the window by fading it in.

Methods inherited from class java.lang.Object

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

Field Details

animation

protected Animation animation

Constructor Details

AbstractBuilder

public AbstractBuilder()

Method Details

addAnimation

protected abstract void addAnimation(Animation animation)

Adds the given animation to the "main" animation.

getAnimation

public abstract Animation getAnimation()

Returns:

the "main" animation instance

init

protected void init(Animation animation)

add

public AnimationUtils.AbstractBuilder add(Animation animation)

Adds the given animation to the "main" animation by calling addAnimation(Animation).

add

public AnimationUtils.AbstractBuilder add(Animation animation,
 EventHandler<ActionEvent> onFinished)

Sets the given onFinished action to the given animation and then adds it to the "main" animation by calling addAnimation(Animation).

add

public AnimationUtils.AbstractBuilder add(Supplier<Animation> animationSupplier)

Gets the animation from the supplier and adds it to the "main" animation by calling addAnimation(Animation).

add

public AnimationUtils.AbstractBuilder add(Supplier<Animation> animationSupplier,
 EventHandler<ActionEvent> onFinished)

Gets the animation from the supplier, sets the given onFinished action to it and then adds it to the "main" animation by calling addAnimation(Animation).

add

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

Builds a Timeline with the given keyframes and adds it to the "main" animation by calling addAnimation(Animation).

add

public AnimationUtils.AbstractBuilder add(EventHandler<ActionEvent> onFinished,
 KeyFrame... keyFrames)

Builds a Timeline with the given keyframes, sets the given onFinished action to it and then adds it to the "main" animation by calling addAnimation(Animation).

disable

public AnimationUtils.AbstractBuilder disable(Duration duration,
 Node... nodes)

For each given node builds and adds an animation that disables the node after the given duration of time.

Parameters:

duration - the time after which the nodes are disabled

enable

public AnimationUtils.AbstractBuilder enable(Duration duration,
 Node... nodes)

For each given node builds and adds an animation that enables the node after the given duration of time.

Parameters:

duration - the duration after which the nodes are enabled

hide

public AnimationUtils.AbstractBuilder hide(Duration duration,
 Window... windows)

For each given window builds and adds an animation that hides the window by fading it out.

Parameters:

duration - the fade animation speed

hide

public AnimationUtils.AbstractBuilder hide(double millis,
 Window... windows)

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

hide

public AnimationUtils.AbstractBuilder hide(Duration duration,
 Node... nodes)

For each given node builds and adds an animation that hides the node by fading it out.

Parameters:

duration - the fade animation speed

hide

public AnimationUtils.AbstractBuilder hide(double millis,
 Node... nodes)

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

hide

public final AnimationUtils.AbstractBuilder hide(AnimationsData... data)

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

show

public AnimationUtils.AbstractBuilder show(Duration duration,
 Window... windows)

For each given window builds and adds an animation that shows the window by fading it in.

Parameters:

duration - the fade animation speed

show

public AnimationUtils.AbstractBuilder show(double millis,
 Window... windows)

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

show

public AnimationUtils.AbstractBuilder show(Duration duration,
 Node... nodes)

For each given node builds and adds an animation that shows the node by fading it in.

Parameters:

duration - the fade animation speed

show

public AnimationUtils.AbstractBuilder show(double millis,
 Node... nodes)

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

show

public final AnimationUtils.AbstractBuilder show(AnimationsData... data)

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

setOnFinished

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

Sets the action to perform when the "main" animation ends.

setCycleCount

public AnimationUtils.AbstractBuilder setCycleCount(int cycleCount)

Sets the "main" animation cycle count.

setDelay

public AnimationUtils.AbstractBuilder setDelay(Duration delay)

Sets the "main" animation delay.

setDelay

public AnimationUtils.AbstractBuilder setDelay(double millis)

Sets the "main" animation delay.

setRate

public AnimationUtils.AbstractBuilder setRate(double rate)

Sets the "main" animation rate/speed.