| 1 |
<?xml version="1.0"?> |
|---|
| 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 |
<!-- ***************************** --> |
|---|
| 4 |
<!-- SPECIFIC DOCUMENT INFORMATION --> |
|---|
| 5 |
<!-- ***************************** --> |
|---|
| 6 |
<ca:docinfo title="Document Information" > |
|---|
| 7 |
<ca:intro>The documentation information provided in this section. Gives specific information on the activities and state of the current widget document.</ca:intro> |
|---|
| 8 |
<ca:language title="Document Language Code"> |
|---|
| 9 |
<ca:value>en-CA</ca:value> |
|---|
| 10 |
<ca:description>This document is written in Canadian English</ca:description> |
|---|
| 11 |
</ca:language> |
|---|
| 12 |
<ca:docbuilddate title="Doc_Builder Date"> |
|---|
| 13 |
<ca:value>1999-12-31</ca:value> |
|---|
| 14 |
<ca:description>The date of the document was last processed through doc builder.</ca:description> |
|---|
| 15 |
</ca:docbuilddate> |
|---|
| 16 |
<ca:docversion title="Document Repository Version"> |
|---|
| 17 |
<ca:value>$id:$</ca:value> |
|---|
| 18 |
<ca:description>CVS repository version description</ca:description> |
|---|
| 19 |
</ca:docversion> |
|---|
| 20 |
<ca:authors title="Authors"> |
|---|
| 21 |
<ca:intro>The following active authors for this widget document are:</ca:intro> |
|---|
| 22 |
<ca:person> |
|---|
| 23 |
<ca:name>Doc_Builder</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:authors> |
|---|
| 29 |
<ca:editors title="Editors"> |
|---|
| 30 |
<ca:intro>The following active editors for this widget document are:</ca:intro> |
|---|
| 31 |
<ca:person> |
|---|
| 32 |
<ca:name>Christopher R. Thorne</ca:name> |
|---|
| 33 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 34 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 35 |
<ca:comment></ca:comment> |
|---|
| 36 |
</ca:person> |
|---|
| 37 |
<ca:person> |
|---|
| 38 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 39 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 40 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 41 |
<ca:comment></ca:comment> |
|---|
| 42 |
</ca:person> |
|---|
| 43 |
</ca:editors> |
|---|
| 44 |
</ca:docinfo> |
|---|
| 45 |
<!-- ********************* --> |
|---|
| 46 |
<!-- WIDGET IDENTIFICATION --> |
|---|
| 47 |
<!-- ********************* --> |
|---|
| 48 |
<ca:identification title="Identification"> |
|---|
| 49 |
<ca:intro>The main developers of this widget should present them selves bellow:</ca:intro> |
|---|
| 50 |
<ca:name title="Widget Name"> |
|---|
| 51 |
<ca:value>MapSize</ca:value> |
|---|
| 52 |
<ca:description>The name of this widget based on last current widget name is:</ca:description> |
|---|
| 53 |
</ca:name> |
|---|
| 54 |
<ca:chameleonpack title="Widget Package"> |
|---|
| 55 |
<ca:value>TBD</ca:value> |
|---|
| 56 |
<ca:description>The widget installation package the widget is in.</ca:description> |
|---|
| 57 |
</ca:chameleonpack> |
|---|
| 58 |
<ca:parentgroup title="Parent Group"> |
|---|
| 59 |
<ca:value>TBD</ca:value> |
|---|
| 60 |
<ca:description></ca:description> |
|---|
| 61 |
</ca:parentgroup> |
|---|
| 62 |
<ca:version title="Version"> |
|---|
| 63 |
<ca:value>1.99</ca:value> |
|---|
| 64 |
<ca:description>Chameleon Technical Release</ca:description> |
|---|
| 65 |
</ca:version> |
|---|
| 66 |
<ca:releasedate title="Release Date"> |
|---|
| 67 |
<ca:value>2005-01-10</ca:value> |
|---|
| 68 |
<ca:description>Chameleon Technical Release</ca:description> |
|---|
| 69 |
</ca:releasedate> |
|---|
| 70 |
<ca:maturitylevel title="Maturity Level"> |
|---|
| 71 |
<ca:value>TECHRELEASE</ca:value> |
|---|
| 72 |
<ca:description>- (i.e., in development, functionally complete, no know major bugs, minimal documentation)</ca:description> |
|---|
| 73 |
</ca:maturitylevel> |
|---|
| 74 |
<ca:developers title="Developers"> |
|---|
| 75 |
<ca:person> |
|---|
| 76 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 77 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 78 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 79 |
<ca:comment></ca:comment> |
|---|
| 80 |
</ca:person> |
|---|
| 81 |
</ca:developers> |
|---|
| 82 |
|
|---|
| 83 |
</ca:identification> |
|---|
| 84 |
<!-- ************************** --> |
|---|
| 85 |
<!-- WIDGET GENERAL DESCRIPTION --> |
|---|
| 86 |
<!-- ************************** --> |
|---|
| 87 |
<ca:descriptions title="Description"> |
|---|
| 88 |
<ca:intro>This section holds all content description for a specific widget.</ca:intro> |
|---|
| 89 |
<ca:description title="General Functionality"> |
|---|
| 90 |
<ca:intro>The general description of the importance of the current widget.</ca:intro> |
|---|
| 91 |
<ca:paras title=""> |
|---|
| 92 |
<ca:para>The MapSize widget is used to allow the user to specify new dimensions for the map image, either from a pre-defined list of sizes or by specifying a custom size. Note that the MapDHTMLWidget widget must have ALLOWRESIZE set to "TRUE" for MapSize to have any effect. This widget can be embedded into the interface with a drop down list or with a popup that is launched by a button. When the widget is embedded, it has Label attributes, and when it is not embedded it has Button attributes.</ca:para> |
|---|
| 93 |
</ca:paras> |
|---|
| 94 |
</ca:description> |
|---|
| 95 |
<!-- ********************************* --> |
|---|
| 96 |
<!-- WIDGET Technical Requirements DESCRIPTIONS --> |
|---|
| 97 |
<!-- ********************************* --> |
|---|
| 98 |
<ca:techrequirements title="Technical Requirements"> |
|---|
| 99 |
<ca:paras title=""> |
|---|
| 100 |
<ca:para></ca:para> |
|---|
| 101 |
</ca:paras> |
|---|
| 102 |
</ca:techrequirements> |
|---|
| 103 |
<!-- ****************** --> |
|---|
| 104 |
<!-- WIDGET Dependency --> |
|---|
| 105 |
<!-- ****************** --> |
|---|
| 106 |
<ca:dependancies title="Dependencies"> |
|---|
| 107 |
<ca:dependancy type="Attribute" title="MapDHTML's ALLOWRESIZE Attribute" > |
|---|
| 108 |
<ca:para>The MapDHTML widget must be present in the application template and it must have its ALLOWRESIZE attribute set to "true" to allow the MapSize widget to change the map size within an application.</ca:para> |
|---|
| 109 |
</ca:dependancy> |
|---|
| 110 |
</ca:dependancies> |
|---|
| 111 |
<!-- ************************************* --> |
|---|
| 112 |
<!-- SHARED RESOURCES --> |
|---|
| 113 |
<!-- ************************************* --> |
|---|
| 114 |
<ca:sharedresources title="Shared Resources"> |
|---|
| 115 |
<ca:intro>The type of attributes used by this widget determines what kind of Shared Resources the widget can use.</ca:intro> |
|---|
| 116 |
<ca:paras title="TextButton and PopupCSS"> |
|---|
| 117 |
<ca:para>The MapSize widget tag has attributes from the Button Attributes and Popup Attributes Groups. This means MapSize has access to the Style and PopupCSS Shared Resources. To learn about these Shared Resources, please refer to the appropriate attribute group sections for details.</ca:para> |
|---|
| 118 |
</ca:paras> |
|---|
| 119 |
</ca:sharedresources> |
|---|
| 120 |
<!-- ****************** --> |
|---|
| 121 |
<!-- WIDGET EMBBEDDED HELP INFO --> |
|---|
| 122 |
<!-- ****************** --> |
|---|
| 123 |
<ca:embeddedhelp title="General User Help"> |
|---|
| 124 |
<ca:paras title=""> |
|---|
| 125 |
<ca:para>This widget provides the capability to modify the size of the map image. The widget may be embedded in the page as a dropdown list of map sizes (choose the desired size) or represented by a button that launches a small dialog to allow picking a map size. This widget may be configured to allow only pre-defined sizes, or it may be configured to allow the user to enter a custom map size. In the latter case, enter the new dimensions (in pixels) and click OK to change the size of the map. Note that larger map sizes take longer to generate and download. The smallest size is typically 400 x 300. The largest size is typically 1000 x 750.</ca:para> |
|---|
| 126 |
</ca:paras> |
|---|
| 127 |
</ca:embeddedhelp> |
|---|
| 128 |
<!-- ********************************* --> |
|---|
| 129 |
<!-- WIDGET FUNCTIONALITY DESCRIPTIONS --> |
|---|
| 130 |
<!-- ********************************* --> |
|---|
| 131 |
<ca:guinotes title="Interface Functionality"> |
|---|
| 132 |
<ca:guinote type="Drop Down List" title="Embedded in Application"> |
|---|
| 133 |
<ca:para>If the MapSize widget is set to embedded mode then a labeled drop-down list of map size options is created. Examples of options could be: Large, Medium, Small, and Custom. If "custom" is included in the list of choices, a dialog box will be opened to allow the user to specify the new size, despite the fact the widget is in embedded mode. </ca:para> |
|---|
| 134 |
</ca:guinote> |
|---|
| 135 |
<ca:guinote type="Button" title="Launches Popup"> |
|---|
| 136 |
<ca:para>If the MapSize widget is not set to be embedded, then it is represented as a button that launches a dialog box. The dialog box allows the user to pick from pre-defined sizes or enter a custom size (if "custom" is one of the choices).</ca:para> |
|---|
| 137 |
</ca:guinote> |
|---|
| 138 |
<ca:guinote type="Popup" title="Customizing Your Map Size"> |
|---|
| 139 |
<ca:para>In the popup window, if "custom" is defined in the "MapSize" Widget tag, text fields are displayed to allow the user to define the WIDTH and HEIGHT of the map.</ca:para> |
|---|
| 140 |
</ca:guinote> |
|---|
| 141 |
</ca:guinotes> |
|---|
| 142 |
|
|---|
| 143 |
<!-- ********************************* --> |
|---|
| 144 |
<!-- WIDGET QA DESCRIPTIONS --> |
|---|
| 145 |
<!-- ********************************* --> |
|---|
| 146 |
<ca:qanotes title="Quality Assurance"> |
|---|
| 147 |
<ca:paras title=""> |
|---|
| 148 |
<ca:para></ca:para> |
|---|
| 149 |
</ca:paras> |
|---|
| 150 |
</ca:qanotes> |
|---|
| 151 |
</ca:descriptions> |
|---|
| 152 |
<!-- ********************************* --> |
|---|
| 153 |
<!-- WIDGET TAG STRUCTURE --> |
|---|
| 154 |
<!-- ********************************* --> |
|---|
| 155 |
<ca:tagstructures title="Tag Syntax"> |
|---|
| 156 |
<ca:intro>The tag syntax of the widget and possible shared resource is outlined here. It is important to show how the tag structure is declared within an HTML, because it will help to determine where and how an attribute is declared. It is important to note that Shared Resource may also be declared through a specific widget. If this is the case for the current widget than there should be a shared resource tag syntax definition below the widget. If a widget utilizes an Attribute Group the current widget will also have access to the Attribute Group Shared Resource.</ca:intro> |
|---|
| 157 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 158 |
<ca:description>If the EMBEDDED attribute is set to "TRUE", then the following widget definition is available. Note that the popup attributes are available, since a popup is available if "custom" is an option in the embedded drop down list. Also note that the widget has label attributes when it is embedded.</ca:description> |
|---|
| 159 |
<ca:code title="When Embedded Equals TRUE"> |
|---|
| 160 |
<ca:description></ca:description> |
|---|
| 161 |
<ca:codeblock bold="true" > |
|---|
| 162 |
<ca:line><CWC2 TYPE="MapSize"</ca:line> |
|---|
| 163 |
</ca:codeblock> |
|---|
| 164 |
<ca:codeblock bold="false"> |
|---|
| 165 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 166 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 167 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 168 |
<ca:line></ca:line> |
|---|
| 169 |
<ca:line> <!-- MapSize Attributes --></ca:line> |
|---|
| 170 |
<ca:line></ca:line> |
|---|
| 171 |
<ca:line> EMBEDDED="[TRUE|FALSE]"</ca:line> |
|---|
| 172 |
<ca:line></ca:line> |
|---|
| 173 |
<ca:line> <!-- Popup Attribute Group --></ca:line> |
|---|
| 174 |
<ca:line></ca:line> |
|---|
| 175 |
</ca:codeblock> |
|---|
| 176 |
<ca:codeblock bold="true"> |
|---|
| 177 |
<ca:line> POPUPHEIGHT="[0 < integer]"</ca:line> |
|---|
| 178 |
<ca:line> POPUPWIDTH="[0 < integer]"</ca:line> |
|---|
| 179 |
</ca:codeblock> |
|---|
| 180 |
<ca:codeblock bold="false"> |
|---|
| 181 |
<ca:line> MENUBAR="[TRUE|FALSE]"</ca:line> |
|---|
| 182 |
<ca:line> POPUPSTYLERESOURCE="[string]"</ca:line> |
|---|
| 183 |
<ca:line> RESIZABLE="[TRUE|FALSE]"</ca:line> |
|---|
| 184 |
<ca:line> SCROLLBARS="[TRUE|FALSE]"</ca:line> |
|---|
| 185 |
<ca:line> STATUS="[TRUE|FALSE]"</ca:line> |
|---|
| 186 |
<ca:line> TOOLBAR="[TRUE|FALSE]"></ca:line> |
|---|
| 187 |
<ca:line></ca:line> |
|---|
| 188 |
<ca:line> <!-- Label Attribute Group--></ca:line> |
|---|
| 189 |
<ca:line/> |
|---|
| 190 |
<ca:line> LABEL="[string]"</ca:line> |
|---|
| 191 |
<ca:line> LABELPOSITION="[0 < integer < 8]"</ca:line> |
|---|
| 192 |
<ca:line> LABELHALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 193 |
<ca:line> LABELVALIGN="[TOP|MIDDLE|BOTTOM]"</ca:line> |
|---|
| 194 |
<ca:line> LABELCLASS="[string]"</ca:line> |
|---|
| 195 |
<ca:line> LABELSTYLE="[string]"/></ca:line> <ca:line></ca:line> |
|---|
| 196 |
<ca:line> <!-- MapSize Subtag Group --></ca:line> |
|---|
| 197 |
<ca:line></ca:line> |
|---|
| 198 |
</ca:codeblock> |
|---|
| 199 |
<ca:codeblock bold="true" > |
|---|
| 200 |
<ca:line> <MAPSIZE LABEL="[string]"</ca:line> |
|---|
| 201 |
<ca:line> HEIGHT="[CUSTOM|0 < integer]"</ca:line> |
|---|
| 202 |
<ca:line> WIDTH="[CUSTOM|0 < integer]"/></ca:line> |
|---|
| 203 |
<ca:line></CWC2></ca:line> |
|---|
| 204 |
</ca:codeblock> |
|---|
| 205 |
</ca:code> |
|---|
| 206 |
</ca:tagstructure> |
|---|
| 207 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 208 |
<ca:description>If the EMBEDDED attribute is set to "FALSE", then the Button and Popup Attribute Groups are valid for this widget. The widget will not use any Label attributes when not embedded. The following widget definition is available:</ca:description> |
|---|
| 209 |
<ca:code title="When Embedded Equals FALSE"> |
|---|
| 210 |
<ca:description></ca:description> |
|---|
| 211 |
<ca:codeblock bold="true" > |
|---|
| 212 |
<ca:line><CWC2 TYPE="MapSize"</ca:line> |
|---|
| 213 |
</ca:codeblock> |
|---|
| 214 |
<ca:codeblock bold="false" > |
|---|
| 215 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 216 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 217 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 218 |
<ca:line></ca:line> |
|---|
| 219 |
<ca:line> <!-- MapSize Attributes --></ca:line> |
|---|
| 220 |
<ca:line></ca:line> |
|---|
| 221 |
<ca:line> EMBEDDED="[TRUE|FALSE]"</ca:line> |
|---|
| 222 |
<ca:line></ca:line> |
|---|
| 223 |
<ca:line> <!-- Popup Attribute Group --></ca:line> |
|---|
| 224 |
<ca:line></ca:line> |
|---|
| 225 |
</ca:codeblock> |
|---|
| 226 |
<ca:codeblock bold="true" > |
|---|
| 227 |
<ca:line> POPUPHEIGHT="[0 < integer]"</ca:line> |
|---|
| 228 |
<ca:line> POPUPWIDTH="[0 < integer]"</ca:line> |
|---|
| 229 |
</ca:codeblock> |
|---|
| 230 |
<ca:codeblock bold="false" > |
|---|
| 231 |
<ca:line> MENUBAR="[TRUE|FALSE]"</ca:line> |
|---|
| 232 |
<ca:line> POPUPSTYLERESOURCE="[string]"</ca:line> |
|---|
| 233 |
<ca:line> RESIZABLE="[TRUE|FALSE]"</ca:line> |
|---|
| 234 |
<ca:line> SCROLLBARS="[TRUE|FALSE]"</ca:line> |
|---|
| 235 |
<ca:line> STATUS="[TRUE|FALSE]"</ca:line> |
|---|
| 236 |
<ca:line> TOOLBAR="[TRUE|FALSE]"></ca:line> |
|---|
| 237 |
<ca:line></ca:line> |
|---|
| 238 |
<ca:line> <!-- Button Attribute Group--></ca:line> |
|---|
| 239 |
<ca:line></ca:line> |
|---|
| 240 |
<ca:line> BACKGROUNDIMAGE="[path]"</ca:line> |
|---|
| 241 |
<ca:line> DEFAULT="[TRUE|FALSE]"</ca:line> |
|---|
| 242 |
<ca:line> IMAGE="[path]"</ca:line> |
|---|
| 243 |
<ca:line> IMAGEHEIGHT="[integer]"</ca:line> |
|---|
| 244 |
<ca:line> IMAGETIP="[string]"</ca:line> |
|---|
| 245 |
<ca:line> IMAGEWIDTH="[integer]"</ca:line> |
|---|
| 246 |
<ca:line> LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 247 |
<ca:line> LABELANTIALIAS="[TRUE|FALSE]"</ca:line> |
|---|
| 248 |
<ca:line> LABELCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 249 |
<ca:line> LABELFONT="[string]"</ca:line> |
|---|
| 250 |
<ca:line> LABELFONTSIZE="[0 < integer]"</ca:line> |
|---|
| 251 |
<ca:line> ONCLICK="[string]"</ca:line> |
|---|
| 252 |
<ca:line> STYLERESOURCE="[string]"</ca:line> |
|---|
| 253 |
<ca:line> TEXTBUTTONBORDER="[path]"</ca:line> |
|---|
| 254 |
<ca:line> TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line> |
|---|
| 255 |
<ca:line> TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line> |
|---|
| 256 |
<ca:line> TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 257 |
<ca:line> TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line> |
|---|
| 258 |
<ca:line> TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line> |
|---|
| 259 |
<ca:line> TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line> |
|---|
| 260 |
<ca:line> TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line> |
|---|
| 261 |
<ca:line> TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 262 |
<ca:line> TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 263 |
<ca:line> TEXTBUTTONNUDGE="[integer]"</ca:line> |
|---|
| 264 |
<ca:line> TEXTBUTTONPADDING="[0 < integer]"</ca:line> |
|---|
| 265 |
<ca:line> TOOLSET="[string]"</ca:line> |
|---|
| 266 |
<ca:line> USETEXTBUTTONCACHE="[TRUE|FALSE]"></ca:line> |
|---|
| 267 |
<ca:line></ca:line> |
|---|
| 268 |
<ca:line> <!-- Button Subtag Group --></ca:line> |
|---|
| 269 |
<ca:line></ca:line> |
|---|
| 270 |
<ca:line> <IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line> |
|---|
| 271 |
<ca:line> IMAGE="[path]"/></ca:line> |
|---|
| 272 |
|
|---|
| 273 |
<ca:line> <!-- MapSize Subtag Group --></ca:line> |
|---|
| 274 |
<ca:line></ca:line> |
|---|
| 275 |
</ca:codeblock> |
|---|
| 276 |
<ca:codeblock bold="true" > |
|---|
| 277 |
<ca:line> <MAPSIZE LABEL="[string]"</ca:line> |
|---|
| 278 |
<ca:line> HEIGHT="[CUSTOM|0 < integer]"</ca:line> |
|---|
| 279 |
<ca:line> WIDTH="[CUSTOM|0 < integer]"/></ca:line> |
|---|
| 280 |
<ca:line></CWC2></ca:line> |
|---|
| 281 |
</ca:codeblock> |
|---|
| 282 |
</ca:code> |
|---|
| 283 |
</ca:tagstructure> |
|---|
| 284 |
</ca:tagstructures> |
|---|
| 285 |
<!-- EXAMPLES SECTION --> |
|---|
| 286 |
<ca:examples title="Examples"> |
|---|
| 287 |
<ca:intro>This is the section for all code examples. From Widget, Shared Resource to Advance Scripting examples.</ca:intro> |
|---|
| 288 |
<!-- Widget Examples --> |
|---|
| 289 |
<ca:widgetexamples title="Widget Examples"> |
|---|
| 290 |
<ca:intro>Below are examples of Chameleon widget tags that could be placed into an HTML template with little to no attribute value changes. All Widget Tags should be placed between the HTML <form> </form> tag with the Template. </ca:intro> |
|---|
| 291 |
<ca:example title="Example #1: Simple"> |
|---|
| 292 |
<ca:description>The following is an embedded="TRUE" example. Please note that the mapsize subtag is required.</ca:description> |
|---|
| 293 |
<ca:code> |
|---|
| 294 |
<ca:codeblock bold="false"> |
|---|
| 295 |
<ca:line><cwc2 type="MapSize"</ca:line> |
|---|
| 296 |
<ca:line> embedded="true"</ca:line> |
|---|
| 297 |
<ca:line> popupwidth="480"</ca:line> |
|---|
| 298 |
<ca:line> popupheight="200"></ca:line> |
|---|
| 299 |
<ca:line> <mapsize label="Small"</ca:line> |
|---|
| 300 |
<ca:line> width="400"</ca:line> |
|---|
| 301 |
<ca:line> height="300"/></ca:line> |
|---|
| 302 |
<ca:line> <mapsize label="Medium"</ca:line> |
|---|
| 303 |
<ca:line> width="600"</ca:line> |
|---|
| 304 |
<ca:line> height="450"/></ca:line> |
|---|
| 305 |
<ca:line> <mapsize label="Large"</ca:line> |
|---|
| 306 |
<ca:line> width="800"</ca:line> |
|---|
| 307 |
<ca:line> height="600"/></ca:line> |
|---|
| 308 |
<ca:line> <mapsize label="Custom ..."</ca:line> |
|---|
| 309 |
<ca:line> width="custom"</ca:line> |
|---|
| 310 |
<ca:line> height="custom"/></ca:line> |
|---|
| 311 |
<ca:line></cwc2></ca:line> |
|---|
| 312 |
</ca:codeblock> |
|---|
| 313 |
</ca:code> |
|---|
| 314 |
</ca:example> |
|---|
| 315 |
<ca:example title="Example #2: Advanced"> |
|---|
| 316 |
<ca:description>The following is an embedded="FALSE" example. Button group attributes should be defined in a Shared Resource.</ca:description> |
|---|
| 317 |
<ca:code > |
|---|
| 318 |
|
|---|
| 319 |
<ca:codeblock bold="false"> |
|---|
| 320 |
<ca:line><cwc2 type="MapSize"</ca:line> |
|---|
| 321 |
<ca:line> embedded="false"</ca:line> |
|---|
| 322 |
<ca:line> popupwidth="480"</ca:line> |
|---|
| 323 |
<ca:line> popupheight="200"</ca:line> |
|---|
| 324 |
<ca:line> toolbar="false"</ca:line> |
|---|
| 325 |
<ca:line> status="false"</ca:line> |
|---|
| 326 |
<ca:line> menubar="false"</ca:line> |
|---|
| 327 |
<ca:line> visible="true"</ca:line> |
|---|
| 328 |
<ca:line> image="icons/icon_mapsize.png"</ca:line> |
|---|
| 329 |
<ca:line> imagewidth="19"</ca:line> |
|---|
| 330 |
<ca:line> imageheight="18"</ca:line> |
|---|
| 331 |
<ca:line> imagetip="Set Map Size"</ca:line> |
|---|
| 332 |
<ca:line> label="Map Size"></ca:line> |
|---|
| 333 |
<ca:line> <mapsize label="Small"</ca:line> |
|---|
| 334 |
<ca:line> width="400"</ca:line> |
|---|
| 335 |
<ca:line> height="300"/></ca:line> |
|---|
| 336 |
<ca:line> <mapsize label="Medium"</ca:line> |
|---|
| 337 |
<ca:line> width="600"</ca:line> |
|---|
| 338 |
<ca:line> height="450"/></ca:line> |
|---|
| 339 |
<ca:line> <mapsize label="Large"</ca:line> |
|---|
| 340 |
<ca:line> width="800"</ca:line> |
|---|
| 341 |
<ca:line> height="600"/></ca:line> |
|---|
| 342 |
<ca:line> <mapsize label="Custom ..."</ca:line> |
|---|
| 343 |
<ca:line> width="custom"</ca:line> |
|---|
| 344 |
<ca:line> height="custom"/></ca:line> |
|---|
| 345 |
<ca:line></cwc2></ca:line> |
|---|
| 346 |
</ca:codeblock> |
|---|
| 347 |
</ca:code> |
|---|
| 348 |
</ca:example> |
|---|
| 349 |
</ca:widgetexamples> |
|---|
| 350 |
<!-- Shared Resources Examples --> |
|---|
| 351 |
<ca:sharedresourceexamples title="Shared Resource Examples"> |
|---|
| 352 |
<ca:example title=""> |
|---|
| 353 |
<ca:description></ca:description> |
|---|
| 354 |
<ca:code title=""> |
|---|
| 355 |
<ca:description></ca:description> |
|---|
| 356 |
<ca:codeblock bold="false"> |
|---|
| 357 |
<ca:line></ca:line> |
|---|
| 358 |
</ca:codeblock> |
|---|
| 359 |
</ca:code> |
|---|
| 360 |
</ca:example> |
|---|
| 361 |
</ca:sharedresourceexamples> |
|---|
| 362 |
<!-- Sample Applications --> |
|---|
| 363 |
<ca:sampleapps title="Sample Applications"> |
|---|
| 364 |
<ca:intro>See this widget in action! Here are some applications that use this widget.</ca:intro> |
|---|
| 365 |
<ca:sampleapp> |
|---|
| 366 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 367 |
<ca:appurl>http://www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 368 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 369 |
</ca:sampleapp> |
|---|
| 370 |
</ca:sampleapps> |
|---|
| 371 |
<!-- Application Programming Script Examples --> |
|---|
| 372 |
<ca:scriptexamples title="Script Examples"> |
|---|
| 373 |
<ca:example title=""> |
|---|
| 374 |
<ca:description></ca:description> |
|---|
| 375 |
<ca:code title=""> |
|---|
| 376 |
<ca:description></ca:description> |
|---|
| 377 |
<ca:codeblock bold="false"> |
|---|
| 378 |
<ca:line></ca:line> |
|---|
| 379 |
</ca:codeblock> |
|---|
| 380 |
</ca:code> |
|---|
| 381 |
</ca:example> |
|---|
| 382 |
</ca:scriptexamples> |
|---|
| 383 |
</ca:examples> |
|---|
| 384 |
<!-- ******************************************************************** --> |
|---|
| 385 |
<!-- ATTRIBUTE GROUP INCLUDE DOCUMENT XML FEATURE --> |
|---|
| 386 |
<!-- ******************************************************************** --> |
|---|
| 387 |
<!-- Child Attribute that are defined in the attribute group --> |
|---|
| 388 |
<ca:attributegroups title="Attribute Groups"> |
|---|
| 389 |
<ca:description></ca:description> |
|---|
| 390 |
<ca:attributegroup> |
|---|
| 391 |
<ca:name>Base</ca:name> |
|---|
| 392 |
<ca:name>Button</ca:name> |
|---|
| 393 |
<ca:name>Popup</ca:name> |
|---|
| 394 |
<ca:name>Label</ca:name> |
|---|
| 395 |
</ca:attributegroup> |
|---|
| 396 |
</ca:attributegroups> |
|---|
| 397 |
<!-- ********************** --> |
|---|
| 398 |
<!-- ATTRIBUTES LIST --> |
|---|
| 399 |
<!-- ********************** --> |
|---|
| 400 |
<ca:widgettag title="Attributes"> |
|---|
| 401 |
<ca:intro>This Attribute section outlines the declared attributes found specifically within this specific widget. This attributes declared include: Widget Attributes, Shared Resource Attributes, as well as Widget XML Sub Tags and Sub Tag attribute groupings.</ca:intro> |
|---|
| 402 |
<!-- Child Widget Attributes to CWC2 tag --> |
|---|
| 403 |
<ca:attribute> |
|---|
| 404 |
<ca:name>EMBEDDED</ca:name> |
|---|
| 405 |
<ca:type title="Type"> |
|---|
| 406 |
<ca:value>boolean</ca:value> |
|---|
| 407 |
<ca:description></ca:description> |
|---|
| 408 |
</ca:type> |
|---|
| 409 |
<ca:class title="Class"> |
|---|
| 410 |
<ca:value>Widget Only</ca:value> |
|---|
| 411 |
</ca:class> |
|---|
| 412 |
<ca:default title="Default"> |
|---|
| 413 |
<ca:value>false</ca:value> |
|---|
| 414 |
<ca:description></ca:description> |
|---|
| 415 |
</ca:default> |
|---|
| 416 |
<ca:possvalues type="list" title="Value"> |
|---|
| 417 |
<ca:value>true</ca:value> |
|---|
| 418 |
<ca:value>false</ca:value> |
|---|
| 419 |
</ca:possvalues> |
|---|
| 420 |
<ca:description>Defines two optional modes for the MapSize widget. If set to "true", the MapSize widget is represented as a dropdown combo-box list. If set to "false", the MapSize widget is represented as a button that launches a popup.</ca:description> |
|---|
| 421 |
</ca:attribute> |
|---|
| 422 |
<ca:attribute> |
|---|
| 423 |
<ca:name>WIDGETCLASS</ca:name> |
|---|
| 424 |
<ca:type> |
|---|
| 425 |
<ca:value>string</ca:value> |
|---|
| 426 |
</ca:type> |
|---|
| 427 |
<ca:class> |
|---|
| 428 |
<ca:value>Widget Only</ca:value> |
|---|
| 429 |
</ca:class> |
|---|
| 430 |
<ca:default> |
|---|
| 431 |
<ca:value>NULL</ca:value> |
|---|
| 432 |
<ca:description/> |
|---|
| 433 |
</ca:default> |
|---|
| 434 |
<ca:description>Specify a CSS class to be used for the HTML select element used when the widget is embedded.</ca:description> |
|---|
| 435 |
</ca:attribute> |
|---|
| 436 |
<!-- Sub Tag Defined and Sub Tag Attribute Grouping Listed --> |
|---|
| 437 |
<ca:subtag> |
|---|
| 438 |
<ca:name><MAPSIZE /></ca:name> |
|---|
| 439 |
<ca:type title="Type"> |
|---|
| 440 |
<ca:value>XML</ca:value> |
|---|
| 441 |
<ca:description>Child Element to Chameleon Widget Tag (Subtag)</ca:description> |
|---|
| 442 |
</ca:type> |
|---|
| 443 |
<ca:class title="Class"> |
|---|
| 444 |
<ca:value>Required</ca:value> |
|---|
| 445 |
</ca:class> |
|---|
| 446 |
<ca:description>A subtag placeholder for MapSize attributes settings. These attributes define what map size options the user of the application has. These options are placed within the combo-box list. Since there are no default settings for this widget, the subtag and attributes are required for the widget to function.</ca:description> |
|---|
| 447 |
<ca:attribute> |
|---|
| 448 |
<ca:name>HEIGHT</ca:name> |
|---|
| 449 |
<ca:type title="Type"> |
|---|
| 450 |
<ca:value>integer</ca:value> |
|---|
| 451 |
<ca:description></ca:description> |
|---|
| 452 |
</ca:type> |
|---|
| 453 |
<ca:class title="Class"> |
|---|
| 454 |
<ca:value>Required</ca:value> |
|---|
| 455 |
</ca:class> |
|---|
| 456 |
<ca:default title="Default"> |
|---|
| 457 |
<ca:value></ca:value> |
|---|
| 458 |
<ca:description></ca:description> |
|---|
| 459 |
</ca:default> |
|---|
| 460 |
<ca:possvalues type="range" title="Value"> |
|---|
| 461 |
<ca:minimum>1</ca:minimum> |
|---|
| 462 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 463 |
</ca:possvalues> |
|---|
| 464 |
<ca:description>This attribute defines the height option (in pixels) of the map size. The HEIGHT attribute has a reserved word option, "custom". If the WIDTH attribute is also defined with this word, then the user can define their own map size using the custom popup interface of the MapSize widget.</ca:description> |
|---|
| 465 |
</ca:attribute> |
|---|
| 466 |
<ca:attribute> |
|---|
| 467 |
<ca:name>LABEL</ca:name> |
|---|
| 468 |
<ca:type title="Type"> |
|---|
| 469 |
<ca:value>string</ca:value> |
|---|
| 470 |
<ca:description></ca:description> |
|---|
| 471 |
</ca:type> |
|---|
| 472 |
<ca:class title="Class"> |
|---|
| 473 |
<ca:value>Required</ca:value> |
|---|
| 474 |
</ca:class> |
|---|
| 475 |
<ca:description>Define what is displayed to the user in the drop down list of map size options. For example, Small, Medium, Large, or Custom.</ca:description> |
|---|
| 476 |
</ca:attribute> |
|---|
| 477 |
<ca:attribute> |
|---|
| 478 |
<ca:name>WIDTH</ca:name> |
|---|
| 479 |
<ca:type title="Type"> |
|---|
| 480 |
<ca:value>integer</ca:value> |
|---|
| 481 |
<ca:description></ca:description> |
|---|
| 482 |
</ca:type> |
|---|
| 483 |
<ca:class title="Class"> |
|---|
| 484 |
<ca:value>Required</ca:value> |
|---|
| 485 |
</ca:class> |
|---|
| 486 |
<ca:default title="Default"> |
|---|
| 487 |
<ca:value></ca:value> |
|---|
| 488 |
<ca:description></ca:description> |
|---|
| 489 |
</ca:default> |
|---|
| 490 |
<ca:possvalues type="range" title="Value"> |
|---|
| 491 |
<ca:minimum>1</ca:minimum> |
|---|
| 492 |
<ca:maximum>2147483647</ca:maximum> |
|---|
| 493 |
</ca:possvalues> |
|---|
| 494 |
<ca:description>This attribute defines the width option (in pixels) of the map size. The WIDTH attribute has a reserved word option "custom". If the HEIGHT attribute is also defined with this word, then the user can define their own map size using the custom popup interface of the MapSize widget.</ca:description> |
|---|
| 495 |
</ca:attribute> |
|---|
| 496 |
</ca:subtag> |
|---|
| 497 |
</ca:widgettag> |
|---|
| 498 |
<!-- ************** --> |
|---|
| 499 |
<!-- FORM ELEMENTS --> |
|---|
| 500 |
<!-- ************** --> |
|---|
| 501 |
<ca:formelements title="Form Elements"> |
|---|
| 502 |
<ca:intro>What is a form element? Needs an introduction.</ca:intro> |
|---|
| 503 |
<ca:formelement> |
|---|
| 504 |
<ca:name>SET_MAP_WIDTH</ca:name> |
|---|
| 505 |
<ca:type title="Type"> |
|---|
| 506 |
<ca:value>integer</ca:value> |
|---|
| 507 |
<ca:description></ca:description> |
|---|
| 508 |
</ca:type> |
|---|
| 509 |
<ca:default title="Default"></ca:default> |
|---|
| 510 |
<!-- formelement description --> |
|---|
| 511 |
<ca:description>The new map width (in pixels) when changing the map window size.</ca:description> |
|---|
| 512 |
|
|---|
| 513 |
</ca:formelement> |
|---|
| 514 |
<ca:formelement> |
|---|
| 515 |
<ca:name>SET_MAP_HEIGHT</ca:name> |
|---|
| 516 |
<ca:type title="Type"> |
|---|
| 517 |
<ca:value>integer</ca:value> |
|---|
| 518 |
<ca:description></ca:description> |
|---|
| 519 |
</ca:type> |
|---|
| 520 |
<!-- formelement description --> |
|---|
| 521 |
<ca:description>The new map height (in pixels) when changing the map window size.</ca:description> |
|---|
| 522 |
</ca:formelement> |
|---|
| 523 |
</ca:formelements> |
|---|
| 524 |
<!-- ********************* --> |
|---|
| 525 |
<!-- JAVA SCRIPT VARIABLES --> |
|---|
| 526 |
<!-- ********************* --> |
|---|
| 527 |
<ca:jsvariables title="Java Script Variables"> |
|---|
| 528 |
<ca:intro>All Java Script Variables defined within the specific widget code should be described here.</ca:intro> |
|---|
| 529 |
<ca:jsvariable> |
|---|
| 530 |
<ca:name></ca:name> |
|---|
| 531 |
<ca:type title="Type"> |
|---|
| 532 |
<ca:value>string</ca:value> |
|---|
| 533 |
</ca:type> |
|---|
| 534 |
<ca:scope title="Scope"> |
|---|
| 535 |
<ca:value>Private</ca:value> |
|---|
| 536 |
</ca:scope> |
|---|
| 537 |
<ca:default title="Default"> |
|---|
| 538 |
<ca:value>0</ca:value> |
|---|
| 539 |
<ca:description>NULL</ca:description> |
|---|
| 540 |
</ca:default> |
|---|
| 541 |
<ca:possvalues type="list" title="Values"> |
|---|
| 542 |
<ca:value>1</ca:value> |
|---|
| 543 |
<ca:value>2</ca:value> |
|---|
| 544 |
</ca:possvalues> |
|---|
| 545 |
<!-- jsvariable description --> |
|---|
| 546 |
<ca:description>What is this variable???</ca:description> |
|---|
| 547 |
</ca:jsvariable> |
|---|
| 548 |
</ca:jsvariables> |
|---|
| 549 |
<!-- ********************* --> |
|---|
| 550 |
<!-- JAVA SCRIPT FUNCTIONS --> |
|---|
| 551 |
<!-- ********************* --> |
|---|
| 552 |
<ca:jsfunctions title="Java Script Functions"> |
|---|
| 553 |
<ca:intro>Here all Java Script Functions that are written within the widget code should be defined here. Along with there parameters, the functions return value and possible JS API event the function might trigger.</ca:intro> |
|---|
| 554 |
<ca:jsfunction> |
|---|
| 555 |
<ca:name>clickMapSizePopup</ca:name> |
|---|
| 556 |
<ca:scope title="Scope"> |
|---|
| 557 |
<ca:value>Private</ca:value> |
|---|
| 558 |
</ca:scope> |
|---|
| 559 |
<ca:description>Callback function for the user clicking the map size button</ca:description> |
|---|
| 560 |
<ca:parameters title="Parameters"> |
|---|
| 561 |
<ca:intro>The parameters for the current Java Script function are outlined here.</ca:intro> |
|---|
| 562 |
<ca:parameter> |
|---|
| 563 |
<ca:name></ca:name> |
|---|
| 564 |
<ca:type title="Type"> |
|---|
| 565 |
<ca:value>string</ca:value> |
|---|
| 566 |
</ca:type> |
|---|
| 567 |
<ca:required title="Required"> |
|---|
| 568 |
<ca:value>false</ca:value> |
|---|
| 569 |
</ca:required> |
|---|
| 570 |
<ca:default title="Default"> |
|---|
| 571 |
<ca:value>0</ca:value> |
|---|
| 572 |
<ca:description>Null</ca:description> |
|---|
| 573 |
</ca:default> |
|---|
| 574 |
<ca:possvalues type="list" title="Values"> |
|---|
| 575 |
<ca:value>0</ca:value> |
|---|
| 576 |
<ca:value>10</ca:value> |
|---|
| 577 |
</ca:possvalues> |
|---|
| 578 |
<!-- js function parameter description --> |
|---|
| 579 |
<ca:description>Description of TESTING Parameter.....</ca:description> |
|---|
| 580 |
</ca:parameter> |
|---|
| 581 |
</ca:parameters> |
|---|
| 582 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 583 |
<ca:intro>The Value to be returned by the current JS Function is as follows.</ca:intro> |
|---|
| 584 |
</ca:returnvalues> |
|---|
| 585 |
<ca:triggeredjsapievents title="JS API Triggered Events"> |
|---|
| 586 |
<ca:intro>Some JS Functions define or rather trigger events through the Chameleon Api.</ca:intro> |
|---|
| 587 |
</ca:triggeredjsapievents> |
|---|
| 588 |
</ca:jsfunction> |
|---|
| 589 |
|
|---|
| 590 |
<ca:jsfunction> |
|---|
| 591 |
<ca:name>applyMapSize</ca:name> |
|---|
| 592 |
<ca:scope title="Scope"> |
|---|
| 593 |
<ca:value>Private</ca:value> |
|---|
| 594 |
</ca:scope> |
|---|
| 595 |
<ca:description>Set the map size.</ca:description> |
|---|
| 596 |
<ca:parameters title="Parameters"> |
|---|
| 597 |
<ca:intro>The parameters for the current Java Script function are outlined here.</ca:intro> |
|---|
| 598 |
<ca:parameter> |
|---|
| 599 |
<ca:name>nWidth</ca:name> |
|---|
| 600 |
<ca:type title="Type"> |
|---|
| 601 |
<ca:value>integer</ca:value> |
|---|
| 602 |
</ca:type> |
|---|
| 603 |
<ca:required title="Required"> |
|---|
| 604 |
<ca:value>true</ca:value> |
|---|
| 605 |
</ca:required> |
|---|
| 606 |
<ca:default title="Default"> |
|---|
| 607 |
<ca:value></ca:value> |
|---|
| 608 |
<ca:description></ca:description> |
|---|
| 609 |
</ca:default> |
|---|
| 610 |
<ca:possvalues type="range" title="Values"> |
|---|
| 611 |
<ca:minimum>1</ca:minimum> |
|---|
| 612 |
<ca:maximum>INF</ca:maximum> |
|---|
| 613 |
</ca:possvalues> |
|---|
| 614 |
<!-- js function parameter description --> |
|---|
| 615 |
<ca:description>The new width of the map.</ca:description> |
|---|
| 616 |
</ca:parameter> |
|---|
| 617 |
<ca:parameter> |
|---|
| 618 |
<ca:name>nHeight</ca:name> |
|---|
| 619 |
<ca:type title="Type"> |
|---|
| 620 |
<ca:value>integer</ca:value> |
|---|
| 621 |
</ca:type> |
|---|
| 622 |
<ca:required title="Required"> |
|---|
| 623 |
<ca:value>true</ca:value> |
|---|
| 624 |
</ca:required> |
|---|
| 625 |
<ca:default title="Default"> |
|---|
| 626 |
<ca:value></ca:value> |
|---|
| 627 |
<ca:description></ca:description> |
|---|
| 628 |
</ca:default> |
|---|
| 629 |
<ca:possvalues type="range" title="Values"> |
|---|
| 630 |
<ca:minimum>1</ca:minimum> |
|---|
| 631 |
<ca:maximum>INF</ca:maximum> |
|---|
| 632 |
</ca:possvalues> |
|---|
| 633 |
<!-- js function parameter description --> |
|---|
| 634 |
<ca:description>The new height of the map.</ca:description> |
|---|
| 635 |
</ca:parameter> |
|---|
| 636 |
</ca:parameters> |
|---|
| 637 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 638 |
<ca:intro>The Value to be returned by the current JS Function is as follows.</ca:intro> |
|---|
| 639 |
</ca:returnvalues> |
|---|
| 640 |
<ca:triggeredjsapievents title="JS API Triggered Events"> |
|---|
| 641 |
<ca:intro>Some JS Functions define or rather trigger events through the Chameleon Api.</ca:intro> |
|---|
| 642 |
</ca:triggeredjsapievents> |
|---|
| 643 |
</ca:jsfunction> |
|---|
| 644 |
|
|---|
| 645 |
<ca:jsfunction> |
|---|
| 646 |
<ca:name>cancelMapSize</ca:name> |
|---|
| 647 |
<ca:scope title="Scope"> |
|---|
| 648 |
<ca:value>Private</ca:value> |
|---|
| 649 |
</ca:scope> |
|---|
| 650 |
<ca:description>Callback function when the user cancels changing the map size so the selection can be reset.</ca:description> |
|---|
| 651 |
<ca:parameters title="Parameters"> |
|---|
| 652 |
<ca:parameter> |
|---|
| 653 |
<ca:name>None.</ca:name> |
|---|
| 654 |
</ca:parameter> |
|---|
| 655 |
</ca:parameters> |
|---|
| 656 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 657 |
<ca:intro>The Value to be returned by the current JS Function is as follows.</ca:intro> |
|---|
| 658 |
|
|---|
| 659 |
</ca:returnvalues> |
|---|
| 660 |
<ca:triggeredjsapievents title="JS API Triggered Events"> |
|---|
| 661 |
<ca:intro>Some JS Functions define or rather trigger events through the Chameleon Api.</ca:intro> |
|---|
| 662 |
|
|---|
| 663 |
</ca:triggeredjsapievents> |
|---|
| 664 |
</ca:jsfunction> |
|---|
| 665 |
|
|---|
| 666 |
<ca:jsfunction> |
|---|
| 667 |
<ca:name>getMapSize</ca:name> |
|---|
| 668 |
<ca:scope title="Scope"> |
|---|
| 669 |
<ca:value>Private</ca:value> |
|---|
| 670 |
</ca:scope> |
|---|
| 671 |
<ca:description>Return the size of the map (in pixels) as an array.</ca:description> |
|---|
| 672 |
<ca:parameters title="Parameters"> |
|---|
| 673 |
<ca:intro>The parameters for the current Java Script function are outlined here.</ca:intro> |
|---|
| 674 |
<ca:parameter> |
|---|
| 675 |
<ca:name></ca:name> |
|---|
| 676 |
<ca:type title="Type"> |
|---|
| 677 |
<ca:value>string</ca:value> |
|---|
| 678 |
</ca:type> |
|---|
| 679 |
<ca:required title="Required"> |
|---|
| 680 |
<ca:value>false</ca:value> |
|---|
| 681 |
</ca:required> <ca:default title="Default"> |
|---|
| 682 |
<ca:value></ca:value> |
|---|
| 683 |
<ca:description></ca:description> |
|---|
| 684 |
</ca:default> |
|---|
| 685 |
<ca:possvalues type="list" title="Values"> |
|---|
| 686 |
<ca:value></ca:value> |
|---|
| 687 |
</ca:possvalues> |
|---|
| 688 |
<!-- js function parameter description --> |
|---|
| 689 |
<ca:description></ca:description> |
|---|
| 690 |
</ca:parameter> |
|---|
| 691 |
</ca:parameters> |
|---|
| 692 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 693 |
<ca:intro>The Value to be returned by the current JS Function is as follows.</ca:intro> |
|---|
| 694 |
<ca:returnvalue> |
|---|
| 695 |
<ca:type title="Type"> |
|---|
| 696 |
<ca:value>array</ca:value> |
|---|
| 697 |
<ca:description></ca:description> |
|---|
| 698 |
</ca:type> |
|---|
| 699 |
<ca:default title="Default" > |
|---|
| 700 |
<ca:value></ca:value> |
|---|
| 701 |
</ca:default> |
|---|
| 702 |
<ca:possvalues type="list" title="Values"> |
|---|
| 703 |
<ca:value>array</ca:value> |
|---|
| 704 |
</ca:possvalues> |
|---|
| 705 |
<!-- js function return value description --> |
|---|
| 706 |
<ca:description>This function returns an array with index 0 set to the width and index 1 set to the height.</ca:description> |
|---|
| 707 |
</ca:returnvalue> |
|---|
| 708 |
</ca:returnvalues> |
|---|
| 709 |
<ca:triggeredjsapievents title="JS API Triggered Events"> |
|---|
| 710 |
<ca:intro>Some JS Functions define or rather trigger events through the Chameleon Api.</ca:intro> |
|---|
| 711 |
<ca:triggeredjsapievent title=""> |
|---|
| 712 |
<ca:name></ca:name> |
|---|
| 713 |
<ca:description></ca:description> |
|---|
| 714 |
</ca:triggeredjsapievent> |
|---|
| 715 |
</ca:triggeredjsapievents> |
|---|
| 716 |
</ca:jsfunction> |
|---|
| 717 |
|
|---|
| 718 |
<ca:jsfunction> |
|---|
| 719 |
<ca:name>changeMapSize</ca:name> |
|---|
| 720 |
<ca:scope title="Scope"> |
|---|
| 721 |
<ca:value>Private</ca:value> |
|---|
| 722 |
</ca:scope> |
|---|
| 723 |
<ca:description>Callback function when the user has selected a new map size from the combo-box on the page.</ca:description> |
|---|
| 724 |
<ca:parameters title="Parameters"> |
|---|
| 725 |
<ca:intro>The parameters for the current Java Script function are outlined here.</ca:intro> |
|---|
| 726 |
<ca:parameter> |
|---|
| 727 |
<ca:name></ca:name> |
|---|
| 728 |
<ca:type title="Type"> |
|---|
| 729 |
<ca:value>string</ca:value> |
|---|
| 730 |
</ca:type> |
|---|
| 731 |
<ca:required title="Required"> |
|---|
| 732 |
<ca:value>false</ca:value> |
|---|
| 733 |
</ca:required> |
|---|
| 734 |
<ca:default title="Default"> |
|---|
| 735 |
<ca:value></ca:value> |
|---|
| 736 |
<ca:description></ca:description> |
|---|
| 737 |
</ca:default> |
|---|
| 738 |
<ca:possvalues type="list" title="Values"> |
|---|
| 739 |
<ca:value></ca:value> |
|---|
| 740 |
</ca:possvalues> |
|---|
| 741 |
<!-- js function parameter description --> |
|---|
| 742 |
<ca:description></ca:description> |
|---|
| 743 |
</ca:parameter> |
|---|
| 744 |
</ca:parameters> |
|---|
| 745 |
<ca:returnvalues title="Function Return Value"> |
|---|
| 746 |
<ca:intro>The Value to be returned by the current JS Function is as follows.</ca:intro> |
|---|
| 747 |
|
|---|
| 748 |
</ca:returnvalues> |
|---|
| 749 |
<ca:triggeredjsapievents title="JS API Triggered Events"> |
|---|
| 750 |
<ca:intro>Some JS Functions define or rather trigger events through the Chameleon Api.</ca:intro> |
|---|
| 751 |
|
|---|
| 752 |
</ca:triggeredjsapievents> |
|---|
| 753 |
</ca:jsfunction> |
|---|
| 754 |
|
|---|
| 755 |
</ca:jsfunctions> |
|---|
| 756 |
<!-- ********************* --> |
|---|
| 757 |
<!-- JAVA SCRIPT FILES --> |
|---|
| 758 |
<!-- ********************* --> |
|---|
| 759 |
<ca:jsfiles title="Java Script Files" > |
|---|
| 760 |
<ca:intro>Some Chameleon Widgets have some or all of its Java Script functions and variables defined within a Java Script File. This file may serve a general purpose that will be described or may have functions, variables or API events that are important to an Chameleon application developer. </ca:intro> |
|---|
| 761 |
|
|---|
| 762 |
</ca:jsfiles> |
|---|
| 763 |
<!-- ******************************* --> |
|---|
| 764 |
<!-- JSAPI LISTENED EVENTS --> |
|---|
| 765 |
<!-- ******************************* --> |
|---|
| 766 |
<ca:listenedjsapievents title="Java Script API Listened Events"> |
|---|
| 767 |
<ca:intro>The specific widget is programmed to listen for an particular action from the Java Script API that produces a triggered event. It is this action reaction between the widgets and the JS API that allow the Chameleon JS API service to function. The Java Script Events that are being listened for are listed below.</ca:intro> |
|---|
| 768 |
<ca:listenedjsapievent title=""> |
|---|
| 769 |
<ca:name></ca:name> |
|---|
| 770 |
<ca:description>Description of this listened event.</ca:description> |
|---|
| 771 |
<ca:calledfunctions title="Functions Calls"> |
|---|
| 772 |
<ca:intro>For each JS API function calls for the widget are outlined here. </ca:intro> |
|---|
| 773 |
<ca:calledfunction> |
|---|
| 774 |
<ca:name>CALEDFUNCTION NAME?</ca:name> |
|---|
| 775 |
<ca:description>Description of function called</ca:description> |
|---|
| 776 |
</ca:calledfunction> |
|---|
| 777 |
</ca:calledfunctions> |
|---|
| 778 |
</ca:listenedjsapievent> |
|---|
| 779 |
</ca:listenedjsapievents> |
|---|
| 780 |
<!-- ********************** --> |
|---|
| 781 |
<!-- WIDGET EVENTS --> |
|---|
| 782 |
<!-- *********************** --> |
|---|
| 783 |
<ca:widgetevents title="Widget Events"> |
|---|
| 784 |
<ca:intro>A few of the widgets have been designed to contain widget events. These type of events are described below.</ca:intro> |
|---|
| 785 |
<ca:widgetevent> |
|---|
| 786 |
<ca:name></ca:name> |
|---|
| 787 |
<ca:parameters title="Parameters"> |
|---|
| 788 |
<ca:intro>The widget events parameters.</ca:intro> |
|---|
| 789 |
<ca:parameter> |
|---|
| 790 |
<ca:name>WIGETEVENT PARAMETER Name</ca:name> |
|---|
| 791 |
<ca:type title="Type"> |
|---|
| 792 |
<ca:value>string</ca:value> |
|---|
| 793 |
</ca:type> |
|---|
| 794 |
<ca:required title="Required"> |
|---|
| 795 |
<ca:value>false</ca:value> |
|---|
| 796 |
</ca:required> |
|---|
| 797 |
<ca:default title="Default"> |
|---|
| 798 |
<ca:value>red</ca:value> |
|---|
| 799 |
<ca:description>test</ca:description> |
|---|
| 800 |
</ca:default> |
|---|
| 801 |
<ca:possvalues type="list" title="Values"> |
|---|
| 802 |
<ca:value>red</ca:value> |
|---|
| 803 |
<ca:value>blue</ca:value> |
|---|
| 804 |
</ca:possvalues> |
|---|
| 805 |
<!-- Widget event parameter description --> |
|---|
| 806 |
<ca:description>Description of parameter of widget event.....</ca:description> |
|---|
| 807 |
</ca:parameter> |
|---|
| 808 |
</ca:parameters> |
|---|
| 809 |
<!-- Widget event description --> |
|---|
| 810 |
<ca:description>Description of widget event.....</ca:description> |
|---|
| 811 |
</ca:widgetevent> |
|---|
| 812 |
</ca:widgetevents> |
|---|
| 813 |
<!-- ************************** --> |
|---|
| 814 |
<!-- END OF WIDGET XML DOCUMENT --> |
|---|
| 815 |
<!-- ************************** --> |
|---|
| 816 |
</ca:widgetdoc> |
|---|
