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

root/Chameleon/trunk/Chameleon/LayerManagerAction/LayerManagerAction.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>layermanageraction</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>See alse the UpdateMap Widget
62 The LayerManagerAction widget will possibly cause the layerorder to be changed
63 See visibility checkbox handling</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:line>   ACTION ="[string]"</ca:line>
104         </ca:codeblock>
105       </ca:code>
106     </ca:tagstructure>
107   </ca:tagstructures>
108   <ca:examples title="Examples">
109     <ca:widgetexamples title="Widget Examples">
110       <ca:example title="Example #1: Simple">
111         <ca:description></ca:description>
112         <ca:code title="">
113           <ca:description></ca:description>
114           <ca:codeblock bold="false">
115             <ca:line></ca:line>
116           </ca:codeblock>
117         </ca:code>
118       </ca:example>
119     </ca:widgetexamples>
120     <ca:sharedresourceexamples title="Shared Resources Examples">
121       <ca:example title="Example #1: Advanced">
122         <ca:description></ca:description>
123         <ca:code title="">
124           <ca:description></ca:description>
125           <ca:codeblock bold="false">
126             <ca:line></ca:line>
127           </ca:codeblock>
128         </ca:code>
129       </ca:example>
130     </ca:sharedresourceexamples>
131     <ca:sampleapps title="Sample Applications">
132       <ca:sampleapp>
133         <ca:name>Hawaii Demo</ca:name>
134         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
135         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
136       </ca:sampleapp>
137     </ca:sampleapps>
138     <ca:scriptexamples title="Script Examples">
139       <ca:example title="Example #1: Simple">
140         <ca:description></ca:description>
141         <ca:code title="">
142           <ca:description></ca:description>
143           <ca:codeblock bold="false">
144             <ca:line></ca:line>
145           </ca:codeblock>
146         </ca:code>
147       </ca:example>
148     </ca:scriptexamples>
149   </ca:examples>
150   <ca:attributegroups title="Attribute Groups">
151     <ca:description></ca:description>
152     <ca:attributegroup>
153       <ca:name>base</ca:name>
154       <ca:name>button</ca:name>
155     </ca:attributegroup>
156   </ca:attributegroups>
157   <ca:widgettag title="Attributes">
158     <ca:attribute>
159       <ca:name>ACTION</ca:name>
160       <ca:type title="Type">
161         <ca:value>string</ca:value>
162         <ca:description></ca:description>
163       </ca:type>
164       <ca:class title="Class">
165         <ca:value>Required</ca:value>
166       </ca:class>
167       <ca:default title="Default">
168         <ca:description></ca:description>
169       </ca:default>
170       <ca:possvalues type="list" title="Value">
171         <ca:value>UP</ca:value>
172         <ca:value>DOWN</ca:value>
173         <ca:value>DELETE</ca:value>
174         <ca:value>APPLY</ca:value>
175       </ca:possvalues>
176     </ca:attribute>
177     <ca:subtag>
178       <ca:name></ca:name>
179       <ca:type title="Type">
180         <ca:value>XML</ca:value>
181         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
182       </ca:type>
183       <ca:class title="Class">
184         <ca:value>Widget &amp; Shared Resource</ca:value>
185       </ca:class>
186       <ca:description></ca:description>
187       <ca:attribute>
188         <ca:name></ca:name>
189         <ca:type title="Type">
190           <ca:value>float</ca:value>
191           <ca:description></ca:description>
192         </ca:type>
193         <ca:class title="Class">
194           <ca:value>Widget &amp; Shared Resource</ca:value>
195         </ca:class>
196         <ca:default title="Default">
197           <ca:value></ca:value>
198           <ca:description></ca:description>
199         </ca:default>
200         <ca:possvalues type="list" title="Value">
201           <ca:value></ca:value>
202         </ca:possvalues>
203         <ca:description></ca:description>
204       </ca:attribute>
205     </ca:subtag>
206   </ca:widgettag>
207   <ca:formelements title="Form Elements">
208     <ca:formelement>
209       <ca:name>sid</ca:name>
210       <ca:type title="Type">
211         <ca:value>unknown</ca:value>
212         <ca:description></ca:description>
213       </ca:type>
214       <ca:default title="Default">
215         <ca:value></ca:value>
216         <ca:description></ca:description>
217       </ca:default>
218       <ca:possvalues type="list" title="Values">
219         <ca:value></ca:value>
220       </ca:possvalues>
221       <ca:description></ca:description>
222     </ca:formelement>
223     <ca:formelement>
224       <ca:name>LAYERMANAGER_ACTION</ca:name>
225       <ca:type title="Type">
226         <ca:value>unknown</ca:value>
227         <ca:description></ca:description>
228       </ca:type>
229       <ca:default title="Default">
230         <ca:value></ca:value>
231         <ca:description></ca:description>
232       </ca:default>
233       <ca:possvalues type="list" title="Values">
234         <ca:value></ca:value>
235       </ca:possvalues>
236       <ca:description></ca:description>
237     </ca:formelement>
238   </ca:formelements>
239   <ca:jsvariables title="JavaScript Variables"/>
240   <ca:jsfunctions title="JavaScript Functions">
241     <ca:jsfunction>
242       <ca:name>clickLayerManagerAction</ca:name>
243       <ca:scope title="Scope">
244         <ca:value>Private</ca:value>
245       </ca:scope>
246       <ca:description></ca:description>
247       <ca:parameters title="Parameters">
248         <ca:parameter>
249           <ca:name>obj</ca:name>
250           <ca:type title="Type">
251             <ca:value>string</ca:value>
252           </ca:type>
253           <ca:default title="Default">
254             <ca:value></ca:value>
255             <ca:description></ca:description>
256           </ca:default>
257           <ca:possvalues type="list" title="Values">
258             <ca:value></ca:value>
259           </ca:possvalues>
260           <ca:description></ca:description>
261         </ca:parameter>
262         <ca:parameter>
263           <ca:name>szAction</ca:name>
264           <ca:type title="Type">
265             <ca:value>string</ca:value>
266           </ca:type>
267           <ca:default title="Default">
268             <ca:value></ca:value>
269             <ca:description></ca:description>
270           </ca:default>
271           <ca:possvalues type="list" title="Values">
272             <ca:value></ca:value>
273           </ca:possvalues>
274           <ca:description></ca:description>
275         </ca:parameter>
276       </ca:parameters>
277       <ca:returnvalues title="Function Return Value">
278         <ca:returnvalue>
279           <ca:type title="Type">
280             <ca:value>unknown</ca:value>
281             <ca:description></ca:description>
282           </ca:type>
283           <ca:default title="Default">
284             <ca:value></ca:value>
285           </ca:default>
286           <ca:possvalues type="list" title="Values">
287             <ca:value></ca:value>
288           </ca:possvalues>
289           <ca:description></ca:description>
290         </ca:returnvalue>
291       </ca:returnvalues>
292       <ca:triggeredjsapievents title="JSAPI Triggered Events">
293         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
294         <ca:triggeredjsapievent title="">
295           <ca:name></ca:name>
296           <ca:description></ca:description>
297         </ca:triggeredjsapievent>
298       </ca:triggeredjsapievents>
299     </ca:jsfunction>
300     <ca:jsfunction>
301       <ca:name>LayerManagerApplyChanges</ca:name>
302       <ca:scope title="Scope">
303         <ca:value>Private</ca:value>
304       </ca:scope>
305       <ca:description></ca:description>
306       <ca:returnvalues title="Function Return Value">
307         <ca:returnvalue>
308           <ca:type title="Type">
309             <ca:value>unknown</ca:value>
310             <ca:description></ca:description>
311           </ca:type>
312           <ca:default title="Default">
313             <ca:value></ca:value>
314           </ca:default>
315           <ca:possvalues type="list" title="Values">
316             <ca:value></ca:value>
317           </ca:possvalues>
318           <ca:description></ca:description>
319         </ca:returnvalue>
320       </ca:returnvalues>
321       <ca:triggeredjsapievents title="JSAPI Triggered Events">
322         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
323         <ca:triggeredjsapievent title="">
324           <ca:name></ca:name>
325           <ca:description></ca:description>
326         </ca:triggeredjsapievent>
327       </ca:triggeredjsapievents>
328     </ca:jsfunction>
329   </ca:jsfunctions>
330   <ca:jsfiles title="JavaScript Files">
331     <ca:jsfile>
332       <ca:name></ca:name>
333       <ca:description></ca:description>
334       <ca:jsvariables title="JavaScript Variables">
335         <ca:jsvariable>
336           <ca:name></ca:name>
337           <ca:type title="Type">
338             <ca:value>string</ca:value>
339           </ca:type>
340           <ca:scope title="Scope">
341             <ca:value>Private</ca:value>
342           </ca:scope>
343           <ca:default title="Default">
344             <ca:value></ca:value>
345           </ca:default>
346           <ca:possvalues type="list" title="Values">
347             <ca:value></ca:value>
348           </ca:possvalues>
349           <ca:description></ca:description>
350         </ca:jsvariable>
351       </ca:jsvariables>
352       <ca:jsfunctions title="JavaScript Functions">
353         <ca:jsfunction>
354           <ca:name></ca:name>
355           <ca:scope title="Scope">
356             <ca:value>Private</ca:value>
357           </ca:scope>
358           <ca:description></ca:description>
359           <ca:parameters title="Parameters">
360             <ca:parameter>
361               <ca:name></ca:name>
362               <ca:type title="Type">
363                 <ca:value>string</ca:value>
364               </ca:type>
365               <ca:required title="Required">
366                 <ca:value>false</ca:value>
367               </ca:required>
368               <ca:default title="Default">
369                 <ca:value></ca:value>
370                 <ca:description></ca:description>
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:parameter>
377           </ca:parameters>
378           <ca:returnvalues title="Function Return Value">
379             <ca:returnvalue>
380               <ca:type title="Type">
381                 <ca:value>unknown</ca:value>
382                 <ca:description></ca:description>
383               </ca:type>
384               <ca:default title="Default">
385                 <ca:value></ca:value>
386               </ca:default>
387               <ca:possvalues type="list" title="Values">
388                 <ca:value></ca:value>
389               </ca:possvalues>
390               <ca:description></ca:description>
391             </ca:returnvalue>
392           </ca:returnvalues>
393           <ca:triggeredjsapievents title="JSAPI Triggered Events">
394             <ca:triggeredjsapievent title="">
395               <ca:name></ca:name>
396               <ca:description></ca:description>
397             </ca:triggeredjsapievent>
398           </ca:triggeredjsapievents>
399         </ca:jsfunction>
400       </ca:jsfunctions>
401     </ca:jsfile>
402   </ca:jsfiles>
403   <ca:listenedjsapievents title="JSAPI Listened Events">
404     <ca:listenedjsapievent title="">
405       <ca:name></ca:name>
406       <ca:description></ca:description>
407       <ca:calledfunctions title="Functions Calls">
408         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
409         <ca:calledfunction>
410           <ca:name></ca:name>
411           <ca:description></ca:description>
412         </ca:calledfunction>
413       </ca:calledfunctions>
414     </ca:listenedjsapievent>
415   </ca:listenedjsapievents>
416   <ca:widgetevents title="Widget Events">
417     <ca:widgetevent>
418       <ca:name></ca:name>
419       <ca:parameters title="Parameters">
420         <ca:parameter>
421           <ca:name></ca:name>
422           <ca:type title="Type">
423             <ca:value>string</ca:value>
424           </ca:type>
425           <ca:required title="Required">
426             <ca:value>false</ca:value>
427           </ca:required>
428           <ca:default title="Default">
429             <ca:value></ca:value>
430             <ca:description></ca:description>
431           </ca:default>
432           <ca:possvalues type="list" title="Values">
433             <ca:value></ca:value>
434           </ca:possvalues>
435           <ca:description></ca:description>
436         </ca:parameter>
437       </ca:parameters>
438       <ca:description></ca:description>
439     </ca:widgetevent>
440   </ca:widgetevents>
441   <ca:errors title="Widget Errors">
442     <ca:error title="Error #1">
443       <ca:type title="Type">
444         <ca:value>PHP Mapscript</ca:value>
445       </ca:type>
446       <ca:severity title="Severity">
447         <ca:value>none</ca:value>
448         <ca:description></ca:description>
449       </ca:severity>
450       <ca:message title="Error Message">
451         <ca:paras title="">
452           <ca:para>Error message string....</ca:para>
453         </ca:paras>
454       </ca:message>
455       <ca:meaning title="Interpretation">
456         <ca:paras title="">
457           <ca:para>The description of what the message means......</ca:para>
458         </ca:paras>
459       </ca:meaning>
460       <ca:solution title="Troubleshooting Tips">
461         <ca:paras title="">
462           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
463         </ca:paras>
464       </ca:solution>
465     </ca:error>
466   </ca:errors>
467 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.