| 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>CompassPoint</ca:value> |
|---|
| 36 |
</ca:name> |
|---|
| 37 |
<ca:chameleonpack> |
|---|
| 38 |
<ca:value>TBD</ca:value> |
|---|
| 39 |
</ca:chameleonpack> |
|---|
| 40 |
<ca:parentgroup> |
|---|
| 41 |
<ca:value>Navigation Widget</ca:value> |
|---|
| 42 |
</ca:parentgroup> |
|---|
| 43 |
<ca:version> |
|---|
| 44 |
<ca:value>1.99</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 CompassPoint widget is used to pan the map by a fixed amount in one of eight directions. The widget is represented as a button in the user interface. The direction and the amount to pan are configurable.</ca:para> |
|---|
| 64 |
</ca:paras> |
|---|
| 65 |
</ca:description> |
|---|
| 66 |
<ca:dependancies> |
|---|
| 67 |
<ca:dependancy type="Widget" title="Map Widget"> |
|---|
| 68 |
<ca:para>A map widget (e.g., MapDHTML) must be present in the interface for the CompassPoint widget to function. This does not mean the button will not show up without a map widget, only that the button would not perform any visible action.</ca:para> |
|---|
| 69 |
</ca:dependancy> |
|---|
| 70 |
</ca:dependancies> |
|---|
| 71 |
<ca:sharedresources> |
|---|
| 72 |
<ca:paras title="Style"> |
|---|
| 73 |
<ca:para>The CompassPoint widget tag has attributes from Button Attributes group. This means CompassPoint widget has access to the Style Shared Resources. To learn about this Shared Resource, please refer to the Button attribute group section for details.</ca:para> |
|---|
| 74 |
</ca:paras> |
|---|
| 75 |
</ca:sharedresources> |
|---|
| 76 |
<ca:embeddedhelp> |
|---|
| 77 |
<ca:paras> |
|---|
| 78 |
<ca:para>The CompassPoint widget provides the capability to pan the map in the direction of a compass point. To use the CompassPoint widget, click one of the compass point icons around the map to pan the map in that direction.</ca:para> |
|---|
| 79 |
</ca:paras> |
|---|
| 80 |
</ca:embeddedhelp> |
|---|
| 81 |
<ca:guinotes title="Interface Functionality"> |
|---|
| 82 |
<ca:guinote type="Button" title="Tip"> |
|---|
| 83 |
<ca:para>Typically, the CompassPoint widget is included in an interface eight times, once for each cardinal direction.</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="CompassPoint"</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> <!-- CompassPoint Attributes--></ca:line> |
|---|
| 100 |
</ca:codeblock> |
|---|
| 101 |
<ca:codeblock bold="true"> |
|---|
| 102 |
<ca:line> DIRECTION ="[NORTHEAST | NORTH | NORTHWEST | WEST | SOUTHWEST | SOUTH | SOUTHEAST | EAST]"</ca:line> |
|---|
| 103 |
</ca:codeblock> |
|---|
| 104 |
<ca:codeblock bold="false"> |
|---|
| 105 |
<ca:line> PANPERCENT ="[0 < integer < 100]"</ca:line> |
|---|
| 106 |
<ca:line/> |
|---|
| 107 |
<ca:line> <!-- Navigation Attributes --></ca:line> |
|---|
| 108 |
<ca:line/> |
|---|
| 109 |
<ca:line> CURSORTYPE="[string]"</ca:line> |
|---|
| 110 |
<ca:line> DEFAULT="[TRUE|FALSE]"</ca:line> |
|---|
| 111 |
<ca:line> MAPID="[string]"</ca:line> |
|---|
| 112 |
<ca:line> WIDGETSTYLE="[string]"</ca:line> |
|---|
| 113 |
<ca:line/> |
|---|
| 114 |
<ca:line> <!-- Button Attribute Group--></ca:line> |
|---|
| 115 |
<ca:line/> |
|---|
| 116 |
<ca:line> BACKGROUNDIMAGE="[path]"</ca:line> |
|---|
| 117 |
<ca:line> DEFAULT="[TRUE|FALSE]"</ca:line> |
|---|
| 118 |
<ca:line> IMAGE="[path]"</ca:line> |
|---|
| 119 |
<ca:line> IMAGEHEIGHT="[integer]"</ca:line> |
|---|
| 120 |
<ca:line> IMAGETIP="[string]"</ca:line> |
|---|
| 121 |
<ca:line> IMAGEWIDTH="[integer]"</ca:line> |
|---|
| 122 |
<ca:line> LABELALIGN="[LEFT|CENTER|RIGHT]"</ca:line> |
|---|
| 123 |
<ca:line> LABELANTIALIAS="[TRUE|FALSE]"</ca:line> |
|---|
| 124 |
<ca:line> LABELCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 125 |
<ca:line> LABELFONT="[string]"</ca:line> |
|---|
| 126 |
<ca:line> LABELFONTSIZE="[0 < integer]"</ca:line> |
|---|
| 127 |
<ca:line> ONCLICK="[string]"</ca:line> |
|---|
| 128 |
<ca:line> STYLERESOURCE="[string]"</ca:line> |
|---|
| 129 |
<ca:line> TEXTBUTTONBORDER="[path]"</ca:line> |
|---|
| 130 |
<ca:line> TEXTBUTTONBORDER_BOTTOM_IMAGE="[path]"</ca:line> |
|---|
| 131 |
<ca:line> TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE="[path]"</ca:line> |
|---|
| 132 |
<ca:line> TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 133 |
<ca:line> TEXTBUTTONBORDER_LEFT_IMAGE="[path]"</ca:line> |
|---|
| 134 |
<ca:line> TEXTBUTTONBORDER_RIGHT_IMAGE="[path]"</ca:line> |
|---|
| 135 |
<ca:line> TEXTBUTTONBORDER_TOP_IMAGE="[path]"</ca:line> |
|---|
| 136 |
<ca:line> TEXTBUTTONBORDER_TOPLEFT_IMAGE="[path]"</ca:line> |
|---|
| 137 |
<ca:line> TEXTBUTTONBORDER_TOPRIGHT_IMAGE="[path]"</ca:line> |
|---|
| 138 |
<ca:line> TEXTBUTTONCOLOR="[#RRGGBB]"</ca:line> |
|---|
| 139 |
<ca:line> TEXTBUTTONNUDGE="[integer]"</ca:line> |
|---|
| 140 |
<ca:line> TEXTBUTTONPADDING="[0 < integer]"</ca:line> |
|---|
| 141 |
<ca:line> TOOLSET="[string]"</ca:line> |
|---|
| 142 |
<ca:line> USETEXTBUTTONCACHE="[TRUE|FALSE]"></ca:line> |
|---|
| 143 |
<ca:line/> |
|---|
| 144 |
<ca:line> <!-- Button Subtag Group --></ca:line> |
|---|
| 145 |
<ca:line/> |
|---|
| 146 |
<ca:line> <IMAGE STATE="[NORMAL|SELECTED|HOVER|DISABLED]"</ca:line> |
|---|
| 147 |
<ca:line> IMAGE="[path]"/></ca:line> |
|---|
| 148 |
</ca:codeblock> |
|---|
| 149 |
<ca:codeblock bold="true"> |
|---|
| 150 |
<ca:line></CWC2></ca:line> |
|---|
| 151 |
</ca:codeblock> |
|---|
| 152 |
</ca:code> |
|---|
| 153 |
</ca:tagstructure> |
|---|
| 154 |
</ca:tagstructures> |
|---|
| 155 |
<ca:examples> |
|---|
| 156 |
<ca:widgetexamples> |
|---|
| 157 |
<ca:example title="Example #1: Simple"> |
|---|
| 158 |
<ca:description>The following widget tag defines a compass point button as a radio button with an icon. The widget pans 80 percent of the current view in the map's northwest direction. Note: this northwest direction is not directly related to the true northwest direction due to differences in projections, rather the panning takes place diagonally up and to the left based on the current map dimensions.</ca:description> |
|---|
| 159 |
<ca:code> |
|---|
| 160 |
<ca:codeblock bold="false"> |
|---|
| 161 |
<ca:line><cwc2 type="CompassPoint"</ca:line> |
|---|
| 162 |
<ca:line> Visible="true" </ca:line> |
|---|
| 163 |
<ca:line> styleresource="PanArrows" </ca:line> |
|---|
| 164 |
<ca:line> Direction="northwest" </ca:line> |
|---|
| 165 |
<ca:line> image="icons/icon_pan_nw.png"</ca:line> |
|---|
| 166 |
<ca:line> PanPercent="80"</ca:line> |
|---|
| 167 |
<ca:line> imagetip="Pan NorthWest"/></ca:line> |
|---|
| 168 |
</ca:codeblock> |
|---|
| 169 |
</ca:code> |
|---|
| 170 |
</ca:example> |
|---|
| 171 |
<ca:example title="Example #2: Advanced"> |
|---|
| 172 |
<ca:description>The widget tag above uses the following text button style resource, "PanArrows", to define the look of the CompassPoint button.</ca:description> |
|---|
| 173 |
<ca:code> |
|---|
| 174 |
<ca:codeblock bold="false"> |
|---|
| 175 |
<ca:line><cwc2 type="CompassPoint"</ca:line> |
|---|
| 176 |
<ca:line> visible="true" </ca:line> |
|---|
| 177 |
<ca:line> styleresource="PanArrows"</ca:line> |
|---|
| 178 |
<ca:line> direction="northwest"</ca:line> |
|---|
| 179 |
<ca:line> image="icons/icon_pan_nw.png"</ca:line> |
|---|
| 180 |
<ca:line> PanPercent="80" </ca:line> |
|---|
| 181 |
<ca:line> imagetip="Pan NorthWest"></ca:line> |
|---|
| 182 |
<ca:line> <image state="normal"/></ca:line> |
|---|
| 183 |
<ca:line> <image state="hover"/></ca:line> |
|---|
| 184 |
<ca:line> <image state="selected"/></ca:line> |
|---|
| 185 |
<ca:line></cwc2></ca:line> |
|---|
| 186 |
</ca:codeblock> |
|---|
| 187 |
</ca:code> |
|---|
| 188 |
</ca:example> |
|---|
| 189 |
</ca:widgetexamples> |
|---|
| 190 |
<ca:sharedresourceexamples /> |
|---|
| 191 |
<ca:sampleapps> |
|---|
| 192 |
<ca:sampleapp> |
|---|
| 193 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 194 |
<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 195 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 196 |
</ca:sampleapp> |
|---|
| 197 |
</ca:sampleapps> |
|---|
| 198 |
<ca:scriptexamples/> |
|---|
| 199 |
</ca:examples> |
|---|
| 200 |
<ca:attributegroups> |
|---|
| 201 |
<ca:attributegroup> |
|---|
| 202 |
<ca:name>Base</ca:name> |
|---|
| 203 |
<ca:name>Button</ca:name> |
|---|
| 204 |
<ca:name>NavTool</ca:name> |
|---|
| 205 |
</ca:attributegroup> |
|---|
| 206 |
</ca:attributegroups> |
|---|
| 207 |
<ca:widgettag> |
|---|
| 208 |
<ca:attribute> |
|---|
| 209 |
<ca:name>DIRECTION</ca:name> |
|---|
| 210 |
<ca:type> |
|---|
| 211 |
<ca:value>string</ca:value> |
|---|
| 212 |
</ca:type> |
|---|
| 213 |
<ca:class> |
|---|
| 214 |
<ca:value>Required</ca:value> |
|---|
| 215 |
</ca:class> |
|---|
| 216 |
<ca:possvalues type="list"> |
|---|
| 217 |
<ca:value>northeast</ca:value> |
|---|
| 218 |
<ca:value>north</ca:value> |
|---|
| 219 |
<ca:value>northwest</ca:value> |
|---|
| 220 |
<ca:value>west</ca:value> |
|---|
| 221 |
<ca:value>southwest</ca:value> |
|---|
| 222 |
<ca:value>south</ca:value> |
|---|
| 223 |
<ca:value>southeast</ca:value> |
|---|
| 224 |
<ca:value>east</ca:value> |
|---|
| 225 |
</ca:possvalues> |
|---|
| 226 |
<ca:description>The direction that the compass point pans the map when clicked. This direction is from the center to the midpoint (or corner) in the specified direction and may not be geographically correct (i.e., northwest pans towards the top left corner, regardless of which direction northwest is on the map).</ca:description> |
|---|
| 227 |
</ca:attribute> |
|---|
| 228 |
<ca:attribute> |
|---|
| 229 |
<ca:name>PANPERCENT</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>50</ca:value> |
|---|
| 238 |
<ca:description/> |
|---|
| 239 |
</ca:default> |
|---|
| 240 |
<ca:possvalues type="range"> |
|---|
| 241 |
<ca:minimum>0</ca:minimum> |
|---|
| 242 |
<ca:maximum>100</ca:maximum> |
|---|
| 243 |
</ca:possvalues> |
|---|
| 244 |
<ca:description>The amount to pan the map in the given direction as a percentage of the map width and/or height.</ca:description> |
|---|
| 245 |
</ca:attribute> |
|---|
| 246 |
</ca:widgettag> |
|---|
| 247 |
<ca:formelements> |
|---|
| 248 |
<ca:formelement> |
|---|
| 249 |
<ca:name>NAV_CMD</ca:name> |
|---|
| 250 |
<ca:type> |
|---|
| 251 |
<ca:value>string</ca:value> |
|---|
| 252 |
</ca:type> |
|---|
| 253 |
<ca:description>The last navigation command that was used to interact with the map. Clicking a CompassPoint widget sets this form variable to "COMPASS_POINT".</ca:description> |
|---|
| 254 |
</ca:formelement> |
|---|
| 255 |
<ca:formelement> |
|---|
| 256 |
<ca:name>NAV_ALLOW_RECTANGLE</ca:name> |
|---|
| 257 |
<ca:type> |
|---|
| 258 |
<ca:value>boolean</ca:value> |
|---|
| 259 |
</ca:type> |
|---|
| 260 |
<ca:description>Tracks whether the current navigation tool uses a rubber-banding box or not. Always FALSE for the CompassPoint. widget.</ca:description> |
|---|
| 261 |
</ca:formelement> |
|---|
| 262 |
</ca:formelements> |
|---|
| 263 |
<ca:jsfunctions> |
|---|
| 264 |
<ca:jsfunction> |
|---|
| 265 |
<ca:name>NavSetActiveTool</ca:name> |
|---|
| 266 |
<ca:scope> |
|---|
| 267 |
<ca:value>Private</ca:value> |
|---|
| 268 |
</ca:scope> |
|---|
| 269 |
<ca:description>Set the active navigation tool for a particular group of tools.</ca:description> |
|---|
| 270 |
<ca:parameters> |
|---|
| 271 |
<ca:parameter> |
|---|
| 272 |
<ca:name>oButton</ca:name> |
|---|
| 273 |
<ca:type> |
|---|
| 274 |
<ca:value>object</ca:value> |
|---|
| 275 |
</ca:type> |
|---|
| 276 |
<ca:required> |
|---|
| 277 |
<ca:value>true</ca:value> |
|---|
| 278 |
</ca:required> |
|---|
| 279 |
<ca:description>This is the JavaScript button object that was clicked to cause this function to be called. May be null.</ca:description> |
|---|
| 280 |
</ca:parameter> |
|---|
| 281 |
<ca:parameter> |
|---|
| 282 |
<ca:name>aVals</ca:name> |
|---|
| 283 |
<ca:type> |
|---|
| 284 |
<ca:value>array</ca:value> |
|---|
| 285 |
</ca:type> |
|---|
| 286 |
<ca:required> |
|---|
| 287 |
<ca:value>true</ca:value> |
|---|
| 288 |
</ca:required> |
|---|
| 289 |
<ca:description>Array of parameters that define the navigation tool. The first element is the tool number. The second element is the tool name. The third element is a boolean indicating whether to allow rectangles or not. The fourth element indicates if the page should be automatically submitted when the widget is clicked. The fifth element is a string that defines the cursor type.</ca:description> |
|---|
| 290 |
</ca:parameter> |
|---|
| 291 |
</ca:parameters> |
|---|
| 292 |
</ca:jsfunction> |
|---|
| 293 |
</ca:jsfunctions> |
|---|
| 294 |
<ca:jsfiles title="JavaScript Files" > |
|---|
| 295 |
<ca:jsfile > |
|---|
| 296 |
<ca:name>cwc_events.js</ca:name> |
|---|
| 297 |
<ca:description>Widgets can create events for other widgets or user-applications to use by registering events with this event manager.</ca:description> |
|---|
| 298 |
<ca:jsvariables/> |
|---|
| 299 |
<ca:jsfunctions/> |
|---|
| 300 |
</ca:jsfile> |
|---|
| 301 |
</ca:jsfiles> |
|---|
| 302 |
|
|---|
| 303 |
</ca:widgetdoc> |
|---|
