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
|
FeatureSelectHandler
|
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="FeatureSelectHandler";
|
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> </TD>
|
27
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-FeatureSelectHandler.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
28
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
29
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
30
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
31
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
32
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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
|
<A HREF="FeatureList.html"><B>PREV CLASS</B></A><!--
|
45
|
NEXT CLASS
|
46
|
-->
|
47
|
<A HREF="FilterAttributes.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>
|
50
|
<A HREF="FeatureSelectHandler.html" TARGET="_top"><B>NO FRAMES</B></A>
|
51
|
|
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: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
67
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
68
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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 FeatureSelectHandler</H2>
|
76
|
<PRE>Object
|
77
|
|
|
78
|
+--<a href='ToolBase.html'>ToolBase</a>
|
79
|
|
|
80
|
+--<b>FeatureSelectHandler</b>
|
81
|
</PRE>
|
82
|
|
83
|
|
84
|
<HR>
|
85
|
<DL>
|
86
|
<!-- Class definition -->
|
87
|
<DT>class
|
88
|
<B>FeatureSelectHandler</B>
|
89
|
|
90
|
<DT>extends <a href='ToolBase.html'>ToolBase</a>
|
91
|
|
92
|
|
93
|
</DL>
|
94
|
|
95
|
<P>
|
96
|
<I>Defined in <a href='overview-summary-FeatureSelectHandler.js.html'>FeatureSelectHandler.js</a></I><BR/><BR/><B>Author:</B> Andreas Hocevar andreas.hocevarATgmail.com <BR/>
|
97
|
</P>
|
98
|
|
99
|
<HR>
|
100
|
|
101
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
102
|
|
103
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
104
|
|
105
|
|
106
|
<!-- =========== FIELD SUMMARY =========== -->
|
107
|
|
108
|
<A NAME="field_summary"><!-- --></A>
|
109
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
110
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
111
|
<TD COLSPAN=2><FONT SIZE="+2">
|
112
|
<B>Field Summary</B></FONT></TD>
|
113
|
</TR>
|
114
|
|
115
|
<!-- This is one instance field summary -->
|
116
|
|
117
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
118
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
119
|
<CODE> Object</CODE></FONT></TD>
|
120
|
<TD><CODE><B><A HREF="#map">map</A></B></CODE>
|
121
|
<BR>
|
122
|
Map for this FeatureSelectHandler.</TD>
|
123
|
</TR>
|
124
|
|
125
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
126
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
127
|
<CODE> Object</CODE></FONT></TD>
|
128
|
<TD><CODE><B><A HREF="#mbFeatureSelectHandler">mbFeatureSelectHandler</A></B></CODE>
|
129
|
<BR>
|
130
|
</TD>
|
131
|
</TR>
|
132
|
|
133
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
134
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
135
|
<CODE> Object</CODE></FONT></TD>
|
136
|
<TD><CODE><B><A HREF="#selectStyle">selectStyle</A></B></CODE>
|
137
|
<BR>
|
138
|
</TD>
|
139
|
</TR>
|
140
|
|
141
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
142
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
143
|
<CODE> Object</CODE></FONT></TD>
|
144
|
<TD><CODE><B><A HREF="#sourceModels">sourceModels</A></B></CODE>
|
145
|
<BR>
|
146
|
</TD>
|
147
|
</TR>
|
148
|
|
149
|
|
150
|
</TABLE>
|
151
|
|
152
|
|
153
|
|
154
|
|
155
|
|
156
|
<A NAME=""><!-- --></A>
|
157
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
158
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
159
|
<TD><B>Fields inherited from class <A HREF="ToolBase.html">ToolBase</A></B></TD>
|
160
|
</TR>
|
161
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
162
|
<TD><CODE>
|
163
|
<a href="ToolBase.html#model">model</a>, <a href="ToolBase.html#toolNode">toolNode</a>, <a href="ToolBase.html#enabled">enabled</a>
|
164
|
</CODE></TD>
|
165
|
</TR>
|
166
|
</TABLE>
|
167
|
|
168
|
|
169
|
|
170
|
|
171
|
<!-- =========== END FIELD SUMMARY =========== -->
|
172
|
|
173
|
|
174
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
175
|
|
176
|
<A NAME="constructor_summary"><!-- --></A>
|
177
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
178
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
179
|
<TD COLSPAN=2><FONT SIZE="+2">
|
180
|
<B>Constructor Summary</B></FONT></TD>
|
181
|
</TR>
|
182
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
183
|
<TD>
|
184
|
<CODE>
|
185
|
<B>
|
186
|
<A HREF="FeatureSelectHandler.html#FeatureSelectHandler()">FeatureSelectHandler</A>
|
187
|
</B>
|
188
|
(toolNode, model)
|
189
|
</CODE>
|
190
|
<BR>
|
191
|
|
192
|
Manages mouseover and clicks on vector features in the map.
|
193
|
</TD>
|
194
|
</TR>
|
195
|
</TABLE>
|
196
|
|
197
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
198
|
|
199
|
|
200
|
|
201
|
<!-- ========== METHOD SUMMARY =========== -->
|
202
|
|
203
|
<A NAME="method_summary"><!-- --></A>
|
204
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
205
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
206
|
<TD COLSPAN=2><FONT SIZE="+2">
|
207
|
<B>Method Summary</B></FONT></TD>
|
208
|
</TR>
|
209
|
|
210
|
|
211
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
212
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
213
|
<FONT SIZE="-1">
|
214
|
<CODE> void</CODE>
|
215
|
</FONT>
|
216
|
</TD>
|
217
|
<TD>
|
218
|
<CODE>
|
219
|
<B>
|
220
|
<A HREF="#clear">clear</A></B>(objRef)
|
221
|
</CODE>
|
222
|
<BR>
|
223
|
|
224
|
|
225
|
</TD>
|
226
|
</TR>
|
227
|
|
228
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
229
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
230
|
<FONT SIZE="-1">
|
231
|
<CODE> void</CODE>
|
232
|
</FONT>
|
233
|
</TD>
|
234
|
<TD>
|
235
|
<CODE>
|
236
|
<B>
|
237
|
<A HREF="#configInit">configInit</A></B>(objRef)
|
238
|
</CODE>
|
239
|
<BR>
|
240
|
|
241
|
Tool Initialisation - Step 1 of 3.
|
242
|
</TD>
|
243
|
</TR>
|
244
|
|
245
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
246
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
247
|
<FONT SIZE="-1">
|
248
|
<CODE> void</CODE>
|
249
|
</FONT>
|
250
|
</TD>
|
251
|
<TD>
|
252
|
<CODE>
|
253
|
<B>
|
254
|
<A HREF="#contextInit">contextInit</A></B>(objRef)
|
255
|
</CODE>
|
256
|
<BR>
|
257
|
|
258
|
Tool Initialisation - Step 2 of 3.
|
259
|
</TD>
|
260
|
</TR>
|
261
|
|
262
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
263
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
264
|
<FONT SIZE="-1">
|
265
|
<CODE> void</CODE>
|
266
|
</FONT>
|
267
|
</TD>
|
268
|
<TD>
|
269
|
<CODE>
|
270
|
<B>
|
271
|
<A HREF="#dehighlight">dehighlight</A></B>(objRef, fid)
|
272
|
</CODE>
|
273
|
<BR>
|
274
|
|
275
|
Dehighlights the specified feature.
|
276
|
</TD>
|
277
|
</TR>
|
278
|
|
279
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
280
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
281
|
<FONT SIZE="-1">
|
282
|
<CODE> void</CODE>
|
283
|
</FONT>
|
284
|
</TD>
|
285
|
<TD>
|
286
|
<CODE>
|
287
|
<B>
|
288
|
<A HREF="#highlight">highlight</A></B>(objRef, fid)
|
289
|
</CODE>
|
290
|
<BR>
|
291
|
|
292
|
Highlights the specified feature.
|
293
|
</TD>
|
294
|
</TR>
|
295
|
|
296
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
297
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
298
|
<FONT SIZE="-1">
|
299
|
<CODE> Object</CODE>
|
300
|
</FONT>
|
301
|
</TD>
|
302
|
<TD>
|
303
|
<CODE>
|
304
|
<B>
|
305
|
<A HREF="#init">init</A></B>(objRef)
|
306
|
</CODE>
|
307
|
<BR>
|
308
|
|
309
|
Tool Initialisation - Step 3 of 3.
|
310
|
</TD>
|
311
|
</TR>
|
312
|
|
313
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
314
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
315
|
<FONT SIZE="-1">
|
316
|
<CODE> void</CODE>
|
317
|
</FONT>
|
318
|
</TD>
|
319
|
<TD>
|
320
|
<CODE>
|
321
|
<B>
|
322
|
<A HREF="#onClick">onClick</A></B>(evt)
|
323
|
</CODE>
|
324
|
<BR>
|
325
|
|
326
|
This method is triggered when a user clicks on a feature.
|
327
|
</TD>
|
328
|
</TR>
|
329
|
|
330
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
331
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
332
|
<FONT SIZE="-1">
|
333
|
<CODE> void</CODE>
|
334
|
</FONT>
|
335
|
</TD>
|
336
|
<TD>
|
337
|
<CODE>
|
338
|
<B>
|
339
|
<A HREF="#onHover">onHover</A></B>(evt)
|
340
|
</CODE>
|
341
|
<BR>
|
342
|
|
343
|
This method is triggered when the mouse is over a feature.
|
344
|
</TD>
|
345
|
</TR>
|
346
|
|
347
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
348
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
349
|
<FONT SIZE="-1">
|
350
|
<CODE> void</CODE>
|
351
|
</FONT>
|
352
|
</TD>
|
353
|
<TD>
|
354
|
<CODE>
|
355
|
<B>
|
356
|
<A HREF="#onSelect">onSelect</A></B>(feature)
|
357
|
</CODE>
|
358
|
<BR>
|
359
|
|
360
|
This method is triggered when the mouse is over a vector
|
361
|
feature.
|
362
|
</TD>
|
363
|
</TR>
|
364
|
|
365
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
366
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
367
|
<FONT SIZE="-1">
|
368
|
<CODE> void</CODE>
|
369
|
</FONT>
|
370
|
</TD>
|
371
|
<TD>
|
372
|
<CODE>
|
373
|
<B>
|
374
|
<A HREF="#onUnselect">onUnselect</A></B>(feature)
|
375
|
</CODE>
|
376
|
<BR>
|
377
|
|
378
|
This method is triggered when the mouse is moving out
|
379
|
of a vector feature.
|
380
|
</TD>
|
381
|
</TR>
|
382
|
|
383
|
|
384
|
</TABLE>
|
385
|
|
386
|
|
387
|
|
388
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
389
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
390
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
391
|
<TD><B>Methods inherited from class <a href="ToolBase.html">ToolBase</a></B></TD>
|
392
|
</TR>
|
393
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
394
|
<TD><CODE>
|
395
|
<!-- Inherited methods -->
|
396
|
<a href="ToolBase.html#initTargetModel">initTargetModel</a>, <a href="ToolBase.html#initMouseHandler">initMouseHandler</a>, <a href="ToolBase.html#getProperty">getProperty</a>
|
397
|
</CODE></TD>
|
398
|
</TR>
|
399
|
</TABLE>
|
400
|
|
401
|
|
402
|
<P>
|
403
|
<!-- ========== END METHOD SUMMARY =========== -->
|
404
|
|
405
|
|
406
|
<!-- ============ FIELD DETAIL START =========== -->
|
407
|
|
408
|
<A NAME="field_detail"><!-- --></A>
|
409
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
410
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
411
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
412
|
</TR>
|
413
|
</TABLE>
|
414
|
|
415
|
|
416
|
<A NAME="map"><!-- --></A>
|
417
|
<H3>map</H3>
|
418
|
<PRE>Object <B>map</B></PRE>
|
419
|
<UL>
|
420
|
Map for this FeatureSelectHandler. We keep a reference
|
421
|
to the map we created the control for, to prevent ourselves
|
422
|
from removing the control from a map that does not exist
|
423
|
anymore.
|
424
|
|
425
|
</UL>
|
426
|
<HR>
|
427
|
|
428
|
<A NAME="mbFeatureSelectHandler"><!-- --></A>
|
429
|
<H3>mbFeatureSelectHandler</H3>
|
430
|
<PRE>Object <B>mbFeatureSelectHandler</B></PRE>
|
431
|
<UL>
|
432
|
|
433
|
|
434
|
</UL>
|
435
|
<HR>
|
436
|
|
437
|
<A NAME="selectStyle"><!-- --></A>
|
438
|
<H3>selectStyle</H3>
|
439
|
<PRE>Object <B>selectStyle</B></PRE>
|
440
|
<UL>
|
441
|
|
442
|
|
443
|
</UL>
|
444
|
<HR>
|
445
|
|
446
|
<A NAME="sourceModels"><!-- --></A>
|
447
|
<H3>sourceModels</H3>
|
448
|
<PRE>Object <B>sourceModels</B></PRE>
|
449
|
<UL>
|
450
|
|
451
|
|
452
|
</UL>
|
453
|
<HR>
|
454
|
|
455
|
|
456
|
|
457
|
<!-- ============ FIELD DETAIL END =========== -->
|
458
|
|
459
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
460
|
|
461
|
<A NAME="constructor_detail"><!-- --></A>
|
462
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
463
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
464
|
<TD COLSPAN=1>
|
465
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
466
|
</TD>
|
467
|
</TR>
|
468
|
</TABLE>
|
469
|
|
470
|
<A NAME="FeatureSelectHandler()"><!-- --></A><H3>
|
471
|
FeatureSelectHandler</H3>
|
472
|
<PRE><B>FeatureSelectHandler</B>(toolNode, model)</PRE>
|
473
|
|
474
|
|
475
|
<UL>
|
476
|
Manages mouseover and clicks on vector features in the map.
|
477
|
This tool works with models that are linked to a OL vector layer,
|
478
|
using eg. the GmlRendererOL widget. Models have to fire the
|
479
|
'gmlRendererLayer' event, which will activate the tool for the
|
480
|
layer.
|
481
|
This tool also fires "mouseoverFeature" and "mouseoutFeature"
|
482
|
events, setting the fid of the feature below the mouse cursor
|
483
|
as param of the model.
|
484
|
</UL>
|
485
|
|
486
|
|
487
|
|
488
|
<UL>
|
489
|
<B>Parameters:</B>
|
490
|
|
491
|
<UL><CODE>toolNode</CODE> - The tool node from the config XML file.
|
492
|
</UL>
|
493
|
|
494
|
<UL><CODE>model</CODE> - The model containing this tool.
|
495
|
</UL>
|
496
|
|
497
|
|
498
|
</UL>
|
499
|
|
500
|
|
501
|
<!-- Constructor return value(s) -->
|
502
|
|
503
|
<!-- End constructor return value(s) -->
|
504
|
|
505
|
<!-- ADDITIONAL ATTRIBUTES -->
|
506
|
|
507
|
<UL>
|
508
|
<B>Author:</B> Andreas Hocevar andreas.hocevarATgmail.com <BR/>
|
509
|
</UL>
|
510
|
|
511
|
<HR/>
|
512
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
513
|
|
514
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
515
|
|
516
|
|
517
|
<!-- ============ METHOD DETAIL START ========== -->
|
518
|
|
519
|
<A NAME="method_detail"><!-- --></A>
|
520
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
521
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
522
|
<TD COLSPAN=1><FONT SIZE="+2">
|
523
|
<B>Method Detail</B></FONT>
|
524
|
</TD>
|
525
|
</TR>
|
526
|
</TABLE>
|
527
|
|
528
|
<!-- One single method detail entry -->
|
529
|
|
530
|
<A NAME="clear"><!-- --></A>
|
531
|
<H3>clear</H3>
|
532
|
<PRE>void <B>clear</B>(objRef)</PRE>
|
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="configInit"><!-- --></A>
|
547
|
<H3>configInit</H3>
|
548
|
<PRE>void <B>configInit</B>(objRef)</PRE>
|
549
|
|
550
|
<UL>Tool Initialisation - Step 1 of 3.
|
551
|
This is called when the config finished loading, so we know
|
552
|
our context (targetModel).</UL>
|
553
|
|
554
|
|
555
|
<!-- METHOD PARAMETERS START -->
|
556
|
|
557
|
<UL>
|
558
|
<B>Parameters:</B>
|
559
|
|
560
|
<UL><CODE>objRef</CODE> - This object
|
561
|
</UL>
|
562
|
|
563
|
</UL>
|
564
|
|
565
|
<!-- METHOD PARAMETERS END -->
|
566
|
|
567
|
|
568
|
|
569
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
570
|
|
571
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
572
|
<HR>
|
573
|
|
574
|
<A NAME="contextInit"><!-- --></A>
|
575
|
<H3>contextInit</H3>
|
576
|
<PRE>void <B>contextInit</B>(objRef)</PRE>
|
577
|
|
578
|
<UL>Tool Initialisation - Step 2 of 3.
|
579
|
This is called when the context model finished loading, so we
|
580
|
know that we have a map available.</UL>
|
581
|
|
582
|
|
583
|
<!-- METHOD PARAMETERS START -->
|
584
|
|
585
|
<UL>
|
586
|
<B>Parameters:</B>
|
587
|
|
588
|
<UL><CODE>objRef</CODE> - This object
|
589
|
</UL>
|
590
|
|
591
|
</UL>
|
592
|
|
593
|
<!-- METHOD PARAMETERS END -->
|
594
|
|
595
|
|
596
|
|
597
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
598
|
|
599
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
600
|
<HR>
|
601
|
|
602
|
<A NAME="dehighlight"><!-- --></A>
|
603
|
<H3>dehighlight</H3>
|
604
|
<PRE>void <B>dehighlight</B>(objRef, fid)</PRE>
|
605
|
|
606
|
<UL>Dehighlights the specified feature. This method is usually
|
607
|
triggered by setting the 'dehighlightFeature' param to the
|
608
|
fid of a feature to be highlighted.</UL>
|
609
|
|
610
|
|
611
|
<!-- METHOD PARAMETERS START -->
|
612
|
|
613
|
<UL>
|
614
|
<B>Parameters:</B>
|
615
|
|
616
|
<UL><CODE>objRef</CODE> - reference to this tool object
|
617
|
</UL>
|
618
|
|
619
|
<UL><CODE>fid</CODE> - GML feature id of the feature to highlight. If not specified, this is taken from the dehighlightFeature model param.
|
620
|
</UL>
|
621
|
|
622
|
</UL>
|
623
|
|
624
|
<!-- METHOD PARAMETERS END -->
|
625
|
|
626
|
|
627
|
|
628
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
629
|
|
630
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
631
|
<HR>
|
632
|
|
633
|
<A NAME="highlight"><!-- --></A>
|
634
|
<H3>highlight</H3>
|
635
|
<PRE>void <B>highlight</B>(objRef, fid)</PRE>
|
636
|
|
637
|
<UL>Highlights the specified feature. This method is usually
|
638
|
triggered by setting the 'highlightFeature' param to the
|
639
|
fid of a feature to be highlighted.</UL>
|
640
|
|
641
|
|
642
|
<!-- METHOD PARAMETERS START -->
|
643
|
|
644
|
<UL>
|
645
|
<B>Parameters:</B>
|
646
|
|
647
|
<UL><CODE>objRef</CODE> - reference to this tool object
|
648
|
</UL>
|
649
|
|
650
|
<UL><CODE>fid</CODE> - GML feature id of the feature to highlight. If not specified, this is taken from the highlightFeature model param.
|
651
|
</UL>
|
652
|
|
653
|
</UL>
|
654
|
|
655
|
<!-- METHOD PARAMETERS END -->
|
656
|
|
657
|
|
658
|
|
659
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
660
|
|
661
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
662
|
<HR>
|
663
|
|
664
|
<A NAME="init"><!-- --></A>
|
665
|
<H3>init</H3>
|
666
|
<PRE>Object <B>init</B>(objRef)</PRE>
|
667
|
|
668
|
<UL>Tool Initialisation - Step 3 of 3.
|
669
|
Turns on feature select when the gmlRendererLayer event is fired.</UL>
|
670
|
|
671
|
|
672
|
<!-- METHOD PARAMETERS START -->
|
673
|
|
674
|
<UL>
|
675
|
<B>Parameters:</B>
|
676
|
|
677
|
<UL><CODE>objRef</CODE> - reference to this object.
|
678
|
</UL>
|
679
|
|
680
|
</UL>
|
681
|
|
682
|
<!-- METHOD PARAMETERS END -->
|
683
|
|
684
|
|
685
|
<UL>
|
686
|
<B>Returns:</B>
|
687
|
<UL>
|
688
|
{OpenLayers.Control} class of the OL control.
|
689
|
</UL>
|
690
|
</UL>
|
691
|
|
692
|
|
693
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
694
|
|
695
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
696
|
<HR>
|
697
|
|
698
|
<A NAME="onClick"><!-- --></A>
|
699
|
<H3>onClick</H3>
|
700
|
<PRE>void <B>onClick</B>(evt)</PRE>
|
701
|
|
702
|
<UL>This method is triggered when a user clicks on a feature.
|
703
|
It is called by OpenLayers event handling in the context
|
704
|
of a feature. This means that 'this' in this method refers
|
705
|
to an {OpenLayers.Feature}. Widgets listening to the
|
706
|
olFeatureSelect have access to the event, because setParam
|
707
|
is used to set the reference to the event.</UL>
|
708
|
|
709
|
|
710
|
<!-- METHOD PARAMETERS START -->
|
711
|
|
712
|
<UL>
|
713
|
<B>Parameters:</B>
|
714
|
|
715
|
<UL><CODE>evt</CODE> - OpenLayers event
|
716
|
</UL>
|
717
|
|
718
|
</UL>
|
719
|
|
720
|
<!-- METHOD PARAMETERS END -->
|
721
|
|
722
|
|
723
|
|
724
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
725
|
|
726
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
727
|
<HR>
|
728
|
|
729
|
<A NAME="onHover"><!-- --></A>
|
730
|
<H3>onHover</H3>
|
731
|
<PRE>void <B>onHover</B>(evt)</PRE>
|
732
|
|
733
|
<UL>This method is triggered when the mouse is over a feature.
|
734
|
It is called by OpenLayers event handling in the context
|
735
|
of a feature. This means that 'this' in this method refers
|
736
|
to an {OpenLayers.Feature}. Widgets listening to the
|
737
|
olFeatureHover have access to the event, because setParam
|
738
|
is used to set the reference to the event.</UL>
|
739
|
|
740
|
|
741
|
<!-- METHOD PARAMETERS START -->
|
742
|
|
743
|
<UL>
|
744
|
<B>Parameters:</B>
|
745
|
|
746
|
<UL><CODE>evt</CODE> - OpenLayers event
|
747
|
</UL>
|
748
|
|
749
|
</UL>
|
750
|
|
751
|
<!-- METHOD PARAMETERS END -->
|
752
|
|
753
|
|
754
|
|
755
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
756
|
|
757
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
758
|
<HR>
|
759
|
|
760
|
<A NAME="onSelect"><!-- --></A>
|
761
|
<H3>onSelect</H3>
|
762
|
<PRE>void <B>onSelect</B>(feature)</PRE>
|
763
|
|
764
|
<UL>This method is triggered when the mouse is over a vector
|
765
|
feature. It registers priority events mousedown and
|
766
|
mousemove, which will call this widget's onClick/onHover
|
767
|
method in the context of a feature. This way we address
|
768
|
two problems with the OpenLayers SelectFeature control:<pre>
|
769
|
- for the info popup, we need the screen coordinates
|
770
|
which we do not get from the handler directly.
|
771
|
- when the active tool changes, something in the
|
772
|
priority of OL event handlers changes, so the
|
773
|
click event on the feature gets lost. By registering
|
774
|
our priority handler and calling Event.stop() in
|
775
|
the target method, we make sure that our event is
|
776
|
handled and no other event handlers are triggered.
|
777
|
</pre></UL>
|
778
|
|
779
|
|
780
|
<!-- METHOD PARAMETERS START -->
|
781
|
|
782
|
<UL>
|
783
|
<B>Parameters:</B>
|
784
|
|
785
|
<UL><CODE>feature</CODE> - OpenLayers feature
|
786
|
</UL>
|
787
|
|
788
|
</UL>
|
789
|
|
790
|
<!-- METHOD PARAMETERS END -->
|
791
|
|
792
|
|
793
|
|
794
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
795
|
|
796
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
797
|
<HR>
|
798
|
|
799
|
<A NAME="onUnselect"><!-- --></A>
|
800
|
<H3>onUnselect</H3>
|
801
|
<PRE>void <B>onUnselect</B>(feature)</PRE>
|
802
|
|
803
|
<UL>This method is triggered when the mouse is moving out
|
804
|
of a vector feature. It removes the event handler we
|
805
|
registered in this widget's onSelect method.</UL>
|
806
|
|
807
|
|
808
|
<!-- METHOD PARAMETERS START -->
|
809
|
|
810
|
<UL>
|
811
|
<B>Parameters:</B>
|
812
|
|
813
|
<UL><CODE>feature</CODE> - OpenLayers feature
|
814
|
</UL>
|
815
|
|
816
|
</UL>
|
817
|
|
818
|
<!-- METHOD PARAMETERS END -->
|
819
|
|
820
|
|
821
|
|
822
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
823
|
|
824
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
825
|
<HR>
|
826
|
|
827
|
|
828
|
|
829
|
<!-- ============ METHOD DETAIL END ========== -->
|
830
|
|
831
|
<!-- ========= END OF CLASS DATA ========= -->
|
832
|
|
833
|
<!-- ========== START OF NAVBAR ========== -->
|
834
|
<A NAME="navbar_bottom"><!-- --></A>
|
835
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
836
|
<TR>
|
837
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
838
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
839
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
840
|
<TR ALIGN="center" VALIGN="top">
|
841
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
842
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-FeatureSelectHandler.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
843
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
844
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
845
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
846
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
847
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
848
|
</TR>
|
849
|
</TABLE>
|
850
|
</TD>
|
851
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
852
|
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
|
853
|
</EM>
|
854
|
</TD
|
855
|
</TR>
|
856
|
|
857
|
<TR>
|
858
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
859
|
<A HREF="FeatureList.html"><B>PREV CLASS</B></A><!--
|
860
|
NEXT CLASS
|
861
|
-->
|
862
|
<A HREF="FilterAttributes.html"><B>NEXT CLASS</B></A></FONT></TD>
|
863
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
864
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
865
|
<A HREF="FeatureSelectHandler.html" TARGET="_top"><B>NO FRAMES</B></A>
|
866
|
|
867
|
<SCRIPT>
|
868
|
<!--
|
869
|
if(window==top) {
|
870
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
871
|
}
|
872
|
//-->
|
873
|
</SCRIPT>
|
874
|
<NOSCRIPT>
|
875
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
876
|
</NOSCRIPT>
|
877
|
</FONT></TD>
|
878
|
</TR>
|
879
|
<TR>
|
880
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
881
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
882
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
883
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
884
|
</TR>
|
885
|
</TABLE>
|
886
|
|
887
|
<!-- =========== END OF NAVBAR =========== -->
|
888
|
|
889
|
<HR>
|
890
|
<FONT SIZE="-1">
|
891
|
|
892
|
</FONT>
|
893
|
<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>
|
894
|
</BODY>
|
895
|
</HTML>
|