Package swingtree.api

Interface AnimatedItemStyler<T,C extends JComponent>

Type Parameters:

T - the type of the item of the bound property, supplied to this function as the first argument.

C - the type of the JComponent that the ComponentStyleDelegate is delegating to.

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AnimatedItemStyler<T,C extends JComponent>

An AnimatedItemStyler is conceptually a union of the ItemStyler and AnimatedStyler functions, which is to say that it takes the current item of a bound Val property, an AnimationStatus and a ComponentStyleDelegate to produce a new ComponentStyleDelegate with some style properties applied to it (usually based on both the item and the animation progress).
All parameters are immutable value oriented objects, so the function is pure and does not modify any of them.

This interface is used by UIForAnySwing.withStyle(sprouts.Val, swingtree.animation.LifeTime, AnimatedItemStyler), where every change of the bound property item restarts a transition animation whose AnimationStatus.progress() runs from 0 to 1 over the given LifeTime. This allows a style to not only follow the application state, but to animate towards it.
Like the ItemStyler, this function receives the property item as an explicit argument, captured from the property change event on the property's owning thread, which is what makes it safe to evaluate on the UI thread in the decoupled threading mode (see EventProcessor.DECOUPLED). Never read the property itself inside this function!

When a single AnimatedItemStyler should follow several properties at once, merge them into one record with the composite view builder Viewable.of(Object, java.util.function.Function) (requires Sprouts 2.7.0 or above) and bind that one merged property, so that any of its inputs changing restarts the transition towards the newly merged item.

See Also:

• The builder method consuming this function.
• The non animated counterpart which follows a property item without a transition.
• The animation status driven styler used for transitional and transitory styles.
• The plain, non property driven and non animated styler.

Method Summary

Modifier and Type	Method	Description
default AnimatedItemStyler<T,C>	andThen(AnimatedItemStyler<T,C> other)	Returns a new AnimatedItemStyler that applies the style of this AnimatedItemStyler and then applies the style of the given AnimatedItemStyler.
static <T, C extends JComponent> AnimatedItemStyler<T,C>	none()	An AnimatedItemStyler that does nothing, meaning it simply returns the given ComponentStyleDelegate without applying any style to it.
ComponentStyleDelegate<C>	style(T item, AnimationStatus status, ComponentStyleDelegate<C> delegate)	Applies some style to the given ComponentStyleDelegate, usually based on the supplied property item and the progress of the supplied AnimationStatus, and returns a new ComponentStyleDelegate that has the style applied (if any).

Method Details

none

static <T,
C extends JComponent>
AnimatedItemStyler<T,C> none()

An AnimatedItemStyler that does nothing, meaning it simply returns the given ComponentStyleDelegate without applying any style to it. Conceptually speaking, this returns the null object of the AnimatedItemStyler type.

Type Parameters:

T - The type of the item of the bound property.

C - The type of the JComponent that the ComponentStyleDelegate is delegating to.

Returns:

An AnimatedItemStyler that does nothing.

style

ComponentStyleDelegate<C> style(T item,
 AnimationStatus status,
 ComponentStyleDelegate<C> delegate)
                         throws Exception

Applies some style to the given ComponentStyleDelegate, usually based on the supplied property item and the progress of the supplied AnimationStatus, and returns a new ComponentStyleDelegate that has the style applied (if any).
Note that this method deliberately requires the handling of checked exceptions at its invocation sites because there may be any number of implementations hiding behind this interface and so it is unwise to assume that all of them will be able to execute gracefully without throwing exceptions.

Parameters:

item - The current item of the bound property, captured from the property change event on the property's owning thread. Style based on this argument only, never on the property itself!

status - The AnimationStatus of the transition towards the supplied item, whose AnimationStatus.progress() runs from 0 to 1.

delegate - The ComponentStyleDelegate to apply the style to.

Returns:

A new ComponentStyleDelegate that has the style applied.

Throws:

Exception - if the style could not be applied by the client code.

andThen

default AnimatedItemStyler<T,C> andThen(AnimatedItemStyler<T,C> other)

Returns a new AnimatedItemStyler that applies the style of this AnimatedItemStyler and then applies the style of the given AnimatedItemStyler.

Parameters:

other - the AnimatedItemStyler to apply after this one.

Returns:

a new AnimatedItemStyler that applies the style of this and then the given one.