/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.netbeans.api.visual.animator;

/**
 * This interface is used for notifying about important events on <code>Animator</code>.
 *
 * @author David Kaspar
 * @since 2.2
 */
public interface AnimatorListener {

    /**
     * Called when an animator is invoked to be started.
     * @param event the animator event
     * @since 2.2
     */
    void animatorStarted (AnimatorEvent event);

    /**
     * Called when an animator is changed, so the animation has to be restarted.
     * @param event the animator event
     * @since 2.2
     */
    void animatorReset (AnimatorEvent event);

    /**
     * Called when an animator is finished - means it was running for 500+ms.
     * @param event the animator event
     * @since 2.2
     */
    void animatorFinished (AnimatorEvent event);

    /**
     * Called immediately before the animator performs a tick of an animation.
     * @param event the animator event
     * @since 2.2
     */
    void animatorPreTick (AnimatorEvent event);

    /**
     * Called immediately after the animator performs a tick of an animation.
     * @param event the animator event
     * @since 2.2
     */
    void animatorPostTick (AnimatorEvent event);

}
