NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/Chameleon/trunk/Chameleon/BoundingBoxPopup/BoundingBoxPopup.en-ca.doc.xml

Revision 13 (checked in by jcleary, 17 years ago)

Latest Chameleon code checkout from previous repository

Line 
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <ca:widgetdoc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd">
3   <ca:docinfo title="Document Information">
4     <ca:language title="Document Language Code">
5       <ca:value>English (en-ca)</ca:value>
6     </ca:language>
7     <ca:docbuilddate title="Doc_Builder Date">
8       <ca:value>2004-12-18</ca:value>
9     </ca:docbuilddate>
10     <ca:docversion title="Document Repository Version">
11       <ca:value>$id: $</ca:value>
12     </ca:docversion>
13     <ca:authors title="Authors">
14       <ca:person>
15         <ca:name>Doc_Builder</ca:name>
16         <ca:company>DM Solutions Group Inc.</ca:company>
17         <ca:contact>chameleon@lists.maptools.org</ca:contact>
18         <ca:comment></ca:comment>
19       </ca:person>
20     </ca:authors>
21     <ca:editors title="Editors">
22       <ca:person>
23         <ca:name>Christopher R. Thorne</ca:name>
24         <ca:company>DM Solutions Group Inc.</ca:company>
25         <ca:contact>chameleon@lists.maptools.org</ca:contact>
26         <ca:comment></ca:comment>
27       </ca:person>
28     </ca:editors>
29   </ca:docinfo>
30   <ca:identification title="Identification">
31     <ca:name title="Name">
32       <ca:value>boundingboxpopup</ca:value>
33     </ca:name>
34     <ca:chameleonpack title="Widet Package">
35       <ca:value>TBD</ca:value>
36     </ca:chameleonpack>
37     <ca:parentgroup title="Parent Group">
38       <ca:value>TBD</ca:value>
39     </ca:parentgroup>
40     <ca:version title="Version">
41       <ca:value>1.99</ca:value>
42     </ca:version>
43     <ca:releasedate title="Release Date">
44       <ca:value>1999-12-31</ca:value>
45     </ca:releasedate>
46     <ca:maturitylevel title="Maturity Level">
47       <ca:value>BETA</ca:value>
48     </ca:maturitylevel>
49     <ca:developers title="Developers">
50       <ca:person>
51         <ca:name>Paul Spencer</ca:name>
52         <ca:company>DM Solutions Group Inc.</ca:company>
53         <ca:contact>chameleon@lists.maptools.org</ca:contact>
54         <ca:comment></ca:comment>
55       </ca:person>
56     </ca:developers>
57   </ca:identification>
58   <ca:descriptions title="Description">
59     <ca:description title="General Functionality">
60       <ca:paras title="None.">
61         <ca:para>The BoundingBoxPopupWidget displays a popup dialog box that allows the user
62 to enter bounding box coordinates to zoom to (either rectangle or point)</ca:para>
63       </ca:paras>
64     </ca:description>
65     <ca:techrequirements title="Technical Requirements">
66       <ca:paras title="None.">
67         <ca:para></ca:para>
68       </ca:paras>
69     </ca:techrequirements>
70     <ca:dependancies title="Dependancies">
71       <ca:dependancy type="None" title="None.">
72         <ca:para></ca:para>
73       </ca:dependancy>
74     </ca:dependancies>
75     <ca:sharedresources title="Shared Resources">
76       <ca:paras title="None.">
77         <ca:para></ca:para>
78       </ca:paras>
79     </ca:sharedresources>
80     <ca:embeddedhelp title="General User Interface Help">
81       <ca:paras title="None.">
82         <ca:para>This button provides the capability to display a specific location. To use it, click the Bounding Box icon to popup the Bounding Box dialog. This dialog box provides two different mechanisms for displaying a new location. The first way is to specify the minimum and maximum values in both the X and Y directions. The second is to specify a point to center to. In both cases, the coordinates must be entered in the units of the projection that the map is displayed in.</ca:para>
83       </ca:paras>
84     </ca:embeddedhelp>
85     <ca:guinotes title="Interface Functionality">
86       <ca:guinote type="None" title="None.">
87         <ca:para></ca:para>
88       </ca:guinote>
89     </ca:guinotes>
90     <ca:qanotes title="Quality Assurance">
91       <ca:paras title="None.">
92         <ca:para></ca:para>
93       </ca:paras>
94     </ca:qanotes>
95   </ca:descriptions>
96   <ca:tagstructures title="Tag Syntax">
97     <ca:tagstructure title="Widget Syntax">
98       <ca:description></ca:description>
99       <ca:code title="">
100         <ca:description></ca:description>
101         <ca:codeblock bold="false"/>
102       </ca:code>
103     </ca:tagstructure>
104   </ca:tagstructures>
105   <ca:examples title="Examples">
106     <ca:widgetexamples title="Widget Examples">
107       <ca:example title="Example #1: Simple">
108         <ca:description></ca:description>
109         <ca:code title="">
110           <ca:description></ca:description>
111           <ca:codeblock bold="false">
112             <ca:line></ca:line>
113           </ca:codeblock>
114         </ca:code>
115       </ca:example>
116     </ca:widgetexamples>
117     <ca:sharedresourceexamples title="Shared Resources Examples">
118       <ca:example title="Example #1: Advanced">
119         <ca:description></ca:description>
120         <ca:code title="">
121           <ca:description></ca:description>
122           <ca:codeblock bold="false">
123             <ca:line></ca:line>
124           </ca:codeblock>
125         </ca:code>
126       </ca:example>
127     </ca:sharedresourceexamples>
128     <ca:sampleapps title="Sample Applications">
129       <ca:sampleapp>
130         <ca:name>Hawaii Demo</ca:name>
131         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
132         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
133       </ca:sampleapp>
134     </ca:sampleapps>
135     <ca:scriptexamples title="Script Examples">
136       <ca:example title="Example #1: Simple">
137         <ca:description></ca:description>
138         <ca:code title="">
139           <ca:description></ca:description>
140           <ca:codeblock bold="false">
141             <ca:line></ca:line>
142           </ca:codeblock>
143         </ca:code>
144       </ca:example>
145     </ca:scriptexamples>
146   </ca:examples>
147   <ca:attributegroups title="Attribute Groups">
148     <ca:description></ca:description>
149     <ca:attributegroup>
150       <ca:name>base</ca:name>
151       <ca:name>button</ca:name>
152       <ca:name>popup</ca:name>
153     </ca:attributegroup>
154   </ca:attributegroups>
155   <ca:widgettag title="Attributes">
156     <ca:subtag>
157       <ca:name></ca:name>
158       <ca:type title="Type">
159         <ca:value>XML</ca:value>
160         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
161       </ca:type>
162       <ca:class title="Class">
163         <ca:value>Widget &amp; Shared Resource</ca:value>
164       </ca:class>
165       <ca:description></ca:description>
166       <ca:attribute>
167         <ca:name></ca:name>
168         <ca:type title="Type">
169           <ca:value>float</ca:value>
170           <ca:description></ca:description>
171         </ca:type>
172         <ca:class title="Class">
173           <ca:value>Widget &amp; Shared Resource</ca:value>
174         </ca:class>
175         <ca:default title="Default">
176           <ca:value></ca:value>
177           <ca:description></ca:description>
178         </ca:default>
179         <ca:possvalues type="list" title="Value">
180           <ca:value></ca:value>
181         </ca:possvalues>
182         <ca:description></ca:description>
183       </ca:attribute>
184     </ca:subtag>
185   </ca:widgettag>
186   <ca:formelements title="Form Elements">
187     <ca:formelement>
188       <ca:name>NAV_CMD</ca:name>
189       <ca:type title="Type">
190         <ca:value>unknown</ca:value>
191       </ca:type>
192       <ca:default title="Default">
193         <ca:value></ca:value>
194         <ca:description></ca:description>
195       </ca:default>
196       <ca:possvalues type="list" title="Values">
197         <ca:value></ca:value>
198       </ca:possvalues>
199       <ca:description>The last command that was used to interact with the map</ca:description>
200     </ca:formelement>
201     <ca:formelement>
202       <ca:name>NAV_INPUT_TYPE</ca:name>
203       <ca:type title="Type">
204         <ca:value>unknown</ca:value>
205         <ca:description></ca:description>
206       </ca:type>
207       <ca:default title="Default">
208         <ca:value></ca:value>
209         <ca:description></ca:description>
210       </ca:default>
211       <ca:possvalues type="list" title="Values">
212         <ca:value></ca:value>
213       </ca:possvalues>
214       <ca:description>the type of the last navigation command, either POINT or RECTANGLE</ca:description>
215     </ca:formelement>
216     <ca:formelement>
217       <ca:name>NAV_INPUT_COORDINATES</ca:name>
218       <ca:type title="Type">
219         <ca:value>unknown</ca:value>
220         <ca:description></ca:description>
221       </ca:type>
222       <ca:default title="Default">
223         <ca:value></ca:value>
224         <ca:description></ca:description>
225       </ca:default>
226       <ca:possvalues type="list" title="Values">
227         <ca:value></ca:value>
228       </ca:possvalues>
229       <ca:description>the coordinates that the last command generated.  May be a single point, or two points representing a rectangle</ca:description>
230     </ca:formelement>
231     <ca:formelement>
232       <ca:name>NAV_INPUT_SRS</ca:name>
233       <ca:type title="Type">
234         <ca:value>unknown</ca:value>
235         <ca:description></ca:description>
236       </ca:type>
237       <ca:default title="Default">
238         <ca:value></ca:value>
239         <ca:description></ca:description>
240       </ca:default>
241       <ca:possvalues type="list" title="Values">
242         <ca:value></ca:value>
243       </ca:possvalues>
244       <ca:description></ca:description>
245     </ca:formelement>
246   </ca:formelements>
247   <ca:jsvariables title="JavaScript Variables"/>
248   <ca:jsfunctions title="JavaScript Functions">
249  
250     <ca:jsfunction>
251       <ca:name>clickBoundingBoxPopup</ca:name>
252       <ca:scope title="Scope">
253         <ca:value>Private</ca:value>
254       </ca:scope>
255       <ca:description>callback function for the user clicking the Zoom to Bounding Box button</ca:description>
256       <ca:returnvalues title="Function Return Value">
257         <ca:returnvalue>
258           <ca:type title="Type">
259             <ca:value>unknown</ca:value>
260             <ca:description></ca:description>
261           </ca:type>
262           <ca:default title="Default">
263             <ca:value></ca:value>
264           </ca:default>
265           <ca:possvalues type="list" title="Values">
266             <ca:value></ca:value>
267           </ca:possvalues>
268           <ca:description></ca:description>
269         </ca:returnvalue>
270       </ca:returnvalues>
271       <ca:triggeredjsapievents title="JSAPI Triggered Events">
272        
273         <ca:triggeredjsapievent title="">
274           <ca:name></ca:name>
275           <ca:description></ca:description>
276         </ca:triggeredjsapievent>
277       </ca:triggeredjsapievents>
278     </ca:jsfunction>
279  
280     <ca:jsfunction>
281       <ca:name>applyBoundingBox</ca:name>
282       <ca:scope title="Scope">
283         <ca:value>Private</ca:value>
284       </ca:scope>
285       <ca:description>callback function to apply a Zoom to Bounding Box or Point Coordinates.</ca:description>
286       <ca:parameters title="Parameters">
287         <ca:parameter>
288           <ca:name>nMinX</ca:name>
289           <ca:type title="Type">
290             <ca:value>string</ca:value>
291           </ca:type>
292           <ca:default title="Default">
293             <ca:value></ca:value>
294             <ca:description></ca:description>
295           </ca:default>
296           <ca:possvalues type="list" title="Values">
297             <ca:value></ca:value>
298           </ca:possvalues>
299           <ca:description></ca:description>
300         </ca:parameter>
301         <ca:parameter>
302           <ca:name>nMinY</ca:name>
303           <ca:type title="Type">
304             <ca:value>string</ca:value>
305           </ca:type>
306           <ca:default title="Default">
307             <ca:value></ca:value>
308             <ca:description></ca:description>
309           </ca:default>
310           <ca:possvalues type="list" title="Values">
311             <ca:value></ca:value>
312           </ca:possvalues>
313           <ca:description></ca:description>
314         </ca:parameter>
315         <ca:parameter>
316           <ca:name>nMaxX</ca:name>
317           <ca:type title="Type">
318             <ca:value>string</ca:value>
319           </ca:type>
320           <ca:default title="Default">
321             <ca:value></ca:value>
322             <ca:description></ca:description>
323           </ca:default>
324           <ca:possvalues type="list" title="Values">
325             <ca:value></ca:value>
326           </ca:possvalues>
327           <ca:description></ca:description>
328         </ca:parameter>
329         <ca:parameter>
330           <ca:name>nMaxY</ca:name>
331           <ca:type title="Type">
332             <ca:value>string</ca:value>
333           </ca:type>
334           <ca:default title="Default">
335             <ca:value></ca:value>
336             <ca:description></ca:description>
337           </ca:default>
338           <ca:possvalues type="list" title="Values">
339             <ca:value></ca:value>
340           </ca:possvalues>
341           <ca:description></ca:description>
342         </ca:parameter>
343       </ca:parameters>
344       <ca:returnvalues title="Function Return Value">
345         <ca:returnvalue>
346           <ca:type title="Type">
347             <ca:value>unknown</ca:value>
348             <ca:description></ca:description>
349           </ca:type>
350           <ca:default title="Default">
351             <ca:value></ca:value>
352           </ca:default>
353           <ca:possvalues type="list" title="Values">
354             <ca:value></ca:value>
355           </ca:possvalues>
356           <ca:description></ca:description>
357         </ca:returnvalue>
358       </ca:returnvalues>
359       <ca:triggeredjsapievents title="JSAPI Triggered Events">
360        
361         <ca:triggeredjsapievent title="">
362           <ca:name></ca:name>
363           <ca:description></ca:description>
364         </ca:triggeredjsapievent>
365       </ca:triggeredjsapievents>
366     </ca:jsfunction>
367
368     <ca:jsfunction>
369       <ca:name>getMapExtents</ca:name>
370       <ca:scope title="Scope">
371         <ca:value>Private</ca:value>
372       </ca:scope>
373       <ca:description>return the current extents of the map.</ca:description>
374       <ca:returnvalues title="Function Return Value">
375         <ca:returnvalue>
376           <ca:type title="Type">
377             <ca:value>unknown</ca:value>
378             <ca:description></ca:description>
379           </ca:type>
380           <ca:default title="Default">
381             <ca:value></ca:value>
382           </ca:default>
383           <ca:possvalues type="list" title="Values">
384             <ca:value></ca:value>
385           </ca:possvalues>
386           <ca:description></ca:description>
387         </ca:returnvalue>
388       </ca:returnvalues>
389       <ca:triggeredjsapievents title="JSAPI Triggered Events">
390        
391         <ca:triggeredjsapievent title="">
392           <ca:name></ca:name>
393           <ca:description></ca:description>
394         </ca:triggeredjsapievent>
395       </ca:triggeredjsapievents>
396     </ca:jsfunction>
397   </ca:jsfunctions>
398
399   <ca:jsfiles title="JavaScript Files">
400     <ca:jsfile>
401       <ca:name></ca:name>
402       <ca:description></ca:description>
403       <ca:jsvariables title="JavaScript Variables">
404         <ca:jsvariable>
405           <ca:name></ca:name>
406           <ca:type title="Type">
407             <ca:value>string</ca:value>
408           </ca:type>
409           <ca:scope title="Scope">
410             <ca:value>Private</ca:value>
411           </ca:scope>
412           <ca:default title="Default">
413             <ca:value></ca:value>
414           </ca:default>
415           <ca:possvalues type="list" title="Values">
416             <ca:value></ca:value>
417           </ca:possvalues>
418           <ca:description></ca:description>
419         </ca:jsvariable>
420       </ca:jsvariables>
421       <ca:jsfunctions title="JavaScript Functions">
422         <ca:jsfunction>
423           <ca:name></ca:name>
424           <ca:scope title="Scope">
425             <ca:value>Private</ca:value>
426           </ca:scope>
427           <ca:description></ca:description>
428           <ca:parameters title="Parameters">
429             <ca:parameter>
430               <ca:name></ca:name>
431               <ca:type title="Type">
432                 <ca:value>string</ca:value>
433               </ca:type>
434               <ca:required title="Required">
435                 <ca:value>false</ca:value>
436               </ca:required>
437               <ca:default title="Default">
438                 <ca:value></ca:value>
439                 <ca:description></ca:description>
440               </ca:default>
441               <ca:possvalues type="list" title="Values">
442                 <ca:value></ca:value>
443               </ca:possvalues>
444               <ca:description></ca:description>
445             </ca:parameter>
446           </ca:parameters>
447           <ca:returnvalues title="Function Return Value">
448             <ca:returnvalue>
449               <ca:type title="Type">
450                 <ca:value>unknown</ca:value>
451                 <ca:description></ca:description>
452               </ca:type>
453               <ca:default title="Default">
454                 <ca:value></ca:value>
455               </ca:default>
456               <ca:possvalues type="list" title="Values">
457                 <ca:value></ca:value>
458               </ca:possvalues>
459               <ca:description></ca:description>
460             </ca:returnvalue>
461           </ca:returnvalues>
462           <ca:triggeredjsapievents title="JSAPI Triggered Events">
463             <ca:triggeredjsapievent title="">
464               <ca:name></ca:name>
465               <ca:description></ca:description>
466             </ca:triggeredjsapievent>
467           </ca:triggeredjsapievents>
468         </ca:jsfunction>
469       </ca:jsfunctions>
470     </ca:jsfile>
471   </ca:jsfiles>
472   <ca:listenedjsapievents title="JSAPI Listened Events">
473     <ca:listenedjsapievent title="">
474       <ca:name></ca:name>
475       <ca:description></ca:description>
476       <ca:calledfunctions title="Functions Calls">
477         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
478         <ca:calledfunction>
479           <ca:name></ca:name>
480           <ca:description></ca:description>
481         </ca:calledfunction>
482       </ca:calledfunctions>
483     </ca:listenedjsapievent>
484   </ca:listenedjsapievents>
485   <ca:widgetevents title="Widget Events">
486     <ca:widgetevent>
487       <ca:name></ca:name>
488       <ca:parameters title="Parameters">
489         <ca:parameter>
490           <ca:name></ca:name>
491           <ca:type title="Type">
492             <ca:value>string</ca:value>
493           </ca:type>
494           <ca:required title="Required">
495             <ca:value>false</ca:value>
496           </ca:required>
497           <ca:default title="Default">
498             <ca:value></ca:value>
499             <ca:description></ca:description>
500           </ca:default>
501           <ca:possvalues type="list" title="Values">
502             <ca:value></ca:value>
503           </ca:possvalues>
504           <ca:description></ca:description>
505         </ca:parameter>
506       </ca:parameters>
507       <ca:description></ca:description>
508     </ca:widgetevent>
509   </ca:widgetevents>
510   <ca:errors title="Widget Errors">
511     <ca:error title="Error #1">
512       <ca:type title="Type">
513         <ca:value>PHP Mapscript</ca:value>
514       </ca:type>
515       <ca:severity title="Severity">
516         <ca:value>none</ca:value>
517         <ca:description></ca:description>
518       </ca:severity>
519       <ca:message title="Error Message">
520         <ca:paras title="">
521           <ca:para>Error message string....</ca:para>
522         </ca:paras>
523       </ca:message>
524       <ca:meaning title="Interpretation">
525         <ca:paras title="">
526           <ca:para>The description of what the message means......</ca:para>
527         </ca:paras>
528       </ca:meaning>
529       <ca:solution title="Troubleshooting Tips">
530         <ca:paras title="">
531           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
532         </ca:paras>
533       </ca:solution>
534     </ca:error>
535   </ca:errors>
536 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.