JFXAnimationTemplate (jfxanimation 1.0.0 API)

java.lang.Object
- de.schlegel11.jfxanimation.JFXAnimationTemplate<N>

All Implemented Interfaces:

JFXTemplateAction<N>, JFXTemplateBuilder<N>, JFXTemplateConfig<N>, JFXTemplateProcess<N>
```
public class JFXAnimationTemplate<N>
extends Object
implements JFXTemplateConfig<N>, JFXTemplateBuilder<N>
```
Class which represents a general JFXAnimationTemplate.
This class is responsible for providing methods where it's possible to build a CSS like structured animation.

Since:

2018-09-18

Author:

Marcel Schlegel (schlegel11)

Nested Class Summary
- Nested classes/interfaces inherited from interface de.schlegel11.jfxanimation.JFXTemplateBuilder
  JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JFXTemplateConfig<N>`	`action(Function<JFXAnimationTemplateAction.InitBuilder<N>,JFXAnimationTemplateAction.Builder<?,?>> valueBuilderFunction)` The action method is similar like a `KeyValue`.
`JFXTemplateConfig<N>`	`action(JFXAnimationTemplateAction.Builder<?,?> animationValueBuilder)` Same as the `JFXTemplateAction.action(Function)` method but without the lazy behaviour and doesn't provide a `JFXAnimationTemplateAction.builder()` instance.
`javafx.animation.Timeline`	`build()` Same method as `JFXTemplateBuilder.build(Object)` )} but takes no default animation object.
`<B> B`	`build(Function<JFXAnimationTemplate<N>,B> builderFunction, Function<JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>,JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>> mapBuilderFunction)` Method which handles a specific builder`Function` which provides the `JFXAnimationTemplate` and should return a specific representation of the animation e.g. a `Timeline`.
`<B> B`	`build(Function<JFXAnimationTemplate<N>,B> builderFunction, N defaultAnimationObject)` Same method as `JFXTemplateBuilder.build(Function, Function)` but takes directly one default animation object.
`javafx.animation.Timeline`	`build(Function<JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>,JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>> mapBuilderFunction)` Same method as `JFXTemplateBuilder.build(Function, Function)` but returns directly a `Timeline` instance as specific animation representation.
`javafx.animation.Timeline`	`build(N defaultAnimationObject)` Same method as `JFXTemplateBuilder.build(Function, Object)` but returns directly a `Timeline` instance as specific animation representation and takes a default animation object.
`Map<Double,List<JFXAnimationTemplateAction<?,?>>>`	`buildAndGetAnimationValues()`
`JFXAnimationTemplateConfig`	`buildAndGetTemplateConfig()`
`JFXTemplateBuilder<N>`	`config(Function<JFXAnimationTemplateConfig.Builder,JFXAnimationTemplateConfig.Builder> configBuilderFunction)` The method provides via a `Function` an config builder `JFXAnimationTemplateConfig.builder()` which holds all the specific methods.
`JFXTemplateBuilder<N>`	`config(JFXAnimationTemplateConfig.Builder configBuilder)` Same as the `JFXTemplateConfig.config(Function)` method but without the lazy behaviour and doesn't provide a `JFXAnimationTemplateConfig.builder()` instance.
`static JFXTemplateProcess<javafx.scene.Node>`	`create()` Same method as `create(Class)` but with the default type `Node`.
`static <N> JFXTemplateProcess<N>`	`create(Class<N> animationObjectType)` Create a `JFXTemplateProcess` with a specific default animation type.
`JFXTemplateAction<N>`	`from()` Defines a percentage value of 0 in the specific animation interval.
`JFXTemplateAction<N>`	`percent(double first, double... rest)` Takes a percentage value or percentage values between 0 and 100 which defines the specific animation interval.
`JFXTemplateAction<N>`	`to()` Defines a percentage value of 100 in the specific animation interval.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static <N> JFXTemplateProcess<N> create(Class<N> animationObjectType)
```
    Create a JFXTemplateProcess with a specific default animation type.
    The default animation objects with this type are set later in the JFXTemplateBuilder.build(Object) method.
    These objects are generally used in JFXTemplateAction.action(Function) methods.
    
    Type Parameters:
    
    N - the specific type.
    
    Parameters:
    
    animationObjectType - a specific animation object type.
    
    Returns:
    
    a JFXTemplateProcess instance.
  - create
