|
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
|
ButtonBase
|
|
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="ButtonBase";
|
|
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-ButtonBase.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="Button.html"><B>PREV CLASS</B></A><!--
|
|
45
|
NEXT CLASS
|
|
46
|
-->
|
|
47
|
<A HREF="Caps2Context.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="ButtonBase.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 ButtonBase</H2>
|
|
76
|
<PRE>Object
|
|
77
|
|
|
|
78
|
+--<a href='WidgetBase.html'>WidgetBase</a>
|
|
79
|
|
|
|
80
|
+--<b>ButtonBase</b>
|
|
81
|
</PRE>
|
|
82
|
|
|
83
|
<DL>
|
|
84
|
<DT>
|
|
85
|
<B>Direct Known Subclasses:</B>
|
|
86
|
<DD>
|
|
87
|
<a href="WfsGetFeature.html">WfsGetFeature</a>, <a href="ZoomOut.html">ZoomOut</a>, <a href="GetFeatureInfoWSR.html">GetFeatureInfoWSR</a>, <a href="InsertFeature.html">InsertFeature</a>, <a href="Graticule.html">Graticule</a>, <a href="DragPan.html">DragPan</a>, <a href="Reset.html">Reset</a>, <a href="GetFeatureInfo.html">GetFeatureInfo</a>, <a href="Forward.html">Forward</a>, <a href="ZoomIn.html">ZoomIn</a>, <a href="EditButtonBase.html">EditButtonBase</a>, <a href="DeleteFeature.html">DeleteFeature</a>, <a href="SetAoi.html">SetAoi</a>, <a href="Button.html">Button</a>, <a href="Save.html">Save</a>, <a href="Back.html">Back</a>
|
|
88
|
</DD>
|
|
89
|
</DL>
|
|
90
|
|
|
91
|
|
|
92
|
<HR>
|
|
93
|
<DL>
|
|
94
|
<!-- Class definition -->
|
|
95
|
<DT>class
|
|
96
|
<B>ButtonBase</B>
|
|
97
|
|
|
98
|
<DT>extends <a href='WidgetBase.html'>WidgetBase</a>
|
|
99
|
|
|
100
|
|
|
101
|
</DL>
|
|
102
|
|
|
103
|
<P>
|
|
104
|
<I>Defined in <a href='overview-summary-ButtonBase.js.html'>ButtonBase.js</a></I><BR/><BR/><B>Author:</B> Mike Adair mike.adairATccrs.nrcan.gc.ca <BR/>
|
|
105
|
</P>
|
|
106
|
|
|
107
|
<HR>
|
|
108
|
|
|
109
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
110
|
|
|
111
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
|
112
|
|
|
113
|
|
|
114
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
115
|
|
|
116
|
<A NAME="field_summary"><!-- --></A>
|
|
117
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
118
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
119
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
120
|
<B>Field Summary</B></FONT></TD>
|
|
121
|
</TR>
|
|
122
|
|
|
123
|
<!-- This is one instance field summary -->
|
|
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="#action">action</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="#active">active</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="#buttonType">buttonType</A></B></CODE>
|
|
145
|
<BR>
|
|
146
|
</TD>
|
|
147
|
</TR>
|
|
148
|
|
|
149
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
150
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
151
|
<CODE> Object</CODE></FONT></TD>
|
|
152
|
<TD><CODE><B><A HREF="#control">control</A></B></CODE>
|
|
153
|
<BR>
|
|
154
|
OpenLayers control for this button.</TD>
|
|
155
|
</TR>
|
|
156
|
|
|
157
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
158
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
159
|
<CODE> Object</CODE></FONT></TD>
|
|
160
|
<TD><CODE><B><A HREF="#cursor">cursor</A></B></CODE>
|
|
161
|
<BR>
|
|
162
|
</TD>
|
|
163
|
</TR>
|
|
164
|
|
|
165
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
166
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
167
|
<CODE> Object</CODE></FONT></TD>
|
|
168
|
<TD><CODE><B><A HREF="#div">div</A></B></CODE>
|
|
169
|
<BR>
|
|
170
|
</TD>
|
|
171
|
</TR>
|
|
172
|
|
|
173
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
174
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
175
|
<CODE> Object</CODE></FONT></TD>
|
|
176
|
<TD><CODE><B><A HREF="#htmlTagId">htmlTagId</A></B></CODE>
|
|
177
|
<BR>
|
|
178
|
</TD>
|
|
179
|
</TR>
|
|
180
|
|
|
181
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
182
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
183
|
<CODE> Object</CODE></FONT></TD>
|
|
184
|
<TD><CODE><B><A HREF="#objRef">objRef</A></B></CODE>
|
|
185
|
<BR>
|
|
186
|
</TD>
|
|
187
|
</TR>
|
|
188
|
|
|
189
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
190
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
191
|
<CODE> Object</CODE></FONT></TD>
|
|
192
|
<TD><CODE><B><A HREF="#olButtonType">olButtonType</A></B></CODE>
|
|
193
|
<BR>
|
|
194
|
</TD>
|
|
195
|
</TR>
|
|
196
|
|
|
197
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
198
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
199
|
<CODE> Object</CODE></FONT></TD>
|
|
200
|
<TD><CODE><B><A HREF="#panel_div">panel_div</A></B></CODE>
|
|
201
|
<BR>
|
|
202
|
</TD>
|
|
203
|
</TR>
|
|
204
|
|
|
205
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
206
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
207
|
<CODE> Object</CODE></FONT></TD>
|
|
208
|
<TD><CODE><B><A HREF="#panelHtmlTagId">panelHtmlTagId</A></B></CODE>
|
|
209
|
<BR>
|
|
210
|
</TD>
|
|
211
|
</TR>
|
|
212
|
|
|
213
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
214
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
215
|
<CODE> Object</CODE></FONT></TD>
|
|
216
|
<TD><CODE><B><A HREF="#selected">selected</A></B></CODE>
|
|
217
|
<BR>
|
|
218
|
</TD>
|
|
219
|
</TR>
|
|
220
|
|
|
221
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
222
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
223
|
<CODE> Object</CODE></FONT></TD>
|
|
224
|
<TD><CODE><B><A HREF="#superclass">superclass</A></B></CODE>
|
|
225
|
<BR>
|
|
226
|
</TD>
|
|
227
|
</TR>
|
|
228
|
|
|
229
|
|
|
230
|
</TABLE>
|
|
231
|
|
|
232
|
|
|
233
|
|
|
234
|
|
|
235
|
|
|
236
|
<A NAME=""><!-- --></A>
|
|
237
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
238
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
239
|
<TD><B>Fields inherited from class <A HREF="WidgetBase.html">WidgetBase</A></B></TD>
|
|
240
|
</TR>
|
|
241
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
242
|
<TD><CODE>
|
|
243
|
<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>
|
|
244
|
</CODE></TD>
|
|
245
|
</TR>
|
|
246
|
</TABLE>
|
|
247
|
|
|
248
|
|
|
249
|
|
|
250
|
|
|
251
|
<!-- =========== END FIELD SUMMARY =========== -->
|
|
252
|
|
|
253
|
|
|
254
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
255
|
|
|
256
|
<A NAME="constructor_summary"><!-- --></A>
|
|
257
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
258
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
259
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
260
|
<B>Constructor Summary</B></FONT></TD>
|
|
261
|
</TR>
|
|
262
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
263
|
<TD>
|
|
264
|
<CODE>
|
|
265
|
<B>
|
|
266
|
<A HREF="ButtonBase.html#ButtonBase()">ButtonBase</A>
|
|
267
|
</B>
|
|
268
|
(widgetNode, model)
|
|
269
|
</CODE>
|
|
270
|
<BR>
|
|
271
|
|
|
272
|
Abstract base button object that all Buttons extend.
|
|
273
|
</TD>
|
|
274
|
</TR>
|
|
275
|
</TABLE>
|
|
276
|
|
|
277
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
|
278
|
|
|
279
|
|
|
280
|
|
|
281
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
282
|
|
|
283
|
<A NAME="method_summary"><!-- --></A>
|
|
284
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
285
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
286
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
287
|
<B>Method Summary</B></FONT></TD>
|
|
288
|
</TR>
|
|
289
|
|
|
290
|
|
|
291
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
292
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
293
|
<FONT SIZE="-1">
|
|
294
|
<CODE> void</CODE>
|
|
295
|
</FONT>
|
|
296
|
</TD>
|
|
297
|
<TD>
|
|
298
|
<CODE>
|
|
299
|
<B>
|
|
300
|
<A HREF="#attachToOL">attachToOL</A></B>(objRef,refreshId)
|
|
301
|
</CODE>
|
|
302
|
<BR>
|
|
303
|
|
|
304
|
Attaches the control for this button to OpenLayers
|
|
305
|
and add it to the buttonBar.
|
|
306
|
</TD>
|
|
307
|
</TR>
|
|
308
|
|
|
309
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
310
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
311
|
<FONT SIZE="-1">
|
|
312
|
<CODE> void</CODE>
|
|
313
|
</FONT>
|
|
314
|
</TD>
|
|
315
|
<TD>
|
|
316
|
<CODE>
|
|
317
|
<B>
|
|
318
|
<A HREF="#buttonInit">buttonInit</A></B>(objRef)
|
|
319
|
</CODE>
|
|
320
|
<BR>
|
|
321
|
|
|
322
|
Set the target context for the button, initialise the
|
|
323
|
buttonBars array in the context document and add a
|
|
324
|
listener to the target model for adding controls
|
|
325
|
to the OL map as soon as the map is initialized.
|
|
326
|
</TD>
|
|
327
|
</TR>
|
|
328
|
|
|
329
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
330
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
331
|
<FONT SIZE="-1">
|
|
332
|
<CODE> void</CODE>
|
|
333
|
</FONT>
|
|
334
|
</TD>
|
|
335
|
<TD>
|
|
336
|
<CODE>
|
|
337
|
<B>
|
|
338
|
<A HREF="#doAction">doAction</A></B>()
|
|
339
|
</CODE>
|
|
340
|
<BR>
|
|
341
|
|
|
342
|
Override this in buttons which inherit from this object to carry out the action.
|
|
343
|
</TD>
|
|
344
|
</TR>
|
|
345
|
|
|
346
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
347
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
348
|
<FONT SIZE="-1">
|
|
349
|
<CODE> void</CODE>
|
|
350
|
</FONT>
|
|
351
|
</TD>
|
|
352
|
<TD>
|
|
353
|
<CODE>
|
|
354
|
<B>
|
|
355
|
<A HREF="#doSelect">doSelect</A></B>(objRef, selected)
|
|
356
|
</CODE>
|
|
357
|
<BR>
|
|
358
|
|
|
359
|
Method overriden by subclasses
|
|
360
|
</TD>
|
|
361
|
</TR>
|
|
362
|
|
|
363
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
364
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
365
|
<FONT SIZE="-1">
|
|
366
|
<CODE> Object</CODE>
|
|
367
|
</FONT>
|
|
368
|
</TD>
|
|
369
|
<TD>
|
|
370
|
<CODE>
|
|
371
|
<B>
|
|
372
|
<A HREF="#getButtonClass">getButtonClass</A></B>(objRef, state)
|
|
373
|
</CODE>
|
|
374
|
<BR>
|
|
375
|
|
|
376
|
Gets the css classname for this button.
|
|
377
|
</TD>
|
|
378
|
</TR>
|
|
379
|
|
|
380
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
381
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
|
382
|
<FONT SIZE="-1">
|
|
383
|
<CODE> void</CODE>
|
|
384
|
</FONT>
|
|
385
|
</TD>
|
|
386
|
<TD>
|
|
387
|
<CODE>
|
|
388
|
<B>
|
|
389
|
<A HREF="#select">select</A></B>()
|
|
390
|
</CODE>
|
|
391
|
<BR>
|
|
392
|
|
|
393
|
Select this button.
|
|
394
|
</TD>
|
|
395
|
</TR>
|
|
396
|
|
|
397
|
|
|
398
|
</TABLE>
|
|
399
|
|
|
400
|
|
|
401
|
|
|
402
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
403
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
404
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
405
|
<TD><B>Methods inherited from class <a href="WidgetBase.html">WidgetBase</a></B></TD>
|
|
406
|
</TR>
|
|
407
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
408
|
<TD><CODE>
|
|
409
|
<!-- Inherited methods -->
|
|
410
|
<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>
|
|
411
|
</CODE></TD>
|
|
412
|
</TR>
|
|
413
|
</TABLE>
|
|
414
|
|
|
415
|
|
|
416
|
<P>
|
|
417
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
418
|
|
|
419
|
|
|
420
|
<!-- ============ FIELD DETAIL START =========== -->
|
|
421
|
|
|
422
|
<A NAME="field_detail"><!-- --></A>
|
|
423
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
424
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
425
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
|
426
|
</TR>
|
|
427
|
</TABLE>
|
|
428
|
|
|
429
|
|
|
430
|
<A NAME="action"><!-- --></A>
|
|
431
|
<H3>action</H3>
|
|
432
|
<PRE>Object <B>action</B></PRE>
|
|
433
|
<UL>
|
|
434
|
|
|
435
|
|
|
436
|
</UL>
|
|
437
|
<HR>
|
|
438
|
|
|
439
|
<A NAME="active"><!-- --></A>
|
|
440
|
<H3>active</H3>
|
|
441
|
<PRE>Object <B>active</B></PRE>
|
|
442
|
<UL>
|
|
443
|
|
|
444
|
|
|
445
|
</UL>
|
|
446
|
<HR>
|
|
447
|
|
|
448
|
<A NAME="buttonType"><!-- --></A>
|
|
449
|
<H3>buttonType</H3>
|
|
450
|
<PRE>Object <B>buttonType</B></PRE>
|
|
451
|
<UL>
|
|
452
|
|
|
453
|
|
|
454
|
</UL>
|
|
455
|
<HR>
|
|
456
|
|
|
457
|
<A NAME="control"><!-- --></A>
|
|
458
|
<H3>control</H3>
|
|
459
|
<PRE>Object <B>control</B></PRE>
|
|
460
|
<UL>
|
|
461
|
OpenLayers control for this button.
|
|
462
|
This will be filled with the instance of the control
|
|
463
|
by the attachToOL method.
|
|
464
|
|
|
465
|
</UL>
|
|
466
|
<HR>
|
|
467
|
|
|
468
|
<A NAME="cursor"><!-- --></A>
|
|
469
|
<H3>cursor</H3>
|
|
470
|
<PRE>Object <B>cursor</B></PRE>
|
|
471
|
<UL>
|
|
472
|
|
|
473
|
|
|
474
|
</UL>
|
|
475
|
<HR>
|
|
476
|
|
|
477
|
<A NAME="div"><!-- --></A>
|
|
478
|
<H3>div</H3>
|
|
479
|
<PRE>Object <B>div</B></PRE>
|
|
480
|
<UL>
|
|
481
|
|
|
482
|
|
|
483
|
</UL>
|
|
484
|
<HR>
|
|
485
|
|
|
486
|
<A NAME="htmlTagId"><!-- --></A>
|
|
487
|
<H3>htmlTagId</H3>
|
|
488
|
<PRE>Object <B>htmlTagId</B></PRE>
|
|
489
|
<UL>
|
|
490
|
|
|
491
|
|
|
492
|
</UL>
|
|
493
|
<HR>
|
|
494
|
|
|
495
|
<A NAME="objRef"><!-- --></A>
|
|
496
|
<H3>objRef</H3>
|
|
497
|
<PRE>Object <B>objRef</B></PRE>
|
|
498
|
<UL>
|
|
499
|
|
|
500
|
|
|
501
|
</UL>
|
|
502
|
<HR>
|
|
503
|
|
|
504
|
<A NAME="olButtonType"><!-- --></A>
|
|
505
|
<H3>olButtonType</H3>
|
|
506
|
<PRE>Object <B>olButtonType</B></PRE>
|
|
507
|
<UL>
|
|
508
|
|
|
509
|
|
|
510
|
</UL>
|
|
511
|
<HR>
|
|
512
|
|
|
513
|
<A NAME="panel_div"><!-- --></A>
|
|
514
|
<H3>panel_div</H3>
|
|
515
|
<PRE>Object <B>panel_div</B></PRE>
|
|
516
|
<UL>
|
|
517
|
|
|
518
|
|
|
519
|
</UL>
|
|
520
|
<HR>
|
|
521
|
|
|
522
|
<A NAME="panelHtmlTagId"><!-- --></A>
|
|
523
|
<H3>panelHtmlTagId</H3>
|
|
524
|
<PRE>Object <B>panelHtmlTagId</B></PRE>
|
|
525
|
<UL>
|
|
526
|
|
|
527
|
|
|
528
|
</UL>
|
|
529
|
<HR>
|
|
530
|
|
|
531
|
<A NAME="selected"><!-- --></A>
|
|
532
|
<H3>selected</H3>
|
|
533
|
<PRE>Object <B>selected</B></PRE>
|
|
534
|
<UL>
|
|
535
|
|
|
536
|
|
|
537
|
</UL>
|
|
538
|
<HR>
|
|
539
|
|
|
540
|
<A NAME="superclass"><!-- --></A>
|
|
541
|
<H3>superclass</H3>
|
|
542
|
<PRE>Object <B>superclass</B></PRE>
|
|
543
|
<UL>
|
|
544
|
|
|
545
|
|
|
546
|
</UL>
|
|
547
|
<HR>
|
|
548
|
|
|
549
|
|
|
550
|
|
|
551
|
<!-- ============ FIELD DETAIL END =========== -->
|
|
552
|
|
|
553
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
|
554
|
|
|
555
|
<A NAME="constructor_detail"><!-- --></A>
|
|
556
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
557
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
558
|
<TD COLSPAN=1>
|
|
559
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
|
560
|
</TD>
|
|
561
|
</TR>
|
|
562
|
</TABLE>
|
|
563
|
|
|
564
|
<A NAME="ButtonBase()"><!-- --></A><H3>
|
|
565
|
ButtonBase</H3>
|
|
566
|
<PRE><B>ButtonBase</B>(widgetNode, model)</PRE>
|
|
567
|
|
|
568
|
|
|
569
|
<UL>
|
|
570
|
Abstract base button object that all Buttons extend.
|
|
571
|
A Button is a widget which renders an image and an optional second image
|
|
572
|
for the enabled state.
|
|
573
|
</UL>
|
|
574
|
|
|
575
|
|
|
576
|
|
|
577
|
<UL>
|
|
578
|
<B>Parameters:</B>
|
|
579
|
|
|
580
|
<UL><CODE>widgetNode</CODE> - The tool node from the Config XML file.
|
|
581
|
</UL>
|
|
582
|
|
|
583
|
<UL><CODE>model</CODE> - The parent model object (optional).
|
|
584
|
</UL>
|
|
585
|
|
|
586
|
|
|
587
|
</UL>
|
|
588
|
|
|
589
|
|
|
590
|
<!-- Constructor return value(s) -->
|
|
591
|
|
|
592
|
<!-- End constructor return value(s) -->
|
|
593
|
|
|
594
|
<!-- ADDITIONAL ATTRIBUTES -->
|
|
595
|
|
|
596
|
<UL>
|
|
597
|
<B>Author:</B> Mike Adair mike.adairATccrs.nrcan.gc.ca <BR/>
|
|
598
|
</UL>
|
|
599
|
|
|
600
|
<HR/>
|
|
601
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
|
602
|
|
|
603
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
|
604
|
|
|
605
|
|
|
606
|
<!-- ============ METHOD DETAIL START ========== -->
|
|
607
|
|
|
608
|
<A NAME="method_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">
|
|
612
|
<B>Method Detail</B></FONT>
|
|
613
|
</TD>
|
|
614
|
</TR>
|
|
615
|
</TABLE>
|
|
616
|
|
|
617
|
<!-- One single method detail entry -->
|
|
618
|
|
|
619
|
<A NAME="attachToOL"><!-- --></A>
|
|
620
|
<H3>attachToOL</H3>
|
|
621
|
<PRE>void <B>attachToOL</B>(objRef,refreshId)</PRE>
|
|
622
|
|
|
623
|
<UL>Attaches the control for this button to OpenLayers
|
|
624
|
and add it to the buttonBar. When this method is called,
|
|
625
|
everything of the OL map is available.</UL>
|
|
626
|
|
|
627
|
|
|
628
|
<!-- METHOD PARAMETERS START -->
|
|
629
|
|
|
630
|
<UL>
|
|
631
|
<B>Parameters:</B>
|
|
632
|
|
|
633
|
<UL><CODE>objRef</CODE> - Reference to this object.
|
|
634
|
</UL>
|
|
635
|
|
|
636
|
<UL><CODE>control</CODE> - to add.
|
|
637
|
</UL>
|
|
638
|
|
|
639
|
</UL>
|
|
640
|
|
|
641
|
<!-- METHOD PARAMETERS END -->
|
|
642
|
|
|
643
|
|
|
644
|
|
|
645
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
646
|
|
|
647
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
648
|
<HR>
|
|
649
|
|
|
650
|
<A NAME="buttonInit"><!-- --></A>
|
|
651
|
<H3>buttonInit</H3>
|
|
652
|
<PRE>void <B>buttonInit</B>(objRef)</PRE>
|
|
653
|
|
|
654
|
<UL>Set the target context for the button, initialise the
|
|
655
|
buttonBars array in the context document and add a
|
|
656
|
listener to the target model for adding controls
|
|
657
|
to the OL map as soon as the map is initialized.</UL>
|
|
658
|
|
|
659
|
|
|
660
|
<!-- METHOD PARAMETERS START -->
|
|
661
|
|
|
662
|
<UL>
|
|
663
|
<B>Parameters:</B>
|
|
664
|
|
|
665
|
<UL><CODE>objRef</CODE> - Reference to this object.
|
|
666
|
</UL>
|
|
667
|
|
|
668
|
</UL>
|
|
669
|
|
|
670
|
<!-- METHOD PARAMETERS END -->
|
|
671
|
|
|
672
|
|
|
673
|
|
|
674
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
675
|
|
|
676
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
677
|
<HR>
|
|
678
|
|
|
679
|
<A NAME="doAction"><!-- --></A>
|
|
680
|
<H3>doAction</H3>
|
|
681
|
<PRE>void <B>doAction</B>()</PRE>
|
|
682
|
|
|
683
|
<UL>Override this in buttons which inherit from this object to carry out the action.
|
|
684
|
This is the function that will be called either when the button is selected
|
|
685
|
via the select() method or on a mouseup event if there is an associated
|
|
686
|
mouseHandler property in config.</UL>
|
|
687
|
|
|
688
|
|
|
689
|
<!-- METHOD PARAMETERS START -->
|
|
690
|
|
|
691
|
<!-- METHOD PARAMETERS END -->
|
|
692
|
|
|
693
|
|
|
694
|
|
|
695
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
696
|
|
|
697
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
698
|
<HR>
|
|
699
|
|
|
700
|
<A NAME="doSelect"><!-- --></A>
|
|
701
|
<H3>doSelect</H3>
|
|
702
|
<PRE>void <B>doSelect</B>(objRef, selected)</PRE>
|
|
703
|
|
|
704
|
<UL>Method overriden by subclasses</UL>
|
|
705
|
|
|
706
|
|
|
707
|
<!-- METHOD PARAMETERS START -->
|
|
708
|
|
|
709
|
<UL>
|
|
710
|
<B>Parameters:</B>
|
|
711
|
|
|
712
|
<UL><CODE>objRef</CODE> - Reference to this object.
|
|
713
|
</UL>
|
|
714
|
|
|
715
|
<UL><CODE>selected</CODE> - True when selected, false when deselected.
|
|
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="getButtonClass"><!-- --></A>
|
|
730
|
<H3>getButtonClass</H3>
|
|
731
|
<PRE>Object <B>getButtonClass</B>(objRef, state)</PRE>
|
|
732
|
|
|
733
|
<UL>Gets the css classname for this button. We use this
|
|
734
|
to define the button styles.</UL>
|
|
735
|
|
|
736
|
|
|
737
|
<!-- METHOD PARAMETERS START -->
|
|
738
|
|
|
739
|
<UL>
|
|
740
|
<B>Parameters:</B>
|
|
741
|
|
|
742
|
<UL><CODE>objRef</CODE> - Reference to this object.
|
|
743
|
</UL>
|
|
744
|
|
|
745
|
<UL><CODE>state</CODE> - 'Active' or 'Inactive' (case sensitive!)
|
|
746
|
</UL>
|
|
747
|
|
|
748
|
</UL>
|
|
749
|
|
|
750
|
<!-- METHOD PARAMETERS END -->
|
|
751
|
|
|
752
|
|
|
753
|
|
|
754
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
755
|
|
|
756
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
757
|
<HR>
|
|
758
|
|
|
759
|
<A NAME="select"><!-- --></A>
|
|
760
|
<H3>select</H3>
|
|
761
|
<PRE>void <B>select</B>()</PRE>
|
|
762
|
|
|
763
|
<UL>Select this button. Enables and disables associated tools,
|
|
764
|
then the control.trigger()/activate() methods make OL call
|
|
765
|
the doSelect method defined in derived classes.</UL>
|
|
766
|
|
|
767
|
|
|
768
|
<!-- METHOD PARAMETERS START -->
|
|
769
|
|
|
770
|
<!-- METHOD PARAMETERS END -->
|
|
771
|
|
|
772
|
|
|
773
|
|
|
774
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
|
775
|
|
|
776
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
|
777
|
<HR>
|
|
778
|
|
|
779
|
|
|
780
|
|
|
781
|
<!-- ============ METHOD DETAIL END ========== -->
|
|
782
|
|
|
783
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
784
|
|
|
785
|
<!-- ========== START OF NAVBAR ========== -->
|
|
786
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
787
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
788
|
<TR>
|
|
789
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
790
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
791
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
792
|
<TR ALIGN="center" VALIGN="top">
|
|
793
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
794
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-ButtonBase.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
795
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
796
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
|
797
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
798
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
799
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
800
|
</TR>
|
|
801
|
</TABLE>
|
|
802
|
</TD>
|
|
803
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
804
|
<B><a href='http://mapbuilder.sourceforge.net'>Community Map Builder</a> 27 Apr 2008</B>
|
|
805
|
</EM>
|
|
806
|
</TD
|
|
807
|
</TR>
|
|
808
|
|
|
809
|
<TR>
|
|
810
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
811
|
<A HREF="Button.html"><B>PREV CLASS</B></A><!--
|
|
812
|
NEXT CLASS
|
|
813
|
-->
|
|
814
|
<A HREF="Caps2Context.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
815
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
816
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
817
|
<A HREF="ButtonBase.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
818
|
|
|
819
|
<SCRIPT>
|
|
820
|
<!--
|
|
821
|
if(window==top) {
|
|
822
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
823
|
}
|
|
824
|
//-->
|
|
825
|
</SCRIPT>
|
|
826
|
<NOSCRIPT>
|
|
827
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
828
|
</NOSCRIPT>
|
|
829
|
</FONT></TD>
|
|
830
|
</TR>
|
|
831
|
<TR>
|
|
832
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
833
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
834
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
835
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
836
|
</TR>
|
|
837
|
</TABLE>
|
|
838
|
|
|
839
|
<!-- =========== END OF NAVBAR =========== -->
|
|
840
|
|
|
841
|
<HR>
|
|
842
|
<FONT SIZE="-1">
|
|
843
|
|
|
844
|
</FONT>
|
|
845
|
<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>
|
|
846
|
</BODY>
|
|
847
|
</HTML>
|