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

root/Chameleon/trunk/Chameleon/ZoomOut/ZoomOut.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>Paul Spencer</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>Christopher R. Thorne</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>ZoomOut</ca:value>
36     </ca:name>
37     <ca:chameleonpack>
38       <ca:value>TBD</ca:value>
39     </ca:chameleonpack>
40     <ca:parentgroup>
41       <ca:value>Navigation Widgets</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 ZoomOut widget is used to zoom out on the map image using a single point click.  The widget uses a default zoom factor of 2 unless there is a ZoomFactor widget in the application, in which case it uses the value set by the ZoomFactor widget.  When zooming out, the extents in both the horizontal and vertical direction are modified by the zoom factor.  For a zoom factor of 2, this results in viewing a geographical area approximately 4 times larger (2 times larger in each dimension).  When zooming out, the user may see features appear or disappear due to scale constraints on layers in the map file or Context file.  Also, the new view extents may be modified by other restrictions, such as the maximum scale in the MapDHTML widget or application-defined maximum extents, resulting in less of a zoom than the user would have otherwise expected.</ca:para>
64         <ca:para>To avoid confusion, the ZoomOut widget should be grouped in a toolset with other navigation tools. Normally, this toolset is called "Navigation"</ca:para>
65       </ca:paras>
66     </ca:description>
67     <ca:dependancies>
68       <ca:dependancy type="None" title="Map Widget">
69         <ca:para>A map widget must be present in the interface for the ZoomOut widget to function. This does not mean that without a map the button does not show up, only that the button is inactive.</ca:para>
70       </ca:dependancy>
71     </ca:dependancies>
72     <ca:sharedresources>
73       <ca:paras title="TextButton">
74         <ca:para>The ZoomOut widget tag has attributes from the Button Attributes Group. This means the ZoomOut widget has access to the Style Shared Resources. To learn about this Shared Resource, please refer to the Button Attribute Group section for details.</ca:para>
75       </ca:paras>
76     </ca:sharedresources>
77     <ca:embeddedhelp>
78       <ca:paras>
79         <ca:para>The ZoomOut widget provides the capability to zoom out from the current map view. To use it, click the Zoom Out button and then click the map. The map is recentered at the selected point and zoomed out by the user-defined Zoom Factor.</ca:para>
80       </ca:paras>
81     </ca:embeddedhelp>
82  
83     <ca:guinotes>
84       <ca:guinote type="Button" title="Functionality Activation">
85         <ca:para>You must select the ZoomOut button to activate this navigation tool before proceeding to the map. If the button is a part of a button toolset, then the functionality of this button remains active until another button is selected in the same toolset.</ca:para>
86       </ca:guinote>
87       <ca:guinote type="Map" title="Navigation Tool">
88         <ca:para>Once the Zoom Out button is selected, the user can point and click on the map and the map zooms out based on the currently set zoom factor (default is "2"). The map then recenters on the "POINT of interest" and increases the scale, meaning the map shows more area and less detail.</ca:para>
89       </ca:guinote>   
90     </ca:guinotes>
91   </ca:descriptions>
92   <ca:tagstructures>
93     <ca:tagstructure title="Widget Syntax">
94       <ca:description/>
95       <ca:code>
96         <ca:codeblock bold="true">
97           <ca:line>&lt;CWC2 TYPE="ZoomOut"</ca:line>
98         </ca:codeblock>
99         <ca:codeblock bold="false">
100           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
101           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
102           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
103           <ca:line/>
104           <ca:line>   &lt;!-- Navigation Attributes --&gt;</ca:line>
105           <ca:line/>
106           <ca:line>   CURSORTYPE="[string]"</ca:line>
107           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
108           <ca:line>   MAPID="[string]"</ca:line>
109           <ca:line>   WIDGETSTYLE="[string]"</ca:line>
110           <ca:line/>
111           <ca:line>   &lt;!-- Button Attribute Group--&gt;</ca:line>
112           <ca:line/>
113           <ca:line>   BACKGROUNDIMAGE="[path]"</ca:line>
114           <ca:line>   DEFAULT="[TRUE|FALSE]"</ca:line>
115           <ca:line>   IMAGE="[path]"</ca:line>
116           <ca:line>   IMAGEHEIGHT="[integer]"</ca:line>
117           <ca:line>   IMAGETIP="[string]"</ca:line>
118           <ca:line>   IMAGEWIDTH="[integer]"</ca:line>
119           <ca:line>   LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line>
120           <ca:line>   LABELANTIALIAS="[TRUE|FALSE]"</ca:line>
121           <ca:line>   LABELCOLOR="[#RRGGBB]"</ca:line>
122           <ca:line>   LABELFONT="[string]"</ca:line>
123           <ca:line>   LABELFONTSIZE="[0 &lt; integer]"</ca:line>
124           <ca:line>   ONCLICK="[string]"</ca:line>
125           <ca:line>   STYLERESOURCE="[string]"</ca:line>
126           <ca:line>   TEXTBUTTONBORDER="[path]"</ca:line>
127           <ca:line>   TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line>
128           <ca:line>   TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line>
129           <ca:line>   TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line>
130           <ca:line>   TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line>
131           <ca:line>   TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line>
132           <ca:line>   TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line>
133           <ca:line>   TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line>
134           <ca:line>   TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line>
135           <ca:line>   TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line>
136           <ca:line>   TEXTBUTTONNUDGE="[integer]"</ca:line>
137           <ca:line>   TEXTBUTTONPADDING="[0 &lt; integer]"</ca:line>
138           <ca:line>   TOOLSET="[string]"</ca:line>
139           <ca:line>   USETEXTBUTTONCACHE="[TRUE|FALSE]"&gt;</ca:line>
140           <ca:line/>
141           <ca:line>      &lt;!-- Button Subtag Group --&gt;</ca:line>
142           <ca:line/>
143           <ca:line>      &lt;IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line>
144           <ca:line>         IMAGE="[path]"/&gt;</ca:line>
145         </ca:codeblock>
146         <ca:codeblock bold="true">
147           <ca:line>&lt;/CWC2&gt;</ca:line>
148         </ca:codeblock>
149       </ca:code>
150     </ca:tagstructure>
151   </ca:tagstructures>
152   <ca:examples>
153     <ca:widgetexamples>
154       <ca:example title="Example #1: Simple">
155         <ca:description>An image can define the ZoomOut button.</ca:description>
156         <ca:code>
157           <ca:codeblock bold="false">
158             <ca:line>&lt;cwc2 type="ZoomOut"</ca:line>
159             <ca:line>   visible="true"</ca:line>
160             <ca:line>   image="buttons/button_zoomout_1.png"/&gt;</ca:line>
161           </ca:codeblock>
162         </ca:code>
163       </ca:example>
164       <ca:example title="Example #2: Advanced">
165         <ca:description>The following example shows how the ZoomOut widget uses a Style Shared Resource called "NavigationButtons".</ca:description>
166         <ca:code>
167           <ca:codeblock bold="false">
168             <ca:line>&lt;cwc2 type="ZoomOut"</ca:line>
169             <ca:line>   visible="true"</ca:line>
170             <ca:line>   imagetip="Zoom Out"</ca:line>
171             <ca:line>   image="icons/pan_zoomout.png"</ca:line>
172             <ca:line>   styleresource="NavigationButtons"&gt;</ca:line>
173             <ca:line>      &lt;image state="normal" /&gt;</ca:line>
174             <ca:line>      &lt;image state="hover" /&gt;</ca:line>
175             <ca:line>      &lt;image state="selected" /&gt;</ca:line>
176             <ca:line>&lt;/cwc2&gt; </ca:line>
177           </ca:codeblock>
178         </ca:code>
179       </ca:example>
180       <ca:example title="Example #3: Advanced">
181         <ca:description>The following ZoomOut 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 ZoomOut is selected, it remains active until another tool within that tool group is selected.</ca:description>
182         <ca:code>
183           <ca:codeblock bold="false">
184             <ca:line>&lt;cwc2 type="ZoomOut"</ca:line>
185             <ca:line>   visible="true"</ca:line>
186             <ca:line>   imagetip="Zoom Out"</ca:line>
187             <ca:line>   toolset="Navigation"</ca:line>
188             <ca:line>   imagewidth="24"</ca:line>
189             <ca:line>   imageheight="24"&gt;</ca:line>
190             <ca:line>      &lt;image state="normal"</ca:line>
191             <ca:line>         image="buttons/button_zoomout_1.png"/&gt;</ca:line>
192             <ca:line>      &lt;image state="hover"</ca:line>
193             <ca:line>         image="buttons/button_zoomout_2.png"/&gt;</ca:line>
194             <ca:line>      &lt;image state="selected"</ca:line>
195             <ca:line>         image="buttons/button_zoomout_3.png"/&gt;</ca:line>
196             <ca:line>&lt;/cwc2&gt;</ca:line>
197           </ca:codeblock>
198         </ca:code>
199       </ca:example>
200     </ca:widgetexamples>
201     <ca:sampleapps>
202       <ca:sampleapp>
203         <ca:name>Hawaii Demo</ca:name>
204         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
205         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
206       </ca:sampleapp>
207     </ca:sampleapps>
208     <ca:scriptexamples/>
209   </ca:examples>
210   <ca:attributegroups>
211     <ca:attributegroup>
212       <ca:name>Base</ca:name>
213       <ca:name>Button</ca:name>
214       <ca:name>NavTool</ca:name>
215     </ca:attributegroup>
216   </ca:attributegroups>
217   <ca:formelements>
218     <ca:formelement>
219       <ca:name>NAV_CMD</ca:name>
220         <ca:type>
221           <ca:value>string</ca:value>
222         </ca:type>
223       <ca:description>The last command that was used to interact with the map.  For this widget, it is set to ZOOM_OUT.</ca:description>
224     </ca:formelement>
225     <ca:formelement>
226       <ca:name>NAV_ALLOW_RECTANGLE</ca:name>
227         <ca:type>
228           <ca:value>boolean</ca:value>
229         </ca:type>
230       <ca:description>Track whether the current navigation tool uses a rubber-banding box or not.  For this widget, it is set to FALSE.</ca:description>
231     </ca:formelement>
232   </ca:formelements>
233   <ca:jsfunctions>
234     <ca:jsfunction>
235       <ca:name>NavSetActiveTool</ca:name>
236       <ca:scope>
237         <ca:value>Private</ca:value>
238       </ca:scope>
239       <ca:description>Set the active navigation tool for a particular group of tools.</ca:description>
240       <ca:parameters>
241         <ca:parameter>
242           <ca:name>oButton</ca:name>
243           <ca:type>
244             <ca:value>object</ca:value>
245           </ca:type>
246           <ca:required>
247             <ca:value>true</ca:value>
248           </ca:required>
249           <ca:description>This is the JavaScript button object.</ca:description>
250         </ca:parameter>
251         <ca:parameter>
252           <ca:name>aVals</ca:name>
253           <ca:type>
254             <ca:value>array</ca:value>
255           </ca:type>
256           <ca:required>
257             <ca:value>true</ca:value>
258           </ca:required>
259           <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 if 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>
260         </ca:parameter>
261       </ca:parameters>
262     </ca:jsfunction>
263   </ca:jsfunctions>
264 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.