KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jgoodies > animation > Animation


1 /*
2  * Copyright (c) 2001-2004 JGoodies Karsten Lentzsch. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * o Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * o Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * o Neither the name of JGoodies Karsten Lentzsch nor the names of
15  * its contributors may be used to endorse or promote products derived
16  * from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 package com.jgoodies.animation;
32
33 /**
34  * This interface describes time based animations. Basically,
35  * the <code>#animate</code> method applies an animation effect
36  * to an animation target over the animation's duration.
37  *
38  * @author Karsten Lentzsch
39  * @version $Revision: 1.3 $
40  *
41  * @see AbstractAnimation
42  * @see Animations
43  */
44 public interface Animation {
45
46     /**
47      * Returns this animation's duration.
48      *
49      * @return this animation duration
50      */
51     long duration();
52     
53
54     /**
55      * Animates for the given time, that is, applies the animation effect
56      * to the animation target and fires events when the animation is
57      * started, stopped or repeated.
58      *
59      * @param time the time used to determine the animation effect
60      */
61     void animate(long time);
62     
63
64     /**
65      * Adds the given <code>AnimationListener</code> to this animation.
66      *
67      * @param listener the <code>AnimationListener</code> to add
68      */
69     void addAnimationListener(AnimationListener listener);
70
71     
72     /**
73      * Removes the given <code>AnimationListener</code> from this animation.
74      *
75      * @param listener the <code>AnimationListener</code> to remove
76      */
77     void removeAnimationListener(AnimationListener listener);
78
79 }
Popular Tags