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
|
LegendGraphic
|
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="LegendGraphic";
|
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-LegendGraphic.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="Legend.html"><B>PREV CLASS</B></A><!--
|
45
|
NEXT CLASS
|
46
|
-->
|
47
|
<A HREF="Listener.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="LegendGraphic.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 LegendGraphic</H2>
|
76
|
<PRE>Object
|
77
|
|
|
78
|
+--<a href='WidgetBase.html'>WidgetBase</a>
|
79
|
|
|
80
|
+--<a href='WidgetBaseXSL.html'>WidgetBaseXSL</a>
|
81
|
|
|
82
|
+--<b>LegendGraphic</b>
|
83
|
</PRE>
|
84
|
|
85
|
|
86
|
<HR>
|
87
|
<DL>
|
88
|
<!-- Class definition -->
|
89
|
<DT>class
|
90
|
<B>LegendGraphic</B>
|
91
|
|
92
|
<DT>extends <a href='WidgetBaseXSL.html'>WidgetBaseXSL</a>
|
93
|
|
94
|
|
95
|
</DL>
|
96
|
|
97
|
<P>
|
98
|
<B>Author:</B> Cameron Shorter cameronATshorter.net <BR/><B>Deprecated</B> <I></I><BR/><BR/><I>Defined in <a href='overview-summary-LegendGraphic.js.html'>LegendGraphic.js</a></I><BR/><BR/>
|
99
|
</P>
|
100
|
|
101
|
<HR>
|
102
|
|
103
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
104
|
|
105
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
106
|
|
107
|
|
108
|
<!-- =========== FIELD SUMMARY =========== -->
|
109
|
|
110
|
|
111
|
|
112
|
|
113
|
<A NAME=""><!-- --></A>
|
114
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
115
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
116
|
<TD><B>Fields inherited from class <A HREF="WidgetBaseXSL.html">WidgetBaseXSL</A></B></TD>
|
117
|
</TR>
|
118
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
119
|
<TD><CODE>
|
120
|
<a href="WidgetBaseXSL.html#stylesheet">stylesheet</a>, <a href="WidgetBaseXSL.html#parseHTMLNodes">parseHTMLNodes</a>
|
121
|
</CODE></TD>
|
122
|
</TR>
|
123
|
</TABLE>
|
124
|
|
125
|
|
126
|
|
127
|
|
128
|
<A NAME=""><!-- --></A>
|
129
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
130
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
131
|
<TD><B>Fields inherited from class <A HREF="WidgetBase.html">WidgetBase</A></B></TD>
|
132
|
</TR>
|
133
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
134
|
<TD><CODE>
|
135
|
<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>
|
136
|
</CODE></TD>
|
137
|
</TR>
|
138
|
</TABLE>
|
139
|
|
140
|
|
141
|
|
142
|
|
143
|
<!-- =========== END FIELD SUMMARY =========== -->
|
144
|
|
145
|
|
146
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
147
|
|
148
|
<A NAME="constructor_summary"><!-- --></A>
|
149
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
150
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
151
|
<TD COLSPAN=2><FONT SIZE="+2">
|
152
|
<B>Constructor Summary</B></FONT></TD>
|
153
|
</TR>
|
154
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
155
|
<TD>
|
156
|
<CODE>
|
157
|
<B>
|
158
|
<A HREF="LegendGraphic.html#LegendGraphic()">LegendGraphic</A>
|
159
|
</B>
|
160
|
(widgetNode, model)
|
161
|
</CODE>
|
162
|
<BR>
|
163
|
|
164
|
Functions to render and update a Legend from a Web Map Context.
|
165
|
</TD>
|
166
|
</TR>
|
167
|
</TABLE>
|
168
|
|
169
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
170
|
|
171
|
|
172
|
|
173
|
<!-- ========== METHOD SUMMARY =========== -->
|
174
|
|
175
|
<A NAME="method_summary"><!-- --></A>
|
176
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
177
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
178
|
<TD COLSPAN=2><FONT SIZE="+2">
|
179
|
<B>Method Summary</B></FONT></TD>
|
180
|
</TR>
|
181
|
|
182
|
|
183
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
184
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
185
|
<FONT SIZE="-1">
|
186
|
<CODE> void</CODE>
|
187
|
</FONT>
|
188
|
</TD>
|
189
|
<TD>
|
190
|
<CODE>
|
191
|
<B>
|
192
|
<A HREF="#refresh">refresh</A></B>(objRef, layerName)
|
193
|
</CODE>
|
194
|
<BR>
|
195
|
|
196
|
Listener method to paint this widget
|
197
|
</TD>
|
198
|
</TR>
|
199
|
|
200
|
|
201
|
</TABLE>
|
202
|
|
203
|
|
204
|
|
205
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
206
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
207
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
208
|
<TD><B>Methods inherited from class <a href="WidgetBaseXSL.html">WidgetBaseXSL</a></B></TD>
|
209
|
</TR>
|
210
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
211
|
<TD><CODE>
|
212
|
<!-- Inherited methods -->
|
213
|
<a href="WidgetBaseXSL.html#paint">paint</a>
|
214
|
</CODE></TD>
|
215
|
</TR>
|
216
|
</TABLE>
|
217
|
|
218
|
|
219
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
220
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
221
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
222
|
<TD><B>Methods inherited from class <a href="WidgetBase.html">WidgetBase</a></B></TD>
|
223
|
</TR>
|
224
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
225
|
<TD><CODE>
|
226
|
<!-- Inherited methods -->
|
227
|
<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>
|
228
|
</CODE></TD>
|
229
|
</TR>
|
230
|
</TABLE>
|
231
|
|
232
|
|
233
|
<P>
|
234
|
<!-- ========== END METHOD SUMMARY =========== -->
|
235
|
|
236
|
|
237
|
<!-- ============ FIELD DETAIL START =========== -->
|
238
|
|
239
|
|
240
|
<!-- ============ FIELD DETAIL END =========== -->
|
241
|
|
242
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
243
|
|
244
|
<A NAME="constructor_detail"><!-- --></A>
|
245
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
246
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
247
|
<TD COLSPAN=1>
|
248
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
249
|
</TD>
|
250
|
</TR>
|
251
|
</TABLE>
|
252
|
|
253
|
<A NAME="LegendGraphic()"><!-- --></A><H3>
|
254
|
LegendGraphic</H3>
|
255
|
<PRE><B>LegendGraphic</B>(widgetNode, model)</PRE>
|
256
|
|
257
|
|
258
|
<UL>
|
259
|
Functions to render and update a Legend from a Web Map Context.
|
260
|
|
261
|
WARNING: In most cases you probably want either Legend.js or LayerControl.js they
|
262
|
both display the legend graphic per layer.
|
263
|
</UL>
|
264
|
|
265
|
|
266
|
|
267
|
<UL>
|
268
|
<B>Parameters:</B>
|
269
|
|
270
|
<UL><CODE>widgetNode</CODE> - The widget's XML object node from the configuration document.
|
271
|
</UL>
|
272
|
|
273
|
<UL><CODE>model</CODE> - The model object that this widget belongs to.
|
274
|
</UL>
|
275
|
|
276
|
|
277
|
</UL>
|
278
|
|
279
|
|
280
|
<!-- Constructor return value(s) -->
|
281
|
|
282
|
<!-- End constructor return value(s) -->
|
283
|
|
284
|
<!-- ADDITIONAL ATTRIBUTES -->
|
285
|
|
286
|
<UL>
|
287
|
<B>Author:</B> Cameron Shorter cameronATshorter.net <BR/><B>Deprecated</B> <I></I><BR/><BR/>
|
288
|
</UL>
|
289
|
|
290
|
<HR/>
|
291
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
292
|
|
293
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
294
|
|
295
|
|
296
|
<!-- ============ METHOD DETAIL START ========== -->
|
297
|
|
298
|
<A NAME="method_detail"><!-- --></A>
|
299
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
300
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
301
|
<TD COLSPAN=1><FONT SIZE="+2">
|
302
|
<B>Method Detail</B></FONT>
|
303
|
</TD>
|
304
|
</TR>
|
305
|
</TABLE>
|
306
|
|
307
|
<!-- One single method detail entry -->
|
308
|
|
309
|
<A NAME="refresh"><!-- --></A>
|
310
|
<H3>refresh</H3>
|
311
|
<PRE>void <B>refresh</B>(objRef, layerName)</PRE>
|
312
|
|
313
|
<UL>Listener method to paint this widget</UL>
|
314
|
|
315
|
|
316
|
<!-- METHOD PARAMETERS START -->
|
317
|
|
318
|
<UL>
|
319
|
<B>Parameters:</B>
|
320
|
|
321
|
<UL><CODE>layerName</CODE> - the name of the layer to highlight
|
322
|
</UL>
|
323
|
|
324
|
</UL>
|
325
|
|
326
|
<!-- METHOD PARAMETERS END -->
|
327
|
|
328
|
|
329
|
|
330
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
331
|
|
332
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
333
|
<HR>
|
334
|
|
335
|
|
336
|
|
337
|
<!-- ============ METHOD DETAIL END ========== -->
|
338
|
|
339
|
<!-- ========= END OF CLASS DATA ========= -->
|
340
|
|
341
|
<!-- ========== START OF NAVBAR ========== -->
|
342
|
<A NAME="navbar_bottom"><!-- --></A>
|
343
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
344
|
<TR>
|
345
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
346
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
347
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
348
|
<TR ALIGN="center" VALIGN="top">
|
349
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
350
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-LegendGraphic.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
351
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
352
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
353
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
354
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
355
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
356
|
</TR>
|
357
|
</TABLE>
|
358
|
</TD>
|
359
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
360
|
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
|
361
|
</EM>
|
362
|
</TD
|
363
|
</TR>
|
364
|
|
365
|
<TR>
|
366
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
367
|
<A HREF="Legend.html"><B>PREV CLASS</B></A><!--
|
368
|
NEXT CLASS
|
369
|
-->
|
370
|
<A HREF="Listener.html"><B>NEXT CLASS</B></A></FONT></TD>
|
371
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
372
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
373
|
<A HREF="LegendGraphic.html" TARGET="_top"><B>NO FRAMES</B></A>
|
374
|
|
375
|
<SCRIPT>
|
376
|
<!--
|
377
|
if(window==top) {
|
378
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
379
|
}
|
380
|
//-->
|
381
|
</SCRIPT>
|
382
|
<NOSCRIPT>
|
383
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
384
|
</NOSCRIPT>
|
385
|
</FONT></TD>
|
386
|
</TR>
|
387
|
<TR>
|
388
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
389
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
390
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
391
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
392
|
</TR>
|
393
|
</TABLE>
|
394
|
|
395
|
<!-- =========== END OF NAVBAR =========== -->
|
396
|
|
397
|
<HR>
|
398
|
<FONT SIZE="-1">
|
399
|
|
400
|
</FONT>
|
401
|
<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>
|
402
|
</BODY>
|
403
|
</HTML>
|