Project

General

Profile

1 4307 leinfelder
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
2
<!--NewPage-->
3
<HTML>
4
<HEAD>
5
<TITLE>
6
Mapbuilder
7
</TITLE>
8
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
9
</HEAD>
10
<SCRIPT>
11
function asd()
12
{
13
parent.document.title="Mapbuilder";
14
}
15
</SCRIPT>
16
<BODY BGCOLOR="white" onload="asd();">
17
18
<!-- ========== START OF NAVBAR ========== -->
19
<A NAME="navbar_bottom"><!-- --></A>
20
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
21
<TR>
22
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
23
<A NAME="navbar_bottom_firstrow"><!-- --></A>
24
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
25
  <TR ALIGN="center" VALIGN="top">
26
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
27
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-Mapbuilder.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
28
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">&nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
29
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
30
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
31
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
32
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
33
  </TR>
34
</TABLE>
35
</TD>
36
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
37
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
38
</EM>
39
</TD
40
</TR>
41
42
<TR>
43
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
44
&nbsp;<A HREF="Logger.html"><B>PREV CLASS</B></A><!--
45
   NEXT CLASS
46
-->
47
&nbsp;<A HREF="MapPaneOL.html"><B>NEXT CLASS</B></A></FONT></TD>
48
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
49
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
50
&nbsp;<A HREF="Mapbuilder.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
51
&nbsp;
52
<SCRIPT>
53
  <!--
54
  if(window==top) {
55
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
56
  }
57
  //-->
58
</SCRIPT>
59
<NOSCRIPT>
60
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
61
</NOSCRIPT>
62
</FONT></TD>
63
</TR>
64
<TR>
65
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
66
  SUMMARY:&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
67
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
68
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
69
</TR>
70
</TABLE>
71
<!-- =========== END OF NAVBAR =========== -->
72
<HR>
73
74
<!-- ======== START OF CLASS DATA ======== -->
75
<H2>Class Mapbuilder</H2>
76
<PRE>Object
77
   |
78
   +--<b>Mapbuilder</b>
79
</PRE>
80
81
82
<HR>
83
<DL>
84
   <!-- Class definition -->
85
   <DT>class
86
   <B>Mapbuilder</B>
87
88
89
</DL>
90
91
   <P>
92
   <I>Defined in <a href='overview-summary-Mapbuilder.js.html'>Mapbuilder.js</a></I><BR/><BR/><B>Requires:</B><UL>- <a href="Config.html#">Config</a><BR/>- <a href="Listener.html#">Listener</a><BR/>- <a href="ModelBase.html#">ModelBase</a><BR/>- <a href="Sarissa.html#">Sarissa</a><BR/>- Util    </UL><B>Author:</B> Cameron Shorter  <BR/>
93
   </P>
94
95
   <HR>
96
97
<!-- ======== NESTED CLASS SUMMARY ======== -->
98
99
<!-- ======== END NESTED CLASS SUMMARY ======== -->
100
101
102
<!-- =========== FIELD SUMMARY =========== -->
103
104
   <A NAME="field_summary"><!-- --></A>
105
      <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
106
         <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
107
            <TD COLSPAN=2><FONT SIZE="+2">
108
               <B>Field Summary</B></FONT></TD>
109
         </TR>
110
111
   <!-- This is one instance field summary -->
112
113
   <TR BGCOLOR="white" CLASS="TableRowColor">
114
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
115
   <CODE>&nbsp;Object</CODE></FONT></TD>
116
   <TD><CODE><B><A HREF="#loadingScripts">loadingScripts</A></B></CODE>
117
   <BR>
118
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Array of objects that are loading.</TD>
119
   </TR>
120
121
   <TR BGCOLOR="white" CLASS="TableRowColor">
122
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123
   <CODE>&nbsp;Object</CODE></FONT></TD>
124
   <TD><CODE><B><A HREF="#loadOrdered">loadOrdered</A></B></CODE>
125
   <BR>
126
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
127
   </TR>
128
129
   <TR BGCOLOR="white" CLASS="TableRowColor">
130
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131
   <CODE>&nbsp;Object</CODE></FONT></TD>
132
   <TD><CODE><B><A HREF="#loadState">loadState</A></B></CODE>
133
   <BR>
134
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines which Mapbuilder scripts are loading.</TD>
135
   </TR>
