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
MapPaneOL
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="MapPaneOL";
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-MapPaneOL.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="Mapbuilder.html"><B>PREV CLASS</B></A><!-- 
45
   NEXT CLASS 
46
-->
47
&nbsp;<A HREF="MapScaleBar.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="MapPaneOL.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 MapPaneOL</H2>
76
<PRE>Object
77
   |
78
   +--<a href='WidgetBase.html'>WidgetBase</a>
79
         |
80
         +--<b>MapPaneOL</b>
81
</PRE>
82

    
83

    
84
<HR>
85
<DL>
86
   <!-- Class definition -->
87
   <DT>class 
88
   <B>MapPaneOL</B>
89
   
90
      <DT>extends <a href='WidgetBase.html'>WidgetBase</a> 
91
   
92

    
93
</DL>
94
   
95
   <P>
96
   <I>Defined in <a href='overview-summary-MapPaneOL.js.html'>MapPaneOL.js</a></I><BR/><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>&nbsp;Object</CODE></FONT></TD>
120
   <TD><CODE><B><A HREF="#containerNodeId">containerNodeId</A></B></CODE>
121
   <BR>
122
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
123
   </TR>
124
   
125
   <TR BGCOLOR="white" CLASS="TableRowColor">
126
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127
   <CODE>&nbsp;Object</CODE></FONT></TD>
128
   <TD><CODE><B><A HREF="#displayOutsideMaxExtent">displayOutsideMaxExtent</A></B></CODE>
129
   <BR>
130
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should layers also be rendered outside the map extent?</TD>
131
   </TR>
132
   
133
   <TR BGCOLOR="white" CLASS="TableRowColor">
134
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
135
   <CODE>&nbsp;Object</CODE></FONT></TD>
136
   <TD><CODE><B><A HREF="#imageBuffer">imageBuffer</A></B></CODE>
137
   <BR>
138
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for untiled wms layers: how many times should the map image be
139
 larger than the visible map.</TD>
140
   </TR>
141
   
142
   <TR BGCOLOR="white" CLASS="TableRowColor">
143
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144
   <CODE>&nbsp;Object</CODE></FONT></TD>
145
   <TD><CODE><B><A HREF="#imageReproject">imageReproject</A></B></CODE>
146
   <BR>
147
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For WMS on top of Google Maps you need to reproject the WMS image.</TD>
148
   </TR>
149
   
150
   <TR BGCOLOR="white" CLASS="TableRowColor">
151
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152
   <CODE>&nbsp;Object</CODE></FONT></TD>
153
   <TD><CODE><B><A HREF="#loadingLayers">loadingLayers</A></B></CODE>
154
   <BR>
155
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of layers that are currently being loaded</TD>
156
   </TR>
157
   
158
   <TR BGCOLOR="white" CLASS="TableRowColor">
159
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160
   <CODE>&nbsp;Object</CODE></FONT></TD>
161
   <TD><CODE><B><A HREF="#singleTile">singleTile</A></B></CODE>
162
   <BR>
163
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For WMS layers: should they be regarded as normal WMS layers, 
164
 with a single tile for the entire boundingbox or as a tiled
165
 WMS layer</TD>
166
   </TR>
167
   
168
   <TR BGCOLOR="white" CLASS="TableRowColor">
169
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170
   <CODE>&nbsp;Object</CODE></FONT></TD>
171
   <TD><CODE><B><A HREF="#tileBuffer">tileBuffer</A></B></CODE>
172
   <BR>
173
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For tiled wms layers: how many rows of tiles should be preloaded
174
 outside the visible map?</TD>
175
   </TR>
176
   
177
   <TR BGCOLOR="white" CLASS="TableRowColor">
178
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179
   <CODE>&nbsp;Object</CODE></FONT></TD>
180
   <TD><CODE><B><A HREF="#tileGutter">tileGutter</A></B></CODE>
181
   <BR>
182
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For tiled wms layers: Overlap of map tiles in pixels.</TD>
183
   </TR>
184
   
185
   <TR BGCOLOR="white" CLASS="TableRowColor">
186
   <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187
   <CODE>&nbsp;Object</CODE></FONT></TD>
188
   <TD><CODE><B><A HREF="#tileSize">tileSize</A></B></CODE>
189
   <BR>
190
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For tiled wms layers: how many pixels should the size of one tile
191
 be?</TD>
192
   </TR>
193
   
194

    
195
   </TABLE>
196
   &nbsp;
197
   
198

    
199
   
200
   
201
   &nbsp;<A NAME=""><!-- --></A>
202
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
203
   <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
204
   <TD><B>Fields inherited from class <A HREF="WidgetBase.html">WidgetBase</A></B></TD>
205
   </TR>
206
   <TR BGCOLOR="white" CLASS="TableRowColor">
207
   <TD><CODE>
208
   <a href="WidgetBase.html#model">model</a>, <a href="WidgetBase.html#widgetNode">widgetNode</a>, <a href="WidgetBase.html#id">id</a>, <a href="WidgetBase.html#outputNodeId">outputNodeId</a>, <a href="WidgetBase.html#htmlTagId">htmlTagId</a>, <a href="WidgetBase.html#autoRefresh">autoRefresh</a>, <a href="WidgetBase.html#debug">debug</a>
209
   </CODE></TD>
210
   </TR>
