XPComponents: class xp.controls.Timer

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

xp.controls

class Timer

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.Timer

class Timer
extends UIControl

Timer

A digital timer display that counts down to a specifc time

Author:: ProWin Computers Ltd. - Rob Edgar

Version:: 3.0.0.000

See also:: support@epresenterplus.com

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 static

classInfo: Object

A static class information object

public

direction: String

direction to count in up or down

public

displayPattern: String

direction to count in up or down

public

expireDate: String

end date in yyyy-mm-dd format

public

expireTime: String

end time in hh-mi-ss format

public

startDate: String

start date in yyyy-mm-dd format

public

startTime: String

start time in hh-mi-ss format

public

styleClass: String

The name of the style class this instance will use.

public

tz: Number

timezone offset

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public

expired: Boolean (read-only)

has the end time been reached

public

started: Boolean (read-only)

has the end time been reached

Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public

Timer ( )

Constructor - This should not be called directly.

Method Summary

public

countdown ( )

Updates the display one time to reflect its current state

public

getClass ( ): Function

Returns a reference to the components static class

public static

newInstance ( owner, instanceId, depth, initObj )

Creates a new Instance of this class

public

reset ( )

reset the timer

public

start ( )

Starts updating the display

public

stop ( )

Stops updating the display

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate

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

classInfo

public static var classInfo: Object

A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

direction

public var direction: String

direction to count in up or down

displayPattern

public var displayPattern: String

direction to count in up or down

expireDate

public var expireDate: String

end date in yyyy-mm-dd format

expireTime

public var expireTime: String

end time in hh-mi-ss format

startDate

public var startDate: String

start date in yyyy-mm-dd format

startTime

public var startTime: String

start time in hh-mi-ss format

styleClass

public var styleClass: String

The name of the style class this instance will use.

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

Timer

public function Timer

()

Constructor - This should not be called directly.

If you want to dynamically create a new instance of a control use its static newInstance method

Method Documentation

countdown

public function countdown

()

Updates the display one time to reflect its current state

Usually called back by the timer

getClass

public function getClass

(): Function

Returns a reference to the components static class

Overrides:: xp.system.UIControl.getClass in class xp.system.UIControl

newInstance

public static function newInstance

(owner,
instanceId,
depth,
initObj)

Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Parameters:

owner		A reference to the movie clip or object that will contains the new Instance.
instanceId		A string indicating the instance name of the new instance.(optional)
depth		A number indicating the depth of the new instance.(optional)
initObj		An object containing initialization properties for the new instance.(optional)

Returns:: A object that is an instance of the specified class.

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:

Timer.as, Last Modified: 10/17/2005 1:25:52 PM

AS2Doc