Project

General

Profile

1
<!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
ToolBase
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="ToolBase";
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-ToolBase.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="TipWidgetOL.html"><B>PREV CLASS</B></A><!-- 
45
   NEXT CLASS 
46
-->
47
&nbsp;<A HREF="Transaction.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="ToolBase.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 ToolBase</H2>
76
<PRE>Object
77
   |
78
   +--<b>ToolBase</b>
79
</PRE>
80

    
81
   <DL>
82
   <DT>
83
      <B>Direct Known Subclasses:</B> 
84
      <DD>
85
                <a href="MergeModels.html">MergeModels</a>, <a href="Timer.html">Timer</a>, <a href="ZoomToAoi.html">ZoomToAoi</a>, <a href="Caps2Context.html">Caps2Context</a>, <a href="EditContext.html">EditContext</a>, <a href="WebServiceRequest.html">WebServiceRequest</a>, <a href="MovieLoop.html">MovieLoop</a>, <a href="History.html">History</a>, <a href="FeatureSelectHandler.html">FeatureSelectHandler</a>
86
      </DD>
87
   </DL>
88

    
89

    
90
<HR>
91
<DL>
92
   <!-- Class definition -->
93
   <DT>class 
94
   <B>ToolBase</B>
95
   
96

    
97
</DL>
98
   
99
   <P>
100
   <I>Defined in <a href='overview-summary-ToolBase.js.html'>ToolBase.js</a></I><BR/><BR/><B>Author:</B> Mike Adair mike.adairATccrs.nrcan.gc.ca  <BR/>
101
   </P>
102
   
103
   <HR>
104

    
105
<!-- ======== NESTED CLASS SUMMARY ======== -->
106

    
107
<!-- ======== END NESTED CLASS SUMMARY ======== -->
108

    
109

    
110
<!-- =========== FIELD SUMMARY =========== -->
111

    
112
   <A NAME="field_summary"><!-- --></A>
113
      <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
114
         <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
115
            <TD COLSPAN=2><FONT SIZE="+2">
116
               <B>Field Summary</B></FONT></TD>
117
         </TR>
118

    
119
   <!-- This is one instance field summary -->
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="#enabled">enabled</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="#model">model</A></B></CODE>
133
   <BR>
134
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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="#toolNode">toolNode</A></B></CODE>
141
   <BR>
142
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
143
   </TR>
144
   
145

    
146
   </TABLE>
147
   &nbsp;
148
   
149

    
150
   
151

    
152
<!-- =========== END FIELD SUMMARY =========== -->
153

    
154

    
155
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
156

    
157
<A NAME="constructor_summary"><!-- --></A>
158
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
159
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160
<TD COLSPAN=2><FONT SIZE="+2">
161
<B>Constructor Summary</B></FONT></TD>
162
</TR>
163
<TR BGCOLOR="white" CLASS="TableRowColor">
164
   <TD>
165
      <CODE>
166
	 <B>
167
	    <A HREF="ToolBase.html#ToolBase()">ToolBase</A> 
168
	 </B>
169
	 (toolNode, model)
170
      </CODE>
171
      <BR>
172
      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173
      Base Tool object that all Tools extend.
174
      </TD>
175
</TR>
176
</TABLE>
177

    
178
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
179

    
180
&nbsp;
181

    
182
<!-- ========== METHOD SUMMARY =========== -->
183

    
184
<A NAME="method_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>Method Summary</B></FONT></TD>
189
</TR>
190

    
191

    
192
   <TR BGCOLOR="white" CLASS="TableRowColor">
193
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
194
	 <FONT SIZE="-1">
195
	    <CODE>&nbsp;Object</CODE>
196
	 </FONT>
197
      </TD>
198
      <TD>
199
	 <CODE>
200
	    <B>
201
	       <A HREF="#getProperty">getProperty</A></B>(property, defaultValue)
202
	 </CODE>
203
	 <BR>
204
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
205
	 Convenient access to Mapbuilder.getProperty
206
      </TD>
207
   </TR>
208

    
209
   <TR BGCOLOR="white" CLASS="TableRowColor">
210
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
211
	 <FONT SIZE="-1">
212
	    <CODE>&nbsp;void</CODE>
213
	 </FONT>
214
      </TD>
215
      <TD>
216
	 <CODE>