211
</TABLE>
212
&nbsp;
213

    
214

    
215

    
216
<!-- =========== END FIELD SUMMARY =========== -->
217

    
218

    
219
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
220

    
221
<A NAME="constructor_summary"><!-- --></A>
222
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
223
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
224
<TD COLSPAN=2><FONT SIZE="+2">
225
<B>Constructor Summary</B></FONT></TD>
226
</TR>
227
<TR BGCOLOR="white" CLASS="TableRowColor">
228
   <TD>
229
      <CODE>
230
	 <B>
231
	    <A HREF="MapPaneOL.html#MapPaneOL()">MapPaneOL</A> 
232
	 </B>
233
	 (widgetNode, model)
234
      </CODE>
235
      <BR>
236
      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
237
      Widget to render a map from an OGC context document.
238
      </TD>
239
</TR>
240
</TABLE>
241

    
242
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
243

    
244
&nbsp;
245

    
246
<!-- ========== METHOD SUMMARY =========== -->
247

    
248
<A NAME="method_summary"><!-- --></A>
249
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
250
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251
<TD COLSPAN=2><FONT SIZE="+2">
252
<B>Method Summary</B></FONT></TD>
253
</TR>
254

    
255

    
256
   <TR BGCOLOR="white" CLASS="TableRowColor">
257
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
258
	 <FONT SIZE="-1">
259
	    <CODE>&nbsp;void</CODE>
260
	 </FONT>
261
      </TD>
262
      <TD>
263
	 <CODE>
264
	    <B>
265
	       <A HREF="#addLayer">addLayer</A></B>(objRef, layerNode)
266
	 </CODE>
267
	 <BR>
268
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
269
	 Adds a layer into the output
270
      </TD>
271
   </TR>
272

    
273
   <TR BGCOLOR="white" CLASS="TableRowColor">
274
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
275
	 <FONT SIZE="-1">
276
	    <CODE>&nbsp;void</CODE>
277
	 </FONT>
278
      </TD>
279
      <TD>
280
	 <CODE>
281
	    <B>
282
	       <A HREF="#clear">clear</A></B>(objRef)
283
	 </CODE>
284
	 <BR>
285
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
286
	 remove OpenLayers events and layers
287
      </TD>
288
   </TR>
289

    
290
   <TR BGCOLOR="white" CLASS="TableRowColor">
291
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
292
	 <FONT SIZE="-1">
293
	    <CODE>&nbsp;void</CODE>
294
	 </FONT>
295
      </TD>
296
      <TD>
297
	 <CODE>
298
	    <B>
299
	       <A HREF="#decreaseLoadingLayers">decreaseLoadingLayers</A></B>(e)
300
	 </CODE>
301
	 <BR>
302
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
303
	 Event handler to keep the modelStatus updated when an OpenLayers layer
304
 finished loading.
305
      </TD>
306
   </TR>
307

    
308
   <TR BGCOLOR="white" CLASS="TableRowColor">
309
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
310
	 <FONT SIZE="-1">
311
	    <CODE>&nbsp;void</CODE>
312
	 </FONT>
313
      </TD>
314
      <TD>
315
	 <CODE>
316
	    <B>
317
	       <A HREF="#deleteAllLayers">deleteAllLayers</A></B>(objRef)
318
	 </CODE>
319
	 <BR>
320
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
321
	 Removes all layers from the output
322
      </TD>
323
   </TR>
324

    
325
   <TR BGCOLOR="white" CLASS="TableRowColor">
326
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
327
	 <FONT SIZE="-1">
328
	    <CODE>&nbsp;void</CODE>
329
	 </FONT>
330
      </TD>
331
      <TD>
332
	 <CODE>
333
	    <B>
334
	       <A HREF="#deleteLayer">deleteLayer</A></B>(objRef, layerId)
335
	 </CODE>
336
	 <BR>
337
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
338
	 Removes a layer from the output
