org.fujion.component

Class Timer

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.Timer

All Implemented Interfaces:

IElementIdentifier

@Component(tag="timer",
           widgetClass="Timer",
           parentTag="*")
public class Timer
extends BaseComponent

A timer component. Once started, fires a timer event at the specified interval and repeating for the specified number of repetitions.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Constructor Summary

Constructors

Constructor and Description
Timer()

Method Summary

Modifier and Type	Method and Description
long	getInterval() Returns the interval, in milliseconds, between timer events.
int	getRepeat() Returns the repetition count.
boolean	isRunning() Returns true if the timer is running.
void	restart() A convenience method for restarting the timer.
void	setInterval(long interval) Sets the interval, in milliseconds, between timer events.
void	setRepeat(int repeat) Sets the repetition count.
void	setRunning(boolean running) Sets the run state of the timer.
void	start() A convenience method to start the timer.
void	stop() A convenience method to stop the timer.

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterRemoveChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasEventListener, hasEventListener, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, notifyAncestors, nullify, onAttach, onDestroy, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, setParent, sub, swapChildren, sync, toString, trimify, validate, validate, validateChild, validateIsChild, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

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

Constructor Detail

Timer

public Timer()

Method Detail

getInterval

@Component.PropertyGetter(value="interval")
public long getInterval()

Returns the interval, in milliseconds, between timer events.

Returns:

The timer interval in milliseconds.

setInterval

@Component.PropertySetter(value="interval")
public void setInterval(long interval)

Sets the interval, in milliseconds, between timer events.

Parameters:

interval - The timer interval in milliseconds. Any value less than or equal to zero will disable the timer.

getRepeat

@Component.PropertyGetter(value="repeat")
public int getRepeat()

Returns the repetition count. This is the number of times the timer will fire additional events after the initial event. A value of zero will cause the timer to fire only once (no repetitions). A negative value will cause the timer to fire indefinitely.

Returns:

The repetition count.

setRepeat

@Component.PropertySetter(value="repeat")
public void setRepeat(int repeat)

Sets the repetition count. This is the number of times the timer will fire additional events after the initial event. A value of zero will cause the timer to fire only once (no repetitions). A negative value will cause the timer to fire indefinitely.

Parameters:

repeat - The repetition count.

isRunning

@Component.PropertyGetter(value="running")
public boolean isRunning()

Returns true if the timer is running.

Returns:

True if the timer is running.

setRunning

@Component.PropertySetter(value="running")
public void setRunning(boolean running)

Sets the run state of the timer.

Parameters:

running - The run state of the timer. Set to true to start the timer, false to stop it.

start

public void start()

A convenience method to start the timer.

stop

public void stop()

A convenience method to stop the timer.

restart

public void restart()

A convenience method for restarting the timer.