217
	    <B>
218
	       <A HREF="#initMouseHandler">initMouseHandler</A></B>(toolRef)
219
	 </CODE>
220
	 <BR>
221
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222
	 Initialize the mouseHandler property to point to the object.
223
      </TD>
224
   </TR>
225

    
226
   <TR BGCOLOR="white" CLASS="TableRowColor">
227
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
228
	 <FONT SIZE="-1">
229
	    <CODE>&nbsp;void</CODE>
230
	 </FONT>
231
      </TD>
232
      <TD>
233
	 <CODE>
234
	    <B>
235
	       <A HREF="#initTargetModel">initTargetModel</A></B>(toolRef)
236
	 </CODE>
237
	 <BR>
238
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
239
	 Initialize the targetModel property to point to the object.
240
      </TD>
241
   </TR>
242

    
243

    
244
</TABLE>
245

    
246

    
247

    
248
<P>
249
<!-- ========== END METHOD SUMMARY =========== -->
250

    
251

    
252
<!-- ============ FIELD DETAIL START =========== -->
253

    
254
   <A NAME="field_detail"><!-- --></A>
255
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
256
      <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
257
         <TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
258
      </TR>
259
   </TABLE>
260

    
261
   
262
   <A NAME="enabled"><!-- --></A>
263
   <H3>enabled</H3>
264
   <PRE>Object&nbsp;<B>enabled</B></PRE>
265
   <UL>
266
   
267
   
268
   </UL>
269
   <HR>
270
   
271
   <A NAME="model"><!-- --></A>
272
   <H3>model</H3>
273
   <PRE>Object&nbsp;<B>model</B></PRE>
274
   <UL>
275
   
276
   
277
   </UL>
278
   <HR>
279
   
280
   <A NAME="toolNode"><!-- --></A>
281
   <H3>toolNode</H3>
282
   <PRE>Object&nbsp;<B>toolNode</B></PRE>
283
   <UL>
284
   
285
   
286
   </UL>
287
   <HR>
288
   
289

    
290

    
291
<!-- ============ FIELD DETAIL END =========== -->
292

    
293
    <!-- ========= CONSTRUCTOR DETAIL START ======== -->
294

    
295
<A NAME="constructor_detail"><!-- --></A>
296
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
297
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
298
      <TD COLSPAN=1>
299
      <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
300
      </TD>
301
   </TR>
302
</TABLE>
303

    
304
<A NAME="ToolBase()"><!-- --></A><H3>
305
ToolBase</H3>
306
<PRE><B>ToolBase</B>(toolNode, model)</PRE>
307

    
308

    
309
<UL>
310
   Base Tool object that all Tools extend.
311
</UL>
312

    
313

    
314

    
315
   <UL>
316
   <B>Parameters:</B>
317
   
318
     <UL><CODE>toolNode</CODE> -  The tool node from the Config XML file.  
319
     </UL>
320
   
321
     <UL><CODE>model</CODE> -     The widget object which created this tool.
322
     </UL>
323
   
324
   
325
   </UL>
326

    
327

    
328
<!-- Constructor return value(s) -->
329

    
330
<!-- End constructor return value(s) -->
331

    
332
<!-- ADDITIONAL ATTRIBUTES -->
333

    
334
<UL>   
335
<B>Author:</B> Mike Adair mike.adairATccrs.nrcan.gc.ca  <BR/>
336
</UL>
337

    
338
<HR/>
339
<!-- END ADDITIONAL ATTRIBUTES  -->
340

    
341
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
342

    
343

    
344
<!-- ============ METHOD DETAIL START ========== -->
345

    
346
<A NAME="method_detail"><!-- --></A>
347
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
348
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
349
      <TD COLSPAN=1><FONT SIZE="+2">
350
         <B>Method Detail</B></FONT>
351
      </TD>
352
   </TR>
353
</TABLE>
354

    
355
<!-- One single method detail entry -->
356

    
357
   <A NAME="getProperty"><!-- --></A>
358
   <H3>getProperty</H3>
359
   <PRE>Object <B>getProperty</B>(property, defaultValue)</PRE>
360
   
361
      <UL>Convenient access to Mapbuilder.getProperty</UL>
362
   
363

    
364
   <!-- METHOD PARAMETERS START -->
365
   
