sk.upjs.jpaz2

Class TickTimer

java.lang.Object

sk.upjs.jpaz2.TickTimer

public class TickTimer
extends Object

Timer that ticks in a given period. Ticks are realized as call of the onTick method. All methods are synchronized with JPAZ.

Constructor Summary

Constructors

Constructor and Description
TickTimer() Constructs a new timer with the onTick method invoked within Swing's EDT.
TickTimer(boolean synchronizeWithSwing) Constructs a new timer with a given method of synchronization with Swing's EDT.
TickTimer(String name) Constructs a new timer with a given name and the onTick method invoked within Swing's EDT
TickTimer(String name, boolean synchronizeWithSwing) Constructs a new timer with a given name and a given method of synchronization with Swing's EDT.

Method Summary

Modifier and Type	Method and Description
long	getTickPeriod() Gets the time period (in milliseconds) in which the onTick method is executed.
boolean	isEnabled() Returns whether tick timer is enabled
boolean	isSynchronizedWithSwing() Returns whether the onTick method is invoked within Swing's EDT.
protected void	onTick() Called periodically by the pane.
void	setEnabled(boolean enabled) Sets activity of the tick timer.
void	setTickPeriod(long tickPeriod) Sets the time period (in milliseconds) in which the onTick method is executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TickTimer

public TickTimer()

Constructs a new timer with the onTick method invoked within Swing's EDT.

TickTimer

public TickTimer(String name)

Constructs a new timer with a given name and the onTick method invoked within Swing's EDT

Parameters:

name - the desired name of this tick timer. The name is used in error messages when an exception from onTick is caught.

TickTimer

public TickTimer(boolean synchronizeWithSwing)

Constructs a new timer with a given method of synchronization with Swing's EDT.

Parameters:

synchronizeWithSwing - true, for onTick invoked within Swing's EDT, false otherwise

TickTimer

public TickTimer(String name,
                 boolean synchronizeWithSwing)

Constructs a new timer with a given name and a given method of synchronization with Swing's EDT.

Parameters:

name - the desired name of this tick timer. The name is used in error messages when an exception from onTick is caught.

synchronizeWithSwing - true, for onTick invoked within Swing's EDT, false otherwise

Method Detail

getTickPeriod

public long getTickPeriod()

Gets the time period (in milliseconds) in which the onTick method is executed. The value 0 indicates disabled periodical execution of the onTick method.

Returns:

the tick period in milliseconds.

setTickPeriod

public void setTickPeriod(long tickPeriod)

Sets the time period (in milliseconds) in which the onTick method is executed. The value 0 indicates disabled periodical execution of the onTick method.

Parameters:

tickPeriod - the tick period in milliseconds.

isSynchronizedWithSwing

public boolean isSynchronizedWithSwing()

Returns whether the onTick method is invoked within Swing's EDT.

Returns:

true, if the timer is synchronized with Swing

isEnabled

public boolean isEnabled()

Returns whether tick timer is enabled

Returns:

true, if tick timer is enabled, false otherwise

setEnabled

public void setEnabled(boolean enabled)

Sets activity of the tick timer.

Parameters:

enabled - true, to enabled, false to disable timer fuctionality

onTick

protected void onTick()

Called periodically by the pane. The period of calling is determined by the property tickPeriod.