Main Page | Packages | Class Tree | Index | Help

xp.controls

class CountDownTimer

MovieClip
  |
  +--xp.controls.CountDownTimer


class CountDownTimer
extends MovieClip

CountDownTimer

A digital timer display that counts down to a specifc time
This control directly extends MovieClip and does not feature any of the methods, properties or events of the XPFramework


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
autoStart: Boolean
should timer auto start when loaded/reset

public
autoStop: Boolean
should timer auto stop when expire date/tiem is reached

public
digitGroupSpacing: Number
spacing between groups of digits

public
digitSpacing: Number
spacing between digits

public
direction: String
direction to count in up or down

public
displayFormat: String
direction to count in up or down

public
expireDate: String
end date in yyyy-mm-dd format

public
expiredHandler: Function
the expired event handler

public
expireTime: String
end time in hh-mi-ss format

public
startDate: String
start date in yyyy-mm-dd format

public
startedHandler: Function
the started event handler

public
startTime: String
start time in hh-mi-ss format

public
tz: Number
timezone offset

Property Summary

public
expired: Boolean (read-only)
has the end time been reached

public
started: Boolean (read-only)
has the end time been reached

Constructor

public
CountDownTimer ( )
Constructor-Do not call directly

Method Summary

public
countdown ( )
Updates the display one time to reflect its current state

public
reset ( )
reset the timer

public
start ( )
Starts updating the display

public
stop ( )
Stops updating the display



Field Documentation

autoStart

public var autoStart: Boolean
should timer auto start when loaded/reset

autoStop

public var autoStop: Boolean
should timer auto stop when expire date/tiem is reached

digitGroupSpacing

public var digitGroupSpacing: Number
spacing between groups of digits

digitSpacing

public var digitSpacing: Number
spacing between digits

direction

public var direction: String
direction to count in up or down

displayFormat

public var displayFormat: String
direction to count in up or down

expireDate

public var expireDate: String
end date in yyyy-mm-dd format

expiredHandler

public var expiredHandler: Function
the expired event handler

expireTime

public var expireTime: String
end time in hh-mi-ss format

startDate

public var startDate: String
start date in yyyy-mm-dd format

startedHandler

public var startedHandler: Function
the started event handler

startTime

public var startTime: String
start time in hh-mi-ss format

tz

public var tz: Number
timezone offset


Property Documentation

expired

public expired: Boolean (read-only)
has the end time been reached

started

public started: Boolean (read-only)
has the end time been reached


Constructor Documentation

CountDownTimer

public function CountDownTimer()
Constructor-Do not call directly

Either place the control on stage of use attachMovie


Method Documentation

countdown

public function countdown()
Updates the display one time to reflect its current state

Usually called back by the timer

reset

public function reset()
reset the timer

start

public function start()
Starts updating the display

stop

public function stop()
Stops updating the display


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc