Timer

Overview

File

Class

Tree

Index

Help

Community Map Builder 27 Apr 2008

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class Timer

Object
   |
   +--ToolBase
         |
         +--Timer

class Timer
extends ToolBase

Defined in Timer.js

Author: Adair , Ian Turton

Field Summary
`Object`	`autoStart`
`Object`	`delay`
`Object`	`eventName`
`Object`	`eventValue`
`Object`	`interval`

Fields inherited from class ToolBase


   model, toolNode, enabled

Constructor Summary
`Timer (toolNode, model)` Timer to fire an event at the specified interval.

Method Summary
`void`	`play()` Starts the timer playing by using a JavaScript timer.
`void`	`startOnLoad(objRef)`
`void`	`stop()` Stops the JavaScript timer.

Methods inherited from class ToolBase



initTargetModel, initMouseHandler, getProperty

Field Detail

autoStart

Object autoStart

delay

Object delay

eventName

Object eventName

eventValue

Object eventValue

interval

Object interval

Constructor Detail

Timer

Timer(toolNode, model)

Timer to fire an event at the specified interval. Any MapBuilder event name may be used, and the eventValue may be a funtion call which returns the expected value for setParam().

Parameters:

toolNode

model

Author:

Method Detail

play

void play()

Starts the timer playing by using a JavaScript timer.

startOnLoad

void startOnLoad(objRef)

stop

void stop()

Stops the JavaScript timer.