io.datafx.controller.flow.container

Class AnimatedFlowContainer

java.lang.Object

io.datafx.controller.flow.container.AnimatedFlowContainer

All Implemented Interfaces:

FlowContainer<javafx.scene.layout.StackPane>

public class AnimatedFlowContainer
extends java.lang.Object
implements FlowContainer<javafx.scene.layout.StackPane>

A FlowContainer that supports animation for the view change.

Constructor Summary

Constructors

Constructor and Description
AnimatedFlowContainer() Defaults constructor that creates a container with a fade animation that last 320 ms.
AnimatedFlowContainer(javafx.util.Duration duration) Creates a container with a fade animation and the given duration
AnimatedFlowContainer(javafx.util.Duration duration, ContainerAnimations animation) Creates a container with the given animation type and duration
AnimatedFlowContainer(javafx.util.Duration duration, java.util.function.Function<AnimatedFlowContainer,java.util.List<javafx.animation.KeyFrame>> animationProducer) Creates a container with the given animation type and duration

Method Summary

Modifier and Type	Method and Description
javafx.util.Duration	getDuration() Returns the duration for the animation
javafx.scene.image.ImageView	getPlaceholder() Returns the ImageView instance that is used as a placeholder for the old view in each navigation animation.
javafx.scene.layout.StackPane	getView() Return the Parent node that is rendering the flow.
<U> void	setViewContext(ViewContext<U> context) The given view will be the new view of the flow.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimatedFlowContainer

public AnimatedFlowContainer()

Defaults constructor that creates a container with a fade animation that last 320 ms.

AnimatedFlowContainer

public AnimatedFlowContainer(javafx.util.Duration duration)

Creates a container with a fade animation and the given duration

Parameters:

duration - the duration of the animation

AnimatedFlowContainer

public AnimatedFlowContainer(javafx.util.Duration duration,
                             ContainerAnimations animation)

Creates a container with the given animation type and duration

Parameters:

duration - the duration of the animation

animation - the animation type

AnimatedFlowContainer

public AnimatedFlowContainer(javafx.util.Duration duration,
                             java.util.function.Function<AnimatedFlowContainer,java.util.List<javafx.animation.KeyFrame>> animationProducer)

Creates a container with the given animation type and duration

Parameters:

duration - the duration of the animation

animationProducer - the KeyFrame instances that define the animation

Method Detail

setViewContext

public <U> void setViewContext(ViewContext<U> context)

Description copied from interface: FlowContainer

The given view will be the new view of the flow. Implementations should add the he Node of the view to the scene graph and remove the old view.

Specified by:

setViewContext in interface FlowContainer<javafx.scene.layout.StackPane>

Parameters:

context - Context of the current view

getPlaceholder

public javafx.scene.image.ImageView getPlaceholder()

Returns the ImageView instance that is used as a placeholder for the old view in each navigation animation.

Returns:

getDuration

public javafx.util.Duration getDuration()

Returns the duration for the animation

Returns:

the duration for the animation

getView

public javafx.scene.layout.StackPane getView()

Description copied from interface: FlowContainer

Return the Parent node that is rendering the flow.

Specified by:

getView in interface FlowContainer<javafx.scene.layout.StackPane>

Returns:

the Parent node that is rendering the flow