Package com.jidesoft.swing
Class Animator
java.lang.Object
com.jidesoft.swing.Animator
- All Implemented Interfaces:
ActionListener,EventListener
An
ActionListener with a timer. It is used to simplify the animation of all kind of sliding windows.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidAdds anAnimatorListenerto this Animator.protected TimercreateTimer(int initDelay, int delay) protected TimercreateTimer(int delay, ActionListener listener) Creates the timer.voiddispose()Returns an array of all theAnimatorListeners added to this Animator with addAnimatorListener().voidInterrupts the animator.booleanIf the animator is running, returns true.voidRemoves anAnimatorListenerfrom this Animator.voidsetDelay(int delay) voidstart()Starts the animator.voidstop()Stop the animator and reset the counter.
-
Field Details
-
_delay
protected int _delay -
_initialDelay
protected int _initialDelay
-
-
Constructor Details
-
Animator
Creates an animator for source with initDelay 50 ms, each step delays 10 ms and total 10 steps.- Parameters:
source- the source for this animator.
-
Animator
Creates an animator for source.- Parameters:
source- the source for this animator.initDelay- the initial delay before timer starts.delay- the delay of the timertotalSteps- the number of steps. If -1, it means this animator will never stop untilstop()is called.
-
-
Method Details
-
createTimer
-
createTimer
Creates the timer.- Parameters:
delay- the delay between each step, in ms.listener- the action listener associated with the timer.- Returns:
- the timer
-
addAnimatorListener
Adds anAnimatorListenerto this Animator.- Parameters:
l- theAnimatorListenerto be added
-
removeAnimatorListener
Removes anAnimatorListenerfrom this Animator.- Parameters:
l- the listener to be removed
-
getAnimatorListeners
Returns an array of all theAnimatorListeners added to this Animator with addAnimatorListener().- Returns:
- all of the
AnimatorListeners added or an empty array if no listeners have been added
-
actionPerformed
- Specified by:
actionPerformedin interfaceActionListener
-
start
public void start()Starts the animator. -
stop
public void stop()Stop the animator and reset the counter. -
interrupt
public void interrupt()Interrupts the animator. The counter is not reset in this case. -
isRunning
public boolean isRunning()If the animator is running, returns true. Otherwise, returns false.- Returns:
- true if animator is running. Otherwise, returns false.
-
setDelay
public void setDelay(int delay) -
dispose
public void dispose()
-