Class Timer

protected EventListenerList listenerList

A field to store all listeners who are listening to this timer.

public Timer(int d,
             ActionListener listener)

Creates a new Timer object.

Parameters:

d - the default value for both initial and between event delay, in milliseconds.

listener - the first action listener, can be null.

public void addActionListener(ActionListener listener)

Add the action listener

Parameters:

listener - the action listener to add

public extends EventListener> T[] getListeners(Class listenerType)

Get the event listeners of the given type that are listening for the events, fired by this timer.

Parameters:

listenerType - the listener type (for example, ActionListener.class)

Returns:

the array of event listeners that are listening for the events, fired by this timer

Since:

1.3

protected void fireActionPerformed(ActionEvent event)

Fire the given action event to the action listeners.

Parameters:

event - the event to fire

public ActionListener[] getActionListeners()

Get the array of action listeners.

Returns:

the array of action listeners that are listening for the events, fired by this timer

Since:

1.4

public int getDelay()

Get the delay between firing the subsequent events.

Returns:

The delay between subsequent events, in milliseconds

public int getInitialDelay()

Get the intial delay before firing the first event since calling the start() method. If the initial delay has not been set, returns the same value as getDelay().

Returns:

the initial delay before firing the first action event.

public static boolean getLogTimers()

Return the logging state.

Returns:

true if the timer is printing a message to System.out when firing each action event

public boolean isCoalesce()

Checks if the Timer coalesces multiple pending event firings. If the coalescing is enabled, the multiple events that have not been fired on time are replaced by the single event. The events may not be fired on time if the application is busy.

Returns:

true if the coalescing is enabled, false otherwise

public boolean isRepeats()

Check is this timer fires repetetive events.

Returns:

true if the timer fires repetetive events, false if it fires only one event after the initial delay

public boolean isRunning()

Get the timer state.

Returns:

true if the timer has been started and is firing the action events as scheduled. false if the timer is inactive.

public void removeActionListener(ActionListener listener)

Remove the action listener.

Parameters:

listener - the action listener to remove

public void restart()

Cancel all pending tasks and fire the first event after the initial delay.

public void setCoalesce(boolean c)

Sets whether the Timer coalesces multiple pending event firings. If the coalescing is enabled, the multiple events that have not been fired on time are replaced by the single event. The events may not be fired on time if the application is busy.

Parameters:

c - true (default) to enable the event coalescing, false otherwise

public void setDelay(int d)

Set the delay between firing the subsequent events. This parameter does not change the value of the initial delay before firing the first event.

Parameters:

d - The time gap between the subsequent events, in milliseconds

Throws:

IllegalArgumentException - if d is less than zero.

public void setInitialDelay(int i)

Set the intial delay before firing the first event since calling the start() method. If the initial delay has not been set, it is assumed having the same value as the delay between the subsequent events.

Parameters:

i - the initial delay, in milliseconds

Throws:

IllegalArgumentException - if i is less than zero.

public static void setLogTimers(boolean lt)

Set the timer logging state. If it is set to true, the timer prints a message to System.out when firing each action event.

Parameters:

lt - true if logging is enabled, false (default value) otherwise

public void setRepeats(boolean r)

Enable firing the repetetive events.

Parameters:

r - true (default value) to fire repetetive events. false to fire only one event after the initial delay

public void start()

Start firing the action events.

public void stop()

Stop firing the action events.