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
OverviewMap
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="OverviewMap";
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-OverviewMap.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="OpenLSResponse.html"><B>PREV CLASS</B></A><!--
45
   NEXT CLASS
46
-->
47
&nbsp;<A HREF="OwsCatResources.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="OverviewMap.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 OverviewMap</H2>
76
<PRE>Object
77
   |
78
   +--<a href='WidgetBase.html'>WidgetBase</a>
79
         |
80
         +--<b>OverviewMap</b>
81
</PRE>
82
83
84
<HR>
85
<DL>
86
   <!-- Class definition -->
87
   <DT>class
88
   <B>OverviewMap</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-OverviewMap.js.html'>OverviewMap.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="#layerNames">layerNames</A></B></CODE>
121
   <BR>
122
   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
123
   </TR>
124
125
126
   </TABLE>
127
   &nbsp;
128
129
130
131
132
   &nbsp;<A NAME=""><!-- --></A>
133
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
134
   <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
135
   <TD><B>Fields inherited from class <A HREF="WidgetBase.html">WidgetBase</A></B></TD>
136
   </TR>
137
   <TR BGCOLOR="white" CLASS="TableRowColor">
138
   <TD><CODE>
139
   <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>
140
   </CODE></TD>
141
   </TR>
142
</TABLE>
143
&nbsp;
144
145
146
147
<!-- =========== END FIELD SUMMARY =========== -->
148
149
150
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
151
152
<A NAME="constructor_summary"><!-- --></A>
153
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
154
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155
<TD COLSPAN=2><FONT SIZE="+2">
156
<B>Constructor Summary</B></FONT></TD>
157
</TR>
158
<TR BGCOLOR="white" CLASS="TableRowColor">
159
   <TD>
160
      <CODE>
161
	 <B>
162
	    <A HREF="OverviewMap.html#OverviewMap()">OverviewMap</A>
163
	 </B>
164
	 (widgetNode, model)
165
      </CODE>
166
      <BR>
167
      &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168
      Widget to add an OL OverviewMap to a main map.
169
      </TD>
170
</TR>
171
</TABLE>
172
173
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
174
175
&nbsp;
176
177
<!-- ========== METHOD SUMMARY =========== -->
178
179
<A NAME="method_summary"><!-- --></A>
180
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
181
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
182
<TD COLSPAN=2><FONT SIZE="+2">
183
<B>Method Summary</B></FONT></TD>
184
</TR>
185
186
187
   <TR BGCOLOR="white" CLASS="TableRowColor">
188
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
189
	 <FONT SIZE="-1">
190
	    <CODE>&nbsp;void</CODE>
191
	 </FONT>
192
      </TD>
193
      <TD>
194
	 <CODE>
195
	    <B>
196
	       <A HREF="#addOverviewMap">addOverviewMap</A></B>(objRef)
197
	 </CODE>
198
	 <BR>
199
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200
	 Add an overview map to the map in this widget's model.
201
      </TD>
202
   </TR>
203
204
   <TR BGCOLOR="white" CLASS="TableRowColor">
205
      <TD ALIGN="right" VALIGN="top" WIDTH="1%">
206
	 <FONT SIZE="-1">
207
	    <CODE>&nbsp;Object</CODE>
208
	 </FONT>
209
      </TD>
210
      <TD>
211
	 <CODE>
212
	    <B>
213
	       <A HREF="#getClonedLayer">getClonedLayer</A></B>(layer, isBaseLayer)
214
	 </CODE>
215
	 <BR>
216
	 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
217
	 Clone a map layer (OpenLayers.Layer subclass).
218
      </TD>
219
   </TR>
220
221
222
</TABLE>
223
224
225
226
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
227
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
228
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
229
<TD><B>Methods inherited from class <a href="WidgetBase.html">WidgetBase</a></B></TD>
230
</TR>
231
<TR BGCOLOR="white" CLASS="TableRowColor">
232
<TD><CODE>
233
<!-- Inherited methods -->
234
<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>
235
</CODE></TD>
236
</TR>
237
</TABLE>
238
&nbsp;
239
240
<P>
241
<!-- ========== END METHOD SUMMARY =========== -->
242
243
244
<!-- ============ FIELD DETAIL START =========== -->
245
246
   <A NAME="field_detail"><!-- --></A>
247
   <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
248
      <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
249
         <TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
250
      </TR>
251
   </TABLE>
252
253
254
   <A NAME="layerNames"><!-- --></A>
255
   <H3>layerNames</H3>
256
   <PRE>Object&nbsp;<B>layerNames</B></PRE>
257
   <UL>
258
259
260
   </UL>
261
   <HR>
262
263
264
265
<!-- ============ FIELD DETAIL END =========== -->
266
267
    <!-- ========= CONSTRUCTOR DETAIL START ======== -->
268
269
<A NAME="constructor_detail"><!-- --></A>
270
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
271
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
272
      <TD COLSPAN=1>
273
      <FONT SIZE="+2"><B>Constructor Detail</B></FONT>
274
      </TD>
275
   </TR>