136
137
   <TR BGCOLOR="white" CLASS="TableRowColor">
138
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139
   <CODE>&nbsp;Object</CODE></FONT></TD>
140
   <TD><CODE><B><A HREF="#orderedScripts">orderedScripts</A></B></CODE>
141
   <BR>
142
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Array of scripts that have to be loaded ordered</TD>
143
   </TR>
144
145
   <TR BGCOLOR="white" CLASS="TableRowColor">
146
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147
   <CODE>&nbsp;Object</CODE></FONT></TD>
148
   <TD><CODE><B><A HREF="#scriptLoader">scriptLoader</A></B></CODE>
149
   <BR>
150
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Timer to load ordered scripts</TD>
151
   </TR>
152
153
   <TR BGCOLOR="white" CLASS="TableRowColor">
154
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155
   <CODE>&nbsp;Object</CODE></FONT></TD>
156
   <TD><CODE><B><A HREF="#scriptsTimer">scriptsTimer</A></B></CODE>
157
   <BR>
158
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Timer to periodically check if scripts have loaded.</TD>
159
   </TR>
160
161
   <TR BGCOLOR="white" CLASS="TableRowColor">
162
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163
   <CODE>&lt;static&gt; &nbsp;Object</CODE></FONT></TD>
164
   <TD><CODE><B><A HREF="#Popup">Popup</A></B></CODE>
165
   <BR>
166
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Derived from OpenLayers.Popup (svn r6430) and
167
 OpenLayers.Popup.Anchored (svn r5614), this class preserves the
168
 functionality of OpenLayers.Popup.Anchored before the new style popups
169
 of http://trac.openlayers.org/ticket/926 were introduced.</TD>
170
   </TR>
171
172
173
   </TABLE>
174
   &nbsp;
175
176
177
178
179
<!-- =========== END FIELD SUMMARY =========== -->
180
181
182
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
183
184
<A NAME="constructor_summary"><!-- --></A>
185
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
186
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
187
<TD COLSPAN=2><FONT SIZE="+2">
188
<B>Constructor Summary</B></FONT></TD>
189
</TR>
190
<TR BGCOLOR="white" CLASS="TableRowColor">
191
   <TD>
192
      <CODE>
193
	 <B>
194
	    <A HREF="Mapbuilder.html#Mapbuilder()">Mapbuilder</A>
195
	 </B>
196
	 ()
197
      </CODE>
198
      <BR>
199
      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200
      This Object bootstraps the Mapbuilder libraries by loading the core
201
 script files.
202
      </TD>
203
</TR>
204
</TABLE>
205
206
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
207
208
&nbsp;
209
210
<!-- ========== METHOD SUMMARY =========== -->
211
212
<A NAME="method_summary"><!-- --></A>
213
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
214
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
215
<TD COLSPAN=2><FONT SIZE="+2">
216
<B>Method Summary</B></FONT></TD>
217
</TR>
218
219
220
   <TR BGCOLOR="white" CLASS="TableRowColor">
221
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
222
	 <FONT SIZE="-1">
223
	    <CODE>&nbsp;void</CODE>
224
	 </FONT>
225
      </TD>
226
      <TD>
227
	 <CODE>
228
	    <B>
229
	       <A HREF="#checkScriptsLoaded">checkScriptsLoaded</A></B>()
230
	 </CODE>
231
	 <BR>
232
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
233
	 Called periodically and moves onto the next loadState when this round of
234
 scripts have loaded.
235
      </TD>
236
   </TR>
237
238
   <TR BGCOLOR="white" CLASS="TableRowColor">
239
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
240
	 <FONT SIZE="-1">
241
	    <CODE>&nbsp;void</CODE>
242
	 </FONT>
243
      </TD>
244
      <TD>
245
	 <CODE>
246
	    <B>
247
	       <A HREF="#checkScriptState">checkScriptState</A></B>(script)
248
	 </CODE>
249
	 <BR>
250
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251
	 readyState handler for scripts - IE only.
252
      </TD>
253
   </TR>
254
255
   <TR BGCOLOR="white" CLASS="TableRowColor">
256
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
257
	 <FONT SIZE="-1">
258
	    <CODE>&nbsp;void</CODE>
259
	 </FONT>
260
      </TD>
261
      <TD>
262
	 <CODE>
263
	    <B>
264
	       <A HREF="#doLoadScript">doLoadScript</A></B>(script)