339
/**
340
 Removes a layer from the output
341
      </TD>
342
   </TR>
343

    
344
   <TR BGCOLOR="white" CLASS="TableRowColor">
345
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
346
	 <FONT SIZE="-1">
347
	    <CODE>&nbsp;Object</CODE>
348
	 </FONT>
349
      </TD>
350
      <TD>
351
	 <CODE>
352
	    <B>
353
	       <A HREF="#getLayer">getLayer</A></B>(objRef,layerId)
354
	 </CODE>
355
	 <BR>
356
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
357
	 Returns OL layer node from LayerMgr
358
      </TD>
359
   </TR>
360

    
361
   <TR BGCOLOR="white" CLASS="TableRowColor">
362
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
363
	 <FONT SIZE="-1">
364
	    <CODE>&nbsp;Object</CODE>
365
	 </FONT>
366
      </TD>
367
      <TD>
368
	 <CODE>
369
	    <B>
370
	       <A HREF="#getWebSafeStyle">getWebSafeStyle</A></B>(objRef, colorNumber)
371
	 </CODE>
372
	 <BR>
373
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
374
	 gets an OpenLayers vector style with web safe colors.
375
      </TD>
376
   </TR>
377

    
378
   <TR BGCOLOR="white" CLASS="TableRowColor">
379
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
380
	 <FONT SIZE="-1">
381
	    <CODE>&nbsp;void</CODE>
382
	 </FONT>
383
      </TD>
384
      <TD>
385
	 <CODE>
386
	    <B>
387
	       <A HREF="#hidden">hidden</A></B>(objRef, layerId)
388
	 </CODE>
389
	 <BR>
390
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
391
	 Hide/unhide a layer.
392
      </TD>
393
   </TR>
394

    
395
   <TR BGCOLOR="white" CLASS="TableRowColor">
396
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
397
	 <FONT SIZE="-1">
398
	    <CODE>&nbsp;void</CODE>
399
	 </FONT>
400
      </TD>
401
      <TD>
402
	 <CODE>
403
	    <B>
404
	       <A HREF="#increaseLoadingLayers">increaseLoadingLayers</A></B>(e)
405
	 </CODE>
406
	 <BR>
407
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
408
	 Event handler to keep the modelStatus updated when an OpenLayers layer
409
 starts loading.
410
      </TD>
411
   </TR>
412

    
413
   <TR BGCOLOR="white" CLASS="TableRowColor">
414
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
415
	 <FONT SIZE="-1">
416
	    <CODE>&nbsp;void</CODE>
417
	 </FONT>
418
      </TD>
419
      <TD>
420
	 <CODE>
421
	    <B>
422
	       <A HREF="#moveLayerDown">moveLayerDown</A></B>(objRef, layerId)
423
	 </CODE>
424
	 <BR>
425
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
426
	 Moves a layer up in the stack of map layers
427
      </TD>
428
   </TR>
429

    
430
   <TR BGCOLOR="white" CLASS="TableRowColor">
431
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
432
	 <FONT SIZE="-1">
433
	    <CODE>&nbsp;void</CODE>
434
	 </FONT>
435
      </TD>
436
      <TD>
437
	 <CODE>
438
	    <B>
439
	       <A HREF="#moveLayerUp">moveLayerUp</A></B>(objRef, layerId)
440
	 </CODE>
441
	 <BR>
442
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
443
	 Moves a layer up in the stack of map layers
444
      </TD>
445
   </TR>
446

    
447
   <TR BGCOLOR="white" CLASS="TableRowColor">
448
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
449
	 <FONT SIZE="-1">
450
	    <CODE>&nbsp;void</CODE>
451
	 </FONT>
452
      </TD>
453
      <TD>
454
	 <CODE>
455
	    <B>
456
	       <A HREF="#paint">paint</A></B>(objRef, refresh)
457
	 </CODE>
458
	 <BR>
459
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
460
	 Render the widget.
461
      </TD>
462
   </TR>
463

    
464
   <TR BGCOLOR="white" CLASS="TableRowColor">
465
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
466
	 <FONT SIZE="-1">
467
	    <CODE>&nbsp;void</CODE>
468
	 </FONT>
469
      </TD>
470
      <TD>
471
	 <CODE>
472
	    <B>
473
	       <A HREF="#refreshLayer">refreshLayer</A></B>(objRef, layerId , newParams)
474
	 </CODE>
475
	 <BR>
476
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
477
	 Called for refreshing one layer.
478
      </TD>
479
   </TR>
480

    
481
   <TR BGCOLOR="white" CLASS="TableRowColor">
482
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
483
	 <FONT SIZE="-1">
484
	    <CODE>&nbsp;void</CODE>
485
	 </FONT>
486
      </TD>
487
      <TD>
488
	 <CODE>
489
	    <B>
490
	       <A HREF="#refreshWmsLayers">refreshWmsLayers</A></B>(objRef)
491
	 </CODE>
492
	 <BR>
493
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
494
	 Called after a feature has been added to a WFS.
495
      </TD>
496
   </TR>
497

    
498
   <TR BGCOLOR="white" CLASS="TableRowColor">
499
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
500
	 <FONT SIZE="-1">
501
	    <CODE>&nbsp;void</CODE>
502
	 </FONT>
503
      </TD>
504
      <TD>
505
	 <CODE>
506
	    <B>
507
	       <A HREF="#setOpacity">setOpacity</A></B>(objRef, layerId)
508
	 </CODE>
509
	 <BR>
510
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
511
	 Called when the context's opacity attribute changes.
512
      </TD>
513
   </TR>
514

    
515
   <TR BGCOLOR="white" CLASS="TableRowColor">
516
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
517
	 <FONT SIZE="-1">
518
	    <CODE>&nbsp;void</CODE>
519
	 </FONT>
520
      </TD>
521
      <TD>
522
	 <CODE>
523
	    <B>
524
	       <A HREF="#timestampListener">timestampListener</A></B>(objRef, timestampIndex)
525
	 </CODE>
526
	 <BR>
527
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
528
	 Called when the map timestamp is changed so set the layer visiblity.
529
      </TD>
530
   </TR>
531

    
532
   <TR BGCOLOR="white" CLASS="TableRowColor">
533
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
534
	 <FONT SIZE="-1">
535
	    <CODE>&nbsp;void</CODE>
536
	 </FONT>
537
      </TD>
538
      <TD>
539
	 <CODE>
540
	    <B>
541
	       <A HREF="#updateContext">updateContext</A></B>(e)
542
	 </CODE>
543
	 <BR>
544
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
545
	 Event handler to keep the Mapbuilder context updated.
546
      </TD>
547
   </TR>
548

    
549
   <TR BGCOLOR="white" CLASS="TableRowColor">
550
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
551
	 <FONT SIZE="-1">
552
	    <CODE>&nbsp;void</CODE>
553
	 </FONT>
554
      </TD>
555
      <TD>
556
	 <CODE>
557
	    <B>
558
	       <A HREF="#updateMouse">updateMouse</A></B>(e)
559
	 </CODE>
560
	 <BR>
561
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
562
	 Restore the map cursor stored by buttons.
563
      </TD>
564
   </TR>
565

    
566
   <TR BGCOLOR="white" CLASS="TableRowColor">
567
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
568
	 <FONT SIZE="-1">
569
	    <CODE>&nbsp;void</CODE>
570
	 </FONT>
571
      </TD>
572
      <TD>
573
	 <CODE>
574
	    <B>
575
	       <A HREF="#zoomToBbox">zoomToBbox</A></B>(objRef)
576
	 </CODE>
577
	 <BR>
578
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
579
	 Zoom to the current Bounding Box.
580
      </TD>
581
   </TR>
582

    
583

    
584
</TABLE>
585

    
586

    
587

    
588
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
589
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
590
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
591
<TD><B>Methods inherited from class <a href="WidgetBase.html">WidgetBase</a></B></TD>
592
</TR>
593
<TR BGCOLOR="white" CLASS="TableRowColor">
594
<TD><CODE>
595
<!-- Inherited methods -->
596
<a href="WidgetBase.html#getProperty">getProperty</a>, <a href="WidgetBase.html#getNode">getNode</a>, <a href="WidgetBase.html#initTargetModel">initTargetModel</a>, <a href="WidgetBase.html#prePaint">prePaint</a>, <a href="WidgetBase.html#postPaint">postPaint</a>, <a href="WidgetBase.html#clearWidget">clearWidget</a>
597
</CODE></TD>
598
</TR>
599
</TABLE>
600
&nbsp;
601

    
602
<P>
603
<!-- ========== END METHOD SUMMARY =========== -->
604

    
605

    
606
<!-- ============ FIELD DETAIL START =========== -->
607

    
608
   <A NAME="field_detail"><!-- --></A>
609
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
610
      <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
611
         <TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
612
      </TR>
613
   </TABLE>
614

    
615
   
616
   <A NAME="containerNodeId"><!-- --></A>
617
   <H3>containerNodeId</H3>
618
   <PRE>Object&nbsp;<B>containerNodeId</B></PRE>
619
   <UL>
620
   
621
   
622
   </UL>
623
   <HR>
624
   
625
   <A NAME="displayOutsideMaxExtent"><!-- --></A>
626
   <H3>displayOutsideMaxExtent</H3>
627
   <PRE>Object&nbsp;<B>displayOutsideMaxExtent</B></PRE>
628
   <UL>
629
   Should layers also be rendered outside the map extent? Default is false.
630
   
631
   </UL>
632
   <HR>
633
   
634
   <A NAME="imageBuffer"><!-- --></A>
635
   <H3>imageBuffer</H3>
636
   <PRE>Object&nbsp;<B>imageBuffer</B></PRE>
637
   <UL>
638
   for untiled wms layers: how many times should the map image be
639
 larger than the visible map. Large values mean slow loading, small
640
 ones mean many reloads when panning. Recommended values: 1-3,
641
 default is 2.
642
   
643
   </UL>
644
   <HR>
645
   
646
   <A NAME="imageReproject"><!-- --></A>
647
   <H3>imageReproject</H3>
648
   <PRE>Object&nbsp;<B>imageReproject</B></PRE>
649
   <UL>
650
   For WMS on top of Google Maps you need to reproject the WMS image. This will stretch
651
 the WMS images to fit the odd sized google tiles. Default is false
652
   
653
   </UL>
654
   <HR>
655
   
656
   <A NAME="loadingLayers"><!-- --></A>
657
   <H3>loadingLayers</H3>
658
   <PRE>Object&nbsp;<B>loadingLayers</B></PRE>
659
   <UL>
660
   Number of layers that are currently being loaded
661
   
662
   </UL>
663
   <HR>
664
   
665
   <A NAME="singleTile"><!-- --></A>
666
   <H3>singleTile</H3>
667
   <PRE>Object&nbsp;<B>singleTile</B></PRE>
668
   <UL>
669
   For WMS layers: should they be regarded as normal WMS layers, 
670
 with a single tile for the entire boundingbox or as a tiled
671
 WMS layer
672
   
673
   </UL>
674
   <HR>
675
   
676
   <A NAME="tileBuffer"><!-- --></A>
677
   <H3>tileBuffer</H3>
678
   <PRE>Object&nbsp;<B>tileBuffer</B></PRE>
679
   <UL>
680
   For tiled wms layers: how many rows of tiles should be preloaded
681
 outside the visible map? Large values mean slow loading, small
682
 ones mean longer delays when panning. Recommended values: 1-3,
683
 default is 2.
684
   
685
   </UL>
686
   <HR>
687
   
688
   <A NAME="tileGutter"><!-- --></A>
689
   <H3>tileGutter</H3>
690
   <PRE>Object&nbsp;<B>tileGutter</B></PRE>
691
   <UL>
692
   For tiled wms layers: Overlap of map tiles in pixels. Useful for
693
 preventing rendering artefacts at tile edges. Recommended values:
694
 0-15, default is 0 (no gutter at all).
695
   
696
   </UL>
697
   <HR>
698
   
699
   <A NAME="tileSize"><!-- --></A>
700
   <H3>tileSize</H3>
701
   <PRE>Object&nbsp;<B>tileSize</B></PRE>
702
   <UL>
703
   For tiled wms layers: how many pixels should the size of one tile
704
 be? Default is 256.
705
   
706
   </UL>
707
   <HR>
708
   
709

    
710

    
711
<!-- ============ FIELD DETAIL END =========== -->
712

    
713
    <!-- ========= CONSTRUCTOR DETAIL START ======== -->
714

    
715
<A NAME="constructor_detail"><!-- --></A>
716
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
717
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
718
      <TD COLSPAN=1>
719
      <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
720
      </TD>
721
   </TR>
722
</TABLE>
723

    
724
<A NAME="MapPaneOL()"><!-- --></A><H3>
725
MapPaneOL</H3>
726
<PRE><B>MapPaneOL</B>(widgetNode, model)</PRE>
727

    
728

    
729
<UL>
730
   Widget to render a map from an OGC context document.  The layers are
731
 rendered using http://openlayers.org .
732
</UL>
733

    
734

    
735

    
736
   <UL>
737
   <B>Parameters:</B>
738
   
739
     <UL><CODE>widgetNode</CODE> -   The widget's XML object node from the configuration document.  
740
     </UL>
741
   
742
     <UL><CODE>model</CODE> -        The model object that this widget belongs to.
743
     </UL>
744
   
745
   
746
   </UL>
747

    
748

    
749
<!-- Constructor return value(s) -->
750

    
751
<!-- End constructor return value(s) -->
752

    
753
<!-- ADDITIONAL ATTRIBUTES -->
754

    
755
<HR/>
756
<!-- END ADDITIONAL ATTRIBUTES  -->
757

    
758
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
759

    
760

    
761
<!-- ============ METHOD DETAIL START ========== -->
762

    
763
<A NAME="method_detail"><!-- --></A>
764
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
765
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
766
      <TD COLSPAN=1><FONT SIZE="+2">
767
         <B>Method Detail</B></FONT>
768
      </TD>
769
   </TR>
770
</TABLE>
771

    
772
<!-- One single method detail entry -->
773

    
774
   <A NAME="addLayer"><!-- --></A>
775
   <H3>addLayer</H3>
776
   <PRE>void <B>addLayer</B>(objRef, layerNode)</PRE>
777
   
778
      <UL>Adds a layer into the output</UL>
779
   
780

    
781
   <!-- METHOD PARAMETERS START -->
782
   
783
   <UL>
784
   <B>Parameters:</B>
785
   
786
     <UL><CODE>objRef</CODE> -  This object.  
787
      </UL> 
788
   
789
     <UL><CODE>layerNode</CODE> -   The node of the layer    
790
      </UL> 
791
   
792
   </UL>
793
   
794
   <!-- METHOD PARAMETERS END -->
795

    
796
   
797

    
798
   <!-- ADDITIONAL ATTRIBUTES START -->
799
   
800
   <!-- ADDITIONAL ATTRIBUTES  END -->
801
<HR>
802

    
803
   <A NAME="clear"><!-- --></A>
804
   <H3>clear</H3>
805
   <PRE>void <B>clear</B>(objRef)</PRE>
806
   
807
      <UL>remove OpenLayers events and layers</UL>
808
   
809

    
810
   <!-- METHOD PARAMETERS START -->
811
   
812
   <UL>
813
   <B>Parameters:</B>
814
   
815
     <UL><CODE>objRef</CODE> -  reference to this widget    
816
      </UL> 
817
   
818
   </UL>
819
   
820
   <!-- METHOD PARAMETERS END -->
821

    
822
   
823

    
824
   <!-- ADDITIONAL ATTRIBUTES START -->
825
   
826
   <!-- ADDITIONAL ATTRIBUTES  END -->
827
<HR>
828

    
829
   <A NAME="decreaseLoadingLayers"><!-- --></A>
830
   <H3>decreaseLoadingLayers</H3>
831
   <PRE>void <B>decreaseLoadingLayers</B>(e)</PRE>
832
   
833
      <UL>Event handler to keep the modelStatus updated when an OpenLayers layer
834
 finished loading.</UL>
835
   
836

    
837
   <!-- METHOD PARAMETERS START -->
838
   
839
   <UL>
840
   <B>Parameters:</B>
841
   
842
     <UL><CODE>e</CODE> -  OpenLayers event    
843
      </UL> 
844
   
845
   </UL>
846
   
847
   <!-- METHOD PARAMETERS END -->
848

    
849
   
850

    
851
   <!-- ADDITIONAL ATTRIBUTES START -->
852
   
853
   <!-- ADDITIONAL ATTRIBUTES  END -->
854
<HR>
855

    
856
   <A NAME="deleteAllLayers"><!-- --></A>
857
   <H3>deleteAllLayers</H3>
858
   <PRE>void <B>deleteAllLayers</B>(objRef)</PRE>
859
   
860
      <UL>Removes all layers from the output</UL>
861
   
862

    
863
   <!-- METHOD PARAMETERS START -->
864
   
865
   <UL>
866
   <B>Parameters:</B>
867
   
868
     <UL><CODE>objRef</CODE> -  Pointer to this object.  
869
      </UL> 
870
   
871
     <UL><CODE>objRef</CODE> -  Pointer to this object.    
872
      </UL> 
873
   
874
   </UL>
875
   
876
   <!-- METHOD PARAMETERS END -->
877

    
878
   
879

    
880
   <!-- ADDITIONAL ATTRIBUTES START -->
881
   
882
   <!-- ADDITIONAL ATTRIBUTES  END -->
883
<HR>
884

    
885
   <A NAME="deleteLayer"><!-- --></A>
886
   <H3>deleteLayer</H3>
887
   <PRE>void <B>deleteLayer</B>(objRef, layerId)</PRE>
888
   
889
      <UL>Removes a layer from the output
890
/**
891
 Removes a layer from the output</UL>
892
   
893

    
894
   <!-- METHOD PARAMETERS START -->
895
   
896
   <UL>
897
   <B>Parameters:</B>
898
   
899
     <UL><CODE>objRef</CODE> -  Pointer to this object.  
900
      </UL> 
901
   
902
     <UL><CODE>layerId</CODE> -  the WMS name for the layer to be removed    
903
      </UL> 
904
   
905
   </UL>
906
   
907
   <!-- METHOD PARAMETERS END -->
908

    
909
   
910

    
911
   <!-- ADDITIONAL ATTRIBUTES START -->
912
   
913
   <!-- ADDITIONAL ATTRIBUTES  END -->
914
<HR>
915

    
916
   <A NAME="getLayer"><!-- --></A>
917
   <H3>getLayer</H3>
918
   <PRE>Object <B>getLayer</B>(objRef,layerId)</PRE>
919
   
920
      <UL>Returns OL layer node from LayerMgr</UL>
921
   
922

    
923
   <!-- METHOD PARAMETERS START -->
924
   
925
   <UL>
926
   <B>Parameters:</B>
927
   
928
     <UL><CODE>layerId</CODE> -  The layer Id (or layerName)
929
      </UL> 
930
   
931
   </UL>
932
   
933
   <!-- METHOD PARAMETERS END -->
934

    
935
   
936

    
937
   <!-- ADDITIONAL ATTRIBUTES START -->
938
   
939
   <!-- ADDITIONAL ATTRIBUTES  END -->
940
<HR>
941

    
942
   <A NAME="getWebSafeStyle"><!-- --></A>
943
   <H3>getWebSafeStyle</H3>
944
   <PRE>Object <B>getWebSafeStyle</B>(objRef, colorNumber)</PRE>
945
   
946
      <UL>gets an OpenLayers vector style with web safe colors.</UL>
947
   
948

    
949
   <!-- METHOD PARAMETERS START -->
950
   
951
   <UL>
952
   <B>Parameters:</B>
953
   
954
     <UL><CODE>objRef</CODE> -  reference to this object  
955
      </UL> 
956
   
957
     <UL><CODE>colorNumber</CODE> -  number of a color from which to generate websafe color  
958
      </UL> 
959
   
960
   </UL>
961
   
962
   <!-- METHOD PARAMETERS END -->
963

    
964
   
965
   <UL>
966
   <B>Returns:</B>
967
        <UL>
968
        {OpenLayers.Style} style for OpenLayers vector rendering 
969
        </UL>
970
   </UL>
971
   
972

    
973
   <!-- ADDITIONAL ATTRIBUTES START -->
974
   
975
   <!-- ADDITIONAL ATTRIBUTES  END -->
976
<HR>
977

    
978
   <A NAME="hidden"><!-- --></A>
979
   <H3>hidden</H3>
980
   <PRE>void <B>hidden</B>(objRef, layerId)</PRE>
981
   
982
      <UL>Hide/unhide a layer. Called by Context when the hidden attribute changes.</UL>
983
   
984

    
985
   <!-- METHOD PARAMETERS START -->
986
   
987
   <UL>
988
   <B>Parameters:</B>
989
   
990
     <UL><CODE>objRef</CODE> -  Pointer to widget object.  
991
      </UL> 
992
   
993
     <UL><CODE>layerId</CODE> -  Id of the layer to hide/unhide.    
994
      </UL> 
995
   
996
   </UL>
997
   
998
   <!-- METHOD PARAMETERS END -->
999

    
1000
   
1001

    
1002
   <!-- ADDITIONAL ATTRIBUTES START -->
1003
   
1004
   <!-- ADDITIONAL ATTRIBUTES  END -->
1005
<HR>
1006

    
1007
   <A NAME="increaseLoadingLayers"><!-- --></A>
1008
   <H3>increaseLoadingLayers</H3>
1009
   <PRE>void <B>increaseLoadingLayers</B>(e)</PRE>
1010
   
1011
      <UL>Event handler to keep the modelStatus updated when an OpenLayers layer
1012
 starts loading.</UL>
1013
   
1014

    
1015
   <!-- METHOD PARAMETERS START -->
1016
   
1017
   <UL>
1018
   <B>Parameters:</B>
1019
   
1020
     <UL><CODE>e</CODE> -  OpenLayers event    
1021
      </UL> 
1022
   
1023
   </UL>
1024
   
1025
   <!-- METHOD PARAMETERS END -->
1026

    
1027
   
1028

    
1029
   <!-- ADDITIONAL ATTRIBUTES START -->
1030
   
1031
   <!-- ADDITIONAL ATTRIBUTES  END -->
1032
<HR>
1033

    
1034
   <A NAME="moveLayerDown"><!-- --></A>
1035
   <H3>moveLayerDown</H3>
1036
   <PRE>void <B>moveLayerDown</B>(objRef, layerId)</PRE>
1037
   
1038
      <UL>Moves a layer up in the stack of map layers</UL>
1039
   
1040

    
1041
   <!-- METHOD PARAMETERS START -->
1042
   
1043
   <UL>
1044
   <B>Parameters:</B>
1045
   
1046
     <UL><CODE>objRef</CODE> -  Pointer to this object.  
1047
      </UL> 
1048
   
1049
     <UL><CODE>layerId</CODE> -  the WMS name for the layer to be removed    
1050
      </UL> 
1051
   
1052
   </UL>
1053
   
1054
   <!-- METHOD PARAMETERS END -->
1055

    
1056
   
1057

    
1058
   <!-- ADDITIONAL ATTRIBUTES START -->
1059
   
1060
   <!-- ADDITIONAL ATTRIBUTES  END -->
1061
<HR>
1062

    
1063
   <A NAME="moveLayerUp"><!-- --></A>
1064
   <H3>moveLayerUp</H3>
1065
   <PRE>void <B>moveLayerUp</B>(objRef, layerId)</PRE>
1066
   
1067
      <UL>Moves a layer up in the stack of map layers</UL>
1068
   
1069

    
1070
   <!-- METHOD PARAMETERS START -->
1071
   
1072
   <UL>
1073
   <B>Parameters:</B>
1074
   
1075
     <UL><CODE>objRef</CODE> -  Pointer to this object.  
1076
      </UL> 
1077
   
1078
     <UL><CODE>layerId</CODE> -  the WMS name for the layer to be removed    
1079
      </UL> 
1080
   
1081
   </UL>
1082
   
1083
   <!-- METHOD PARAMETERS END -->
1084

    
1085
   
1086

    
1087
   <!-- ADDITIONAL ATTRIBUTES START -->
1088
   
1089
   <!-- ADDITIONAL ATTRIBUTES  END -->
1090
<HR>
1091

    
1092
   <A NAME="paint"><!-- --></A>
1093
   <H3>paint</H3>
1094
   <PRE>void <B>paint</B>(objRef, refresh)</PRE>
1095
   
1096
      <UL>Render the widget.</UL>
1097
   
1098

    
1099
   <!-- METHOD PARAMETERS START -->
1100
   
1101
   <UL>
1102
   <B>Parameters:</B>
1103
   
1104
     <UL><CODE>objRef</CODE> -  Pointer to widget object.    
1105
      </UL> 
1106
   
1107
   </UL>
1108
   
1109
   <!-- METHOD PARAMETERS END -->
1110

    
1111
   
1112

    
1113
   <!-- ADDITIONAL ATTRIBUTES START -->
1114
   
1115
   <!-- ADDITIONAL ATTRIBUTES  END -->
1116
<HR>
1117

    
1118
   <A NAME="refreshLayer"><!-- --></A>
1119
   <H3>refreshLayer</H3>
1120
   <PRE>void <B>refreshLayer</B>(objRef, layerId , newParams)</PRE>
1121
   
1122
      <UL>Called for refreshing one layer.</UL>
1123
   
1124

    
1125
   <!-- METHOD PARAMETERS START -->
1126
   
1127
   <UL>
1128
   <B>Parameters:</B>
1129
   
1130
     <UL><CODE>objRef</CODE> -  This object.  
1131
      </UL> 
1132
   
1133
     <UL><CODE>layerId</CODE> -   The id of the layer that was toggled.      
1134
      </UL> 
1135
   
1136
   </UL>
1137
   
1138
   <!-- METHOD PARAMETERS END -->
1139

    
1140
   
1141

    
1142
   <!-- ADDITIONAL ATTRIBUTES START -->
1143
   
1144
   <!-- ADDITIONAL ATTRIBUTES  END -->
1145
<HR>
1146

    
1147
   <A NAME="refreshWmsLayers"><!-- --></A>
1148
   <H3>refreshWmsLayers</H3>
1149
   <PRE>void <B>refreshWmsLayers</B>(objRef)</PRE>
1150
   
1151
      <UL>Called after a feature has been added to a WFS.  This function triggers
1152
 the WMS basemaps to be redrawn.  A timestamp param is added to the URL
1153
 to ensure the basemap image is not cached.
1154
 This function is triggered by the refreshWmsLayers event. If this event
1155
 is fired with a <layerId> as param, only that layer will be refreshed.</UL>
1156
   
1157

    
1158
   <!-- METHOD PARAMETERS START -->
1159
   
1160
   <UL>
1161
   <B>Parameters:</B>
1162
   
1163
     <UL><CODE>objRef</CODE> -  reference to this widget      
1164
      </UL> 
1165
   
1166
   </UL>
1167
   
1168
   <!-- METHOD PARAMETERS END -->
1169

    
1170
   
1171

    
1172
   <!-- ADDITIONAL ATTRIBUTES START -->
1173
   
1174
   <!-- ADDITIONAL ATTRIBUTES  END -->
1175
<HR>
1176

    
1177
   <A NAME="setOpacity"><!-- --></A>
1178
   <H3>setOpacity</H3>
1179
   <PRE>void <B>setOpacity</B>(objRef, layerId)</PRE>
1180
   
1181
      <UL>Called when the context's opacity attribute changes.
1182
/**
1183
 Called when the context's opacity attribute changes.</UL>
1184
   
1185

    
1186
   <!-- METHOD PARAMETERS START -->
1187
   
1188
   <UL>
1189
   <B>Parameters:</B>
1190
   
1191
     <UL><CODE>objRef</CODE> -  This object.  
1192
      </UL> 
1193
   
1194
     <UL><CODE>layerId</CODE> -   The id of the layer that was toggled.      
1195
      </UL> 
1196
   
1197
   </UL>
1198
   
1199
   <!-- METHOD PARAMETERS END -->
1200

    
1201
   
1202

    
1203
   <!-- ADDITIONAL ATTRIBUTES START -->
1204
   
1205
   <!-- ADDITIONAL ATTRIBUTES  END -->
1206
<HR>
1207

    
1208
   <A NAME="timestampListener"><!-- --></A>
1209
   <H3>timestampListener</H3>
1210
   <PRE>void <B>timestampListener</B>(objRef, timestampIndex)</PRE>
1211
   
1212
      <UL>Called when the map timestamp is changed so set the layer visiblity.</UL>
1213
   
1214

    
1215
   <!-- METHOD PARAMETERS START -->
1216
   
1217
   <UL>
1218
   <B>Parameters:</B>
1219
   
1220
     <UL><CODE>objRef</CODE> -  This object.  
1221
      </UL> 
1222
   
1223
     <UL><CODE>timestampIndex</CODE> -   The array index for the layer to be displayed.       
1224
      </UL> 
1225
   
1226
   </UL>
1227
   
1228
   <!-- METHOD PARAMETERS END -->
1229

    
1230
   
1231

    
1232
   <!-- ADDITIONAL ATTRIBUTES START -->
1233
   
1234
   <!-- ADDITIONAL ATTRIBUTES  END -->
1235
<HR>
1236

    
1237
   <A NAME="updateContext"><!-- --></A>
1238
   <H3>updateContext</H3>
1239
   <PRE>void <B>updateContext</B>(e)</PRE>
1240
   
1241
      <UL>Event handler to keep the Mapbuilder context updated. It also
1242
 sets the map cursor to the previously stored value.
1243
 This is called by OpenLayers.</UL>
1244
   
1245

    
1246
   <!-- METHOD PARAMETERS START -->
1247
   
1248
   <UL>
1249
   <B>Parameters:</B>
1250
   
1251
     <UL><CODE>e</CODE> -  OpenLayers event    
1252
      </UL> 
1253
   
1254
   </UL>
1255
   
1256
   <!-- METHOD PARAMETERS END -->
1257

    
1258
   
1259

    
1260
   <!-- ADDITIONAL ATTRIBUTES START -->
1261
   
1262
   <!-- ADDITIONAL ATTRIBUTES  END -->
1263
<HR>
1264

    
1265
   <A NAME="updateMouse"><!-- --></A>
1266
   <H3>updateMouse</H3>
1267
   <PRE>void <B>updateMouse</B>(e)</PRE>
1268
   
1269
      <UL>Restore the map cursor stored by buttons. This has to be done
1270
 in an OpenLayers mouseup event, because the mouseup event
1271
 in OpenLayers resets the cursor to default.</UL>
1272
   
1273

    
1274
   <!-- METHOD PARAMETERS START -->
1275
   
1276
   <UL>
1277
   <B>Parameters:</B>
1278
   
1279
     <UL><CODE>e</CODE> -  OpenLayers event    
1280
      </UL> 
1281
   
1282
   </UL>
1283
   
1284
   <!-- METHOD PARAMETERS END -->
1285

    
1286
   
1287

    
1288
   <!-- ADDITIONAL ATTRIBUTES START -->
1289
   
1290
   <!-- ADDITIONAL ATTRIBUTES  END -->
1291
<HR>
1292

    
1293
   <A NAME="zoomToBbox"><!-- --></A>
1294
   <H3>zoomToBbox</H3>
1295
   <PRE>void <B>zoomToBbox</B>(objRef)</PRE>
1296
   
1297
      <UL>Zoom to the current Bounding Box.</UL>
1298
   
1299

    
1300
   <!-- METHOD PARAMETERS START -->
1301
   
1302
   <UL>
1303
   <B>Parameters:</B>
1304
   
1305
     <UL><CODE>objRef</CODE> -  reference to this widget    
1306
      </UL> 
1307
   
1308
   </UL>
1309
   
1310
   <!-- METHOD PARAMETERS END -->
1311

    
1312
   
1313

    
1314
   <!-- ADDITIONAL ATTRIBUTES START -->
1315
   
1316
   <!-- ADDITIONAL ATTRIBUTES  END -->
1317
<HR>
1318

    
1319

    
1320

    
1321
<!-- ============ METHOD DETAIL END ========== -->
1322

    
1323
<!-- ========= END OF CLASS DATA ========= -->
1324

    
1325
<!-- ========== START OF NAVBAR ========== -->
1326
<A NAME="navbar_bottom"><!-- --></A>
1327
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
1328
<TR>
1329
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1330
<A NAME="navbar_bottom_firstrow"><!-- --></A>
1331
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
1332
  <TR ALIGN="center" VALIGN="top">
1333
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1334
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-MapPaneOL.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
1335
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1336
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A>&nbsp;</TD>
1337
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
1338
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1339
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1340
  </TR>
1341
</TABLE>
1342
</TD>
1343
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1344
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
1345
</EM>
1346
</TD
1347
</TR>
1348

    
1349
<TR>
1350
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1351
&nbsp;<A HREF="Mapbuilder.html"><B>PREV CLASS</B></A><!-- 
1352
   NEXT CLASS 
1353
-->
1354
&nbsp;<A HREF="MapScaleBar.html"><B>NEXT CLASS</B></A></FONT></TD>
1355
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1356
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
1357
&nbsp;<A HREF="MapPaneOL.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
1358
&nbsp;
1359
<SCRIPT>
1360
  <!--
1361
  if(window==top) {
1362
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
1363
  }
1364
  //-->
1365
</SCRIPT>
1366
<NOSCRIPT>
1367
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
1368
</NOSCRIPT>
1369
</FONT></TD>
1370
</TR>
1371
<TR>
1372
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1373
  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>
1374
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1375
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>
1376
</TR>
1377
</TABLE>
1378

    
1379
<!-- =========== END OF NAVBAR =========== -->
1380

    
1381
<HR>
1382
<FONT SIZE="-1">
1383

    
1384
</FONT>
1385
<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>
1386
</BODY>
1387
</HTML>
(49-49/316)