AnimationUtils.java

package org.jtheque.ui.utils;

import org.pushingpixels.trident.Timeline;
import org.pushingpixels.trident.callback.TimelineCallbackAdapter;

/*
 * Copyright JTheque (Baptiste Wicht)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * An utility class for animation.
 *
 * @author Baptiste Wicht
 */
public final class AnimationUtils {
    private static final int SPRING_EFFECT_DURATION = 400;

    /**
     * This is an utility class, not instanciable.
     */
    private AnimationUtils() {
        throw new AssertionError();
    }

    /**
     * Create a Fade Out animator for the view.
     *
     * @param view The view to fade out.
     *
     * @return The timeline animation.
     */
    public static Timeline createFadeOutAnimation(Object view) {
        return createInterpolationAnimation(view, 1000, "alpha", 1.0f, 0.0f);
    }

    /**
     * Create a fade in animator for a view.
     *
     * @param view The view to fade in.
     *
     * @return The timeline animation.
     */
    public static Timeline createFadeInAnimation(Object view) {
        return createInterpolationAnimation(view, 1000, "alpha", 0.0f, 1.0f);
    }

    /**
     * Create a spring effect animator for a view.
     *
     * @param view The view to animate.
     *
     * @return The timeline animation.
     */
    public static Timeline createSpringEffectAnimation(Object view) {
        return createInterpolationAnimation(view, SPRING_EFFECT_DURATION, "zoom", 0.0f, 1.0f);
    }

    /**
     * Create an animation to interpolate a property.
     *
     * @param object   The bean on which the property must be interpolated.
     * @param duration The duration of the animation.
     * @param property The property to interpolate.
     * @param from     The from value.
     * @param to       The to value.
     * @param <T>      The type of property to interpolate.
     *
     * @return The timeline animation.
     */
    public static <T> Timeline createInterpolationAnimation(Object object, int duration, String property, T from, T to) {
        Timeline timeline = new Timeline(object);

        timeline.addPropertyToInterpolate(property, from, to);
        timeline.setDuration(duration);

        return timeline;
    }

    /**
     * Fade in the view.
     *
     * @param view The view to fade in.
     *
     * @return The timeline animation.
     */
    public static Timeline startFadeIn(Object view) {
        Timeline animation = createFadeInAnimation(view);

        animation.play();

        return animation;
    }

    /**
     * Fade out the view.
     *
     * @param view The view to fade out.
     *
     * @return The timeline animation.
     */
    public static Timeline startFadeOut(Object view) {
        Timeline animation = createFadeOutAnimation(view);

        animation.play();

        return animation;
    }

    /**
     * Starts looping of the target when the source animation is done.
     *
     * @param source The source animation.
     * @param target The target animation.
     */
    public static void startsLoopWhenStop(Timeline source, final Timeline target) {
        source.addCallback(new TimelineCallbackAdapter() {
            @Override
            public void onTimelineStateChanged(Timeline.TimelineState oldState, Timeline.TimelineState newState,
                                               float durationFraction, float timelinePosition) {
                if (newState == Timeline.TimelineState.DONE) {
                    if (target.getState() == Timeline.TimelineState.SUSPENDED) {
                        target.resume();
                    } else {
                        target.playLoop(Timeline.RepeatBehavior.LOOP);
                    }
                }
            }
        });
    }
}