```
public static JFXTemplateProcess<javafx.scene.Node> create()
```
    Same method as create(Class) but with the default type Node. This type is a general default type in a JFXAnimationTemplate.
    
    Returns:
    
    a JFXTemplateProcess instance.
    
    See Also:
    
    create(Class)
  - buildAndGetAnimationValues
```
public Map<Double,List<JFXAnimationTemplateAction<?,?>>> buildAndGetAnimationValues()
```
  - buildAndGetTemplateConfig
```
public JFXAnimationTemplateConfig buildAndGetTemplateConfig()
```
  - percent
```
public JFXTemplateAction<N> percent(double first,
                                    double... rest)
```
    Description copied from interface: JFXTemplateProcess
    
    Takes a percentage value or percentage values between 0 and 100 which defines the specific animation interval.
    
    Specified by:
    
    percent in interface JFXTemplateProcess<N>
    
    Parameters:
    
    first - the percentage value.
    
    rest - the percentage values.
    
    Returns:
    
    A JFXTemplateAction instance.
  - from
```
public JFXTemplateAction<N> from()
```
    Description copied from interface: JFXTemplateProcess
    
    Defines a percentage value of 0 in the specific animation interval.
    
    Specified by:
    
    from in interface JFXTemplateProcess<N>
    
    Returns:
    
    A JFXTemplateAction instance.
  - to
```
public JFXTemplateAction<N> to()
```
    Description copied from interface: JFXTemplateProcess
    
    Defines a percentage value of 100 in the specific animation interval.
    
    Specified by:
    
    to in interface JFXTemplateProcess<N>
    
    Returns:
    
    A JFXTemplateAction instance.
  - action
```
public JFXTemplateConfig<N> action(Function<JFXAnimationTemplateAction.InitBuilder<N>,JFXAnimationTemplateAction.Builder<?,?>> valueBuilderFunction)
```
    Description copied from interface: JFXTemplateAction
    The action method is similar like a KeyValue.
    The method provides via a Function an action builder JFXAnimationTemplateAction.builder() which holds all the specific methods.
    Example:
```
 .action(b -> b.target(Node::opacityProperty).endValue(0))
 
```
    Specified by:
    
    action in interface JFXTemplateAction<N>
    
    Parameters:
    
    valueBuilderFunction - a Function which provides and accepts an JFXAnimationTemplateAction builder.
    
    Returns:
    
    a JFXTemplateConfig instance.
  - action
```
public JFXTemplateConfig<N> action(JFXAnimationTemplateAction.Builder<?,?> animationValueBuilder)
```
    Description copied from interface: JFXTemplateAction
    
    Same as the JFXTemplateAction.action(Function) method but without the lazy behaviour and doesn't provide a JFXAnimationTemplateAction.builder() instance.
    
    Specified by:
    
    action in interface JFXTemplateAction<N>
    
    Parameters:
    
    animationValueBuilder - the JFXAnimationTemplateAction.builder() instance.
    
    Returns:
    
    a JFXTemplateConfig instance.
    
    See Also:
    
    JFXTemplateAction.action(Function)
  - config
```
public JFXTemplateBuilder<N> config(Function<JFXAnimationTemplateConfig.Builder,JFXAnimationTemplateConfig.Builder> configBuilderFunction)
```
    Description copied from interface: JFXTemplateConfig
    The method provides via a Function an config builder JFXAnimationTemplateConfig.builder() which holds all the specific methods.
    These JFXAnimationTemplateConfig.builder() methods represents the methods e.g. from a Timeline.
    Example:
```
 .config(b -> b.duration(Duration.seconds(2)).interpolator(Interpolator.EASE_BOTH))
 
```
    Specified by:
    
    config in interface JFXTemplateConfig<N>
    
    Parameters:
    
    configBuilderFunction - a Function which provides and accepts an JFXAnimationTemplateConfig builder.
    
    Returns:
    
    a JFXTemplateBuilder instance.
  - config
