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

root/Chameleon/trunk/Chameleon/ScaleZoom/ScaleZoom.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>scalezoom</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 ScaleZoom widget displays a series of preset scale buttons that the user
62 can use to quickly zoom in or out at predefined intervals.  The intermediate
63 scales are defined using sub-tags as follows: &lt;ZOOMVALUE SCALE="42000000"
64 IMAGE="images/zoom_h_1.gif" IMAGEWIDTH="14" IMAGEHEIGHT="22"/&gt;.  Any number
65 of zoomvalues are allowed, but there is likely a practical limit depending on
66 the images used.</ca:para>
67       </ca:paras>
68     </ca:description>
69     <ca:techrequirements title="Technical Requirements">
70       <ca:paras title="Not Available">
71         <ca:para></ca:para>
72       </ca:paras>
73     </ca:techrequirements>
74     <ca:dependancies title="Dependancies">
75       <ca:dependancy type="None" title="Not Available">
76         <ca:para></ca:para>
77       </ca:dependancy>
78     </ca:dependancies>
79     <ca:sharedresources title="Shared Resources">
80       <ca:paras title="Not Available">
81         <ca:para></ca:para>
82       </ca:paras>
83     </ca:sharedresources>
84     <ca:embeddedhelp title="General User Interface Help">
85       <ca:paras title="">
86         <ca:para>These buttons provide the capability to quickly zoom the
87   map to a pre-defined scale value at the current center of the map view. The
88   scale values available are determined by the application designer. To change
89   to a new scale, click the appropriate Scale Zoom button.</ca:para>
90       </ca:paras>
91     </ca:embeddedhelp>
92     <ca:guinotes title="Interface Functionality">
93       <ca:guinote type="None" title="None.">
94         <ca:para></ca:para>
95       </ca:guinote>
96     </ca:guinotes>
97     <ca:qanotes title="Quality Assurance">
98       <ca:paras title="None.">
99         <ca:para></ca:para>
100       </ca:paras>
101     </ca:qanotes>
102   </ca:descriptions>
103   <ca:tagstructures title="Tag Syntax">
104     <ca:tagstructure title="Widget Syntax">
105       <ca:description></ca:description>
106       <ca:code title="">
107         <ca:description></ca:description>
108         <ca:codeblock bold="false">
109           <ca:line>   WIDGETSTYLE ="[string]"</ca:line>
110           <ca:line>   MAPID ="[string]"</ca:line>
111           <ca:line>   INCREASEIMAGE ="[string]"</ca:line>
112           <ca:line>   DECREASEIMAGE ="[string]"</ca:line>
113           <ca:line>   INCREASETO ="[integer]"</ca:line>
114           <ca:line>   DECREASETO ="[integer]"</ca:line>
115           <ca:line>   ORIENTATION ="[string]"</ca:line>
116           <ca:line>   CURRENTIMAGE ="[string]"</ca:line>
117           <ca:line>   PUTTABLETAGS ="[boolean]"</ca:line>
118         </ca:codeblock>
119       </ca:code>
120     </ca:tagstructure>
121   </ca:tagstructures>
122   <ca:examples title="Examples">
123     <ca:widgetexamples title="Widget Examples">
124       <ca:example title="Example #1: Simple">
125         <ca:description></ca:description>
126         <ca:code title="">
127           <ca:description></ca:description>
128           <ca:codeblock bold="false">
129             <ca:line></ca:line>
130           </ca:codeblock>
131         </ca:code>
132       </ca:example>
133     </ca:widgetexamples>
134     <ca:sharedresourceexamples title="Shared Resources Examples">
135       <ca:example title="Example #1: Advanced">
136         <ca:description></ca:description>
137         <ca:code title="">
138           <ca:description></ca:description>
139           <ca:codeblock bold="false">
140             <ca:line></ca:line>
141           </ca:codeblock>
142         </ca:code>
143       </ca:example>
144     </ca:sharedresourceexamples>
145     <ca:sampleapps title="Sample Applications">
146       <ca:sampleapp>
147         <ca:name>Hawaii Demo</ca:name>
148         <ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl>
149         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
150       </ca:sampleapp>
151     </ca:sampleapps>
152     <ca:scriptexamples title="Script Examples">
153       <ca:example title="Example #1: Simple">
154         <ca:description></ca:description>
155         <ca:code title="">
156           <ca:description></ca:description>
157           <ca:codeblock bold="false">
158             <ca:line></ca:line>
159           </ca:codeblock>
160         </ca:code>
161       </ca:example>
162     </ca:scriptexamples>
163   </ca:examples>
164   <ca:attributegroups title="Attribute Groups">
165     <ca:description></ca:description>
166     <ca:attributegroup>
167       <ca:name>base</ca:name>
168       <ca:name>button</ca:name>
169     </ca:attributegroup>
170   </ca:attributegroups>
171   <ca:widgettag title="Attributes">
172     <ca:attribute>
173       <ca:name>WIDGETSTYLE</ca:name>
174       <ca:type title="Type">
175         <ca:value>string</ca:value>
176       </ca:type>
177       <ca:class title="Class">
178         <ca:value>Widget Only</ca:value>
179       </ca:class>
180       <ca:default title="Default">
181         <ca:description></ca:description>
182       </ca:default>
183       <ca:description>The CSS style to apply to this widget.</ca:description>
184     </ca:attribute>
185     <ca:attribute>
186       <ca:name>MAPID</ca:name>
187       <ca:type title="Type">
188         <ca:value>string</ca:value>
189       </ca:type>
190       <ca:class title="Class">
191         <ca:value>Widget Only</ca:value>
192       </ca:class>
193       <ca:default title="Default">
194         <ca:description></ca:description>
195       </ca:default>
196       <ca:description>The ID of the map to which this widget should apply its navigation.</ca:description>
197     </ca:attribute>
198     <ca:attribute>
199       <ca:name>INCREASEIMAGE</ca:name>
200       <ca:type title="Type">
201         <ca:value>string</ca:value>
202       </ca:type>
203       <ca:class title="Class">
204         <ca:value>Widget Only</ca:value>
205       </ca:class>
206       <ca:default title="Default">
207         <ca:description></ca:description>
208       </ca:default>
209       <ca:description>The image to use for the scale zoom increase button.</ca:description>
210     </ca:attribute>
211     <ca:attribute>
212       <ca:name>DECREASEIMAGE</ca:name>
213       <ca:type title="Type">
214         <ca:value>string</ca:value>
215       </ca:type>
216       <ca:class title="Class">
217         <ca:value>Widget Only</ca:value>
218       </ca:class>
219       <ca:default title="Default">
220         <ca:description></ca:description>
221       </ca:default>
222       <ca:description>The image to use for the scale zoom decrease button.</ca:description>
223     </ca:attribute>
224     <ca:attribute>
225       <ca:name>INCREASETO</ca:name>
226       <ca:type title="Type">
227         <ca:value>integer</ca:value>
228         <ca:description></ca:description>
229       </ca:type>
230       <ca:class title="Class">
231         <ca:value>Widget Only</ca:value>
232       </ca:class>
233       <ca:default title="Default">
234         <ca:description></ca:description>
235       </ca:default>
236       <ca:possvalues type="range" title="Value">
237         <ca:minimum>-2147483647</ca:minimum>
238         <ca:maximum>2147483647</ca:maximum>
239       </ca:possvalues>
240     </ca:attribute>
241     <ca:attribute>
242       <ca:name>DECREASETO</ca:name>
243       <ca:type title="Type">
244         <ca:value>integer</ca:value>
245         <ca:description></ca:description>
246       </ca:type>
247       <ca:class title="Class">
248         <ca:value>Widget Only</ca:value>
249       </ca:class>
250       <ca:default title="Default">
251         <ca:description></ca:description>
252       </ca:default>
253       <ca:possvalues type="range" title="Value">
254         <ca:minimum>-2147483647</ca:minimum>
255         <ca:maximum>2147483647</ca:maximum>
256       </ca:possvalues>
257     </ca:attribute>
258     <ca:attribute>
259       <ca:name>ORIENTATION</ca:name>
260       <ca:type title="Type">
261         <ca:value>string</ca:value>
262         <ca:description></ca:description>
263       </ca:type>
264       <ca:class title="Class">
265         <ca:value>Widget Only</ca:value>
266       </ca:class>
267       <ca:default title="Default">
268         <ca:description></ca:description>
269       </ca:default>
270       <ca:possvalues type="list" title="Value">
271         <ca:value>HORIZONTAL</ca:value>
272         <ca:value>VERTICAL</ca:value>
273       </ca:possvalues>
274     </ca:attribute>
275     <ca:attribute>
276       <ca:name>CURRENTIMAGE</ca:name>
277       <ca:type title="Type">
278         <ca:value>string</ca:value>
279         <ca:description></ca:description>
280       </ca:type>
281       <ca:class title="Class">
282         <ca:value>Widget Only</ca:value>
283       </ca:class>
284       <ca:default title="Default">
285         <ca:description></ca:description>
286       </ca:default>
287     </ca:attribute>
288     <ca:attribute>
289       <ca:name>PUTTABLETAGS</ca:name>
290       <ca:type title="Type">
291         <ca:value>boolean</ca:value>
292         <ca:description></ca:description>
293       </ca:type>
294       <ca:class title="Class">
295         <ca:value>Widget Only</ca:value>
296       </ca:class>
297       <ca:default title="Default">
298         <ca:description></ca:description>
299       </ca:default>
300       <ca:possvalues type="list" title="Value">
301         <ca:value>true</ca:value>
302         <ca:value>false</ca:value>
303       </ca:possvalues>
304     </ca:attribute>
305     <ca:subtag>
306       <ca:name></ca:name>
307       <ca:type title="Type">
308         <ca:value>XML</ca:value>
309         <ca:description>Child Element to Chameleon widget tag (subtag)</ca:description>
310       </ca:type>
311       <ca:class title="Class">
312         <ca:value>Widget &amp; Shared Resource</ca:value>
313       </ca:class>
314       <ca:description></ca:description>
315       <ca:attribute>
316         <ca:name></ca:name>
317         <ca:type title="Type">
318           <ca:value>float</ca:value>
319           <ca:description></ca:description>
320         </ca:type>
321         <ca:class title="Class">
322           <ca:value>Widget &amp; Shared Resource</ca:value>
323         </ca:class>
324         <ca:default title="Default">
325           <ca:value></ca:value>
326           <ca:description></ca:description>
327         </ca:default>
328         <ca:possvalues type="list" title="Value">
329           <ca:value></ca:value>
330         </ca:possvalues>
331         <ca:description></ca:description>
332       </ca:attribute>
333     </ca:subtag>
334   </ca:widgettag>
335   <ca:formelements title="Form Elements">
336     <ca:formelement>
337       <ca:name>NAV_CMD</ca:name>
338       <ca:type title="Type">
339         <ca:value>unknown</ca:value>
340       </ca:type>
341       <ca:default title="Default">
342         <ca:value></ca:value>
343         <ca:description></ca:description>
344       </ca:default>
345       <ca:possvalues type="list" title="Values">
346         <ca:value></ca:value>
347       </ca:possvalues>
348       <ca:description>The last command that was used to interact with the map</ca:description>
349     </ca:formelement>
350     <ca:formelement>
351       <ca:name>NAV_ALLOW_RECTANGLE</ca:name>
352       <ca:type title="Type">
353         <ca:value>unknown</ca:value>
354         <ca:description></ca:description>
355       </ca:type>
356       <ca:default title="Default">
357         <ca:value></ca:value>
358         <ca:description></ca:description>
359       </ca:default>
360       <ca:possvalues type="list" title="Values">
361         <ca:value></ca:value>
362       </ca:possvalues>
363       <ca:description>Tracks whether the current navigation tool uses a rubber-banding box or not.</ca:description>
364     </ca:formelement>
365     <ca:formelement>
366       <ca:name>SCALE_ZOOM</ca:name>
367       <ca:type title="Type">
368         <ca:value>unknown</ca:value>
369         <ca:description></ca:description>
370       </ca:type>
371       <ca:default title="Default">
372         <ca:value></ca:value>
373         <ca:description></ca:description>
374       </ca:default>
375       <ca:possvalues type="list" title="Values">
376         <ca:value></ca:value>
377       </ca:possvalues>
378       <ca:description>the scale to zoom to if the user changes the scale value and updates the map</ca:description>
379     </ca:formelement>
380   </ca:formelements>
381   <ca:jsvariables title="JavaScript Variables"/>
382   <ca:jsfunctions title="JavaScript Functions">
383     <ca:jsfunction>
384       <ca:name>NavSetActiveTool</ca:name>
385       <ca:scope title="Scope">
386         <ca:value>Private</ca:value>
387       </ca:scope>
388       <ca:description>set the active navigation tool for a particular group of tools</ca:description>
389       <ca:parameters title="Parameters">
390         <ca:parameter>
391           <ca:name>oButton</ca:name>
392           <ca:type title="Type">
393             <ca:value>string</ca:value>
394           </ca:type>
395           <ca:default title="Default">
396             <ca:value></ca:value>
397             <ca:description></ca:description>
398           </ca:default>
399           <ca:possvalues type="list" title="Values">
400             <ca:value></ca:value>
401           </ca:possvalues>
402           <ca:description></ca:description>
403         </ca:parameter>
404         <ca:parameter>
405           <ca:name>aVals</ca:name>
406           <ca:type title="Type">
407             <ca:value>string</ca:value>
408           </ca:type>
409           <ca:default title="Default">
410             <ca:value></ca:value>
411             <ca:description></ca:description>
412           </ca:default>
413           <ca:possvalues type="list" title="Values">
414             <ca:value></ca:value>
415           </ca:possvalues>
416           <ca:description></ca:description>
417         </ca:parameter>
418       </ca:parameters>
419       <ca:returnvalues title="Function Return Value">
420         <ca:returnvalue>
421           <ca:type title="Type">
422             <ca:value>unknown</ca:value>
423             <ca:description></ca:description>
424           </ca:type>
425           <ca:default title="Default">
426             <ca:value></ca:value>
427           </ca:default>
428           <ca:possvalues type="list" title="Values">
429             <ca:value></ca:value>
430           </ca:possvalues>
431           <ca:description></ca:description>
432         </ca:returnvalue>
433       </ca:returnvalues>
434       <ca:triggeredjsapievents title="JSAPI Triggered Events">
435         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
436         <ca:triggeredjsapievent title="">
437           <ca:name></ca:name>
438           <ca:description></ca:description>
439         </ca:triggeredjsapievent>
440       </ca:triggeredjsapievents>
441     </ca:jsfunction>
442     <ca:jsfunction>
443       <ca:name>clickScaleValue</ca:name>
444       <ca:scope title="Scope">
445         <ca:value>Private</ca:value>
446       </ca:scope>
447       <ca:description></ca:description>
448       <ca:parameters title="Parameters">
449         <ca:parameter>
450           <ca:name>szScale</ca:name>
451           <ca:type title="Type">
452             <ca:value>string</ca:value>
453           </ca:type>
454           <ca:default title="Default">
455             <ca:value></ca:value>
456             <ca:description></ca:description>
457           </ca:default>
458           <ca:possvalues type="list" title="Values">
459             <ca:value></ca:value>
460           </ca:possvalues>
461           <ca:description></ca:description>
462         </ca:parameter>
463       </ca:parameters>
464       <ca:returnvalues title="Function Return Value">
465         <ca:returnvalue>
466           <ca:type title="Type">
467             <ca:value>unknown</ca:value>
468             <ca:description></ca:description>
469           </ca:type>
470           <ca:default title="Default">
471             <ca:value></ca:value>
472           </ca:default>
473           <ca:possvalues type="list" title="Values">
474             <ca:value></ca:value>
475           </ca:possvalues>
476           <ca:description></ca:description>
477         </ca:returnvalue>
478       </ca:returnvalues>
479       <ca:triggeredjsapievents title="JSAPI Triggered Events">
480         <ca:intro>Describe the JS functions (if any) that define or rather trigger events through the Chameleon JSAPI.</ca:intro>
481         <ca:triggeredjsapievent title="">
482           <ca:name></ca:name>
483           <ca:description></ca:description>
484         </ca:triggeredjsapievent>
485       </ca:triggeredjsapievents>
486     </ca:jsfunction>
487   </ca:jsfunctions>
488   <ca:jsfiles title="JavaScript Files">
489     <ca:jsfile>
490       <ca:name></ca:name>
491       <ca:description></ca:description>
492       <ca:jsvariables title="JavaScript Variables">
493         <ca:jsvariable>
494           <ca:name></ca:name>
495           <ca:type title="Type">
496             <ca:value>string</ca:value>
497           </ca:type>
498           <ca:scope title="Scope">
499             <ca:value>Private</ca:value>
500           </ca:scope>
501           <ca:default title="Default">
502             <ca:value></ca:value>
503           </ca:default>
504           <ca:possvalues type="list" title="Values">
505             <ca:value></ca:value>
506           </ca:possvalues>
507           <ca:description></ca:description>
508         </ca:jsvariable>
509       </ca:jsvariables>
510       <ca:jsfunctions title="JavaScript Functions">
511         <ca:jsfunction>
512           <ca:name></ca:name>
513           <ca:scope title="Scope">
514             <ca:value>Private</ca:value>
515           </ca:scope>
516           <ca:description></ca:description>
517           <ca:parameters title="Parameters">
518             <ca:parameter>
519               <ca:name></ca:name>
520               <ca:type title="Type">
521                 <ca:value>string</ca:value>
522               </ca:type>
523               <ca:required title="Required">
524                 <ca:value>false</ca:value>
525               </ca:required>
526               <ca:default title="Default">
527                 <ca:value></ca:value>
528                 <ca:description></ca:description>
529               </ca:default>
530               <ca:possvalues type="list" title="Values">
531                 <ca:value></ca:value>
532               </ca:possvalues>
533               <ca:description></ca:description>
534             </ca:parameter>
535           </ca:parameters>
536           <ca:returnvalues title="Function Return Value">
537             <ca:returnvalue>
538               <ca:type title="Type">
539                 <ca:value>unknown</ca:value>
540                 <ca:description></ca:description>
541               </ca:type>
542               <ca:default title="Default">
543                 <ca:value></ca:value>
544               </ca:default>
545               <ca:possvalues type="list" title="Values">
546                 <ca:value></ca:value>
547               </ca:possvalues>
548               <ca:description></ca:description>
549             </ca:returnvalue>
550           </ca:returnvalues>
551           <ca:triggeredjsapievents title="JSAPI Triggered Events">
552             <ca:triggeredjsapievent title="">
553               <ca:name></ca:name>
554               <ca:description></ca:description>
555             </ca:triggeredjsapievent>
556           </ca:triggeredjsapievents>
557         </ca:jsfunction>
558       </ca:jsfunctions>
559     </ca:jsfile>
560   </ca:jsfiles>
561   <ca:listenedjsapievents title="JSAPI Listened Events">
562     <ca:listenedjsapievent title="">
563       <ca:name></ca:name>
564       <ca:description></ca:description>
565       <ca:calledfunctions title="Functions Calls">
566         <ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro>
567         <ca:calledfunction>
568           <ca:name></ca:name>
569           <ca:description></ca:description>
570         </ca:calledfunction>
571       </ca:calledfunctions>
572     </ca:listenedjsapievent>
573   </ca:listenedjsapievents>
574   <ca:widgetevents title="Widget Events">
575     <ca:widgetevent>
576       <ca:name></ca:name>
577       <ca:parameters title="Parameters">
578         <ca:parameter>
579           <ca:name></ca:name>
580           <ca:type title="Type">
581             <ca:value>string</ca:value>
582           </ca:type>
583           <ca:required title="Required">
584             <ca:value>false</ca:value>
585           </ca:required>
586           <ca:default title="Default">
587             <ca:value></ca:value>
588             <ca:description></ca:description>
589           </ca:default>
590           <ca:possvalues type="list" title="Values">
591             <ca:value></ca:value>
592           </ca:possvalues>
593           <ca:description></ca:description>
594         </ca:parameter>
595       </ca:parameters>
596       <ca:description></ca:description>
597     </ca:widgetevent>
598   </ca:widgetevents>
599   <ca:errors title="Widget Errors">
600     <ca:error title="Error #1">
601       <ca:type title="Type">
602         <ca:value>PHP Mapscript</ca:value>
603       </ca:type>
604       <ca:severity title="Severity">
605         <ca:value>none</ca:value>
606         <ca:description></ca:description>
607       </ca:severity>
608       <ca:message title="Error Message">
609         <ca:paras title="">
610           <ca:para>Error message string....</ca:para>
611         </ca:paras>
612       </ca:message>
613       <ca:meaning title="Interpretation">
614         <ca:paras title="">
615           <ca:para>The description of what the message means......</ca:para>
616         </ca:paras>
617       </ca:meaning>
618       <ca:solution title="Troubleshooting Tips">
619         <ca:paras title="">
620           <ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para>
621         </ca:paras>
622       </ca:solution>
623     </ca:error>
624   </ca:errors>
625 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.