| 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>cwcjsapi</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>ALPHA</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="None."> |
|---|
| 61 |
<ca:para>The CWCJSAPI Widget provides a javascript API to the CWC core architecture. |
|---|
| 62 |
This provides an application that runs almost entirely on the client side, |
|---|
| 63 |
with very few 'submits' of the page. It also provides the application |
|---|
| 64 |
developer with a javascript API to access and change the state of the Context.</ca:para> |
|---|
| 65 |
</ca:paras> |
|---|
| 66 |
</ca:description> |
|---|
| 67 |
<ca:techrequirements title="Technical Requirements"> |
|---|
| 68 |
<ca:paras title="None."> |
|---|
| 69 |
<ca:para></ca:para> |
|---|
| 70 |
</ca:paras> |
|---|
| 71 |
</ca:techrequirements> |
|---|
| 72 |
<ca:dependancies title="Dependancies"> |
|---|
| 73 |
<ca:dependancy type="None" title="None."> |
|---|
| 74 |
<ca:para></ca:para> |
|---|
| 75 |
</ca:dependancy> |
|---|
| 76 |
</ca:dependancies> |
|---|
| 77 |
<ca:sharedresources title="Shared Resources"> |
|---|
| 78 |
<ca:paras title="None."> |
|---|
| 79 |
<ca:para></ca:para> |
|---|
| 80 |
</ca:paras> |
|---|
| 81 |
</ca:sharedresources> |
|---|
| 82 |
<ca:embeddedhelp title="General User Interface Help"> |
|---|
| 83 |
<ca:paras title=""> |
|---|
| 84 |
<ca:para></ca:para> |
|---|
| 85 |
</ca:paras> |
|---|
| 86 |
</ca:embeddedhelp> |
|---|
| 87 |
<ca:guinotes title="Interface Functionality"> |
|---|
| 88 |
<ca:guinote type="None" title="None."> |
|---|
| 89 |
<ca:para></ca:para> |
|---|
| 90 |
</ca:guinote> |
|---|
| 91 |
</ca:guinotes> |
|---|
| 92 |
<ca:qanotes title="Quality Assurance"> |
|---|
| 93 |
<ca:paras title="None."> |
|---|
| 94 |
<ca:para></ca:para> |
|---|
| 95 |
</ca:paras> |
|---|
| 96 |
</ca:qanotes> |
|---|
| 97 |
</ca:descriptions> |
|---|
| 98 |
<ca:tagstructures title="Tag Syntax"> |
|---|
| 99 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 100 |
<ca:description></ca:description> |
|---|
| 101 |
<ca:code title=""> |
|---|
| 102 |
<ca:description></ca:description> |
|---|
| 103 |
<ca:codeblock bold="false"> |
|---|
| 104 |
<ca:line> DEBUG ="[boolean]"</ca:line> |
|---|
| 105 |
</ca:codeblock> |
|---|
| 106 |
</ca:code> |
|---|
| 107 |
</ca:tagstructure> |
|---|
| 108 |
</ca:tagstructures> |
|---|
| 109 |
<ca:examples title="Examples"> |
|---|
| 110 |
<ca:widgetexamples title="Widget Examples"> |
|---|
| 111 |
<ca:example title="Example #1: Simple"> |
|---|
| 112 |
<ca:description></ca:description> |
|---|
| 113 |
<ca:code title=""> |
|---|
| 114 |
<ca:description></ca:description> |
|---|
| 115 |
<ca:codeblock bold="false"> |
|---|
| 116 |
<ca:line></ca:line> |
|---|
| 117 |
</ca:codeblock> |
|---|
| 118 |
</ca:code> |
|---|
| 119 |
</ca:example> |
|---|
| 120 |
</ca:widgetexamples> |
|---|
| 121 |
<ca:sharedresourceexamples title="Shared Resources Examples"> |
|---|
| 122 |
<ca:example title="Example #1: Advanced"> |
|---|
| 123 |
<ca:description></ca:description> |
|---|
| 124 |
<ca:code title=""> |
|---|
| 125 |
<ca:description></ca:description> |
|---|
| 126 |
<ca:codeblock bold="false"> |
|---|
| 127 |
<ca:line></ca:line> |
|---|
| 128 |
</ca:codeblock> |
|---|
| 129 |
</ca:code> |
|---|
| 130 |
</ca:example> |
|---|
| 131 |
</ca:sharedresourceexamples> |
|---|
| 132 |
<ca:sampleapps title="Sample Applications"> |
|---|
| 133 |
<ca:sampleapp> |
|---|
| 134 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 135 |
<ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 136 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 137 |
</ca:sampleapp> |
|---|
| 138 |
</ca:sampleapps> |
|---|
| 139 |
<ca:scriptexamples title="Script Examples"> |
|---|
| 140 |
<ca:example title="Example #1: Simple"> |
|---|
| 141 |
<ca:description></ca:description> |
|---|
| 142 |
<ca:code title=""> |
|---|
| 143 |
<ca:description></ca:description> |
|---|
| 144 |
<ca:codeblock bold="false"> |
|---|
| 145 |
<ca:line></ca:line> |
|---|
| 146 |
</ca:codeblock> |
|---|
| 147 |
</ca:code> |
|---|
| 148 |
</ca:example> |
|---|
| 149 |
</ca:scriptexamples> |
|---|
| 150 |
</ca:examples> |
|---|
| 151 |
<ca:attributegroups title="Attribute Groups"> |
|---|
| 152 |
<ca:description></ca:description> |
|---|
| 153 |
<ca:attributegroup> |
|---|
| 154 |
<ca:name>base</ca:name> |
|---|
| 155 |
</ca:attributegroup> |
|---|
| 156 |
</ca:attributegroups> |
|---|
| 157 |
<ca:widgettag title="Attributes"> |
|---|
| 158 |
<ca:attribute> |
|---|
| 159 |
<ca:name>DEBUG</ca:name> |
|---|
| 160 |
<ca:type title="Type"> |
|---|
| 161 |
<ca:value>boolean</ca:value> |
|---|
| 162 |
</ca:type> |
|---|
| 163 |
<ca:class title="Class"> |
|---|
| 164 |
<ca:value>Widget Only</ca:value> |
|---|
| 165 |
</ca:class> |
|---|
| 166 |
<ca:default title="Default"> |
|---|
| 167 |
<ca:description></ca:description> |
|---|
| 168 |
</ca:default> |
|---|
| 169 |
<ca:possvalues type="list" title="Value"> |
|---|
| 170 |
<ca:value>true</ca:value> |
|---|
| 171 |
<ca:value>false</ca:value> |
|---|
| 172 |
</ca:possvalues> |
|---|
| 173 |
<ca:description>Set to TRUE to see the JSAPI hidden layer's input box to assist in debugging errors only.</ca:description> |
|---|
| 174 |
</ca:attribute> |
|---|
| 175 |
<ca:subtag> |
|---|
| 176 |
<ca:name></ca:name> |
|---|
| 177 |
<ca:type title="Type"> |
|---|
| 178 |
<ca:value>XML</ca:value> |
|---|
| 179 |
<ca:description>Child Element to Chameleon widget tag (subtag)</ca:description> |
|---|
| 180 |
</ca:type> |
|---|
| 181 |
<ca:class title="Class"> |
|---|
| 182 |
<ca:value>Widget & Shared Resource</ca:value> |
|---|
| 183 |
</ca:class> |
|---|
| 184 |
<ca:description></ca:description> |
|---|
| 185 |
<ca:attribute> |
|---|
| 186 |
<ca:name></ca:name> |
|---|
| 187 |
<ca:type title="Type"> |
|---|
| 188 |
<ca:value>float</ca:value> |
|---|
| 189 |
<ca:description></ca:description> |
|---|
| 190 |
</ca:type> |
|---|
| 191 |
<ca:class title="Class"> |
|---|
| 192 |
<ca:value>Widget & Shared Resource</ca:value> |
|---|
| 193 |
</ca:class> |
|---|
| 194 |
<ca:default title="Default"> |
|---|
| 195 |
<ca:value></ca:value> |
|---|
| 196 |
<ca:description></ca:description> |
|---|
| 197 |
</ca:default> |
|---|
| 198 |
<ca:possvalues type="list" title="Value"> |
|---|
| 199 |
<ca:value></ca:value> |
|---|
| 200 |
</ca:possvalues> |
|---|
| 201 |
<ca:description></ca:description> |
|---|
| 202 |
</ca:attribute> |
|---|
| 203 |
</ca:subtag> |
|---|
| 204 |
</ca:widgettag> |
|---|
| 205 |
<ca:formelements title="Form Elements"> |
|---|
| 206 |
<ca:formelement> |
|---|
| 207 |
<ca:name>CONTEXT</ca:name> |
|---|
| 208 |
<ca:type title="Type"> |
|---|
| 209 |
<ca:value>unknown</ca:value> |
|---|
| 210 |
<ca:description></ca:description> |
|---|
| 211 |
</ca:type> |
|---|
| 212 |
<ca:default title="Default"> |
|---|
| 213 |
<ca:value></ca:value> |
|---|
| 214 |
<ca:description></ca:description> |
|---|
| 215 |
</ca:default> |
|---|
| 216 |
<ca:possvalues type="list" title="Values"> |
|---|
| 217 |
<ca:value></ca:value> |
|---|
| 218 |
</ca:possvalues> |
|---|
| 219 |
<ca:description>The currently loaded context</ca:description> |
|---|
| 220 |
</ca:formelement> |
|---|
| 221 |
</ca:formelements> |
|---|
| 222 |
<ca:jsvariables title="JavaScript Variables"> |
|---|
| 223 |
<ca:jsvariable> |
|---|
| 224 |
<ca:name>goCWCJSAPI</ca:name> |
|---|
| 225 |
<ca:type title="Type"> |
|---|
| 226 |
<ca:value>string</ca:value> |
|---|
| 227 |
</ca:type> |
|---|
| 228 |
<ca:scope title="Scope"> |
|---|
| 229 |
<ca:value>Private</ca:value> |
|---|
| 230 |
</ca:scope> |
|---|
| 231 |
<ca:default title="Default"> |
|---|
| 232 |
<ca:value></ca:value> |
|---|
| 233 |
</ca:default> |
|---|
| 234 |
<ca:possvalues type="list" title="Values"> |
|---|
| 235 |
<ca:value></ca:value> |
|---|
| 236 |
</ca:possvalues> |
|---|
| 237 |
<ca:description>The global JSAPI object.</ca:description> |
|---|
| 238 |
</ca:jsvariable> |
|---|
| 239 |
</ca:jsvariables> |
|---|
| 240 |
<ca:jsfunctions title="JavaScript Functions"/> |
|---|
| 241 |
<ca:jsfiles title="JavaScript Files"> |
|---|
| 242 |
<ca:jsfile> |
|---|
| 243 |
<ca:name></ca:name> |
|---|
| 244 |
<ca:description></ca:description> |
|---|
| 245 |
<ca:jsvariables title="JavaScript Variables"> |
|---|
| 246 |
<ca:jsvariable> |
|---|
| 247 |
<ca:name></ca:name> |
|---|
| 248 |
<ca:type title="Type"> |
|---|
| 249 |
<ca:value>string</ca:value> |
|---|
| 250 |
</ca:type> |
|---|
| 251 |
<ca:scope title="Scope"> |
|---|
| 252 |
<ca:value>Private</ca:value> |
|---|
| 253 |
</ca:scope> |
|---|
| 254 |
<ca:default title="Default"> |
|---|
| 255 |
<ca:value></ca:value> |
|---|
| 256 |
</ca:default> |
|---|
| 257 |
<ca:possvalues type="list" title="Values"> |
|---|
| 258 |
<ca:value></ca:value> |
|---|
| 259 |
</ca:possvalues> |
|---|
| 260 |
<ca:description></ca:description> |
|---|
| 261 |
</ca:jsvariable> |
|---|
| 262 |
</ca:jsvariables> |
|---|
| 263 |
<ca:jsfunctions title="JavaScript Functions"> |
|---|
| 264 |
<ca:jsfunction> |
|---|
| 265 |
<ca:name></ca:name> |
|---|
| 266 |
<ca:scope title="Scope"> |
|---|
| 267 |
<ca:value>Private</ca:value> |
|---|
| 268 |
</ca:scope> |
|---|
| 269 |
<ca:description></ca:description> |
|---|
| 270 |
<ca:parameters title="Parameters"> |
|---|
| 271 |
<ca:parameter> |
|---|
| 272 |
<ca:name></ca:name> |
|---|
| 273 |
<ca:type title="Type"> |
|---|
| 274 |
<ca:value>string</ca:value> |
|---|
| 275 |
</ca:type> |
|---|
| 276 |
<ca:required title="Required"> |
|---|
| 277 |
<ca:value>false</ca:value> |
|---|
| 278 |
</ca:required> |
|---|
| 279 |
<ca:default title="Default"> |
|---|
| 280 |
<ca:value></ca:value> |
|---|
| 281 |
<ca:description></ca:description> |
|---|
| 282 |
</ca:default> |
|---|
| 283 |
<ca:possvalues type="list" title="Values"> |
|---|
| 284 |
<ca:value></ca:value> |
|---|
| 285 |
</ca:possvalues> |
|---|
| 286 |
<ca:description></ca:description> |
|---|
| 287 |
</ca:parameter> |
|---|
| 288 |
</ca:parameters> |
|---|
| 289 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 290 |
<ca:returnvalue> |
|---|
| 291 |
<ca:type title="Type"> |
|---|
| 292 |
<ca:value>unknown</ca:value> |
|---|
| 293 |
<ca:description></ca:description> |
|---|
| 294 |
</ca:type> |
|---|
| 295 |
<ca:default title="Default"> |
|---|
| 296 |
<ca:value></ca:value> |
|---|
| 297 |
</ca:default> |
|---|
| 298 |
<ca:possvalues type="list" title="Values"> |
|---|
| 299 |
<ca:value></ca:value> |
|---|
| 300 |
</ca:possvalues> |
|---|
| 301 |
<ca:description></ca:description> |
|---|
| 302 |
</ca:returnvalue> |
|---|
| 303 |
</ca:returnvalues> |
|---|
| 304 |
<ca:triggeredjsapievents title="JSAPI Triggered Events"> |
|---|
| 305 |
<ca:triggeredjsapievent title=""> |
|---|
| 306 |
<ca:name></ca:name> |
|---|
| 307 |
<ca:description></ca:description> |
|---|
| 308 |
</ca:triggeredjsapievent> |
|---|
| 309 |
</ca:triggeredjsapievents> |
|---|
| 310 |
</ca:jsfunction> |
|---|
| 311 |
</ca:jsfunctions> |
|---|
| 312 |
</ca:jsfile> |
|---|
| 313 |
</ca:jsfiles> |
|---|
| 314 |
<ca:listenedjsapievents title="JSAPI Listened Events"> |
|---|
| 315 |
<ca:listenedjsapievent title=""> |
|---|
| 316 |
<ca:name></ca:name> |
|---|
| 317 |
<ca:description></ca:description> |
|---|
| 318 |
<ca:calledfunctions title="Functions Calls"> |
|---|
| 319 |
<ca:intro>JSAPI function calls for this widget are outlined here. </ca:intro> |
|---|
| 320 |
<ca:calledfunction> |
|---|
| 321 |
<ca:name></ca:name> |
|---|
| 322 |
<ca:description></ca:description> |
|---|
| 323 |
</ca:calledfunction> |
|---|
| 324 |
</ca:calledfunctions> |
|---|
| 325 |
</ca:listenedjsapievent> |
|---|
| 326 |
</ca:listenedjsapievents> |
|---|
| 327 |
<ca:widgetevents title="Widget Events"> |
|---|
| 328 |
<ca:widgetevent> |
|---|
| 329 |
<ca:name></ca:name> |
|---|
| 330 |
<ca:parameters title="Parameters"> |
|---|
| 331 |
<ca:parameter> |
|---|
| 332 |
<ca:name></ca:name> |
|---|
| 333 |
<ca:type title="Type"> |
|---|
| 334 |
<ca:value>string</ca:value> |
|---|
| 335 |
</ca:type> |
|---|
| 336 |
<ca:required title="Required"> |
|---|
| 337 |
<ca:value>false</ca:value> |
|---|
| 338 |
</ca:required> |
|---|
| 339 |
<ca:default title="Default"> |
|---|
| 340 |
<ca:value></ca:value> |
|---|
| 341 |
<ca:description></ca:description> |
|---|
| 342 |
</ca:default> |
|---|
| 343 |
<ca:possvalues type="list" title="Values"> |
|---|
| 344 |
<ca:value></ca:value> |
|---|
| 345 |
</ca:possvalues> |
|---|
| 346 |
<ca:description></ca:description> |
|---|
| 347 |
</ca:parameter> |
|---|
| 348 |
</ca:parameters> |
|---|
| 349 |
<ca:description></ca:description> |
|---|
| 350 |
</ca:widgetevent> |
|---|
| 351 |
</ca:widgetevents> |
|---|
| 352 |
<ca:errors title="Widget Errors"> |
|---|
| 353 |
<ca:error title="Error #1"> |
|---|
| 354 |
<ca:type title="Type"> |
|---|
| 355 |
<ca:value>PHP Mapscript</ca:value> |
|---|
| 356 |
</ca:type> |
|---|
| 357 |
<ca:severity title="Severity"> |
|---|
| 358 |
<ca:value>none</ca:value> |
|---|
| 359 |
<ca:description></ca:description> |
|---|
| 360 |
</ca:severity> |
|---|
| 361 |
<ca:message title="Error Message"> |
|---|
| 362 |
<ca:paras title=""> |
|---|
| 363 |
<ca:para>Error message string....</ca:para> |
|---|
| 364 |
</ca:paras> |
|---|
| 365 |
</ca:message> |
|---|
| 366 |
<ca:meaning title="Interpretation"> |
|---|
| 367 |
<ca:paras title=""> |
|---|
| 368 |
<ca:para>The description of what the message means......</ca:para> |
|---|
| 369 |
</ca:paras> |
|---|
| 370 |
</ca:meaning> |
|---|
| 371 |
<ca:solution title="Troubleshooting Tips"> |
|---|
| 372 |
<ca:paras title=""> |
|---|
| 373 |
<ca:para>Any possible solution that will help application developers troubleshoot and fix the problem.</ca:para> |
|---|
| 374 |
</ca:paras> |
|---|
| 375 |
</ca:solution> |
|---|
| 376 |
</ca:error> |
|---|
| 377 |
</ca:errors> |
|---|
| 378 |
</ca:widgetdoc> |
|---|