```
public JFXTemplateBuilder<N> config(JFXAnimationTemplateConfig.Builder configBuilder)
```
    Description copied from interface: JFXTemplateConfig
    
    Same as the JFXTemplateConfig.config(Function) method but without the lazy behaviour and doesn't provide a JFXAnimationTemplateConfig.builder() instance.
    
    Specified by:
    
    config in interface JFXTemplateConfig<N>
    
    Parameters:
    
    configBuilder - the JFXAnimationTemplateConfig.builder() instance.
    
    Returns:
    
    a JFXTemplateBuilder instance.
    
    See Also:
    
    JFXTemplateConfig.config(Function)
  - build
```
public <B> B build(Function<JFXAnimationTemplate<N>,B> builderFunction,
                   Function<JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>,JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>> mapBuilderFunction)
```
    Description copied from interface: JFXTemplateBuilder
    
    Method which handles a specific builderFunction which provides the JFXAnimationTemplate and should return a specific representation of the animation e.g. a Timeline.
    Furthermore the method provides a Function which provides a JFXTemplateBuilder.JFXAnimationObjectMapBuilder for defining the default animation objects and/or named animation objects.
    
    Specified by:
    
    build in interface JFXTemplateBuilder<N>
    
    Type Parameters:
    
    B - the specific animation representation type.
    
    Parameters:
    
    builderFunction - the builderFunction for a specific representation of the animation.
    
    mapBuilderFunction - the builderFunction for defining the default animation objects and/or named animation objects.
    
    Returns:
    
    the specific animation representation.
  - build
```
public <B> B build(Function<JFXAnimationTemplate<N>,B> builderFunction,
                   N defaultAnimationObject)
```
    Description copied from interface: JFXTemplateBuilder
    
    Same method as JFXTemplateBuilder.build(Function, Function) but takes directly one default animation object.
    
    Specified by:
    
    build in interface JFXTemplateBuilder<N>
    
    Type Parameters:
    
    B - the specific animation representation type.
    
    Parameters:
    
    builderFunction - the builderFunction for a specific representation of the animation.
    
    defaultAnimationObject - the default animation object.
    
    Returns:
    
    the specific animation representation.
    
    See Also:
    
    JFXTemplateBuilder.build(Function, Function)
  - build
```
public javafx.animation.Timeline build(Function<JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>,JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>> mapBuilderFunction)
```
    Description copied from interface: JFXTemplateBuilder
    
    Same method as JFXTemplateBuilder.build(Function, Function) but returns directly a Timeline instance as specific animation representation.
    
    Specified by:
    
    build in interface JFXTemplateBuilder<N>
    
    Parameters:
    
    mapBuilderFunction - the builderFunction for defining the default animation objects and/or named animation objects.
    
    Returns:
    
    the animation as Timeline instance.
    
    See Also:
    
    JFXTemplateBuilder.build(Function, Function)
  - build
```
public javafx.animation.Timeline build(N defaultAnimationObject)
```
    Description copied from interface: JFXTemplateBuilder
    
    Same method as JFXTemplateBuilder.build(Function, Object) but returns directly a Timeline instance as specific animation representation and takes a default animation object.
    
    Specified by:
    
    build in interface JFXTemplateBuilder<N>
    
    Parameters:
    
    defaultAnimationObject - the default animation object.
    
    Returns:
    
    the animation as Timeline instance.
    
    See Also:
    
    JFXTemplateBuilder.build(Function, Object)
  - build
```
public javafx.animation.Timeline build()
```
    Description copied from interface: JFXTemplateBuilder
    
    Same method as JFXTemplateBuilder.build(Object) )} but takes no default animation object.
    If you don't need a default animation object choose this method.
    In any case the default animation object will be null.
    
    Specified by:
    
    build in interface JFXTemplateBuilder<N>
    
    Returns:
    
    the animation as Timeline instance.

Class JFXAnimationTemplate<N>

Nested Class Summary

Nested classes/interfaces inherited from interface de.schlegel11.jfxanimation.JFXTemplateBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

buildAndGetAnimationValues

buildAndGetTemplateConfig

percent

from

to

action

action

config

config

build

build

build

build

build