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

root/Chameleon/trunk/Chameleon/PanMap/PanMap.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="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>en-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:person>
27         <ca:name>Paul Spencer</ca:name>
28         <ca:company>DM Solutions Group Inc.</ca:company>
29         <ca:contact>chameleon@lists.maptools.org</ca:contact>
30       </ca:person>
31     </ca:editors>
32   </ca:docinfo>
33   <ca:identification>
34     <ca:name>
35       <ca:value>PanMap</ca:value>
36     </ca:name>
37     <ca:chameleonpack>
38       <ca:value>TBD</ca:value>
39     </ca:chameleonpack>
40     <ca:parentgroup>
41       <ca:value>Navigation Widget</ca:value>
42     </ca:parentgroup>
43     <ca:version>
44       <ca:value>2.0</ca:value>
45     </ca:version>
46     <ca:releasedate>
47       <ca:value>2005-01-10</ca:value>
48     </ca:releasedate>
49     <ca:maturitylevel>
50       <ca:value>TECHRELEASE</ca:value>
51     </ca:maturitylevel>
52     <ca:developers>
53       <ca:person>
54         <ca:name>Paul Spencer</ca:name>
55         <ca:company>DM Solutions Group Inc.</ca:company>
56         <ca:contact>chameleon@lists.maptools.org</ca:contact>
57       </ca:person>
58     </ca:developers>
59   </ca:identification>
60   <ca:descriptions>
61     <ca:description>
62       <ca:paras>
63         <ca:para>The PanMap widget is a navigation tool that allows the user to drag the map image to recenter the map at a given location.</ca:para>
64       </ca:paras>
65     </ca:description>
66     <ca:dependancies>
67       <ca:dependancy type="Widget" title="Map Widget">
68         <ca:para>A map widget must be present in the interface for the PanMap widget to function. This does not mean the button will not show up without a map, only that the button would not do anything.</ca:para>
69       </ca:dependancy>
70     </ca:dependancies>
71     <ca:sharedresources>
72       <ca:paras title="Style Resource">
73         <ca:para>The PanMap widget tag has attributes from the Button Attributes Group. This means the PanMap widget has access to the Style Shared Resource. To learn about this Shared Resource, please refer to the Button Attribute Group section for details.</ca:para>
74       </ca:paras>
75     </ca:sharedresources>
76     <ca:embeddedhelp>
77       <ca:paras>
78         <ca:para>This widget provides the capability to interactively change the current center of the map view. To use it, select the Pan tool and then click on and drag the map. When the mouse button is released to 'drop' the map at a new location, the map is refreshed to display the new extents but maintaining the original scale.</ca:para>
79       </ca:paras>
80     </ca:embeddedhelp>
81   <ca:guinotes>
82     <ca:guinote type="Button" title="Functionality Activation">
83       <ca:para>This widget should be a part of a button toolset that includes all other interactive navigation tools.</ca:para>
84     </ca:guinote>
85     <ca:guinote type="Map" title="Navigation Tool">
86       <ca:para>The user can click and drag their cursor on the map to recenter the map view. Wherever the user releases the map image will be the new center point of the current map scale and extents.</ca:para>
87     </ca:guinote>   
88   </ca:guinotes> 
89     <ca:qanotes/>   
90   </ca:descriptions>
91   <ca:tagstructures>
92     <ca:tagstructure title="Widget Syntax">
93       <ca:description/>
94       <ca:code>
95         <ca:codeblock bold="true">
96           <ca:line>&lt;CWC2 TYPE="PanMap"</ca:line>
97         </ca:codeblock>
98         <ca:codeblock bold="false">
99           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
100           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
101           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
102           <ca:line/>
103           <ca:line>   &lt;!-- Navigation Attributes --&gt;</ca:line>
104           <ca:line/>
105           <ca:line>   CURSORTYPE="[string]"</ca:line>
106           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
107           <ca:line>   MAPID="[string]"</ca:line>
108           <ca:line>   WIDGETSTYLE="[string]"</ca:line>
109           <ca:line/>
110           <ca:line>   &lt;!-- Button Attribute Group--&gt;</ca:line>
111           <ca:line/>
112           <ca:line>   BACKGROUNDIMAGE="[path]"</ca:line>
113           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
114           <ca:line>   IMAGE="[path]"</ca:line>
115           <ca:line>   IMAGEHEIGHT="[integer]"</ca:line>
116           <ca:line>   IMAGETIP="[string]"</ca:line>
117           <ca:line>   IMAGEWIDTH="[integer]"</ca:line>
118           <ca:line>   LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line>
119           <ca:line>   LABELANTIALIAS="[TRUE|FALSE]"</ca:line>
120           <ca:line>   LABELCOLOR="[#RRGGBB]"</ca:line>
121           <ca:line>   LABELFONT="[string]"</ca:line>
122           <ca:line>   LABELFONTSIZE="[0 &lt; integer]"</ca:line>
123           <ca:line>   ONCLICK="[string]"</ca:line>
124           <ca:line>   STYLERESOURCE="[string]"</ca:line>
125           <ca:line>   TEXTBUTTONBORDER="[path]"</ca:line>
126           <ca:line>   TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line>
127           <ca:line>   TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line>
128           <ca:line>   TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line>
129           <ca:line>   TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line>
130           <ca:line>   TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line>
131           <ca:line>   TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line>
132           <ca:line>   TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line>
133           <ca:line>   TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line>
134           <ca:line>   TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line>
135           <ca:line>   TEXTBUTTONNUDGE="[integer]"</ca:line>
136           <ca:line>   TEXTBUTTONPADDING="[0 &lt; integer]"</ca:line>
137           <ca:line>   TOOLSET="[string]"</ca:line>
138           <ca:line>   USETEXTBUTTONCACHE="[TRUE|FALSE]"&gt;</ca:line>
139           <ca:line/>
140           <ca:line>      &lt;!-- Button Subtag Group --&gt;</ca:line>
141           <ca:line/>
142           <ca:line>      &lt;IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line>
143           <ca:line>         IMAGE="[path]"/&gt;</ca:line>
144         </ca:codeblock>
145         <ca:codeblock bold="true">
146           <ca:line>&lt;/CWC2&gt;</ca:line>
147         </ca:codeblock>
148       </ca:code>
149     </ca:tagstructure>
150   </ca:tagstructures>
151   <ca:examples>
152     <ca:widgetexamples>
153       <ca:example title="Example #1: Simple">
154         <ca:description>An image can be used to define the PanMap button.</ca:description>
155         <ca:code>
156           <ca:codeblock bold="false">
157             <ca:line>&lt;cwc2 type="PanMap"</ca:line>
158             <ca:line>   visible="true"</ca:line>
159             <ca:line>   image="buttons/button_pan_1.png"/&gt;</ca:line>
160           </ca:codeblock>
161         </ca:code>
162       </ca:example>
163       <ca:example title="Example #2: Advanced">
164         <ca:description>The following example shows how the PanMap widget uses a button Shared Resource called "NavigationButtons".</ca:description>
165         <ca:code>
166           <ca:codeblock bold="false">
167             <ca:line>&lt;cwc2 type="PanMap"</ca:line>
168             <ca:line>   visible="true"</ca:line>
169             <ca:line>   imagetip="Pan Map"</ca:line>
170             <ca:line>   image="icons/pan_icon.png"</ca:line>
171             <ca:line>   styleresource="NavigationButtons"&gt;</ca:line>
172             <ca:line>      &lt;image state="normal" /&gt;</ca:line>
173             <ca:line>      &lt;image state="hover" /&gt;</ca:line>
174             <ca:line>      &lt;image state="selected" /&gt;</ca:line>
175             <ca:line>&lt;/cwc2&gt;</ca:line>
176           </ca:codeblock>
177         </ca:code>
178       </ca:example>
179       <ca:example title="Example #3: Advanced">
180         <ca:description>The following PanMap 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 PanMap is selected, it will remain active until you select another tool within that tool group.</ca:description>
181         <ca:code>
182           <ca:codeblock bold="false">
183             <ca:line>&lt;cwc2 type="PanMap"</ca:line>
184             <ca:line>   visible="true"</ca:line>
185             <ca:line>   imagetip="Pan Map"</ca:line>
186             <ca:line>   toolset="Navigation"</ca:line>
187             <ca:line>   imagewidth="24"</ca:line>
188             <ca:line>   imageheight="24"&gt;</ca:line>
189             <ca:line>      &lt;image state="normal"</ca:line>
190             <ca:line>         image="buttons/button_pan_1.png"/&gt;</ca:line>
191             <ca:line>      &lt;image state="hover"</ca:line>
192             <ca:line>         image="buttons/button_pan_2.png"/&gt;</ca:line>
193             <ca:line>      &lt;image state="selected"</ca:line>
194             <ca:line>         image="buttons/button_pan_3.png"/&gt;</ca:line>
195             <ca:line>&lt;/cwc2&gt;</ca:line>
196           </ca:codeblock>
197         </ca:code>
198       </ca:example>
199     </ca:widgetexamples>
200     <ca:sampleapps>
201       <ca:sampleapp>
202         <ca:name>Hawaii Demo</ca:name>
203         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
204         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
205       </ca:sampleapp>
206     </ca:sampleapps>
207     <ca:scriptexamples/>
208   </ca:examples>
209   <ca:attributegroups>
210     <ca:attributegroup>
211       <ca:name>Base</ca:name>
212       <ca:name>Button</ca:name>
213       <ca:name>NavTool</ca:name>
214     </ca:attributegroup>
215   </ca:attributegroups>
216   <ca:formelements>
217     <ca:formelement>
218       <ca:name>NAV_CMD</ca:name>
219       <ca:type>
220         <ca:value>string</ca:value>
221       </ca:type>
222       <ca:description>The last command that was used to interact with the map.  This is set to PAN_MAP by the PanMap widget.</ca:description>
223     </ca:formelement>
224     <ca:formelement>
225       <ca:name>NAV_ALLOW_RECTANGLE</ca:name>
226       <ca:type>
227         <ca:value>boolean</ca:value>
228       </ca:type>
229       <ca:description>Tracks whether the current navigation tool uses a rubber-banding box or not.  The PanMap widget does allow a rectangle but it isn't visible.</ca:description>
230     </ca:formelement>
231   </ca:formelements>
232  
233   <ca:jsvariables>
234     <ca:jsvariable>
235       <ca:name>gnPanWFirstPointX</ca:name>
236       <ca:type>
237         <ca:value>float</ca:value>
238       </ca:type>
239       <ca:scope>
240         <ca:value>Private</ca:value>
241       </ca:scope>
242       <ca:default>
243         <ca:value>-1</ca:value>
244         <ca:description/>
245       </ca:default>
246       <ca:description>The X coordinate of the point at which the drag pan started.</ca:description>
247     </ca:jsvariable>
248  
249     <ca:jsvariable>
250       <ca:name>gnPanWFirstPointY</ca:name>
251       <ca:type>
252         <ca:value>float</ca:value>
253       </ca:type>
254       <ca:scope>
255         <ca:value>Private</ca:value>
256       </ca:scope>
257       <ca:default>
258         <ca:value>-1</ca:value>
259         <ca:description/>
260       </ca:default>
261       <ca:description>The Y coordinate of the point at which the drag pan started.</ca:description>
262     </ca:jsvariable>
263   </ca:jsvariables>
264  
265   <ca:jsfunctions>
266     <ca:jsfunction>
267       <ca:name>NavSetActiveTool</ca:name>
268       <ca:scope>
269         <ca:value>Private</ca:value>
270       </ca:scope>
271       <ca:description>Set the active navigation tool for a particular group of tools.</ca:description>
272       <ca:parameters>
273         <ca:parameter>
274           <ca:name>oButton</ca:name>
275           <ca:type>
276             <ca:value>object</ca:value>
277           </ca:type>
278           <ca:required>
279             <ca:value>true</ca:value>
280           </ca:required>
281           <ca:description>This is the JavaScript button object.</ca:description>
282         </ca:parameter>
283         <ca:parameter>
284           <ca:name>aVals</ca:name>
285           <ca:type>
286             <ca:value>array</ca:value>
287           </ca:type>
288           <ca:required>
289             <ca:value>true</ca:value>
290           </ca:required>
291           <ca:description>Array of parameters that defines the navigation tool. The first element is the tool number. The second element is the tool name. The third element is boolean and determines whether rectangle mode is enabled or not. The fourth element controls automatic submission of the page after navigation. The fifth element is a string that define the cursor type.</ca:description>
292         </ca:parameter>
293       </ca:parameters>
294     </ca:jsfunction>
295    
296     <ca:jsfunction>
297       <ca:name>PanMapWInit</ca:name>
298       <ca:scope>
299         <ca:value>Private</ca:value>
300       </ca:scope>
301       <ca:description>Initialize the PanMap tool.</ca:description>
302       <ca:parameters>
303         <ca:parameter>
304           <ca:name></ca:name>
305           <ca:type>
306             <ca:value>unknown</ca:value>
307           </ca:type>
308           <ca:required>
309             <ca:value>true</ca:value>
310           </ca:required>
311           <ca:description/>
312         </ca:parameter>
313       </ca:parameters>
314     </ca:jsfunction>
315    
316     <ca:jsfunction>
317       <ca:name>PanMapWMouseMove</ca:name>
318       <ca:scope>
319         <ca:value>Private</ca:value>
320       </ca:scope>
321       <ca:description>Handle the user moving the mouse.</ca:description>
322       <ca:parameters>
323         <ca:parameter>
324           <ca:name>e</ca:name>
325           <ca:type>
326             <ca:value>object</ca:value>
327           </ca:type>
328           <ca:required>
329             <ca:value>true</ca:value>
330           </ca:required>
331           <ca:description>A JavaScript event object.</ca:description>
332         </ca:parameter>
333       </ca:parameters>
334     </ca:jsfunction>
335    
336     <ca:jsfunction>
337       <ca:name>PanMapWMouseUp</ca:name>
338       <ca:scope>
339         <ca:value>Private</ca:value>
340       </ca:scope>
341       <ca:description>Handle the user pressing the mouse button.</ca:description>
342       <ca:parameters>
343         <ca:parameter>
344           <ca:name>e</ca:name>
345           <ca:type>
346             <ca:value>object</ca:value>
347           </ca:type>
348           <ca:required>
349             <ca:value>true</ca:value>
350           </ca:required>
351           <ca:description>A JavaScript event object.</ca:description>
352         </ca:parameter>
353       </ca:parameters>
354     </ca:jsfunction>
355     <ca:jsfunction>
356       <ca:name>PanMapWMouseDown</ca:name>
357       <ca:scope>
358         <ca:value>Private</ca:value>
359       </ca:scope>
360       <ca:description>Handle the user releasing the mouse button.</ca:description>
361       <ca:parameters>
362         <ca:parameter>
363           <ca:name>e</ca:name>
364           <ca:type>
365             <ca:value>object</ca:value>
366           </ca:type>
367           <ca:required>
368             <ca:value>true</ca:value>
369           </ca:required>
370           <ca:description>A JavaScript event object.</ca:description>
371         </ca:parameter>
372       </ca:parameters>
373     </ca:jsfunction>
374     <ca:jsfunction>
375       <ca:name>PanMapWDragEnd</ca:name>
376       <ca:scope>
377         <ca:value>Private</ca:value>
378       </ca:scope>
379       <ca:description>Stop drag-panning the map.</ca:description>
380       <ca:parameters>
381         <ca:parameter>
382           <ca:name>x</ca:name>
383           <ca:type>
384             <ca:value>integer</ca:value>
385           </ca:type>
386           <ca:required>
387             <ca:value>true</ca:value>
388           </ca:required>
389           <ca:description>X coordinate of where the pan ended.</ca:description>
390         </ca:parameter>
391         <ca:parameter>
392           <ca:name>y</ca:name>
393           <ca:type>
394             <ca:value>integer</ca:value>
395           </ca:type>
396           <ca:required>
397             <ca:value>true</ca:value>
398           </ca:required>
399           <ca:description>Y coordinate of where the pan ended.</ca:description>
400         </ca:parameter>
401       </ca:parameters>
402     </ca:jsfunction>
403     <ca:jsfunction>
404       <ca:name>PanMapWDragStart</ca:name>
405       <ca:scope>
406         <ca:value>Private</ca:value>
407       </ca:scope>
408       <ca:description>Start drag-panning the map.</ca:description>
409       <ca:parameters>
410         <ca:parameter>
411           <ca:name>x</ca:name>
412           <ca:type>
413             <ca:value>integer</ca:value>
414           </ca:type>
415           <ca:required>
416             <ca:value>true</ca:value>
417           </ca:required>
418           <ca:description>X coordinate of where the pan started.</ca:description>
419         </ca:parameter>
420         <ca:parameter>
421           <ca:name>y</ca:name>
422           <ca:type>
423             <ca:value>integer</ca:value>
424           </ca:type>
425           <ca:required>
426             <ca:value>true</ca:value>
427           </ca:required>
428           <ca:description>Y coordinate of where the pan started.</ca:description>
429         </ca:parameter>
430       </ca:parameters>
431     </ca:jsfunction>
432     <ca:jsfunction>
433       <ca:name>PanMapWRegisterForEvent</ca:name>
434       <ca:scope>
435         <ca:value>Private</ca:value>
436       </ca:scope>
437       <ca:description>Called to register when the map extents change (JSAPI).</ca:description>
438     </ca:jsfunction>
439     <ca:jsfunction>
440       <ca:name>PanMapWMapExtentsChanged</ca:name>
441       <ca:scope>
442         <ca:value>Private</ca:value>
443       </ca:scope>
444       <ca:description>Called when the map extents are changed to update the scalebar images (JSAPI).</ca:description>
445     </ca:jsfunction>
446   </ca:jsfunctions>
447 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.