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

root/Chameleon/trunk/Chameleon/ROIFeatureTool/ROIFeatureTool.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>roifeaturetool</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="">
61         <ca:para>The v widget allows the user to draw a region
62 of interest on the map interface by selecting an existing
63 feature from a polygon layer.</ca:para>
64       </ca:paras>
65     </ca:description>
66     <ca:techrequirements title="Technical Requirements">
67       <ca:paras title="Not Available">
68         <ca:para></ca:para>
69       </ca:paras>
70     </ca:techrequirements>
71     <ca:dependancies title="Dependancies">
72       <ca:dependancy type="None" title="Not Available">
73         <ca:para></ca:para>
74       </ca:dependancy>
75     </ca:dependancies>
76     <ca:sharedresources title="Shared Resources">
77       <ca:paras title="Not Available">
78         <ca:para></ca:para>
79       </ca:paras>
80     </ca:sharedresources>
81     <ca:embeddedhelp title="General User Interface Help">
82       <ca:paras title="">
83         <ca:para></ca:para>
84       </ca:paras>
85     </ca:embeddedhelp>
86     <ca:guinotes title="Interface Functionality">
87       <ca:guinote type="None" title="None.">
88         <ca:para></ca:para>
89       </ca:guinote>
90     </ca:guinotes>
91     <ca:qanotes title="Quality Assurance">
92       <ca:paras title="None.">
93         <ca:para></ca:para>
94       </ca:paras>
95     </ca:qanotes>
96   </ca:descriptions>
97   <ca:tagstructures title="Tag Syntax">
98     <ca:tagstructure title="Widget Syntax">
99       <ca:description></ca:description>
100       <ca:code title="">
101         <ca:description></ca:description>
102         <ca:codeblock bold="false"/>
103       </ca:code>
104     </ca:tagstructure>
105   </ca:tagstructures>
106   <ca:examples title="Examples">
107     <ca:widgetexamples title="Widget Examples">
108       <ca:example title="Example #1: Simple">
109         <ca:description></ca:description>
110         <ca:code title="">
111           <ca:description></ca:description>
112           <ca:codeblock bold="false">
113             <ca:line></ca:line>
114           </ca:codeblock>
115         </ca:code>
116       </ca:example>
117     </ca:widgetexamples>
118     <ca:sharedresourceexamples title="Shared Resources Examples">
119       <ca:example title="Example #1: Advanced">
120         <ca:description></ca:description>
121         <ca:code title="">
122           <ca:description></ca:description>
123           <ca:codeblock bold="false">
124             <ca:line></ca:line>
125           </ca:codeblock>
126         </ca:code>
127       </ca:example>
128     </ca:sharedresourceexamples>
129     <ca:sampleapps title="Sample Applications">
130       <ca:sampleapp>
131         <ca:name>Hawaii Demo</ca:name>
132         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
133         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
134       </ca:sampleapp>
135     </ca:sampleapps>
136     <ca:scriptexamples title="Script Examples">
137       <ca:example title="Example #1: Simple">
138         <ca:description></ca:description>
139         <ca:code title="">
140           <ca:description></ca:description>
141           <ca:codeblock bold="false">
142             <ca:line></ca:line>
143           </ca:codeblock>
144         </ca:code>
145       </ca:example>
146     </ca:scriptexamples>
147   </ca:examples>
148   <ca:attributegroups title="Attribute Groups">
149     <ca:description></ca:description>
150     <ca:attributegroup>
151       <ca:name>base</ca:name>
152       <ca:name>button</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:description></ca:description>
192       </ca:type>
193       <ca:default title="Default">
194         <ca:value></ca:value>
195         <ca:description></ca:description>
196       </ca:default>
197       <ca:possvalues type="list" title="Values">
198         <ca:value></ca:value>
199       </ca:possvalues>
200       <ca:description></ca:description>
201     </ca:formelement>
202   </ca:formelements>
203   <ca:jsvariables title="JavaScript Variables">
204     <ca:jsvariable>
205       <ca:name>gROIToolmouseX</ca:name>
206       <ca:type title="Type">
207         <ca:value>float</ca:value>
208       </ca:type>
209       <ca:scope title="Scope">
210         <ca:value>Private</ca:value>
211       </ca:scope>
212       <ca:default title="Default">
213         <ca:value>0</ca:value>
214       </ca:default>
215       <ca:possvalues type="list" title="Values">
216         <ca:value></ca:value>
217       </ca:possvalues>
218       <ca:description></ca:description>
219     </ca:jsvariable>
220     <ca:jsvariable>
221       <ca:name>gROIToolmouseY</ca:name>
222       <ca:type title="Type">
223         <ca:value>float</ca:value>
224       </ca:type>
225       <ca:scope title="Scope">
226         <ca:value>Private</ca:value>
227       </ca:scope>
228       <ca:default title="Default">
229         <ca:value>0</ca:value>
230       </ca:default>
231       <ca:possvalues type="list" title="Values">
232         <ca:value></ca:value>
233       </ca:possvalues>
234       <ca:description></ca:description>
235     </ca:jsvariable>
236     <ca:jsvariable>
237       <ca:name>goROIFeatureObj</ca:name>
238       <ca:type title="Type">
239         <ca:value>float</ca:value>
240       </ca:type>
241       <ca:scope title="Scope">
242         <ca:value>Private</ca:value>
243       </ca:scope>
244       <ca:default title="Default">
245         <ca:value>null</ca:value>
246       </ca:default>
247       <ca:possvalues type="list" title="Values">
248         <ca:value></ca:value>
249       </ca:possvalues>
250       <ca:description></ca:description>
251     </ca:jsvariable>
252   </ca:jsvariables>
253   <ca:jsfunctions title="JavaScript Functions">
254     <ca:jsfunction>
255       <ca:name>ROIFeatureTool</ca:name>
256       <ca:scope title="Scope">
257         <ca:value>Private</ca:value>
258       </ca:scope>
259       <ca:description></ca:description>
260       <ca:returnvalues title="Function Return Value">
261         <ca:returnvalue>
262           <ca:type title="Type">
263             <ca:value>unknown</ca:value>
264             <ca:description></ca:description>
265           </ca:type>
266           <ca:default title="Default">
267             <ca:value></ca:value>
268           </ca:default>
269           <ca:possvalues type="list" title="Values">
270             <ca:value></ca:value>
271           </ca:possvalues>
272           <ca:description></ca:description>
273         </ca:returnvalue>
274       </ca:returnvalues>
275       <ca:triggeredjsapievents title="JSAPI Triggered Events">
276         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
277         <ca:triggeredjsapievent title="">
278           <ca:name></ca:name>
279           <ca:description></ca:description>
280         </ca:triggeredjsapievent>
281       </ca:triggeredjsapievents>
282     </ca:jsfunction>
283     <ca:jsfunction>
284       <ca:name>ROIRectToolInit</ca:name>
285       <ca:scope title="Scope">
286         <ca:value>Private</ca:value>
287       </ca:scope>
288       <ca:description></ca:description>
289       <ca:returnvalues title="Function Return Value">
290         <ca:returnvalue>
291           <ca:type title="Type">
292             <ca:value>unknown</ca:value>
293             <ca:description></ca:description>
294           </ca:type>
295           <ca:default title="Default">
296             <ca:value></ca:value>
297           </ca:default>
298           <ca:possvalues type="list" title="Values">
299             <ca:value></ca:value>
300           </ca:possvalues>
301           <ca:description></ca:description>
302         </ca:returnvalue>
303       </ca:returnvalues>
304       <ca:triggeredjsapievents title="JSAPI Triggered Events">
305         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
306         <ca:triggeredjsapievent title="">
307           <ca:name></ca:name>
308           <ca:description></ca:description>
309         </ca:triggeredjsapievent>
310       </ca:triggeredjsapievents>
311     </ca:jsfunction>
312     <ca:jsfunction>
313       <ca:name>ROIFeatureToolInitObjects</ca:name>
314       <ca:scope title="Scope">
315         <ca:value>Private</ca:value>
316       </ca:scope>
317       <ca:description></ca:description>
318       <ca:returnvalues title="Function Return Value">
319         <ca:returnvalue>
320           <ca:type title="Type">
321             <ca:value>unknown</ca:value>
322             <ca:description></ca:description>
323           </ca:type>
324           <ca:default title="Default">
325             <ca:value></ca:value>
326           </ca:default>
327           <ca:possvalues type="list" title="Values">
328             <ca:value></ca:value>
329           </ca:possvalues>
330           <ca:description></ca:description>
331         </ca:returnvalue>
332       </ca:returnvalues>
333       <ca:triggeredjsapievents title="JSAPI Triggered Events">
334         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
335         <ca:triggeredjsapievent title="">
336           <ca:name></ca:name>
337           <ca:description></ca:description>
338         </ca:triggeredjsapievent>
339       </ca:triggeredjsapievents>
340     </ca:jsfunction>
341     <ca:jsfunction>
342       <ca:name>ROIFeatureToolMouseUp</ca:name>
343       <ca:scope title="Scope">
344         <ca:value>Private</ca:value>
345       </ca:scope>
346       <ca:description></ca:description>
347       <ca:parameters title="Parameters">
348         <ca:parameter>
349           <ca:name>e</ca:name>
350           <ca:type title="Type">
351             <ca:value>string</ca:value>
352           </ca:type>
353           <ca:default title="Default">
354             <ca:value></ca:value>
355             <ca:description></ca:description>
356           </ca:default>
357           <ca:possvalues type="list" title="Values">
358             <ca:value></ca:value>
359           </ca:possvalues>
360           <ca:description></ca:description>
361         </ca:parameter>
362       </ca:parameters>
363       <ca:returnvalues title="Function Return Value">
364         <ca:returnvalue>
365           <ca:type title="Type">
366             <ca:value>unknown</ca:value>
367             <ca:description></ca:description>
368           </ca:type>
369           <ca:default title="Default">
370             <ca:value></ca:value>
371           </ca:default>
372           <ca:possvalues type="list" title="Values">
373             <ca:value></ca:value>
374           </ca:possvalues>
375           <ca:description></ca:description>
376         </ca:returnvalue>
377       </ca:returnvalues>
378       <ca:triggeredjsapievents title="JSAPI Triggered Events">
379         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
380         <ca:triggeredjsapievent title="">
381           <ca:name></ca:name>
382           <ca:description></ca:description>
383         </ca:triggeredjsapievent>
384       </ca:triggeredjsapievents>
385     </ca:jsfunction>
386     <ca:jsfunction>
387       <ca:name>ROIFeatureToolGetMousePosition</ca:name>
388       <ca:scope title="Scope">
389         <ca:value>Private</ca:value>
390       </ca:scope>
391       <ca:description></ca:description>
392       <ca:parameters title="Parameters">
393         <ca:parameter>
394           <ca:name>e</ca:name>
395           <ca:type title="Type">
396             <ca:value>string</ca:value>
397           </ca:type>
398           <ca:default title="Default">
399             <ca:value></ca:value>
400             <ca:description></ca:description>
401           </ca:default>
402           <ca:possvalues type="list" title="Values">
403             <ca:value></ca:value>
404           </ca:possvalues>
405           <ca:description></ca:description>
406         </ca:parameter>
407       </ca:parameters>
408       <ca:returnvalues title="Function Return Value">
409         <ca:returnvalue>
410           <ca:type title="Type">
411             <ca:value>unknown</ca:value>
412             <ca:description></ca:description>
413           </ca:type>
414           <ca:default title="Default">
415             <ca:value></ca:value>
416           </ca:default>
417           <ca:possvalues type="list" title="Values">
418             <ca:value></ca:value>
419           </ca:possvalues>
420           <ca:description></ca:description>
421         </ca:returnvalue>
422       </ca:returnvalues>
423       <ca:triggeredjsapievents title="JSAPI Triggered Events">
424         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
425         <ca:triggeredjsapievent title="">
426           <ca:name></ca:name>
427           <ca:description></ca:description>
428         </ca:triggeredjsapievent>
429       </ca:triggeredjsapievents>
430     </ca:jsfunction>
431     <ca:jsfunction>
432       <ca:name>ROIFeatureToolMouseMove</ca:name>
433       <ca:scope title="Scope">
434         <ca:value>Private</ca:value>
435       </ca:scope>
436       <ca:description></ca:description>
437       <ca:parameters title="Parameters">
438         <ca:parameter>
439           <ca:name>e</ca:name>
440           <ca:type title="Type">
441             <ca:value>string</ca:value>
442           </ca:type>
443           <ca:default title="Default">
444             <ca:value></ca:value>
445             <ca:description></ca:description>
446           </ca:default>
447           <ca:possvalues type="list" title="Values">
448             <ca:value></ca:value>
449           </ca:possvalues>
450           <ca:description></ca:description>
451         </ca:parameter>
452       </ca:parameters>
453       <ca:returnvalues title="Function Return Value">
454         <ca:returnvalue>
455           <ca:type title="Type">
456             <ca:value>unknown</ca:value>
457             <ca:description></ca:description>
458           </ca:type>
459           <ca:default title="Default">
460             <ca:value></ca:value>
461           </ca:default>
462           <ca:possvalues type="list" title="Values">
463             <ca:value></ca:value>
464           </ca:possvalues>
465           <ca:description></ca:description>
466         </ca:returnvalue>
467       </ca:returnvalues>
468       <ca:triggeredjsapievents title="JSAPI Triggered Events">
469         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
470         <ca:triggeredjsapievent title="">
471           <ca:name></ca:name>
472           <ca:description></ca:description>
473         </ca:triggeredjsapievent>
474       </ca:triggeredjsapievents>
475     </ca:jsfunction>
476   </ca:jsfunctions>
477   <ca:jsfiles title="JavaScript Files">
478     <ca:jsfile>
479       <ca:name></ca:name>
480       <ca:description></ca:description>
481       <ca:jsvariables title="JavaScript Variables">
482         <ca:jsvariable>
483           <ca:name></ca:name>
484           <ca:type title="Type">
485             <ca:value>string</ca:value>
486           </ca:type>
487           <ca:scope title="Scope">
488             <ca:value>Private</ca:value>
489           </ca:scope>
490           <ca:default title="Default">
491             <ca:value></ca:value>
492           </ca:default>
493           <ca:possvalues type="list" title="Values">
494             <ca:value></ca:value>
495           </ca:possvalues>
496           <ca:description></ca:description>
497         </ca:jsvariable>
498       </ca:jsvariables>
499       <ca:jsfunctions title="JavaScript Functions">
500         <ca:jsfunction>
501           <ca:name></ca:name>
502           <ca:scope title="Scope">
503             <ca:value>Private</ca:value>
504           </ca:scope>
505           <ca:description></ca:description>
506           <ca:parameters title="Parameters">
507             <ca:parameter>
508               <ca:name></ca:name>
509               <ca:type title="Type">
510                 <ca:value>string</ca:value>
511               </ca:type>
512               <ca:required title="Required">
513                 <ca:value>false</ca:value>
514               </ca:required>
515               <ca:default title="Default">
516                 <ca:value></ca:value>
517                 <ca:description></ca:description>
518               </ca:default>
519               <ca:possvalues type="list" title="Values">
520                 <ca:value></ca:value>
521               </ca:possvalues>
522               <ca:description></ca:description>
523             </ca:parameter>
524           </ca:parameters>
525           <ca:returnvalues title="Function Return Value">
526             <ca:returnvalue>
527               <ca:type title="Type">
528                 <ca:value>unknown</ca:value>
529                 <ca:description></ca:description>
530               </ca:type>
531               <ca:default title="Default">
532                 <ca:value></ca:value>
533               </ca:default>
534               <ca:possvalues type="list" title="Values">
535                 <ca:value></ca:value>
536               </ca:possvalues>
537               <ca:description></ca:description>
538             </ca:returnvalue>
539           </ca:returnvalues>
540           <ca:triggeredjsapievents title="JSAPI Triggered Events">
541             <ca:triggeredjsapievent title="">
542               <ca:name></ca:name>
543               <ca:description></ca:description>
544             </ca:triggeredjsapievent>
545           </ca:triggeredjsapievents>
546         </ca:jsfunction>
547       </ca:jsfunctions>
548     </ca:jsfile>
549   </ca:jsfiles>
550   <ca:listenedjsapievents title="JSAPI Listened Events">
551     <ca:listenedjsapievent title="">
552       <ca:name></ca:name>
553       <ca:description></ca:description>
554       <ca:calledfunctions title="Functions Calls">
555         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
556         <ca:calledfunction>
557           <ca:name></ca:name>
558           <ca:description></ca:description>
559         </ca:calledfunction>
560       </ca:calledfunctions>
561     </ca:listenedjsapievent>
562   </ca:listenedjsapievents>
563   <ca:widgetevents title="Widget Events">
564     <ca:widgetevent>
565       <ca:name></ca:name>
566       <ca:parameters title="Parameters">
567         <ca:parameter>
568           <ca:name></ca:name>
569           <ca:type title="Type">
570             <ca:value>string</ca:value>
571           </ca:type>
572           <ca:required title="Required">
573             <ca:value>false</ca:value>
574           </ca:required>
575           <ca:default title="Default">
576             <ca:value></ca:value>
577             <ca:description></ca:description>
578           </ca:default>
579           <ca:possvalues type="list" title="Values">
580             <ca:value></ca:value>
581           </ca:possvalues>
582           <ca:description></ca:description>
583         </ca:parameter>
584       </ca:parameters>
585       <ca:description></ca:description>
586     </ca:widgetevent>
587   </ca:widgetevents>
588   <ca:errors title="Widget Errors">
589     <ca:error title="Error #1">
590       <ca:type title="Type">
591         <ca:value>PHP Mapscript</ca:value>
592       </ca:type>
593       <ca:severity title="Severity">
594         <ca:value>none</ca:value>
595         <ca:description></ca:description>
596       </ca:severity>
597       <ca:message title="Error Message">
598         <ca:paras title="">
599           <ca:para>Error message string....</ca:para>
600         </ca:paras>
601       </ca:message>
602       <ca:meaning title="Interpretation">
603         <ca:paras title="">
604           <ca:para>The description of what the message means......</ca:para>
605         </ca:paras>
606       </ca:meaning>
607       <ca:solution title="Troubleshooting Tips">
608         <ca:paras title="">
609           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
610         </ca:paras>
611       </ca:solution>
612     </ca:error>
613   </ca:errors>
614 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.