265
	 </CODE>
266
	 <BR>
267
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
268
	 starts script loading by adding the script node to the dom tree - IE only.
269
      </TD>
270
   </TR>
271
272
   <TR BGCOLOR="white" CLASS="TableRowColor">
273
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
274
	 <FONT SIZE="-1">
275
	    <CODE>&nbsp;void</CODE>
276
	 </FONT>
277
      </TD>
278
      <TD>
279
	 <CODE>
280
	    <B>
281
	       <A HREF="#loadNextScript">loadNextScript</A></B>()
282
	 </CODE>
283
	 <BR>
284
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
285
	 loads one script after another - only for IE.
286
      </TD>
287
   </TR>
288
289
   <TR BGCOLOR="white" CLASS="TableRowColor">
290
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
291
	 <FONT SIZE="-1">
292
	    <CODE>&nbsp;void</CODE>
293
	 </FONT>
294
      </TD>
295
      <TD>
296
	 <CODE>
297
	    <B>
298
	       <A HREF="#loadScript">loadScript</A></B>(url)
299
	 </CODE>
300
	 <BR>
301
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
302
	 Dynamically load a script file if it has not already been loaded.
303
      </TD>
304
   </TR>
305
306
   <TR BGCOLOR="white" CLASS="TableRowColor">
307
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
308
	 <FONT SIZE="-1">
309
	    <CODE>&nbsp;void</CODE>
310
	 </FONT>
311
      </TD>
312
      <TD>
313
	 <CODE>
314
	    <B>
315
	       <A HREF="#loadScriptsFromXpath">loadScriptsFromXpath</A></B>(nodes,dir)
316
	 </CODE>
317
	 <BR>
318
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
319
	 Internal function to load scripts for components that don't have <scriptfile>
320
 specified in the config file.
321
      </TD>
322
   </TR>
323
324
   <TR BGCOLOR="white" CLASS="TableRowColor">
325
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
326
	 <FONT SIZE="-1">
327
	    <CODE>&nbsp;void</CODE>
328
	 </FONT>
329
      </TD>
330
      <TD>
331
	 <CODE>
332
	    <B>
333
	       <A HREF="#setLoadState">setLoadState</A></B>(newState)
334
	 </CODE>
335
	 <BR>
336
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
337
	 Move onto loading the next set of scripts.
338
      </TD>
339
   </TR>
340
341
   <TR BGCOLOR="white" CLASS="TableRowColor">
342
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
343
	 <FONT SIZE="-1">
344
	    <CODE>&lt;static&gt;&nbsp;Object</CODE>
345
	 </FONT>
346
      </TD>
347
      <TD>
348
	 <CODE>
349
	    <B>
350
	       <A HREF="#getProperty">getProperty</A></B>(domNode, propertyName, defaultValue)
351
	 </CODE>
352
	 <BR>
353
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
354
	 Convenience method that is used to parse dom nodes.
355
      </TD>
356
   </TR>
357
358
   <TR BGCOLOR="white" CLASS="TableRowColor">
359
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
360
	 <FONT SIZE="-1">
361
	    <CODE>&lt;static&gt;&nbsp;Object</CODE>
362
	 </FONT>
363
      </TD>
364
      <TD>
365
	 <CODE>
366
	    <B>
367
	       <A HREF="#parseBoolean">parseBoolean</A></B>(value)
368
	 </CODE>
369
	 <BR>
370
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
371
	 Convenience method to parse a string or number as a boolean value
372
      </TD>
373
   </TR>
374
375
376
</TABLE>
377
378
379
380
<P>
381
<!-- ========== END METHOD SUMMARY =========== -->
382
383
384
<!-- ============ FIELD DETAIL START =========== -->
385
386
   <A NAME="field_detail"><!-- --></A>
387
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
388
      <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
389
         <TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
390
      </TR>
391
   </TABLE>
392
393
394
   <A NAME="loadingScripts"><!-- --></A>
395
   <H3>loadingScripts</H3>
396
   <PRE>Object&nbsp;<B>loadingScripts</B></PRE>
397
   <UL>
398
   Array of objects that are loading.  Don't continue initialisation until
399
 all objects have loaded.
400
401
   </UL>
402
   <HR>
403
404
   <A NAME="loadOrdered"><!-- --></A>
405
   <H3>loadOrdered</H3>
