Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.Timer

java.lang.Object
  |
  +--com.sun.java.swing.Timer

public class Timer

extends java.lang.Object

implements java.io.Serializable

Object subclass that causes an action to occur at a predefined rate. For example, an animation object can use a Timer as the trigger for drawing its next frame. Each Timer has a list of ActionListeners and a delay ( the time between actionPerfomed() calls). When delay milliseconds have passed, a Timer sends the actionPerformed() message to its listeners. This cycle repeats until stop() is called, or halts immediately if the Jimer is configured to send its message just once.

Using a Timer involves first creating it, then starting it using the start() method.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Serialized Form

Field Summary

EventListenerList

listenerList

Constructor Summary

Timer(int delay, java.awt.event.ActionListener listener)
Creates a Timer that will notify its listeners every delay milliseconds.

Method Summary

void	addActionListener(java.awt.event.ActionListener listener) Adds an actionListener to the Timer
void	fireActionPerformed(java.awt.event.ActionEvent e)
int	getDelay() Returns the Timer's delay.
int	getInitialDelay() Returns the Timer's initial delay.
static boolean	getLogTimers()
boolean	isCoalesce() Returns true if the Timer coalesces multiple pending performCommand() messages.
boolean	isRepeats() Returns true if the Timer will send a actionPerformed() message to its listeners multiple times.
boolean	isRunning() Returns true if the Timer is running.
void	removeActionListener(java.awt.event.ActionListener listener) Removes an ActionListener from the Timer.
void	restart() Restarts a Timer, canceling any pending firings, and causing it to fire with its initial dely.
void	setCoalesce(boolean flag) Sets whether the Timer coalesces multiple pending ActionEvent firings.
void	setDelay(int delay) Sets the Timer's delay, the number of milliseconds between successive actionPerfomed() messages to its listeners
void	setInitialDelay(int initialDelay) Sets the Timer's initial delay.
static void	setLogTimers(boolean flag)
void	setRepeats(boolean flag) If flag is false, instructs the Timer to send actionPerformed() to its listeners only once, and then stop.
void	start() Starts the Timer, causing it to send actionPerformed() messages to its listeners.
void	stop() Stops a Timer, causing it to stop sending actionPerformed() messages to its Target.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Field Detail

listenerList

protected EventListenerList listenerList

Constructor Detail

Timer

public Timer(int delay,
             java.awt.event.ActionListener listener)

Creates a Timer that will notify its listeners every delay milliseconds.

Parameters:

delay - The number of milliseconds between listener notification

listener - An initial listener

See Also:

setInitialDelay, setRepeats

Method Detail

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

Adds an actionListener to the Timer

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)

Removes an ActionListener from the Timer.

fireActionPerformed

protected void fireActionPerformed(java.awt.event.ActionEvent e)

setLogTimers

public static void setLogTimers(boolean flag)

getLogTimers

public static boolean getLogTimers()

setDelay

public void setDelay(int delay)

Sets the Timer's delay, the number of milliseconds between successive actionPerfomed() messages to its listeners

See Also:

setInitialDelay

getDelay

public int getDelay()

Returns the Timer's delay.

See Also:

setDelay

setInitialDelay

public void setInitialDelay(int initialDelay)

Sets the Timer's initial delay. This will be used for the first "ringing" of the Timer only. Subsequent ringings will be spaced using the delay property.

See Also:

setDelay

getInitialDelay

public int getInitialDelay()

Returns the Timer's initial delay.

See Also:

setDelay

setRepeats

public void setRepeats(boolean flag)

If flag is false, instructs the Timer to send actionPerformed() to its listeners only once, and then stop.

isRepeats

public boolean isRepeats()

Returns true if the Timer will send a actionPerformed() message to its listeners multiple times.

See Also:

setRepeats

setCoalesce

public void setCoalesce(boolean flag)

Sets whether the Timer coalesces multiple pending ActionEvent firings. A busy application may not be able to keep up with a Timer's message generation, causing multiple actionPerformed() message sends to be queued. When processed, the application sends these messages one after the other, causing the Timer's listeners to receive a sequence of actionPerformed() messages with no delay between them. Coalescing avoids this situation by reducing multiple pending messages to a single message send. Timers coalesce their message sends by default.

isCoalesce

public boolean isCoalesce()

Returns true if the Timer coalesces multiple pending performCommand() messages.

See Also:

setCoalesce

start

public void start()

Starts the Timer, causing it to send actionPerformed() messages to its listeners.

See Also:

stop

isRunning

public boolean isRunning()

Returns true if the Timer is running.

See Also:

start

stop

public void stop()

Stops a Timer, causing it to stop sending actionPerformed() messages to its Target.

See Also:

start

restart

public void restart()

Restarts a Timer, canceling any pending firings, and causing it to fire with its initial dely.