de.gsi.chart.ui.ChartLayoutAnimator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2010, 2014, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package de.gsi.chart.ui;

import java.util.HashMap;
import java.util.Map;

import javafx.animation.Animation;
import javafx.animation.AnimationTimer;
import javafx.animation.KeyFrame;
import javafx.animation.SequentialTransition;
import javafx.animation.Timeline;
import javafx.event.ActionEvent;
import javafx.event.EventHandler;
import javafx.scene.Parent;
import javafx.scene.chart.Axis;

/**
 * Runs any number of animations of KeyFrames calling requestLayout on the given node for every frame while one of those
 * animations is running.
 */
public final class ChartLayoutAnimator extends AnimationTimer implements EventHandler {
    private final Parent nodeToLayout;
    private final Map activeTimeLines = new HashMap<>();
    private final boolean isAxis;

    public ChartLayoutAnimator(Parent nodeToLayout) {
        this.nodeToLayout = nodeToLayout;
        isAxis = nodeToLayout instanceof Axis;
    }

    /**
     * Play a animation containing the given keyframes.
     *
     * @param animation The animation to play
     * @return A id reference to the animation that can be used to stop the animation if needed
     */
    public Object animate(Animation animation) {
        SequentialTransition t = new SequentialTransition();
        t.getChildren().add(animation);
        t.setOnFinished(this);
        // start animation timer if needed
        if (activeTimeLines.isEmpty())
            start();
        // get id and add to map
        activeTimeLines.put(t, t);
        // play animation
        t.play();
        return t;
    }

    /**
     * Play a animation containing the given keyframes.
     *
     * @param keyFrames The keyframes to animate
     * @return A id reference to the animation that can be used to stop the animation if needed
     */
    public Object animate(KeyFrame... keyFrames) {
        Timeline t = new Timeline();
        t.setAutoReverse(false);
        t.setCycleCount(1);
        t.getKeyFrames().addAll(keyFrames);
        t.setOnFinished(this);
        // start animation timer if needed
        if (activeTimeLines.isEmpty())
            start();
        // get id and add to map
        activeTimeLines.put(t, t);
        // play animation
        t.play();
        return t;
    }

    @Override
    public void handle(ActionEvent actionEvent) {
        activeTimeLines.remove(actionEvent.getSource());
        if (activeTimeLines.isEmpty())
            stop();
        // cause one last re-layout to make sure final values were used
        handle(0L);
    }

    @Override
    public void handle(long l) {
        if (isAxis) {
            ((Axis) nodeToLayout).requestAxisLayout();
        } else {
            nodeToLayout.requestLayout();
        }
    }

    /**
     * Stop the animation with the given ID
     *
     * @param animationID The id of the animation to stop
     */
    public void stop(Object animationID) {
        Animation t = activeTimeLines.remove(animationID);
        if (t != null)
            t.stop();
        if (activeTimeLines.isEmpty())
            stop();
    }
}