276
</TABLE>
277
278
<A NAME="OverviewMap()"><!-- --></A><H3>
279
OverviewMap</H3>
280
<PRE><B>OverviewMap</B>(widgetNode, model)</PRE>
281
282
283
<UL>
284
   Widget to add an OL OverviewMap to a main map.
285
</UL>
286
287
288
289
   <UL>
290
   <B>Parameters:</B>
291
292
     <UL><CODE>widgetNode</CODE> -   The widget's XML object node from the configuration document.
293
     </UL>
294
295
     <UL><CODE>model</CODE> -        The model object that this widget belongs to.
296
     </UL>
297
298
299
   </UL>
300
301
302
<!-- Constructor return value(s) -->
303
304
<!-- End constructor return value(s) -->
305
306
<!-- ADDITIONAL ATTRIBUTES -->
307
308
<HR/>
309
<!-- END ADDITIONAL ATTRIBUTES  -->
310
311
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
312
313
314
<!-- ============ METHOD DETAIL START ========== -->
315
316
<A NAME="method_detail"><!-- --></A>
317
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
318
   <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
319
      <TD COLSPAN=1><FONT SIZE="+2">
320
         <B>Method Detail</B></FONT>
321
      </TD>
322
   </TR>
323
</TABLE>
324
325
<!-- One single method detail entry -->
326
327
   <A NAME="addOverviewMap"><!-- --></A>
328
   <H3>addOverviewMap</H3>
329
   <PRE>void <B>addOverviewMap</B>(objRef)</PRE>
330
331
      <UL>Add an overview map to the map in this widget's model.
332
 If layers have been specified in the config, clone these layers for the
333
 overview map, otherwise just use the base layer from the main map.
334
 If any of the layers to use are WMS layers it uses an untiled version of them.</UL>
335
336
337
   <!-- METHOD PARAMETERS START -->
338
339
   <UL>
340
   <B>Parameters:</B>
341
342
     <UL><CODE>objRef</CODE> -  Pointer to widget object.
343
      </UL>
344
345
   </UL>
346
347
   <!-- METHOD PARAMETERS END -->
348
349
350
351
   <!-- ADDITIONAL ATTRIBUTES START -->
352
353
   <!-- ADDITIONAL ATTRIBUTES  END -->
354
<HR>
355
356
   <A NAME="getClonedLayer"><!-- --></A>
357
   <H3>getClonedLayer</H3>
358
   <PRE>Object <B>getClonedLayer</B>(layer, isBaseLayer)</PRE>
359
360
      <UL>Clone a map layer (OpenLayers.Layer subclass).
361
 If the layer is a WMS layer it returns an untiled version of it.</UL>
362
363
364
   <!-- METHOD PARAMETERS START -->
365
366
   <UL>
367
   <B>Parameters:</B>
368
369
     <UL><CODE>layer</CODE> -  Pointer to layer object.
370
      </UL>
371
372
     <UL><CODE>isBaseLayer</CODE> -  {Boolean} optional parameter: should the layer become  baselayer on the overview map?
373
      </UL>
374
375
   </UL>
376
377
   <!-- METHOD PARAMETERS END -->
378
379
380
381
   <!-- ADDITIONAL ATTRIBUTES START -->
382
383
   <!-- ADDITIONAL ATTRIBUTES  END -->
384
<HR>
385
386
387
388
<!-- ============ METHOD DETAIL END ========== -->
389
390
<!-- ========= END OF CLASS DATA ========= -->
391
392
<!-- ========== START OF NAVBAR ========== -->
393
<A NAME="navbar_bottom"><!-- --></A>
394
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
395
<TR>
396
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
397
<A NAME="navbar_bottom_firstrow"><!-- --></A>
398
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
399
  <TR ALIGN="center" VALIGN="top">
400
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
401
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">  <A HREF="overview-summary-OverviewMap.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A>&nbsp;</TD>
402
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
403
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A>&nbsp;</TD>
404
  <!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"-->    <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!--&nbsp;</TD-->
405
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
406
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
407
  </TR>
408
</TABLE>
409
</TD>
410
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
411
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
412
</EM>
413
</TD
414
</TR>
415
416
<TR>
417
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
418
&nbsp;<A HREF="OpenLSResponse.html"><B>PREV CLASS</B></A><!--
419
   NEXT CLASS
420
-->
421
&nbsp;<A HREF="OwsCatResources.html"><B>NEXT CLASS</B></A></FONT></TD>
422
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
423
  <A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>  &nbsp;
424
&nbsp;<A HREF="OverviewMap.html" TARGET="_top"><B>NO FRAMES</B></A>  &nbsp;
425
&nbsp;
426
<SCRIPT>
427
  <!--
428
  if(window==top) {
429
    document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
430
  }
431
  //-->
432
</SCRIPT>
433
<NOSCRIPT>
434
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
435
</NOSCRIPT>
436
</FONT></TD>
437
</TR>
438
<TR>
439
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
440
  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>
441
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
442
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>
443
</TR>
444
</TABLE>
445
446
<!-- =========== END OF NAVBAR =========== -->
447
448
<HR>
449
<FONT SIZE="-1">
450
451
</FONT>
452
<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>
453
</BODY>
454
</HTML>