| 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>UpdateMap</ca:value> |
|---|
| 36 |
</ca:name> |
|---|
| 37 |
<ca:chameleonpack> |
|---|
| 38 |
<ca:value>TBD</ca:value> |
|---|
| 39 |
</ca:chameleonpack> |
|---|
| 40 |
<ca:parentgroup> |
|---|
| 41 |
<ca:value>Map 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 UpdateMap widget is used to refresh the current page without performing any other navigation. This is useful for sending values from widgets that do not have some more direct form of communication, such as the Scale widget and the LegendTemplate widget. The UpdateMap widget does not use the toolset attribute from the Button Attribute Group. The attribute is blocked by the Update widget code.</ca:para> |
|---|
| 64 |
</ca:paras> |
|---|
| 65 |
</ca:description> |
|---|
| 66 |
<ca:dependancies> |
|---|
| 67 |
<ca:dependancy type="None" title="None."> |
|---|
| 68 |
<ca:para/> |
|---|
| 69 |
</ca:dependancy> |
|---|
| 70 |
</ca:dependancies> |
|---|
| 71 |
<ca:sharedresources> |
|---|
| 72 |
<ca:paras title="Style Resource"> |
|---|
| 73 |
<ca:para>The UpdateMap widget tag has attributes from Button Attribute Group. This means the UpdateMap widget has access to the Style Shared Resource. To learn more about this Shared Resource, please refer to the appropriate attribute group section for details.</ca:para> |
|---|
| 74 |
</ca:paras> |
|---|
| 75 |
</ca:sharedresources> |
|---|
| 76 |
<ca:embeddedhelp> |
|---|
| 77 |
<ca:paras> |
|---|
| 78 |
<ca:para>This widget provides the capability to update the map image to reflect changes that have not yet been committed. To update the map, click the Update Map button.</ca:para> |
|---|
| 79 |
</ca:paras> |
|---|
| 80 |
</ca:embeddedhelp> |
|---|
| 81 |
</ca:descriptions> |
|---|
| 82 |
<ca:tagstructures> |
|---|
| 83 |
<ca:tagstructure title="Widget Syntax"> |
|---|
| 84 |
<ca:description/> |
|---|
| 85 |
<ca:code> |
|---|
| 86 |
<ca:codeblock bold="true"> |
|---|
| 87 |
<ca:line><CWC2 TYPE="UpdateMap"</ca:line> |
|---|
| 88 |
</ca:codeblock> |
|---|
| 89 |
<ca:codeblock bold="false"> |
|---|
| 90 |
<ca:line> ENABLED="[TRUE|FALSE]"</ca:line> |
|---|
| 91 |
<ca:line> FORMINDEX="[0 < integer]"</ca:line> |
|---|
| 92 |
<ca:line> VISIBLE="[TRUE|FALSE]"</ca:line> |
|---|
| 93 |
<ca:line/> |
|---|
| 94 |
<ca:line> <!-- Button Attribute Group--></ca:line> |
|---|
| 95 |
<ca:line/> |
|---|
| 96 |
<ca:line> BACKGROUNDIMAGE="[path]"</ca:line> |
|---|
| 97 |
<ca:line> DEFAULT="[TRUE|FALSE]"</ca:line> |
|---|
| 98 |
<ca:line> IMAGE="[path]"</ca:line> |
|---|
| 99 |
<ca:line> IMAGEHEIGHT="[integer]"</ca:line> |
|---|
| 100 |
<ca:line> IMAGETIP="[string]"</ca:line> |
|---|
| 101 |
<ca:line> IMAGEWIDTH="[integer]"</ca:line> |
|---|
| 102 |
<ca:line> LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 103 |
<ca:line> LABELANTIALIAS="[TRUE|FALSE]"</ca:line> |
|---|
| 104 |
<ca:line> LABELCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 105 |
<ca:line> LABELFONT="[string]"</ca:line> |
|---|
| 106 |
<ca:line> LABELFONTSIZE="[0 < integer]"</ca:line> |
|---|
| 107 |
<ca:line> ONCLICK="[string]"</ca:line> |
|---|
| 108 |
<ca:line> STYLERESOURCE="[string]"</ca:line> |
|---|
| 109 |
<ca:line> TEXTBUTTONBORDER="[path]"</ca:line> |
|---|
| 110 |
<ca:line> TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line> |
|---|
| 111 |
<ca:line> TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line> |
|---|
| 112 |
<ca:line> TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 113 |
<ca:line> TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line> |
|---|
| 114 |
<ca:line> TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line> |
|---|
| 115 |
<ca:line> TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line> |
|---|
| 116 |
<ca:line> TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line> |
|---|
| 117 |
<ca:line> TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 118 |
<ca:line> TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 119 |
<ca:line> TEXTBUTTONNUDGE="[integer]"</ca:line> |
|---|
| 120 |
<ca:line> TEXTBUTTONPADDING="[0 < integer]"</ca:line> |
|---|
| 121 |
<ca:line> TOOLSET="[string]"</ca:line> |
|---|
| 122 |
<ca:line> USETEXTBUTTONCACHE="[TRUE|FALSE]"></ca:line> |
|---|
| 123 |
<ca:line/> |
|---|
| 124 |
<ca:line> <!-- Button Subtag Group --></ca:line> |
|---|
| 125 |
<ca:line/> |
|---|
| 126 |
<ca:line> <IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line> |
|---|
| 127 |
<ca:line> IMAGE="[path]"/></ca:line> |
|---|
| 128 |
</ca:codeblock> |
|---|
| 129 |
<ca:codeblock bold="true"> |
|---|
| 130 |
<ca:line></CWC2></ca:line> |
|---|
| 131 |
</ca:codeblock> |
|---|
| 132 |
</ca:code> |
|---|
| 133 |
</ca:tagstructure> |
|---|
| 134 |
</ca:tagstructures> |
|---|
| 135 |
<ca:examples> |
|---|
| 136 |
<ca:widgetexamples> |
|---|
| 137 |
<ca:example title="Example #1: Simple"> |
|---|
| 138 |
<ca:description>The following is the simplest example of the UpdateMap widget.</ca:description> |
|---|
| 139 |
<ca:code> |
|---|
| 140 |
<ca:codeblock bold="false"> |
|---|
| 141 |
<ca:line><cwc2 type="UpdateMap"</ca:line> |
|---|
| 142 |
<ca:line> visible="true"</ca:line> |
|---|
| 143 |
<ca:line> image="buttons/button_update_1.png"/></ca:line> |
|---|
| 144 |
</ca:codeblock> |
|---|
| 145 |
</ca:code> |
|---|
| 146 |
</ca:example> |
|---|
| 147 |
<ca:example title="Example #2: Advanced"> |
|---|
| 148 |
<ca:description>The following example shows how the UpdateMap widget using the "TextButtons" Shared Resource is called with three possible image states. Also this button contains a label, "Redraw Map", that is written right on the button.</ca:description> |
|---|
| 149 |
<ca:code> |
|---|
| 150 |
<ca:codeblock bold="false"> |
|---|
| 151 |
<ca:line><cwc2 type="UpdateMap"</ca:line> |
|---|
| 152 |
<ca:line> visible="true"</ca:line> |
|---|
| 153 |
<ca:line> imagetip="Update Map With Current Selections"</ca:line> |
|---|
| 154 |
<ca:line> image="icons/icon_update.png"</ca:line> |
|---|
| 155 |
<ca:line> label="Redraw Map"</ca:line> |
|---|
| 156 |
<ca:line> styleresource="TextButtons"></ca:line> |
|---|
| 157 |
<ca:line> <image state="normal" /></ca:line> |
|---|
| 158 |
<ca:line> <image state="hover" /></ca:line> |
|---|
| 159 |
<ca:line> <image state="selected" /></ca:line> |
|---|
| 160 |
<ca:line></cwc2> </ca:line> |
|---|
| 161 |
</ca:codeblock> |
|---|
| 162 |
</ca:code> |
|---|
| 163 |
</ca:example> |
|---|
| 164 |
<ca:example title="Example #3: Advanced"> |
|---|
| 165 |
<ca:description>The following example shows how the widget could be defined without using a Shared Resource.</ca:description> |
|---|
| 166 |
<ca:code> |
|---|
| 167 |
<ca:codeblock bold="false"> |
|---|
| 168 |
<ca:line><cwc2 type="UpdateMap"</ca:line> |
|---|
| 169 |
<ca:line> visible="true"</ca:line> |
|---|
| 170 |
<ca:line> imagetip="Update Map With Current Selections"</ca:line> |
|---|
| 171 |
<ca:line> imagewidth="24"</ca:line> |
|---|
| 172 |
<ca:line> imageheight="24"></ca:line> |
|---|
| 173 |
<ca:line> <image state="normal"</ca:line> |
|---|
| 174 |
<ca:line> image="buttons/button_update_1.png"/></ca:line> |
|---|
| 175 |
<ca:line> <image state="hover"</ca:line> |
|---|
| 176 |
<ca:line> image="buttons/button_update_2.png"/></ca:line> |
|---|
| 177 |
<ca:line> <image state="selected"</ca:line> |
|---|
| 178 |
<ca:line> image="buttons/button_update_3.png"/></ca:line> |
|---|
| 179 |
<ca:line></cwc2></ca:line> |
|---|
| 180 |
</ca:codeblock> |
|---|
| 181 |
</ca:code> |
|---|
| 182 |
</ca:example> |
|---|
| 183 |
</ca:widgetexamples> |
|---|
| 184 |
<ca:sampleapps> |
|---|
| 185 |
<ca:sampleapp> |
|---|
| 186 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 187 |
<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 188 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 189 |
</ca:sampleapp> |
|---|
| 190 |
</ca:sampleapps> |
|---|
| 191 |
<ca:scriptexamples/> |
|---|
| 192 |
</ca:examples> |
|---|
| 193 |
<ca:attributegroups> |
|---|
| 194 |
<ca:attributegroup> |
|---|
| 195 |
<ca:name>Base</ca:name> |
|---|
| 196 |
<ca:name>Button</ca:name> |
|---|
| 197 |
</ca:attributegroup> |
|---|
| 198 |
</ca:attributegroups> |
|---|
| 199 |
<ca:formelements> |
|---|
| 200 |
<ca:formelement> |
|---|
| 201 |
<ca:name>UPDATE_MAP</ca:name> |
|---|
| 202 |
<ca:type> |
|---|
| 203 |
<ca:value>unknown</ca:value> |
|---|
| 204 |
</ca:type> |
|---|
| 205 |
<ca:description>Set by the UpdateMap widget when the Update Map button is clicked.</ca:description> |
|---|
| 206 |
</ca:formelement> |
|---|
| 207 |
</ca:formelements> |
|---|
| 208 |
<ca:jsfunctions> |
|---|
| 209 |
<ca:jsfunction> |
|---|
| 210 |
<ca:name>clickUpdateMap</ca:name> |
|---|
| 211 |
<ca:scope> |
|---|
| 212 |
<ca:value>Private</ca:value> |
|---|
| 213 |
</ca:scope> |
|---|
| 214 |
<ca:description>Callback function for the user clicking the "Update Map" button.</ca:description> |
|---|
| 215 |
</ca:jsfunction> |
|---|
| 216 |
</ca:jsfunctions> |
|---|
| 217 |
</ca:widgetdoc> |
|---|
