| 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>ZoomFactor</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 ZoomFactor widget is used to enter a zoom factor that is used when the user zooms in at a point. This factor is ignored if the user zooms to a rectangular region. The widget contains the ability to restrict the zoom factor to a range of values.</ca:para> |
|---|
| 64 |
</ca:paras> |
|---|
| 65 |
</ca:description> |
|---|
| 66 |
<ca:dependancies> |
|---|
| 67 |
<ca:dependancy type="None" title=""> |
|---|
| 68 |
<ca:para/> |
|---|
| 69 |
</ca:dependancy> |
|---|
| 70 |
</ca:dependancies> |
|---|
| 71 |
<ca:sharedresources> |
|---|
| 72 |
<ca:paras title="None Available."> |
|---|
| 73 |
<ca:para/> |
|---|
| 74 |
</ca:paras> |
|---|
| 75 |
</ca:sharedresources> |
|---|
| 76 |
<ca:embeddedhelp> |
|---|
| 77 |
<ca:paras> |
|---|
| 78 |
<ca:para>The ZoomFactor widget provides the capability for the user to determine the amount to zoom in or out on a single click. When zooming in, the resulting view is 1/[zoom factor] times zoomed in. When zooming out, the resulting view is [zoom factor] times zoomed out. To enter a new zoom factor, erase the existing value and type a new value. The new value is used the next time a point zoom in or zoom out is performed. Zoom factors are integer values.</ca:para> |
|---|
| 79 |
</ca:paras> |
|---|
| 80 |
</ca:embeddedhelp> |
|---|
| 81 |
<ca:guinotes> |
|---|
| 82 |
<ca:guinote type="TextBox" title="Setting the Zoom Factor."> |
|---|
| 83 |
<ca:para>The ZoomFactor widget is represented by a labeled HTML INPUT box. By default, both the minimum and default zoom factor settings are set to 2.</ca:para> |
|---|
| 84 |
</ca:guinote> |
|---|
| 85 |
</ca:guinotes> |
|---|
| 86 |
</ca:descriptions> |
|---|
| 87 |
<ca:tagstructures> |
|---|
| 88 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 89 |
<ca:description/> |
|---|
| 90 |
<ca:code> |
|---|
| 91 |
<ca:codeblock bold="true"> |
|---|
| 92 |
<ca:line><CWC2 TYPE="ZoomFactor"</ca:line> |
|---|
| 93 |
</ca:codeblock> |
|---|
| 94 |
<ca:codeblock bold="false"> |
|---|
| 95 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 96 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 97 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 98 |
<ca:line/> |
|---|
| 99 |
<ca:line> <!-- ZoomFactor Attributes --></ca:line> |
|---|
| 100 |
<ca:line/> |
|---|
| 101 |
<ca:line> DEFAULTFACTOR ="[integer]"</ca:line> |
|---|
| 102 |
<ca:line> MAXIMUMFACTOR ="[integer]"</ca:line> |
|---|
| 103 |
<ca:line> MINIMUMFACTOR ="[integer]"</ca:line> |
|---|
| 104 |
<ca:line> TEXTFIELDSIZE ="[integer]"</ca:line> |
|---|
| 105 |
<ca:line/> |
|---|
| 106 |
<ca:line> <!-- Label Attribute Group--></ca:line> |
|---|
| 107 |
<ca:line/> |
|---|
| 108 |
<ca:line> LABEL="[string]"</ca:line> |
|---|
| 109 |
<ca:line> LABELCLASS="[string]"</ca:line> |
|---|
| 110 |
<ca:line> LABELHALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 111 |
<ca:line> LABELPOSITION="[0 < integer < 8]"</ca:line> |
|---|
| 112 |
<ca:line> LABELSTYLE="[path]"</ca:line> |
|---|
| 113 |
<ca:line> LABELVALIGN="[TOP|MIDDLE|BOTTOM]"/></ca:line> |
|---|
| 114 |
</ca:codeblock> |
|---|
| 115 |
</ca:code> |
|---|
| 116 |
</ca:tagstructure> |
|---|
| 117 |
</ca:tagstructures> |
|---|
| 118 |
<ca:examples> |
|---|
| 119 |
<ca:widgetexamples> |
|---|
| 120 |
<ca:example title="Example #1: Simple"> |
|---|
| 121 |
<ca:description>The following example is the typical configuration for this widget tag without any label styling. </ca:description> |
|---|
| 122 |
<ca:code> |
|---|
| 123 |
<ca:codeblock bold="false"> |
|---|
| 124 |
<ca:line><cwc2 type="ZoomFactor" </ca:line> |
|---|
| 125 |
<ca:line> visible="true" </ca:line> |
|---|
| 126 |
<ca:line> defaultfactor="2" </ca:line> |
|---|
| 127 |
<ca:line> minimumfactor="2" </ca:line> |
|---|
| 128 |
<ca:line> label="Zoom Factor"</ca:line> |
|---|
| 129 |
<ca:line> textfieldsize="2" /></ca:line> |
|---|
| 130 |
</ca:codeblock> |
|---|
| 131 |
</ca:code> |
|---|
| 132 |
</ca:example> |
|---|
| 133 |
<ca:example title="Example #2: Advanced"> |
|---|
| 134 |
<ca:description>The following example contains a label class to style the zoom factor label.</ca:description> |
|---|
| 135 |
<ca:code> |
|---|
| 136 |
<ca:codeblock bold="false"> |
|---|
| 137 |
<ca:line><cwc2 type="ZoomFactor" </ca:line> |
|---|
| 138 |
<ca:line> visible="true" </ca:line> |
|---|
| 139 |
<ca:line> defaultfactor="2" </ca:line> |
|---|
| 140 |
<ca:line> minimumfactor="2" </ca:line> |
|---|
| 141 |
<ca:line> label="Zoom Factor"</ca:line> |
|---|
| 142 |
<ca:line> textfieldsize="2" </ca:line> |
|---|
| 143 |
<ca:line> labelclass="label"/></ca:line> |
|---|
| 144 |
</ca:codeblock> |
|---|
| 145 |
</ca:code> |
|---|
| 146 |
</ca:example> |
|---|
| 147 |
</ca:widgetexamples> |
|---|
| 148 |
<ca:sharedresourceexamples> |
|---|
| 149 |
<ca:example title=""> |
|---|
| 150 |
<ca:description/> |
|---|
| 151 |
<ca:code> |
|---|
| 152 |
<ca:codeblock bold="false"> |
|---|
| 153 |
<ca:line/> |
|---|
| 154 |
</ca:codeblock> |
|---|
| 155 |
</ca:code> |
|---|
| 156 |
</ca:example> |
|---|
| 157 |
</ca:sharedresourceexamples> |
|---|
| 158 |
<ca:sampleapps> |
|---|
| 159 |
<ca:sampleapp> |
|---|
| 160 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 161 |
<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 162 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 163 |
</ca:sampleapp> |
|---|
| 164 |
</ca:sampleapps> |
|---|
| 165 |
<ca:scriptexamples/> |
|---|
| 166 |
</ca:examples> |
|---|
| 167 |
<ca:attributegroups> |
|---|
| 168 |
<ca:attributegroup> |
|---|
| 169 |
<ca:name>Base</ca:name> |
|---|
| 170 |
<ca:name>Label</ca:name> |
|---|
| 171 |
</ca:attributegroup> |
|---|
| 172 |
</ca:attributegroups> |
|---|
| 173 |
<ca:widgettag> |
|---|
| 174 |
<ca:attribute> |
|---|
| 175 |
<ca:name>DEFAULTFACTOR</ca:name> |
|---|
| 176 |
<ca:type> |
|---|
| 177 |
<ca:value>integer</ca:value> |
|---|
| 178 |
</ca:type> |
|---|
| 179 |
<ca:class> |
|---|
| 180 |
<ca:value>Widget Only</ca:value> |
|---|
| 181 |
</ca:class> |
|---|
| 182 |
<ca:default> |
|---|
| 183 |
<ca:value>2</ca:value> |
|---|
| 184 |
<ca:description/> |
|---|
| 185 |
</ca:default> |
|---|
| 186 |
<ca:possvalues type="range"> |
|---|
| 187 |
<ca:minimum>2</ca:minimum> |
|---|
| 188 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 189 |
</ca:possvalues> |
|---|
| 190 |
<ca:description>The default zoom factor to use.</ca:description> |
|---|
| 191 |
</ca:attribute> |
|---|
| 192 |
<ca:attribute> |
|---|
| 193 |
<ca:name>MAXIMUMFACTOR</ca:name> |
|---|
| 194 |
<ca:type> |
|---|
| 195 |
<ca:value>integer</ca:value> |
|---|
| 196 |
</ca:type> |
|---|
| 197 |
<ca:class> |
|---|
| 198 |
<ca:value>Widget Only</ca:value> |
|---|
| 199 |
</ca:class> |
|---|
| 200 |
<ca:default> |
|---|
| 201 |
<ca:value>NULL</ca:value> |
|---|
| 202 |
<ca:description/> |
|---|
| 203 |
</ca:default> |
|---|
| 204 |
<ca:possvalues type="range"> |
|---|
| 205 |
<ca:minimum>2</ca:minimum> |
|---|
| 206 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 207 |
</ca:possvalues> |
|---|
| 208 |
<ca:description>The maximum zoom factor. The default is no maximum.</ca:description> |
|---|
| 209 |
</ca:attribute> |
|---|
| 210 |
<ca:attribute> |
|---|
| 211 |
<ca:name>MINIMUMFACTOR</ca:name> |
|---|
| 212 |
<ca:type> |
|---|
| 213 |
<ca:value>integer</ca:value> |
|---|
| 214 |
</ca:type> |
|---|
| 215 |
<ca:class> |
|---|
| 216 |
<ca:value>Widget Only</ca:value> |
|---|
| 217 |
</ca:class> |
|---|
| 218 |
<ca:default> |
|---|
| 219 |
<ca:value>2</ca:value> |
|---|
| 220 |
<ca:description/> |
|---|
| 221 |
</ca:default> |
|---|
| 222 |
<ca:possvalues type="range"> |
|---|
| 223 |
<ca:minimum>2</ca:minimum> |
|---|
| 224 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 225 |
</ca:possvalues> |
|---|
| 226 |
<ca:description>The minimum zoom factor. The default is 2.</ca:description> |
|---|
| 227 |
</ca:attribute> |
|---|
| 228 |
<ca:attribute> |
|---|
| 229 |
<ca:name>TEXTFIELDSIZE</ca:name> |
|---|
| 230 |
<ca:type> |
|---|
| 231 |
<ca:value>integer</ca:value> |
|---|
| 232 |
</ca:type> |
|---|
| 233 |
<ca:class> |
|---|
| 234 |
<ca:value>Widget Only</ca:value> |
|---|
| 235 |
</ca:class> |
|---|
| 236 |
<ca:default> |
|---|
| 237 |
<ca:value>2</ca:value> |
|---|
| 238 |
<ca:description/> |
|---|
| 239 |
</ca:default> |
|---|
| 240 |
<ca:possvalues type="range"> |
|---|
| 241 |
<ca:minimum>1</ca:minimum> |
|---|
| 242 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 243 |
</ca:possvalues> |
|---|
| 244 |
<ca:description>The size (in characters) of the HTML INPUT text box. The default is 2.</ca:description> |
|---|
| 245 |
</ca:attribute> |
|---|
| 246 |
</ca:widgettag> |
|---|
| 247 |
<ca:formelements/> |
|---|
| 248 |
<ca:jsfunctions> |
|---|
| 249 |
<ca:jsfunction> |
|---|
| 250 |
<ca:name>changeZoomFactor</ca:name> |
|---|
| 251 |
<ca:scope> |
|---|
| 252 |
<ca:value>Private</ca:value> |
|---|
| 253 |
</ca:scope> |
|---|
| 254 |
<ca:description>Callback function for handling the user changing the zoom factor. (Used for validation.)</ca:description> |
|---|
| 255 |
<ca:parameters> |
|---|
| 256 |
<ca:parameter> |
|---|
| 257 |
<ca:name>obj</ca:name> |
|---|
| 258 |
<ca:type> |
|---|
| 259 |
<ca:value>object</ca:value> |
|---|
| 260 |
</ca:type> |
|---|
| 261 |
<ca:required> |
|---|
| 262 |
<ca:value>true</ca:value> |
|---|
| 263 |
</ca:required> |
|---|
| 264 |
<ca:description>The HTML or JavaScript object that contains the new zoom factor.</ca:description> |
|---|
| 265 |
</ca:parameter> |
|---|
| 266 |
</ca:parameters> |
|---|
| 267 |
</ca:jsfunction> |
|---|
| 268 |
<ca:jsfunction> |
|---|
| 269 |
<ca:name>validateInteger</ca:name> |
|---|
| 270 |
<ca:scope> |
|---|
| 271 |
<ca:value>Private</ca:value> |
|---|
| 272 |
</ca:scope> |
|---|
| 273 |
<ca:description>Validate an integer value.</ca:description> |
|---|
| 274 |
<ca:parameters> |
|---|
| 275 |
<ca:parameter> |
|---|
| 276 |
<ca:name>nValue</ca:name> |
|---|
| 277 |
<ca:type> |
|---|
| 278 |
<ca:value>integer</ca:value> |
|---|
| 279 |
</ca:type> |
|---|
| 280 |
<ca:required> |
|---|
| 281 |
<ca:value>true</ca:value> |
|---|
| 282 |
</ca:required> |
|---|
| 283 |
<ca:description/> |
|---|
| 284 |
</ca:parameter> |
|---|
| 285 |
</ca:parameters> |
|---|
| 286 |
</ca:jsfunction> |
|---|
| 287 |
</ca:jsfunctions> |
|---|
| 288 |
</ca:widgetdoc> |
|---|
