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

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