406
   <PRE>Object&nbsp;<B>loadOrdered</B></PRE>
407
   <UL>
408
409
410
   </UL>
411
   <HR>
412
413
   <A NAME="loadState"><!-- --></A>
414
   <H3>loadState</H3>
415
   <PRE>Object&nbsp;<B>loadState</B></PRE>
416
   <UL>
417
   Determines which Mapbuilder scripts are loading.
418
 TBD: Is it possible to use enumerated types in JS?
419
420
   </UL>
421
   <HR>
422
423
   <A NAME="orderedScripts"><!-- --></A>
424
   <H3>orderedScripts</H3>
425
   <PRE>Object&nbsp;<B>orderedScripts</B></PRE>
426
   <UL>
427
   Array of scripts that have to be loaded ordered
428
429
   </UL>
430
   <HR>
431
432
   <A NAME="scriptLoader"><!-- --></A>
433
   <H3>scriptLoader</H3>
434
   <PRE>Object&nbsp;<B>scriptLoader</B></PRE>
435
   <UL>
436
   Timer to load ordered scripts
437
438
   </UL>
439
   <HR>
440
441
   <A NAME="scriptsTimer"><!-- --></A>
442
   <H3>scriptsTimer</H3>
443
   <PRE>Object&nbsp;<B>scriptsTimer</B></PRE>
444
   <UL>
445
   Timer to periodically check if scripts have loaded.
446
447
   </UL>
448
   <HR>
449
450
   <A NAME="Popup"><!-- --></A>
451
   <H3>Popup</H3>
452
   <PRE>&lt;static&gt;&nbsp;Object&nbsp;<B>Popup</B></PRE>
453
   <UL>
454
   Derived from OpenLayers.Popup (svn r6430) and
455
 OpenLayers.Popup.Anchored (svn r5614), this class preserves the
456
 functionality of OpenLayers.Popup.Anchored before the new style popups
457
 of http://trac.openlayers.org/ticket/926 were introduced.
458
459
   </UL>
460
   <HR>
461
462
463
464
<!-- ============ FIELD DETAIL END =========== -->
465
466
    <!-- ========= CONSTRUCTOR DETAIL START ======== -->
467
468
<A NAME="constructor_detail"><!-- --></A>
469
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
470
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
471
      <TD COLSPAN=1>
472
      <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
473
      </TD>
474
   </TR>
475
</TABLE>
476
477
<A NAME="Mapbuilder()"><!-- --></A><H3>
478
Mapbuilder</H3>
479
<PRE><B>Mapbuilder</B>()</PRE>
480
481
482
<UL>
483
   This Object bootstraps the Mapbuilder libraries by loading the core
484
 script files.
485
 When Config.js is loaded, the script files for objects described in the
486
 Mapbuilder config file are loaded.
487
 Objects which have dependencies will trigger the dependancies to load
488
 when they are loaded.
489
</UL>
490
491
492
493
   </UL>
494
495
496
<!-- Constructor return value(s) -->
497
498
<!-- End constructor return value(s) -->
499
500
<!-- ADDITIONAL ATTRIBUTES -->
501
502
<UL>
503
<B>Requires:</B><UL>- <a href="Config.html#">Config</a><BR/>- <a href="Listener.html#">Listener</a><BR/>- <a href="ModelBase.html#">ModelBase</a><BR/>- <a href="Sarissa.html#">Sarissa</a><BR/>- Util    </UL><B>Author:</B> Cameron Shorter  <BR/>
504
</UL>
505
506
<HR/>
507
<!-- END ADDITIONAL ATTRIBUTES  -->
508
509
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
510
511
512
<!-- ============ METHOD DETAIL START ========== -->
513
514
<A NAME="method_detail"><!-- --></A>
515
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
516
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
517
      <TD COLSPAN=1><FONT SIZE="+2">
518
         <B>Method Detail</B></FONT>
519
      </TD>
520
   </TR>
521
</TABLE>
522
523
<!-- One single method detail entry -->
524
525
   <A NAME="checkScriptsLoaded"><!-- --></A>
526
   <H3>checkScriptsLoaded</H3>
527
   <PRE>void <B>checkScriptsLoaded</B>()</PRE>
528
529
      <UL>Called periodically and moves onto the next loadState when this round of
530
 scripts have loaded.
