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

root/Chameleon/trunk/Chameleon/Query/Query.fr-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="UTF-8"?>
2 <ca:widgetdoc xmlns:ca="http://localhost/chameleon/utils/xml/schemas" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://localhost/chameleon/utils/xml/schemas ..\..\..\utils\xml\schemas\chameleon.xsd">
3   <ca:docinfo>
4     <ca:language>
5       <ca:value>fr-ca</ca:value>
6     </ca:language>
7     <ca:docbuilddate>
8       <ca:value>1999-12-31</ca:value>
9     </ca:docbuilddate>
10     <ca:docversion>
11       <ca:value>$id:$</ca:value>
12     </ca:docversion>
13     <ca: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:person>
19     </ca:authors>
20     <ca:editors>
21       <ca:person>
22         <ca:name>Christopher R. Thorne</ca:name>
23         <ca:company>DM Solutions Group Inc.</ca:company>
24         <ca:contact>chameleon@lists.maptools.org</ca:contact>
25       </ca:person>
26     </ca:editors>
27   </ca:docinfo>
28   <ca:identification>
29     <ca:name>
30       <ca:value>Query</ca:value>
31     </ca:name>
32     <ca:chameleonpack>
33       <ca:value>TBD</ca:value>
34     </ca:chameleonpack>
35     <ca:parentgroup>
36       <ca:value>Navigation Widget</ca:value>
37     </ca:parentgroup>
38     <ca:version>
39       <ca:value>1.99</ca:value>
40     </ca:version>
41     <ca:releasedate>
42       <ca:value>1999-12-31</ca:value>
43     </ca:releasedate>
44     <ca:maturitylevel>
45       <ca:value>BETA</ca:value>
46     </ca:maturitylevel>
47     <ca:developers>
48       <ca:person>
49         <ca:name>Paul Spencer</ca:name>
50         <ca:company>DM Solutions Group Inc.</ca:company>
51         <ca:contact>chameleon@lists.maptools.org</ca:contact>
52       </ca:person>
53     </ca:developers>
54   </ca:identification>
55   <ca:descriptions>
56     <ca:description>
57       <ca:paras>
58         <ca:para>If a visible feature (point, line, polygon or raster) found in the map has accessible tabular information, the Query widget returns the query results in a tabular popup window.</ca:para>
59       </ca:paras>
60     </ca:description>
61     <ca:dependancies>
62       <ca:dependancy type="Widget" title="Map Widget">
63         <ca:para>A map widget must be present in the interface for this widget to find possible queriable map features.</ca:para>
64       </ca:dependancy>
65     </ca:dependancies>
66     <ca:sharedresources>
67       <ca:paras title="PopUpCss">
68         <ca:para>The Query widget tag has attributes from the Button Attributes and Popup Attributes groups. This means Query Widget has access to the "TextButtons" and "PopUpCSS" Shared Resources. To learn about them, please refer to the appropriate attribute group section for details.</ca:para>
69       </ca:paras>
70     </ca:sharedresources>
71     <ca:embeddedhelp>
72       <ca:paras>
73         <ca:para>Ce bouton permet d'obtenir de l'information sur les &eacute;l&eacute;ments de la carte. Il permet de consulter les m&eacute;tadonn&eacute;es d'une couche &agrave; une position donn&eacute;e. Pour faire une recherche, s&eacute;lectionnez l'ic&ocirc;ne &laquo;&nbsp;i&nbsp;&raquo; et cliquez sur l'&eacute;l&eacute;ment pour lequel vous d&eacute;sirez obtenir de l'information. Les r&eacute;sultats de la recherche s'afficheront dans une nouvelle fen&ecirc;tre.
74   </ca:para>
75       </ca:paras>
76     </ca:embeddedhelp>
77   </ca:descriptions>
78   <ca:tagstructures>
79     <ca:tagstructure>
80       <ca:description/>
81       <ca:code>
82         <ca:codeblock bold="true">
83           <ca:line>&lt;CWC2 TYPE="Query"</ca:line>
84         </ca:codeblock>
85         <ca:codeblock bold="false">
86           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
87           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
88           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
89           <ca:line/>
90           <ca:line>   &lt;!-- Query Attributes--&gt;</ca:line>
91           <ca:line/>
92           <ca:line>   ALLOWRECTANGLE = "[TRUE|FALSE]"</ca:line>
93           <ca:line>   HIGHLIGHTRESULTS = "[TRUE|FALSE]"</ca:line>
94           <ca:line>   INCLUDEEMPTYRESULTS = "[TRUE|FALSE]"</ca:line>
95           <ca:line>   MAXFEATURES = "[1 &lt; integer]"</ca:line>
96           <ca:line>   PERSISTENTRESULTS = "[TRUE|FALSE]"</ca:line>
97           <ca:line>   POPUPRESULTS = "[TRUE|FALSE]"</ca:line>
98           <ca:line>   RADIUS = "[1 &lt; integer]"</ca:line>
99           <ca:line>   SUBMITPAGE = "[TRUE|FALSE]"</ca:line>
100           <ca:line/>
101           <ca:line>   &lt;!-- Navigation Attributes --&gt;</ca:line>
102           <ca:line/>
103           <ca:line>   CURSORTYPE="[string]"</ca:line>
104           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
105           <ca:line>   MAPID="[string]"</ca:line>
106           <ca:line>   WIDGETSTYLE="[string]"</ca:line>
107           <ca:line/>
108           <ca:line>   &lt;!-- Popup Attribute Group --&gt;</ca:line>
109           <ca:line/>
110         </ca:codeblock>
111         <ca:codeblock bold="true">
112           <ca:line>   POPUPHEIGHT="[0 &lt; integer]" </ca:line>
113           <ca:line>   POPUPWIDTH="[0 &lt; integer]"</ca:line>
114         </ca:codeblock>
115         <ca:codeblock bold="false">
116           <ca:line>   MENUBAR="[TRUE|FALSE]"</ca:line>
117           <ca:line>   POPUPSTYLERESOURCE="[string]"</ca:line>
118           <ca:line>   RESIZABLE="[TRUE|FALSE]"</ca:line>
119           <ca:line>   SCROLLBARS="[TRUE|FALSE]"</ca:line>
120           <ca:line>   STATUS="[TRUE|FALSE]"</ca:line>
121           <ca:line>   TOOLBAR="[TRUE|FALSE]"</ca:line>
122           <ca:line/>
123           <ca:line>   &lt;!-- Button Attribute Group--&gt;</ca:line>
124           <ca:line/>
125           <ca:line>   BACKGROUNDIMAGE="[path]"</ca:line>
126           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
127           <ca:line>   IMAGE="[path]"</ca:line>
128           <ca:line>   IMAGEHEIGHT="[integer]"</ca:line>
129           <ca:line>   IMAGETIP="[string]"</ca:line>
130           <ca:line>   IMAGEWIDTH="[integer]"</ca:line>
131           <ca:line>   LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line>
132           <ca:line>   LABELANTIALIAS="[TRUE|FALSE]"</ca:line>
133           <ca:line>   LABELCOLOR="[#RRGGBB]"</ca:line>
134           <ca:line>   LABELFONT="[string]"</ca:line>
135           <ca:line>   LABELFONTSIZE="[0 &lt; integer]"</ca:line>
136           <ca:line>   ONCLICK="[string]"</ca:line>
137           <ca:line>   STYLERESOURCE="[string]"</ca:line>
138           <ca:line>   TEXTBUTTONBORDER="[path]"</ca:line>
139           <ca:line>   TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line>
140           <ca:line>   TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line>
141           <ca:line>   TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line>
142           <ca:line>   TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line>
143           <ca:line>   TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line>
144           <ca:line>   TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line>
145           <ca:line>   TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line>
146           <ca:line>   TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line>
147           <ca:line>   TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line>
148           <ca:line>   TEXTBUTTONNUDGE="[integer]"</ca:line>
149           <ca:line>   TEXTBUTTONPADDING="[0 &lt; integer]"</ca:line>
150           <ca:line>   TOOLSET="[string]"</ca:line>
151           <ca:line>   USETEXTBUTTONCACHE="[TRUE|FALSE]"&gt;</ca:line>
152           <ca:line/>
153           <ca:line>      &lt;!-- Button Subtag Group --&gt;</ca:line>
154           <ca:line/>
155           <ca:line>      &lt;IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line>
156           <ca:line>         IMAGE="[path]"/&gt;</ca:line>
157         </ca:codeblock>
158         <ca:codeblock bold="true">
159           <ca:line>&lt;CWC2 /&gt;</ca:line>
160         </ca:codeblock>
161       </ca:code>
162     </ca:tagstructure>
163   </ca:tagstructures>
164   <ca:examples>
165     <ca:widgetexamples>
166       <ca:example title="Example #1: Simple">
167         <ca:description>The radius of the query is set to 3 pixels and the number of features to be displayed in the popup table results is set to 5.</ca:description>
168         <ca:code>
169           <ca:codeblock bold="false">
170             <ca:line>&lt;cwc2 type="Query"</ca:line>
171             <ca:line>   visible="true"</ca:line>
172             <ca:line>   image="buttons/button_query_1.png"</ca:line>
173             <ca:line>   radius="3"</ca:line>
174             <ca:line>   maxfeatures="5"/&gt;</ca:line>
175           </ca:codeblock>
176         </ca:code>
177       </ca:example>
178       <ca:example title="Example #2: Advanced">
179         <ca:description>This example shows how the Query widget will use a "TextButtons" Shared Resource called "NavigationButtons" with three possible image states.</ca:description>
180         <ca:code>
181           <ca:codeblock bold="false">
182             <ca:line>&lt;cwc2 type="Query"</ca:line>
183             <ca:line>   visible="true"</ca:line>
184             <ca:line>   imagetip="Identify Feature"</ca:line>
185             <ca:line>   image="icons/query_icon.png"</ca:line>
186             <ca:line>   styleresource="NavigationButtons"</ca:line>
187             <ca:line>   popupwidth="500"</ca:line>
188             <ca:line>   popupheight="600"</ca:line>
189             <ca:line>   radius="3"</ca:line>
190             <ca:line>   maxfeatures="5"&gt;</ca:line>
191             <ca:line>      &lt;image state="normal" /&gt;</ca:line>
192             <ca:line>      &lt;image state="hover" /&gt;</ca:line>
193             <ca:line>      &lt;image state="selected" /&gt;</ca:line>
194             <ca:line>&lt;/cwc2&gt;</ca:line>
195           </ca:codeblock>
196         </ca:code>
197       </ca:example>
198       <ca:example title="Example #3: Advanced">
199         <ca:description>This Query example shows how the widget could be defined without using a Shared Resource. Note that this tool is linked to a group of button-based navigation widgets using the TOOLSET attribute. This means that if Query is selected, it will remain active until you select another tool within that tool group.</ca:description>
200         <ca:code>
201           <ca:codeblock bold="false">
202             <ca:line>&lt;cwc2 type="Query"</ca:line>
203             <ca:line>   visible="true"</ca:line>
204             <ca:line>   imagetip="Identify Feature"</ca:line>
205             <ca:line>   toolset="Navigation"</ca:line>
206             <ca:line>   imagewidth="24"</ca:line>
207             <ca:line>   imageheight="24"</ca:line>
208             <ca:line>   popupwidth="500"</ca:line>
209             <ca:line>   popupheight="600"</ca:line>
210             <ca:line>   toolbar="false"</ca:line>
211             <ca:line>   status="false"</ca:line>
212             <ca:line>   menubar="false"</ca:line>
213             <ca:line>   radius="3"</ca:line>
214             <ca:line>   maxfeatures="5"&gt;</ca:line>
215             <ca:line>      &lt;image state="normal"</ca:line>
216             <ca:line>         image="buttons/button_query_1.png"/&gt;</ca:line>
217             <ca:line>      &lt;image state="hover"</ca:line>
218             <ca:line>         image="buttons/button_query_2.png"/&gt;</ca:line>
219             <ca:line>      &lt;image state="selected"</ca:line>
220             <ca:line>         image="buttons/button_query_3.png"/&gt;</ca:line>
221             <ca:line>&lt;/cwc2&gt;</ca:line>
222           </ca:codeblock>
223         </ca:code>
224       </ca:example>
225     </ca:widgetexamples>
226     <ca:sampleapps>
227       <ca:sampleapp>
228         <ca:name>Hawaii Demo</ca:name>
229         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
230         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
231       </ca:sampleapp>
232     </ca:sampleapps>
233     <ca:scriptexamples/>
234   </ca:examples>
235   <ca:attributegroups>
236     <ca:attributegroup>
237       <ca:name>Base</ca:name>
238       <ca:name>Button</ca:name>
239       <ca:name>NavTool</ca:name>
240       <ca:name>Popup</ca:name>
241     </ca:attributegroup>
242   </ca:attributegroups>
243   <ca:widgettag>
244     <ca:attribute>
245       <ca:name>ALLOWRECTANGLE</ca:name>
246       <ca:type>
247         <ca:value>boolean</ca:value>
248       </ca:type>
249       <ca:class>
250         <ca:value>Widget Only</ca:value>
251       </ca:class>
252       <ca:default>
253         <ca:value>false</ca:value>
254         <ca:description/>
255       </ca:default>
256       <ca:possvalues type="list">
257         <ca:value>true</ca:value>
258         <ca:value>false</ca:value>
259       </ca:possvalues>
260       <ca:description/>
261     </ca:attribute>
262     <ca:attribute>
263       <ca:name>HIGHLIGHTRESULTS</ca:name>
264       <ca:type>
265         <ca:value>boolean</ca:value>
266       </ca:type>
267       <ca:class>
268         <ca:value>Widget Only</ca:value>
269       </ca:class>
270       <ca:default>
271         <ca:value>false</ca:value>
272         <ca:description/>
273       </ca:default>
274       <ca:possvalues type="list">
275         <ca:value>true</ca:value>
276         <ca:value>false</ca:value>
277       </ca:possvalues>
278       <ca:description/>
279     </ca:attribute>
280     <ca:attribute>
281       <ca:name>INCLUDEEMPTYRESULTS</ca:name>
282       <ca:type>
283         <ca:value>boolean</ca:value>
284       </ca:type>
285       <ca:class>
286         <ca:value>Widget Only</ca:value>
287       </ca:class>
288       <ca:default>
289         <ca:value>false</ca:value>
290         <ca:description/>
291       </ca:default>
292       <ca:possvalues type="list">
293         <ca:value>true</ca:value>
294         <ca:value>false</ca:value>
295       </ca:possvalues>
296       <ca:description>If set to "TRUE", output a message when no search results are found.</ca:description>
297     </ca:attribute>
298     <ca:attribute>
299       <ca:name>MAXFEATURES</ca:name>
300       <ca:type>
301         <ca:value>integer</ca:value>
302       </ca:type>
303       <ca:class>
304         <ca:value>Widget Only</ca:value>
305       </ca:class>
306       <ca:default>
307         <ca:value>5</ca:value>
308         <ca:description>records</ca:description>
309       </ca:default>
310       <ca:possvalues type="range">
311         <ca:minimum>1</ca:minimum>
312         <ca:maximum>2147483647</ca:maximum>
313       </ca:possvalues>
314       <ca:description>The number of features to limit a GetFeatureInfo response to. This is the limit for each layer; it is not cumulative. This is a CubeWerx-specific extension to the WMS GetFeatureInfo request and may not be supported by all servers, although most should at least ignore it.</ca:description>
315     </ca:attribute>
316     <ca:attribute>
317       <ca:name>PERSISTENTRESULTS</ca:name>
318       <ca:type>
319         <ca:value>boolean</ca:value>
320       </ca:type>
321       <ca:class>
322         <ca:value>Widget Only</ca:value>
323       </ca:class>
324       <ca:default>
325         <ca:value>false</ca:value>
326         <ca:description/>
327       </ca:default>
328       <ca:possvalues type="list">
329         <ca:value>true</ca:value>
330         <ca:value>false</ca:value>
331       </ca:possvalues>
332       <ca:description/>
333     </ca:attribute>
334     <ca:attribute>
335       <ca:name>POPUPRESULTS</ca:name>
336       <ca:type>
337         <ca:value>boolean</ca:value>
338       </ca:type>
339       <ca:class>
340         <ca:value>Widget Only</ca:value>
341       </ca:class>
342       <ca:default>
343         <ca:value>false</ca:value>
344         <ca:description/>
345       </ca:default>
346       <ca:possvalues type="list">
347         <ca:value>true</ca:value>
348         <ca:value>false</ca:value>
349       </ca:possvalues>
350       <ca:description/>
351     </ca:attribute>
352     <ca:attribute>
353       <ca:name>RADIUS</ca:name>
354       <ca:type>
355         <ca:value>integer</ca:value>
356       </ca:type>
357       <ca:class>
358         <ca:value>Widget Only</ca:value>
359       </ca:class>
360       <ca:default>
361         <ca:value>3</ca:value>
362         <ca:description>pixel width</ca:description>
363       </ca:default>
364       <ca:possvalues type="range">
365         <ca:minimum>1</ca:minimum>
366         <ca:maximum>2147483647</ca:maximum>
367       </ca:possvalues>
368       <ca:description>The number of pixels to search around the clicked location for features. This is a CubeWerx-specific extension to the current WMS GetFeatureInfo request and may not be supported by all servers, although most should at least ignore it.</ca:description>
369     </ca:attribute>
370     <ca:attribute>
371       <ca:name>SUBMITPAGE</ca:name>
372       <ca:type>
373         <ca:value>boolean</ca:value>
374       </ca:type>
375       <ca:class>
376         <ca:value>Widget Only</ca:value>
377       </ca:class>
378       <ca:default>
379         <ca:value>false</ca:value>
380         <ca:description/>
381       </ca:default>
382       <ca:possvalues type="list">
383         <ca:value>true</ca:value>
384         <ca:value>false</ca:value>
385       </ca:possvalues>
386       <ca:description/>
387     </ca:attribute>
388   </ca:widgettag>
389   <ca:formelements>
390     <ca:formelement>
391       <ca:name>NAV_CMD</ca:name>
392       <ca:type>
393         <ca:value>unknown</ca:value>
394       </ca:type>
395       <ca:description/>
396     </ca:formelement>
397     <ca:formelement>
398       <ca:name>NAV_ALLOW_RECTANGLE</ca:name>
399       <ca:type>
400         <ca:value>unknown</ca:value>
401       </ca:type>
402       <ca:description/>
403     </ca:formelement>
404   </ca:formelements>
405   <ca:jsfunctions>
406     <ca:jsfunction>
407       <ca:name>NavSetActiveTool</ca:name>
408       <ca:scope>
409         <ca:value>Private</ca:value>
410       </ca:scope>
411       <ca:description/>
412       <ca:parameters>
413         <ca:parameter>
414           <ca:name>oButton</ca:name>
415           <ca:type>
416             <ca:value>unknown</ca:value>
417           </ca:type>
418           <ca:required>
419             <ca:value>true</ca:value>
420           </ca:required>
421           <ca:description/>
422         </ca:parameter>
423         <ca:parameter>
424           <ca:name>aVals</ca:name>
425           <ca:type>
426             <ca:value>unknown</ca:value>
427           </ca:type>
428           <ca:required>
429             <ca:value>true</ca:value>
430           </ca:required>
431           <ca:description/>
432         </ca:parameter>
433       </ca:parameters>
434     </ca:jsfunction>
435     <ca:jsfunction>
436       <ca:name>QueryWMouseClick</ca:name>
437       <ca:scope>
438         <ca:value>Private</ca:value>
439       </ca:scope>
440       <ca:description/>
441       <ca:parameters>
442         <ca:parameter>
443           <ca:name>e</ca:name>
444           <ca:type>
445             <ca:value>unknown</ca:value>
446           </ca:type>
447           <ca:required>
448             <ca:value>true</ca:value>
449           </ca:required>
450           <ca:description/>
451         </ca:parameter>
452       </ca:parameters>
453     </ca:jsfunction>
454     <ca:jsfunction>
455       <ca:name>QueryWMouseMove</ca:name>
456       <ca:scope>
457         <ca:value>Private</ca:value>
458       </ca:scope>
459       <ca:description/>
460       <ca:parameters>
461         <ca:parameter>
462           <ca:name>e</ca:name>
463           <ca:type>
464             <ca:value>unknown</ca:value>
465           </ca:type>
466           <ca:required>
467             <ca:value>true</ca:value>
468           </ca:required>
469           <ca:description/>
470         </ca:parameter>
471       </ca:parameters>
472     </ca:jsfunction>
473   </ca:jsfunctions>
474 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.