de.schlegel11.jfxanimation

Class JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>

java.lang.Object

de.schlegel11.jfxanimation.JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>

Enclosing interface:

JFXTemplateBuilder<N>

public static class JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ANIMATION_OBJECT_NAME

Method Summary

Modifier and Type	Method and Description
static <N> JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>	builder()
JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>	defaultObject(N animationObject, N... animationObjects) Method for the default animation objects of the animation.
JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>	defaultObjectsOf(Collection<N> animationObjects) Same method as defaultObject(Object, Object[]) but with a Collection of animation objects.
Map<String,Collection<Object>>	getAnimationObjects() Get the animationObjects.
JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>	namedObject(String name, Object animationObject, Object... animationObjects) Method for the named animation objects of the animation.
JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>	namedObjectsOf(Map<String,Collection<Object>> animationObjects) Same method as namedObjectsOf(String, Collection) but with a Map of animation objects.
JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N>	namedObjectsOf(String name, Collection<Object> animationObjects) Same method as namedObject(String, Object, Object...) but with a Collection of animation objects.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ANIMATION_OBJECT_NAME

public static final String DEFAULT_ANIMATION_OBJECT_NAME

See Also:

Constant Field Values

Method Detail

builder

public static <N> JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N> builder()

defaultObject

@SafeVarargs
public final JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N> defaultObject(N animationObject,
                                                                                           N... animationObjects)

Method for the default animation objects of the animation.
The default type of the objects is a Node, which is created when the JFXAnimationTemplate is created:

 JFXAnimationTemplate.create()
 

To set another type use the JFXAnimationTemplate.create(Class) method:

 JFXAnimationTemplate.create(MyType.class)
 

The default objects can be used in every action(...) method:

 .action(b -> b.target(defaultNode -> defaultNode.scaleXProperty(), Node::scaleYProperty).endValue(1))
 

If this method is called multiple times, all animation objects will be added to the animationObjects.

Parameters:

animationObject - the first animation object.

animationObjects - rest of animation objects.

Returns:

the JFXTemplateBuilder.JFXAnimationObjectMapBuilder instance.

defaultObjectsOf

public JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N> defaultObjectsOf(Collection<N> animationObjects)

Same method as defaultObject(Object, Object[]) but with a Collection of animation objects.

Parameters:

animationObjects - the animation objects.

Returns:

the JFXTemplateBuilder.JFXAnimationObjectMapBuilder instance.

See Also:

defaultObject(Object, Object[])

namedObject

public JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N> namedObject(String name,
                                                                      Object animationObject,
                                                                      Object... animationObjects)

Method for the named animation objects of the animation.
The named animation objects are similar to the default objects defaultObject(Object, Object[]).
The difference is that a named object needs an unique name as key and that they have to be called specifically in every action(...) method.
Furthermore the specific type of the animation object must be provided in every action(...) method where the object is used.

Define a named animation object like (in this case e.g. also with a default animation object):

 .build(b -> b.defaultObject(button).namedObject("label", label)))
 

In our JFXAnimationTemplate we have e.g. two action(...) methods where the first uses the default animation object.
The second uses the named animation object:

 .action(b -> b.target(defaultObject -> defaultObject.translateYProperty()).endValue(0))
 .action(b -> b.withAnimationObject(Label.class, "label").target(label -> label.translateYProperty()).endValue(5))
 

If this method is called multiple times with the same name, all animation objects will be added to the animationObjects.

Parameters:

name - the unique name of the named animation objects.

animationObject - the first animation object.

animationObjects - rest of animation objects.

Returns:

the JFXTemplateBuilder.JFXAnimationObjectMapBuilder instance.

namedObjectsOf

public JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N> namedObjectsOf(String name,
                                                                         Collection<Object> animationObjects)

Same method as namedObject(String, Object, Object...) but with a Collection of animation objects.

Parameters:

name - the unique name of the named animation objects.

animationObjects - the animation objects.

Returns:

the JFXTemplateBuilder.JFXAnimationObjectMapBuilder instance.

See Also:

namedObject(String, Object, Object...)

namedObjectsOf

public JFXTemplateBuilder.JFXAnimationObjectMapBuilder<N> namedObjectsOf(Map<String,Collection<Object>> animationObjects)

Same method as namedObjectsOf(String, Collection) but with a Map of animation objects.

Parameters:

animationObjects - the animation objects.

Returns:

the JFXTemplateBuilder.JFXAnimationObjectMapBuilder instance.

See Also:

namedObjectsOf(String, Collection)

getAnimationObjects

public Map<String,Collection<Object>> getAnimationObjects()

Get the animationObjects.

Returns:

the animationObjects.