| 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>Cursorpos</ca:value> |
|---|
| 36 |
</ca:name> |
|---|
| 37 |
<ca:chameleonpack> |
|---|
| 38 |
<ca:value>Base Package</ca:value> |
|---|
| 39 |
</ca:chameleonpack> |
|---|
| 40 |
<ca:parentgroup> |
|---|
| 41 |
<ca:value>Label 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>1999-12-31</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 Cursorpos widget is used to display the current cursor position, in the geographic coordinates of the map. To assist template developers, this widget can be configured to display one of the two axes of the cursor position. The cursor position must be displayed in an HTML element that can be updated, so an HTML INPUT box is used. CSS files can be used to modify the appearance of the INPUT box to make it look nicer in more modern browsers.</ca:para> |
|---|
| 64 |
</ca:paras> |
|---|
| 65 |
</ca:description> |
|---|
| 66 |
<ca:techrequirements/> |
|---|
| 67 |
<ca:dependancies> |
|---|
| 68 |
<ca:dependancy type="Widget" title="Map Widget"> |
|---|
| 69 |
<ca:para> A map widget must be present in the interface so this widget can display the coordinate position on the map.</ca:para> |
|---|
| 70 |
</ca:dependancy> |
|---|
| 71 |
</ca:dependancies> |
|---|
| 72 |
<ca:sharedresources> |
|---|
| 73 |
<ca:paras title="None Available."> |
|---|
| 74 |
<ca:para/> |
|---|
| 75 |
</ca:paras> |
|---|
| 76 |
</ca:sharedresources> |
|---|
| 77 |
<ca:embeddedhelp> |
|---|
| 78 |
<ca:paras> |
|---|
| 79 |
<ca:para>The Cursorpos widget displays current X or Y values as the cursor moves over the map. The location is displayed in the units of the current projection.</ca:para> |
|---|
| 80 |
</ca:paras> |
|---|
| 81 |
</ca:embeddedhelp> |
|---|
| 82 |
<ca:guinotes> |
|---|
| 83 |
<ca:guinote type="Label" title="A Dynamic Label"> |
|---|
| 84 |
<ca:para>Even though this widget uses an HTML input box to display its value, it is regarded as a label widget. The value of the location of the cursor is updated dynamically as the user moves the mouse over the map. This widget can be placed anywhere on the page, but is often placed near the MapUnits and ProjectionLabel widgets. </ca:para> |
|---|
| 85 |
</ca:guinote> |
|---|
| 86 |
<ca:guinote type="Label" title="Design Tip"> |
|---|
| 87 |
<ca:para>Typically, this widget is included in an interface twice, once for each axis.</ca:para> |
|---|
| 88 |
</ca:guinote> |
|---|
| 89 |
</ca:guinotes> |
|---|
| 90 |
<ca:qanotes/> |
|---|
| 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><CWC2 TYPE="Cursorpos"</ca:line> |
|---|
| 98 |
</ca:codeblock> |
|---|
| 99 |
<ca:codeblock bold="false"> |
|---|
| 100 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 101 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 102 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 103 |
<ca:line/> |
|---|
| 104 |
<ca:line> <!-- CursorPos Attributes--></ca:line> |
|---|
| 105 |
</ca:codeblock> |
|---|
| 106 |
<ca:codeblock bold="true"> |
|---|
| 107 |
<ca:line> AXIS="[X|Y]"</ca:line> |
|---|
| 108 |
</ca:codeblock> |
|---|
| 109 |
<ca:codeblock bold="false"> |
|---|
| 110 |
<ca:line> TEXTFIELDSIZE="[0 < integer]"</ca:line> |
|---|
| 111 |
<ca:line> WIDGETCLASS="[string]"</ca:line> |
|---|
| 112 |
<ca:line> WIDGETSTYLE="[string]"</ca:line> |
|---|
| 113 |
<ca:line/> |
|---|
| 114 |
<ca:line> <!-- Label Attribute Group--></ca:line> |
|---|
| 115 |
<ca:line/> |
|---|
| 116 |
<ca:line> LABEL="[string]"</ca:line> |
|---|
| 117 |
<ca:line> LABELPOSITION="[0 < integer < 8]"</ca:line> |
|---|
| 118 |
<ca:line> LABELHALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 119 |
<ca:line> LABELVALIGN="[TOP|MIDDLE|BOTTOM]"</ca:line> |
|---|
| 120 |
<ca:line> LABELCLASS="[string]"</ca:line> |
|---|
| 121 |
<ca:line> LABELSTYLE="[string]"/></ca:line> |
|---|
| 122 |
</ca:codeblock> |
|---|
| 123 |
</ca:code> |
|---|
| 124 |
</ca:tagstructure> |
|---|
| 125 |
</ca:tagstructures> |
|---|
| 126 |
<ca:examples> |
|---|
| 127 |
<ca:widgetexamples> |
|---|
| 128 |
<ca:example title="Example #1: Simple"> |
|---|
| 129 |
<ca:description>This example tag outputs only the "X" coordinate cursor position value whenever the mouse is over the application map.</ca:description> |
|---|
| 130 |
<ca:code> |
|---|
| 131 |
<ca:codeblock bold="false"> |
|---|
| 132 |
<ca:line><cwc2 type="CursorPos" axis="X"/></ca:line> |
|---|
| 133 |
</ca:codeblock> |
|---|
| 134 |
</ca:code> |
|---|
| 135 |
</ca:example> |
|---|
| 136 |
<ca:example title="Example #2: Advanced"> |
|---|
| 137 |
<ca:description>In the following example, the coordinate position "X" is labeled to the left of the value with "Longitude: ". This label widget has also been given a CSS style to make it look nicer than the default style.</ca:description> |
|---|
| 138 |
<ca:code> |
|---|
| 139 |
<ca:codeblock bold="false"> |
|---|
| 140 |
<ca:line><cwc2 type="CursorPos"</ca:line> |
|---|
| 141 |
<ca:line>axis="X"</ca:line> |
|---|
| 142 |
<ca:line>label="Longitude: "</ca:line> |
|---|
| 143 |
<ca:line>labelposition="8"</ca:line> |
|---|
| 144 |
<ca:line>labelvalign="middle"</ca:line> |
|---|
| 145 |
<ca:line>labelclass="label"</ca:line> |
|---|
| 146 |
<ca:line>widgetclass="inputBox"/></ca:line> |
|---|
| 147 |
</ca:codeblock> |
|---|
| 148 |
</ca:code> |
|---|
| 149 |
</ca:example> |
|---|
| 150 |
</ca:widgetexamples> |
|---|
| 151 |
<ca:sampleapps> |
|---|
| 152 |
<ca:sampleapp> |
|---|
| 153 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 154 |
<ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 155 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 156 |
</ca:sampleapp> |
|---|
| 157 |
</ca:sampleapps> |
|---|
| 158 |
<ca:scriptexamples/> |
|---|
| 159 |
</ca:examples> |
|---|
| 160 |
<ca:attributegroups> |
|---|
| 161 |
<ca:attributegroup> |
|---|
| 162 |
<ca:name>Base</ca:name> |
|---|
| 163 |
<ca:name>Label</ca:name> |
|---|
| 164 |
</ca:attributegroup> |
|---|
| 165 |
</ca:attributegroups> |
|---|
| 166 |
<ca:widgettag> |
|---|
| 167 |
<ca:attribute> |
|---|
| 168 |
<ca:name>AXIS</ca:name> |
|---|
| 169 |
<ca:type> |
|---|
| 170 |
<ca:value>string</ca:value> |
|---|
| 171 |
</ca:type> |
|---|
| 172 |
<ca:class> |
|---|
| 173 |
<ca:value>Required</ca:value> |
|---|
| 174 |
</ca:class> |
|---|
| 175 |
<ca:possvalues type="list"> |
|---|
| 176 |
<ca:value>X</ca:value> |
|---|
| 177 |
<ca:value>Y</ca:value> |
|---|
| 178 |
</ca:possvalues> |
|---|
| 179 |
<ca:description>Determines which of the X or Y values of the current cursor position is displayed.</ca:description> |
|---|
| 180 |
</ca:attribute> |
|---|
| 181 |
<ca:attribute> |
|---|
| 182 |
<ca:name>TEXTFIELDSIZE</ca:name> |
|---|
| 183 |
<ca:type> |
|---|
| 184 |
<ca:value>integer</ca:value> |
|---|
| 185 |
</ca:type> |
|---|
| 186 |
<ca:class> |
|---|
| 187 |
<ca:value>Widget Only</ca:value> |
|---|
| 188 |
</ca:class> |
|---|
| 189 |
<ca:default> |
|---|
| 190 |
<ca:value>20</ca:value> |
|---|
| 191 |
</ca:default> |
|---|
| 192 |
<ca:possvalues type="range"> |
|---|
| 193 |
<ca:minimum>0</ca:minimum> |
|---|
| 194 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 195 |
</ca:possvalues> |
|---|
| 196 |
<ca:description>The size (in characters) of the text box that displays the cursor position.</ca:description> |
|---|
| 197 |
</ca:attribute> |
|---|
| 198 |
<ca:attribute> |
|---|
| 199 |
<ca:name>WIDGETCLASS</ca:name> |
|---|
| 200 |
<ca:type> |
|---|
| 201 |
<ca:value>string</ca:value> |
|---|
| 202 |
</ca:type> |
|---|
| 203 |
<ca:class> |
|---|
| 204 |
<ca:value>Widget Only</ca:value> |
|---|
| 205 |
</ca:class> |
|---|
| 206 |
<ca:default> |
|---|
| 207 |
<ca:value>CWCCursorPositionWidgetClass</ca:value> |
|---|
| 208 |
</ca:default> |
|---|
| 209 |
<ca:description>The CSS class to control the style of the HTML INPUT box.</ca:description> |
|---|
| 210 |
</ca:attribute> |
|---|
| 211 |
<ca:attribute> |
|---|
| 212 |
<ca:name>WIDGETSTYLE</ca:name> |
|---|
| 213 |
<ca:type> |
|---|
| 214 |
<ca:value>string</ca:value> |
|---|
| 215 |
</ca:type> |
|---|
| 216 |
<ca:class> |
|---|
| 217 |
<ca:value>Widget Only</ca:value> |
|---|
| 218 |
</ca:class> |
|---|
| 219 |
<ca:default> |
|---|
| 220 |
<ca:value>NULL</ca:value> |
|---|
| 221 |
</ca:default> |
|---|
| 222 |
<ca:description> The CSS style to control the style of the HTML INPUT box.</ca:description> |
|---|
| 223 |
</ca:attribute> |
|---|
| 224 |
</ca:widgettag> |
|---|
| 225 |
<ca:formelements> |
|---|
| 226 |
<ca:formelement> |
|---|
| 227 |
<ca:name>sid</ca:name> |
|---|
| 228 |
<ca:type> |
|---|
| 229 |
<ca:value>unknown</ca:value> |
|---|
| 230 |
</ca:type> |
|---|
| 231 |
<ca:description/> |
|---|
| 232 |
</ca:formelement> |
|---|
| 233 |
</ca:formelements> |
|---|
| 234 |
<ca:jsfunctions> |
|---|
| 235 |
<ca:jsfunction> |
|---|
| 236 |
<ca:name>CursorXMouseMoved</ca:name> |
|---|
| 237 |
<ca:scope> |
|---|
| 238 |
<ca:value>Private</ca:value> |
|---|
| 239 |
</ca:scope> |
|---|
| 240 |
<ca:description>Callback function for tracking mouse movement in the X direction. The same function exists for the Y direction (called CursorYMouseMoved).</ca:description> |
|---|
| 241 |
<ca:parameters> |
|---|
| 242 |
<ca:parameter> |
|---|
| 243 |
<ca:name>e</ca:name> |
|---|
| 244 |
<ca:type> |
|---|
| 245 |
<ca:value>object</ca:value> |
|---|
| 246 |
</ca:type> |
|---|
| 247 |
<ca:required> |
|---|
| 248 |
<ca:value>true</ca:value> |
|---|
| 249 |
</ca:required> |
|---|
| 250 |
<ca:description/> |
|---|
| 251 |
</ca:parameter> |
|---|
| 252 |
</ca:parameters> |
|---|
| 253 |
</ca:jsfunction> |
|---|
| 254 |
<ca:jsfunction> |
|---|
| 255 |
<ca:name>WidgetPix2Geo</ca:name> |
|---|
| 256 |
<ca:scope> |
|---|
| 257 |
<ca:value>Private</ca:value> |
|---|
| 258 |
</ca:scope> |
|---|
| 259 |
<ca:description>Convert pixel position to geographic coordinates</ca:description> |
|---|
| 260 |
<ca:parameters> |
|---|
| 261 |
<ca:parameter> |
|---|
| 262 |
<ca:name>nPixPos</ca:name> |
|---|
| 263 |
<ca:type> |
|---|
| 264 |
<ca:value>integer</ca:value> |
|---|
| 265 |
</ca:type> |
|---|
| 266 |
<ca:required> |
|---|
| 267 |
<ca:value>true</ca:value> |
|---|
| 268 |
</ca:required> |
|---|
| 269 |
<ca:description/> |
|---|
| 270 |
</ca:parameter> |
|---|
| 271 |
<ca:parameter> |
|---|
| 272 |
<ca:name>dfPixMin</ca:name> |
|---|
| 273 |
<ca:type> |
|---|
| 274 |
<ca:value>integer</ca:value> |
|---|
| 275 |
</ca:type> |
|---|
| 276 |
<ca:required> |
|---|
| 277 |
<ca:value>true</ca:value> |
|---|
| 278 |
</ca:required> |
|---|
| 279 |
<ca:description/> |
|---|
| 280 |
</ca:parameter> |
|---|
| 281 |
<ca:parameter> |
|---|
| 282 |
<ca:name>dfPixMax</ca:name> |
|---|
| 283 |
<ca:type> |
|---|
| 284 |
<ca:value>integer</ca:value> |
|---|
| 285 |
</ca:type> |
|---|
| 286 |
<ca:required> |
|---|
| 287 |
<ca:value>true</ca:value> |
|---|
| 288 |
</ca:required> |
|---|
| 289 |
<ca:description/> |
|---|
| 290 |
</ca:parameter> |
|---|
| 291 |
<ca:parameter> |
|---|
| 292 |
<ca:name>dfGeoMin</ca:name> |
|---|
| 293 |
<ca:type> |
|---|
| 294 |
<ca:value>float</ca:value> |
|---|
| 295 |
</ca:type> |
|---|
| 296 |
<ca:required> |
|---|
| 297 |
<ca:value>true</ca:value> |
|---|
| 298 |
</ca:required> |
|---|
| 299 |
<ca:description/> |
|---|
| 300 |
</ca:parameter> |
|---|
| 301 |
<ca:parameter> |
|---|
| 302 |
<ca:name>dfGeoMax</ca:name> |
|---|
| 303 |
<ca:type> |
|---|
| 304 |
<ca:value>float</ca:value> |
|---|
| 305 |
</ca:type> |
|---|
| 306 |
<ca:required> |
|---|
| 307 |
<ca:value>true</ca:value> |
|---|
| 308 |
</ca:required> |
|---|
| 309 |
<ca:description/> |
|---|
| 310 |
</ca:parameter> |
|---|
| 311 |
<ca:parameter> |
|---|
| 312 |
<ca:name>nInversePix</ca:name> |
|---|
| 313 |
<ca:type> |
|---|
| 314 |
<ca:value>integer</ca:value> |
|---|
| 315 |
</ca:type> |
|---|
| 316 |
<ca:required> |
|---|
| 317 |
<ca:value>true</ca:value> |
|---|
| 318 |
</ca:required> |
|---|
| 319 |
<ca:description/> |
|---|
| 320 |
</ca:parameter> |
|---|
| 321 |
</ca:parameters> |
|---|
| 322 |
</ca:jsfunction> |
|---|
| 323 |
</ca:jsfunctions> |
|---|
| 324 |
</ca:widgetdoc> |
|---|