366
   <UL>
367
   <B>Parameters:</B>
368
   
369
     <UL><CODE>property</CODE> -  property to get  
370
      </UL> 
371
   
372
     <UL><CODE>default</CODE> -  value to use if property is not set  
373
      </UL> 
374
   
375
   </UL>
376
   
377
   <!-- METHOD PARAMETERS END -->
378

    
379
   
380
   <UL>
381
   <B>Returns:</B>
382
        <UL>
383
        the value for the property 
384
        </UL>
385
   </UL>
386
   
387

    
388
   <!-- ADDITIONAL ATTRIBUTES START -->
389
   
390
   <!-- ADDITIONAL ATTRIBUTES  END -->
391
<HR>
392

    
393
   <A NAME="initMouseHandler"><!-- --></A>
394
   <H3>initMouseHandler</H3>
395
   <PRE>void <B>initMouseHandler</B>(toolRef)</PRE>
396
   
397
      <UL>Initialize the mouseHandler property to point to the object.  This happens
398
 as an init listener to ensure that the referenced model has been created.</UL>
399
   
400

    
401
   <!-- METHOD PARAMETERS START -->
402
   
403
   <UL>
404
   <B>Parameters:</B>
405
   
406
     <UL><CODE>toolRef</CODE> -  Pointer to this object.      
407
      </UL> 
408
   
409
   </UL>
410
   
411
   <!-- METHOD PARAMETERS END -->
412

    
413
   
414

    
415
   <!-- ADDITIONAL ATTRIBUTES START -->
416
   
417
   <!-- ADDITIONAL ATTRIBUTES  END -->
418
<HR>
419

    
420
   <A NAME="initTargetModel"><!-- --></A>
421
   <H3>initTargetModel</H3>
422
   <PRE>void <B>initTargetModel</B>(toolRef)</PRE>
423
   
424
      <UL>Initialize the targetModel property to point to the object.  This happens
425
 as an init listener to ensure that the referenced model has been created.</UL>
426
   
427

    
428
   <!-- METHOD PARAMETERS START -->
429
   
430
   <UL>
431
   <B>Parameters:</B>
432
   
433
     <UL><CODE>toolRef</CODE> -  Pointer to this object.      
434
      </UL> 
435
   
436
   </UL>
437
   
438
   <!-- METHOD PARAMETERS END -->
439

    
440
   
441

    
442
   <!-- ADDITIONAL ATTRIBUTES START -->
443
   
444
   <!-- ADDITIONAL ATTRIBUTES  END -->
445
<HR>
446

    
447

    
448

    
449
<!-- ============ METHOD DETAIL END ========== -->
450

    
451
<!-- ========= END OF CLASS DATA ========= -->
452

    
453
<!-- ========== START OF NAVBAR ========== -->
454
<A NAME="navbar_bottom"><!-- --></A>
455
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
456
<TR>
457
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
458
<A NAME="navbar_bottom_firstrow"><!-- --></A>
459
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
460
  <TR ALIGN="center" VALIGN="top">
461
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
462
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-ToolBase.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
463
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
464
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A>&nbsp;</TD>
465
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
466
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
467
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
468
  </TR>
469
</TABLE>
470
</TD>
471
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
472
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
473
</EM>
474
</TD
475
</TR>
476

    
477
<TR>
478
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
479
&nbsp;<A HREF="TipWidgetOL.html"><B>PREV CLASS</B></A><!-- 
480
   NEXT CLASS 
481
-->
482
&nbsp;<A HREF="Transaction.html"><B>NEXT CLASS</B></A></FONT></TD>
483
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
484
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
485
&nbsp;<A HREF="ToolBase.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
486
&nbsp;
487
<SCRIPT>
488
  <!--
489
  if(window==top) {
490
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
491
  }
492
  //-->
493
</SCRIPT>
494
<NOSCRIPT>
495
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
496
</NOSCRIPT>
497
</FONT></TD>
498
</TR>
499
<TR>
500
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
501
  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>
502
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
503
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>
504
</TR>
505
</TABLE>
506

    
507
<!-- =========== END OF NAVBAR =========== -->
508

    
509
<HR>
510
<FONT SIZE="-1">
511

    
512
</FONT>
513
<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>
514
</BODY>
515
</HTML>
(86-86/316)