|
1
|
<!doctype html public "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
|
|
2
|
<html>
|
|
3
|
<head>
|
|
4
|
<title>
|
|
5
|
<a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008 Overview
|
|
6
|
</title>
|
|
7
|
<link rel ="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
8
|
<script>
|
|
9
|
function asd() {
|
|
10
|
|
|
11
|
parent.document.title="Timer.js Overview";
|
|
12
|
|
|
13
|
}
|
|
14
|
</script>
|
|
15
|
</head>
|
|
16
|
<body bgcolor="white" onload="asd();">
|
|
17
|
|
|
18
|
<!-- ========== START OF NAVBAR ========== -->
|
|
19
|
<a name="navbar_top"><!-- --></a>
|
|
20
|
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
|
21
|
<tr>
|
|
22
|
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
|
23
|
<a name="navbar_top_firstrow"><!-- --></a>
|
|
24
|
<table border="0" cellpadding="0" cellspacing="3">
|
|
25
|
<tr align="center" valign="top">
|
|
26
|
|
|
27
|
|
|
28
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="overview-summary.html"><font class="NavBarFont1"><b>Overview</b></font></a> </td>
|
|
29
|
<td bgcolor="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
|
30
|
|
|
31
|
|
|
32
|
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</font> </td>
|
|
33
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="overview-tree.html"><font class="NavBarFont1"><b>Tree</b></font></a> </td>
|
|
34
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="index-all.html"--><font class="NavBarFont1"><b>Index</b></font></a> </td>
|
|
35
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="help-doc.html"><font class="NavBarFont1"><b>Help</b></font></a> </td>
|
|
36
|
</tr>
|
|
37
|
</table>
|
|
38
|
</td>
|
|
39
|
<td bgcolor="#EEEEFF" align="right" valign="top">
|
|
40
|
<em>
|
|
41
|
<b><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</b></em>
|
|
42
|
</td>
|
|
43
|
</tr>
|
|
44
|
|
|
45
|
<tr>
|
|
46
|
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
|
47
|
PREV
|
|
48
|
NEXT</font></td>
|
|
49
|
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
|
50
|
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
|
51
|
<a href="overview-summary.html" target="_top"><b>NO FRAMES</b></a>
|
|
52
|
|
|
53
|
<script>
|
|
54
|
<!--
|
|
55
|
if(window==top) {
|
|
56
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
57
|
}
|
|
58
|
//-->
|
|
59
|
</script>
|
|
60
|
<noscript>
|
|
61
|
<a href="allclasses-noframe.html" target=""><b>All Classes</b></a>
|
|
62
|
</noscript>
|
|
63
|
</font></td>
|
|
64
|
</tr>
|
|
65
|
</table>
|
|
66
|
<!-- =========== END OF NAVBAR =========== -->
|
|
67
|
|
|
68
|
<hr>
|
|
69
|
<center>
|
|
70
|
|
|
71
|
<h2>Timer.js</h2>
|
|
72
|
|
|
73
|
</center>
|
|
74
|
|
|
75
|
|
|
76
|
|
|
77
|
|
|
78
|
<h4>Summary</h4>
|
|
79
|
<p>
|
|
80
|
|
|
81
|
No overview generated for 'Timer.js'<BR/><BR/>
|
|
82
|
|
|
83
|
</p>
|
|
84
|
|
|
85
|
<hr>
|
|
86
|
|
|
87
|
|
|
88
|
<table border="1" cellpadding="3" cellspacing="0" width="100%">
|
|
89
|
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
|
|
90
|
<td colspan=2><font size="+2">
|
|
91
|
|
|
92
|
<b>Class Summary</b>
|
|
93
|
|
|
94
|
</font></td>
|
|
95
|
</tr>
|
|
96
|
|
|
97
|
<tr bgcolor="white" class="TableRowColor">
|
|
98
|
<td width="15%"><b><a href="Timer.html">Timer</a></b></td>
|
|
99
|
<td> </td>
|
|
100
|
</tr>
|
|
101
|
|
|
102
|
</table>
|
|
103
|
<hr/>
|
|
104
|
|
|
105
|
|
|
106
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
107
|
|
|
108
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
109
|
|
|
110
|
|
|
111
|
<pre class="sourceview"><span class="comment">/*
|
|
112
|
License: LGPL as per: http://www.gnu.org/copyleft/lesser.html
|
|
113
|
Dependancies: Context
|
|
114
|
$Id: Timer.js 3881 2008-02-27 15:41:07Z gjvoosten $
|
|
115
|
*/</span>
|
|
116
|
<span class="comment">
|
|
117
|
// Ensure this object's dependancies are loaded.</span>
|
|
118
|
mapbuilder.loadScript(baseDir+<span class="literal">"/tool/ToolBase.js"</span>);
|
|
119
|
|
|
120
|
<span class="comment">/**
|
|
121
|
* Timer to fire an event at the specified interval. Any MapBuilder event name may be used,
|
|
122
|
* and the eventValue may be a funtion call which returns the expected value for setParam().
|
|
123
|
* <span class="attrib">@constructor</span>
|
|
124
|
* <span class="attrib">@base</span> ToolBase
|
|
125
|
* <span class="attrib">@author</span> Adair
|
|
126
|
* <span class="attrib">@author</span> Ian Turton
|
|
127
|
* <span class="attrib">@param</span> toolNode The tool node from the config document for this tool
|
|
128
|
* <span class="attrib">@param</span> model the model object that contains this tool
|
|
129
|
*/</span>
|
|
130
|
<span class="reserved">function</span> Timer(toolNode, model) {
|
|
131
|
ToolBase.apply(<span class="reserved">this</span>, new Array(toolNode, model));
|
|
132
|
<span class="comment">
|
|
133
|
//delay in milliseconds - defaults to every half hour</span>
|
|
134
|
<span class="reserved">this</span>.delay = 1000*<span class="reserved">this</span>.getProperty(<span class="literal">"mb:every"</span>, 30);
|
|
135
|
<span class="comment">
|
|
136
|
//set the event to be fired, default event is to reload the model</span>
|
|
137
|
<span class="reserved">this</span>.eventName = <span class="reserved">this</span>.getProperty(<span class="literal">"mb:eventName"</span>, <span class="literal">"reloadModel"</span>);
|
|
138
|
<span class="comment">
|
|
139
|
//set the value to be passed with the event, default eventValue is null</span>
|
|
140
|
<span class="reserved">this</span>.eventValue = <span class="reserved">this</span>.getProperty(<span class="literal">"mb:eventValue"</span>);
|
|
141
|
|
|
142
|
<span class="comment">/**
|
|
143
|
* Starts the timer playing by using a JavaScript timer.
|
|
144
|
*/</span>
|
|
145
|
<span class="reserved">this</span>.play = <span class="reserved">function</span>() {
|
|
146
|
clearInterval(<span class="reserved">this</span>.interval);
|
|
147
|
var workString = <span class="literal">"config.objects."</span>+<span class="reserved">this</span>.targetModel.id+<span class="literal">".setParam('"</span>+<span class="reserved">this</span>.eventName+<span class="literal">"'"</span>;
|
|
148
|
<span class="reserved">if</span> (<span class="reserved">this</span>.eventValue) workString += <span class="literal">","</span>+<span class="reserved">this</span>.eventValue;
|
|
149
|
workString += <span class="literal">")"</span>;
|
|
150
|
<span class="comment"> //alert("about to set timer for "+this.delay+" millisecs: "+workString); </span>
|
|
151
|
<span class="reserved">this</span>.interval = setInterval(workString,<span class="reserved">this</span>.delay);
|
|
152
|
}
|
|
153
|
|
|
154
|
<span class="comment">/**
|
|
155
|
* Stops the JavaScript timer.
|
|
156
|
*/</span>
|
|
157
|
<span class="reserved">this</span>.stop = <span class="reserved">function</span>() {
|
|
158
|
clearInterval(<span class="reserved">this</span>.interval);
|
|
159
|
}
|
|
160
|
<span class="comment">
|
|
161
|
//the timer can start automatically or not, in which case there should be a call to timer.start() somewhere</span>
|
|
162
|
<span class="reserved">this</span>.autoStart = Mapbuilder.parseBoolean(<span class="reserved">this</span>.getProperty(<span class="literal">"mb:autoStart"</span>, true));
|
|
163
|
<span class="reserved">this</span>.startOnLoad = <span class="reserved">function</span>(objRef) {
|
|
164
|
<span class="reserved">if</span> (objRef.autoStart) objRef.play();
|
|
165
|
}
|
|
166
|
<span class="reserved">this</span>.model.addListener(<span class="literal">"init"</span>,<span class="reserved">this</span>.startOnLoad, <span class="reserved">this</span>);
|
|
167
|
|
|
168
|
}
|
|
169
|
|
|
170
|
|
|
171
|
|
|
172
|
</pre>
|
|
173
|
<hr>
|
|
174
|
|
|
175
|
|
|
176
|
|
|
177
|
<!-- ========== START OF NAVBAR ========== -->
|
|
178
|
<a name="navbar_top"><!-- --></a>
|
|
179
|
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
|
180
|
<tr>
|
|
181
|
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
|
182
|
<a name="navbar_top_firstrow"><!-- --></a>
|
|
183
|
<table border="0" cellpadding="0" cellspacing="3">
|
|
184
|
<tr align="center" valign="top">
|
|
185
|
|
|
186
|
|
|
187
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="overview-summary.html"><font class="NavBarFont1"><b>Overview</b></font></a> </td>
|
|
188
|
<td bgcolor="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
|
189
|
|
|
190
|
|
|
191
|
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</font> </td>
|
|
192
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="overview-tree.html"><font class="NavBarFont1"><b>Tree</b></font></a> </td>
|
|
193
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="index-all.html"--><font class="NavBarFont1"><b>Index</b></font></a> </td>
|
|
194
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="help-doc.html"><font class="NavBarFont1"><b>Help</b></font></a> </td>
|
|
195
|
</tr>
|
|
196
|
</table>
|
|
197
|
</td>
|
|
198
|
<td bgcolor="#EEEEFF" align="right" valign="top"><em>
|
|
199
|
<b><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</b></em>
|
|
200
|
</td>
|
|
201
|
</tr>
|
|
202
|
|
|
203
|
<tr>
|
|
204
|
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
|
205
|
PREV
|
|
206
|
NEXT</font></td>
|
|
207
|
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
|
208
|
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
|
209
|
<a href="overview-summary.html" target="_top"><b>NO FRAMES</b></a>
|
|
210
|
|
|
211
|
<script>
|
|
212
|
<!--
|
|
213
|
if(window==top) {
|
|
214
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
215
|
}
|
|
216
|
//-->
|
|
217
|
</script>
|
|
218
|
<noscript>
|
|
219
|
<a href="allclasses-noframe.html" target=""><b>All Classes</b></a>
|
|
220
|
</noscript>
|
|
221
|
</font></td>
|
|
222
|
</tr>
|
|
223
|
</table>
|
|
224
|
<!-- =========== END OF NAVBAR =========== -->
|
|
225
|
|
|
226
|
<hr>
|
|
227
|
<font size="-1">
|
|
228
|
|
|
229
|
</font>
|
|
230
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Sun Apr 27 20:30:54 2008</div>
|
|
231
|
</body>
|
|
232
|
</html>
|