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

root/Chameleon/trunk/Chameleon/ClearWFSFilter/ClearWFSFilter.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>clearwfsfilter</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 ClearWFSFilter widget clears the WFS filter from the active layer and deletes
62 the temporary annotation layer.</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="">
82         <ca:para>This button provides the capability to clear a WFS filter expression from the all "selected" layers.  To use it, click on the clear WFS filter icon and a confirmation dialog box will popup.  Click OK to clear the fiilter(s) if present or cancel to abort.</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:attributegroup>
153   </ca:attributegroups>
154   <ca:widgettag title="Attributes">
155     <ca:subtag>
156       <ca:name></ca:name>
157       <ca:type title="Type">
158         <ca:value>XML</ca:value>
159         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
160       </ca:type>
161       <ca:class title="Class">
162         <ca:value>Widget &amp; Shared Resource</ca:value>
163       </ca:class>
164       <ca:description></ca:description>
165       <ca:attribute>
166         <ca:name></ca:name>
167         <ca:type title="Type">
168           <ca:value>float</ca:value>
169           <ca:description></ca:description>
170         </ca:type>
171         <ca:class title="Class">
172           <ca:value>Widget &amp; Shared Resource</ca:value>
173         </ca:class>
174         <ca:default title="Default">
175           <ca:value></ca:value>
176           <ca:description></ca:description>
177         </ca:default>
178         <ca:possvalues type="list" title="Value">
179           <ca:value></ca:value>
180         </ca:possvalues>
181         <ca:description></ca:description>
182       </ca:attribute>
183     </ca:subtag>
184   </ca:widgettag>
185   <ca:formelements title="Form Elements">
186     <ca:formelement>
187       <ca:name>WFS_CLEAR_FILTER</ca:name>
188       <ca:type title="Type">
189         <ca:value>unknown</ca:value>
190         <ca:description></ca:description>
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>Flag to trigger a clear filter action.</ca:description>
200     </ca:formelement>
201     <ca:formelement>
202       <ca:name>WFS_CLEAR_FILTER_ISSET</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></ca:description>
215     </ca:formelement>
216   </ca:formelements>
217   <ca:jsvariables title="JavaScript Variables"/>
218   <ca:jsfunctions title="JavaScript Functions">
219  
220     <ca:jsfunction>
221       <ca:name>clickClearWFSFilter</ca:name>
222       <ca:scope title="Scope">
223         <ca:value>Private</ca:value>
224       </ca:scope>
225       <ca:description>Clears the current WFS filter on the selected layer.</ca:description>
226       <ca:returnvalues title="Function Return Value">
227         <ca:returnvalue>
228           <ca:type title="Type">
229             <ca:value>unknown</ca:value>
230             <ca:description></ca:description>
231           </ca:type>
232           <ca:default title="Default">
233             <ca:value></ca:value>
234           </ca:default>
235           <ca:possvalues type="list" title="Values">
236             <ca:value></ca:value>
237           </ca:possvalues>
238           <ca:description></ca:description>
239         </ca:returnvalue>
240       </ca:returnvalues>
241       <ca:triggeredjsapievents title="JSAPI Triggered Events">
242         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
243         <ca:triggeredjsapievent title="">
244           <ca:name></ca:name>
245           <ca:description></ca:description>
246         </ca:triggeredjsapievent>
247       </ca:triggeredjsapievents>
248     </ca:jsfunction>
249   </ca:jsfunctions>
250  
251   <ca:jsfiles title="JavaScript Files">
252     <ca:jsfile>
253       <ca:name></ca:name>
254       <ca:description></ca:description>
255       <ca:jsvariables title="JavaScript Variables">
256         <ca:jsvariable>
257           <ca:name></ca:name>
258           <ca:type title="Type">
259             <ca:value>string</ca:value>
260           </ca:type>
261           <ca:scope title="Scope">
262             <ca:value>Private</ca:value>
263           </ca:scope>
264           <ca:default title="Default">
265             <ca:value></ca:value>
266           </ca:default>
267           <ca:possvalues type="list" title="Values">
268             <ca:value></ca:value>
269           </ca:possvalues>
270           <ca:description></ca:description>
271         </ca:jsvariable>
272       </ca:jsvariables>
273       <ca:jsfunctions title="JavaScript Functions">
274         <ca:jsfunction>
275           <ca:name></ca:name>
276           <ca:scope title="Scope">
277             <ca:value>Private</ca:value>
278           </ca:scope>
279           <ca:description></ca:description>
280           <ca:parameters title="Parameters">
281             <ca:parameter>
282               <ca:name></ca:name>
283               <ca:type title="Type">
284                 <ca:value>string</ca:value>
285               </ca:type>
286               <ca:required title="Required">
287                 <ca:value>false</ca:value>
288               </ca:required>
289               <ca:default title="Default">
290                 <ca:value></ca:value>
291                 <ca:description></ca:description>
292               </ca:default>
293               <ca:possvalues type="list" title="Values">
294                 <ca:value></ca:value>
295               </ca:possvalues>
296               <ca:description></ca:description>
297             </ca:parameter>
298           </ca:parameters>
299           <ca:returnvalues title="Function Return Value">
300             <ca:returnvalue>
301               <ca:type title="Type">
302                 <ca:value>unknown</ca:value>
303                 <ca:description></ca:description>
304               </ca:type>
305               <ca:default title="Default">
306                 <ca:value></ca:value>
307               </ca:default>
308               <ca:possvalues type="list" title="Values">
309                 <ca:value></ca:value>
310               </ca:possvalues>
311               <ca:description></ca:description>
312             </ca:returnvalue>
313           </ca:returnvalues>
314           <ca:triggeredjsapievents title="JSAPI Triggered Events">
315             <ca:triggeredjsapievent title="">
316               <ca:name></ca:name>
317               <ca:description></ca:description>
318             </ca:triggeredjsapievent>
319           </ca:triggeredjsapievents>
320         </ca:jsfunction>
321       </ca:jsfunctions>
322     </ca:jsfile>
323   </ca:jsfiles>
324   <ca:listenedjsapievents title="JSAPI Listened Events">
325     <ca:listenedjsapievent title="">
326       <ca:name></ca:name>
327       <ca:description></ca:description>
328       <ca:calledfunctions title="Functions Calls">
329         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
330         <ca:calledfunction>
331           <ca:name></ca:name>
332           <ca:description></ca:description>
333         </ca:calledfunction>
334       </ca:calledfunctions>
335     </ca:listenedjsapievent>
336   </ca:listenedjsapievents>
337   <ca:widgetevents title="Widget Events">
338     <ca:widgetevent>
339       <ca:name></ca:name>
340       <ca:parameters title="Parameters">
341         <ca:parameter>
342           <ca:name></ca:name>
343           <ca:type title="Type">
344             <ca:value>string</ca:value>
345           </ca:type>
346           <ca:required title="Required">
347             <ca:value>false</ca:value>
348           </ca:required>
349           <ca:default title="Default">
350             <ca:value></ca:value>
351             <ca:description></ca:description>
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:parameter>
358       </ca:parameters>
359       <ca:description></ca:description>
360     </ca:widgetevent>
361   </ca:widgetevents>
362   <ca:errors title="Widget Errors">
363     <ca:error title="Error #1">
364       <ca:type title="Type">
365         <ca:value>PHP Mapscript</ca:value>
366       </ca:type>
367       <ca:severity title="Severity">
368         <ca:value>none</ca:value>
369         <ca:description></ca:description>
370       </ca:severity>
371       <ca:message title="Error Message">
372         <ca:paras title="">
373           <ca:para>Error message string....</ca:para>
374         </ca:paras>
375       </ca:message>
376       <ca:meaning title="Interpretation">
377         <ca:paras title="">
378           <ca:para>The description of what the message means......</ca:para>
379         </ca:paras>
380       </ca:meaning>
381       <ca:solution title="Troubleshooting Tips">
382         <ca:paras title="">
383           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
384         </ca:paras>
385       </ca:solution>
386     </ca:error>
387   </ca:errors>
388 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.