531
 For IE clients, object.readyState is used to check if scripts are loaded.
532
 Mozilla works fine without this function - I think it is single threaded.</UL>
533
534
535
   <!-- METHOD PARAMETERS START -->
536
537
   <!-- METHOD PARAMETERS END -->
538
539
540
541
   <!-- ADDITIONAL ATTRIBUTES START -->
542
543
   <!-- ADDITIONAL ATTRIBUTES  END -->
544
<HR>
545
546
   <A NAME="checkScriptState"><!-- --></A>
547
   <H3>checkScriptState</H3>
548
   <PRE>void <B>checkScriptState</B>(script)</PRE>
549
550
      <UL>readyState handler for scripts - IE only. This will remove the script from
551
 the array of scripts that have still to be loaded.</UL>
552
553
554
   <!-- METHOD PARAMETERS START -->
555
556
   <!-- METHOD PARAMETERS END -->
557
558
559
560
   <!-- ADDITIONAL ATTRIBUTES START -->
561
562
   <!-- ADDITIONAL ATTRIBUTES  END -->
563
<HR>
564
565
   <A NAME="doLoadScript"><!-- --></A>
566
   <H3>doLoadScript</H3>
567
   <PRE>void <B>doLoadScript</B>(script)</PRE>
568
569
      <UL>starts script loading by adding the script node to the dom tree - IE only.
570
 This function adds a readyState handler to the script node.</UL>
571
572
573
   <!-- METHOD PARAMETERS START -->
574
575
   <!-- METHOD PARAMETERS END -->
576
577
578
579
   <!-- ADDITIONAL ATTRIBUTES START -->
580
581
   <!-- ADDITIONAL ATTRIBUTES  END -->
582
<HR>
583
584
   <A NAME="loadNextScript"><!-- --></A>
585
   <H3>loadNextScript</H3>
586
   <PRE>void <B>loadNextScript</B>()</PRE>
587
588
      <UL>loads one script after another - only for IE. This function is run in a
589
 50ms interval and clears its interval if there are no more scripts to
590
 load. It actually loads the first script from the orderedScripts array.</UL>
591
592
593
   <!-- METHOD PARAMETERS START -->
594
595
   <!-- METHOD PARAMETERS END -->
596
597
598
599
   <!-- ADDITIONAL ATTRIBUTES START -->
600
601
   <!-- ADDITIONAL ATTRIBUTES  END -->
602
<HR>
603
604
   <A NAME="loadScript"><!-- --></A>
605
   <H3>loadScript</H3>
606
   <PRE>void <B>loadScript</B>(url)</PRE>
607
608
      <UL>Dynamically load a script file if it has not already been loaded.</UL>
609
610
611
   <!-- METHOD PARAMETERS START -->
612
613
   <UL>
614
   <B>Parameters:</B>
615
616
     <UL><CODE>url</CODE> -  The url of the script.  that loadScript was called
617
      </UL>
618
619
   </UL>
620
621
   <!-- METHOD PARAMETERS END -->
622
623
624
625
   <!-- ADDITIONAL ATTRIBUTES START -->
626
627
   <!-- ADDITIONAL ATTRIBUTES  END -->
628
<HR>
629
630
   <A NAME="loadScriptsFromXpath"><!-- --></A>
631
   <H3>loadScriptsFromXpath</H3>
632
   <PRE>void <B>loadScriptsFromXpath</B>(nodes,dir)</PRE>
633
634
      <UL>Internal function to load scripts for components that don't have <scriptfile>
635
 specified in the config file.</UL>
636
637
638
   <!-- METHOD PARAMETERS START -->
639
640
   <UL>
641
   <B>Parameters:</B>
642
643
     <UL><CODE>dir</CODE> -  The directory the script is located in.
644
      </UL>
645
646
     <UL><CODE>xPath</CODE> -  Xpath match of components from the Config file.
647
      </UL>
648
649
   </UL>
650
651
   <!-- METHOD PARAMETERS END -->
652
653
654
655
   <!-- ADDITIONAL ATTRIBUTES START -->
656
657
   <!-- ADDITIONAL ATTRIBUTES  END -->
658
<HR>
659
660
   <A NAME="setLoadState"><!-- --></A>
661
   <H3>setLoadState</H3>
662
   <PRE>void <B>setLoadState</B>(newState)</PRE>
663
664
      <UL>Move onto loading the next set of scripts.</UL>
