|
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="Listener.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>Listener.js</h2>
|
|
72
|
|
|
73
|
</center>
|
|
74
|
|
|
75
|
|
|
76
|
|
|
77
|
|
|
78
|
<h4>Summary</h4>
|
|
79
|
<p>
|
|
80
|
|
|
81
|
No overview generated for 'Listener.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="Listener.html">Listener</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
|
$Id: Listener.js 3835 2008-02-13 02:20:23Z ahocevar $
|
|
114
|
*/</span>
|
|
115
|
|
|
116
|
<span class="comment">/**
|
|
117
|
* Base Listener class that is instanciated by all objects which provide
|
|
118
|
* event listeners.
|
|
119
|
* <span class="attrib">@constructor</span>
|
|
120
|
* <span class="attrib">@author</span> Cameron Shorter
|
|
121
|
*/</span>
|
|
122
|
<span class="reserved">function</span> Listener() {
|
|
123
|
<span class="comment">/** An array [params] of (listener, target). */</span>
|
|
124
|
<span class="reserved">this</span>.listeners=new Array();
|
|
125
|
|
|
126
|
<span class="comment">/**
|
|
127
|
* An array [params] of values. These values might not be used if the set/get
|
|
128
|
* functions are overwritten.
|
|
129
|
*/</span>
|
|
130
|
<span class="reserved">this</span>.values=new Array();
|
|
131
|
|
|
132
|
<span class="comment">/**
|
|
133
|
* Add a listener function which will be called when param is updated; The
|
|
134
|
* listener function should usually be: paint(target).
|
|
135
|
* <span class="attrib">@param</span> listener The function to call when the parameter changes.
|
|
136
|
* <span class="attrib">@param</span> target The object which owns the listener function.
|
|
137
|
* <span class="attrib">@param</span> param Parameter name; if this parameter changes then an event is
|
|
138
|
* sent to all interested listeners.
|
|
139
|
*/</span>
|
|
140
|
<span class="reserved">this</span>.addListener=<span class="reserved">function</span>(param, listener, target) {
|
|
141
|
<span class="reserved">if</span> (window.logger) logger.logEvent(<span class="literal">"addListener: "</span>+param,<span class="reserved">this</span>.id,target.id);
|
|
142
|
<span class="reserved">if</span>(!<span class="reserved">this</span>.listeners[param]){
|
|
143
|
<span class="reserved">this</span>.listeners[param]=new Array();
|
|
144
|
}
|
|
145
|
<span class="reserved">this</span>.removeListener(param,listener,target);
|
|
146
|
<span class="comment"> //for(var i=0;i<this.listeners[param].length;i++){</span>
|
|
147
|
<span class="comment"> // if(this.listeners[param][i][0]==listener && this.listeners[param][i][1]==target){</span>
|
|
148
|
<span class="comment"> // return;</span>
|
|
149
|
<span class="comment"> // alert("Listener.addListener again: target="+target.id);</span>
|
|
150
|
<span class="comment"> // }</span>
|
|
151
|
<span class="comment"> //}</span>
|
|
152
|
<span class="reserved">this</span>.listeners[param].push(new Array(listener,target));
|
|
153
|
<span class="reserved">if</span>( !listener ) {
|
|
154
|
alert(mbGetMessage(<span class="literal">"undefinedListener"</span>, target.id));
|
|
155
|
}
|
|
156
|
}
|
|
157
|
|
|
158
|
<span class="comment">/**
|
|
159
|
* Add a listener function at the start of the list.
|
|
160
|
* <span class="attrib">@param</span> listener The function to call when the parameter changes.
|
|
161
|
* <span class="attrib">@param</span> target The object which owns the listener function.
|
|
162
|
* <span class="attrib">@param</span> param Parameter name; if this parameter changes then an event is
|
|
163
|
* sent to all interested listeners.
|
|
164
|
*/</span>
|
|
165
|
<span class="reserved">this</span>.addFirstListener=<span class="reserved">function</span>(param, listener, target) {
|
|
166
|
<span class="reserved">if</span> (window.logger) logger.logEvent(<span class="literal">"addFirstListener: "</span>+param,<span class="reserved">this</span>.id,target.id);
|
|
167
|
<span class="reserved">if</span>(!<span class="reserved">this</span>.listeners[param]){
|
|
168
|
<span class="reserved">this</span>.listeners[param]=new Array();
|
|
169
|
}
|
|
170
|
<span class="reserved">this</span>.removeListener(param,listener,target);
|
|
171
|
<span class="reserved">this</span>.listeners[param].unshift(new Array(listener,target));
|
|
172
|
<span class="reserved">if</span>( !listener ) {
|
|
173
|
alert(mbGetMessage(<span class="literal">"undefinedListener"</span>, target));
|
|
174
|
}
|
|
175
|
}
|
|
176
|
|
|
177
|
<span class="comment">/**
|
|
178
|
* Remove a listener so that it is not called anymore when a param changes.
|
|
179
|
* <span class="attrib">@param</span> listener The function to call when the parameter changes.
|
|
180
|
* <span class="attrib">@param</span> target The object which owns the listener function.
|
|
181
|
* <span class="attrib">@param</span> param Parameter name; if this parameter changes then an event is
|
|
182
|
* sent to all interested listeners.
|
|
183
|
*/</span>
|
|
184
|
<span class="reserved">this</span>.removeListener=<span class="reserved">function</span>(param,listener,target){
|
|
185
|
<span class="reserved">if</span>(<span class="reserved">this</span>.listeners[param]){
|
|
186
|
<span class="reserved">for</span>(var i=0;i<<span class="reserved">this</span>.listeners[param].length;i++){
|
|
187
|
<span class="reserved">if</span>(<span class="reserved">this</span>.listeners[param][i][0]==listener && <span class="reserved">this</span>.listeners[param][i][1]==target){
|
|
188
|
<span class="reserved">for</span>(var j=i;j<<span class="reserved">this</span>.listeners[param].length-1;j++){
|
|
189
|
<span class="reserved">this</span>.listeners[param][j]=<span class="reserved">this</span>.listeners[param][j+1];
|
|
190
|
}
|
|
191
|
<span class="reserved">this</span>.listeners[param].pop();
|
|
192
|
<span class="reserved">return</span>;
|
|
193
|
}
|
|
194
|
}
|
|
195
|
}
|
|
196
|
}
|
|
197
|
|
|
198
|
<span class="comment">/**
|
|
199
|
* Call all the listeners that have registered interest in this parameter
|
|
200
|
* using addListener.
|
|
201
|
* <span class="attrib">@param</span> param The parameter that has changed.
|
|
202
|
* <span class="attrib">@param</span> value The new parameter value.
|
|
203
|
*/</span>
|
|
204
|
<span class="reserved">this</span>.callListeners=<span class="reserved">function</span>(param,value) {
|
|
205
|
<span class="reserved">if</span> (<span class="reserved">this</span>.listeners[param]){
|
|
206
|
var count = <span class="reserved">this</span>.listeners[param].length;
|
|
207
|
<span class="reserved">for</span>(var i=0;i<count;i++){
|
|
208
|
<span class="reserved">if</span> (window.logger) logger.logEvent(param,<span class="reserved">this</span>.id,<span class="reserved">this</span>.listeners[param][i][1].id,value);
|
|
209
|
<span class="comment"> //this is listenerFunction(target,value)</span>
|
|
210
|
<span class="reserved">if</span> (<span class="reserved">this</span>.listeners[param][i][0]) {
|
|
211
|
<span class="reserved">this</span>.listeners[param][i][0](<span class="reserved">this</span>.listeners[param][i][1],value);
|
|
212
|
} <span class="reserved">else</span> {
|
|
213
|
alert(mbGetMessage(<span class="literal">"listenerError"</span>, param, <span class="reserved">this</span>.listeners[param][i][1].id, <span class="reserved">this</span>.listeners[param][i][0]));
|
|
214
|
}
|
|
215
|
}
|
|
216
|
}
|
|
217
|
}
|
|
218
|
|
|
219
|
<span class="comment">/**
|
|
220
|
* Update parameter and call all interested listeners. This function may
|
|
221
|
* be overloaded to store the parameter in a elsewhere (eg in an XML
|
|
222
|
* document).
|
|
223
|
* <span class="attrib">@param</span> param The parameter to change.
|
|
224
|
* <span class="attrib">@parma</span> value The new value of the param.
|
|
225
|
*/</span>
|
|
226
|
<span class="reserved">this</span>.setParam=<span class="reserved">function</span>(param,value) {
|
|
227
|
<span class="reserved">this</span>.values[param] = value;
|
|
228
|
<span class="comment">
|
|
229
|
// Call all the interested listeners</span>
|
|
230
|
<span class="reserved">this</span>.callListeners(param,value);
|
|
231
|
}
|
|
232
|
|
|
233
|
<span class="comment">/**
|
|
234
|
* Return the param value, or return null if it does not exist. This
|
|
235
|
* function may be overloaded to store the param elsewhere (eg in
|
|
236
|
* an XML document).
|
|
237
|
* <span class="attrib">@param</span> param The parameter to get.
|
|
238
|
* <span class="attrib">@return</span> The value of the param.
|
|
239
|
*/</span>
|
|
240
|
<span class="reserved">this</span>.getParam=<span class="reserved">function</span>(param) {
|
|
241
|
<span class="reserved">return</span> <span class="reserved">this</span>.values[param];
|
|
242
|
}
|
|
243
|
}
|
|
244
|
</pre>
|
|
245
|
<hr>
|
|
246
|
|
|
247
|
|
|
248
|
|
|
249
|
<!-- ========== START OF NAVBAR ========== -->
|
|
250
|
<a name="navbar_top"><!-- --></a>
|
|
251
|
<table border="0" width="100%" cellpadding="1" cellspacing="0">
|
|
252
|
<tr>
|
|
253
|
<td colspan=2 bgcolor="#EEEEFF" class="NavBarCell1">
|
|
254
|
<a name="navbar_top_firstrow"><!-- --></a>
|
|
255
|
<table border="0" cellpadding="0" cellspacing="3">
|
|
256
|
<tr align="center" valign="top">
|
|
257
|
|
|
258
|
|
|
259
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="overview-summary.html"><font class="NavBarFont1"><b>Overview</b></font></a> </td>
|
|
260
|
<td bgcolor="#FFFFFF" class="NavBarCell1Rev"> <font class="NavBarFont1Rev"><b>File</b></font> </td>
|
|
261
|
|
|
262
|
|
|
263
|
<td bgcolor="#FFFFFF" class="NavBarCell1"> <font class="NavBarFont1">Class</font> </td>
|
|
264
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="overview-tree.html"><font class="NavBarFont1"><b>Tree</b></font></a> </td>
|
|
265
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="index-all.html"--><font class="NavBarFont1"><b>Index</b></font></a> </td>
|
|
266
|
<td bgcolor="#EEEEFF" class="NavBarCell1"> <a href="help-doc.html"><font class="NavBarFont1"><b>Help</b></font></a> </td>
|
|
267
|
</tr>
|
|
268
|
</table>
|
|
269
|
</td>
|
|
270
|
<td bgcolor="#EEEEFF" align="right" valign="top"><em>
|
|
271
|
<b><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</b></em>
|
|
272
|
</td>
|
|
273
|
</tr>
|
|
274
|
|
|
275
|
<tr>
|
|
276
|
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
|
277
|
PREV
|
|
278
|
NEXT</font></td>
|
|
279
|
<td bgcolor="white" class="NavBarCell2"><font size="-2">
|
|
280
|
<a href="index.html" target="_top"><b>FRAMES</b></a>
|
|
281
|
<a href="overview-summary.html" target="_top"><b>NO FRAMES</b></a>
|
|
282
|
|
|
283
|
<script>
|
|
284
|
<!--
|
|
285
|
if(window==top) {
|
|
286
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
287
|
}
|
|
288
|
//-->
|
|
289
|
</script>
|
|
290
|
<noscript>
|
|
291
|
<a href="allclasses-noframe.html" target=""><b>All Classes</b></a>
|
|
292
|
</noscript>
|
|
293
|
</font></td>
|
|
294
|
</tr>
|
|
295
|
</table>
|
|
296
|
<!-- =========== END OF NAVBAR =========== -->
|
|
297
|
|
|
298
|
<hr>
|
|
299
|
<font size="-1">
|
|
300
|
|
|
301
|
</font>
|
|
302
|
<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>
|
|
303
|
</body>
|
|
304
|
</html>
|