665
666
667
   <!-- METHOD PARAMETERS START -->
668
669
   <UL>
670
   <B>Parameters:</B>
671
672
     <UL><CODE>newState</CODE> -  The new loading state.
673
      </UL>
674
675
   </UL>
676
677
   <!-- METHOD PARAMETERS END -->
678
679
680
681
   <!-- ADDITIONAL ATTRIBUTES START -->
682
683
   <!-- ADDITIONAL ATTRIBUTES  END -->
684
<HR>
685
686
   <A NAME="getProperty"><!-- --></A>
687
   <H3>getProperty</H3>
688
   <PRE>&lt;static&gt; Object <B>getProperty</B>(domNode, propertyName, defaultValue)</PRE>
689
690
      <UL>Convenience method that is used to parse dom nodes.</UL>
691
692
693
   <!-- METHOD PARAMETERS START -->
694
695
   <UL>
696
   <B>Parameters:</B>
697
698
     <UL><CODE>domNode</CODE> -  node to find the property in
699
      </UL>
700
701
     <UL><CODE>propertyName</CODE> -  string of the property name (including namespace prefix)
702
      </UL>
703
704
     <UL><CODE>defaultValue</CODE> -  value to return if property is not found (null by default)
705
      </UL>
706
707
   </UL>
708
709
   <!-- METHOD PARAMETERS END -->
710
711
712
   <UL>
713
   <B>Returns:</B>
714
        <UL>
715
        the property value
716
        </UL>
717
   </UL>
718
719
720
   <!-- ADDITIONAL ATTRIBUTES START -->
721
722
   <!-- ADDITIONAL ATTRIBUTES  END -->
723
<HR>
724
725
   <A NAME="parseBoolean"><!-- --></A>
726
   <H3>parseBoolean</H3>
727
   <PRE>&lt;static&gt; Object <B>parseBoolean</B>(value)</PRE>
728
729
      <UL>Convenience method to parse a string or number as a boolean value</UL>
730
731
732
   <!-- METHOD PARAMETERS START -->
733
734
   <UL>
735
   <B>Parameters:</B>
736
737
     <UL><CODE>value</CODE> -  string (true/false) or number (1/0)
738
      </UL>
739
740
   </UL>
741
742
   <!-- METHOD PARAMETERS END -->
743
744
745
   <UL>
746
   <B>Returns:</B>
747
        <UL>
748
        boolean value, default false
749
        </UL>
750
   </UL>
751
752
753
   <!-- ADDITIONAL ATTRIBUTES START -->
754
755
   <!-- ADDITIONAL ATTRIBUTES  END -->
756
<HR>
757
758
759
760
<!-- ============ METHOD DETAIL END ========== -->
761
762
<!-- ========= END OF CLASS DATA ========= -->
763
764
<!-- ========== START OF NAVBAR ========== -->
765
<A NAME="navbar_bottom"><!-- --></A>
766
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
767
<TR>
768
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
769
<A NAME="navbar_bottom_firstrow"><!-- --></A>
770
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
771
  <TR ALIGN="center" VALIGN="top">
772
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
773
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-Mapbuilder.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
774
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
775
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A>&nbsp;</TD>
776
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
777
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
778
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
779
  </TR>
780
</TABLE>
781
</TD>
782
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
783
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
784
</EM>
785
</TD
786
</TR>
787
788
<TR>
789
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
790
&nbsp;<A HREF="Logger.html"><B>PREV CLASS</B></A><!--
791
   NEXT CLASS
792
-->
793
&nbsp;<A HREF="MapPaneOL.html"><B>NEXT CLASS</B></A></FONT></TD>
794
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
795
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
796
&nbsp;<A HREF="Mapbuilder.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
797
&nbsp;
798
<SCRIPT>
799
  <!--
800
  if(window==top) {
801
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
802
  }
803
  //-->
804
</SCRIPT>
805
<NOSCRIPT>
806
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
807
</NOSCRIPT>
808
</FONT></TD>
809
</TR>
810
<TR>
811
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
812
  SUMMARY:&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
813
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
814
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
815
</TR>
816
</TABLE>
817
818
<!-- =========== END OF NAVBAR =========== -->
819
820
<HR>
821
<FONT SIZE="-1">
822
823
</FONT>
824
<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>
825
</BODY>
826
</HTML>