| 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:person> |
|---|
| 23 |
<ca:name>Paul Spencer</ca:name> |
|---|
| 24 |
<ca:company>DM Solutions Group Inc.</ca:company> |
|---|
| 25 |
<ca:contact>chameleon@lists.maptools.org</ca:contact> |
|---|
| 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>SharedResource</ca:value> |
|---|
| 36 |
</ca:name> |
|---|
| 37 |
<ca:chameleonpack> |
|---|
| 38 |
<ca:value>TBD</ca:value> |
|---|
| 39 |
</ca:chameleonpack> |
|---|
| 40 |
<ca:parentgroup> |
|---|
| 41 |
<ca:value>Utility 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 SharedResource widget is an invisible widget that is used to define a placeholder for some set of arbitrary values that are to be shared among one or more widgets. Shared Resources are used as global placeholders for sets of common attributes from a widget or an attribute group. The attributes allowed in Shared Resources, and their individual formats/structures, are defined within the code for the individual widget or attribute group. Shared Resources help Chameleon application developers better manage all their different attribute sets.</ca:para> |
|---|
| 64 |
</ca:paras> |
|---|
| 65 |
</ca:description> |
|---|
| 66 |
<ca:dependancies> |
|---|
| 67 |
<ca:dependancy type="Widget" title="Defining Shared Resources"> |
|---|
| 68 |
<ca:para>The definition of the contents of a Shared Resource is dependent on how other widgets use it. The Shared Resource does not become truly functional or useful unless other widgets are programmed to use it.</ca:para> |
|---|
| 69 |
</ca:dependancy> |
|---|
| 70 |
</ca:dependancies> |
|---|
| 71 |
<ca:sharedresources> |
|---|
| 72 |
<ca:paras title="None Available"> |
|---|
| 73 |
<ca:para>This is the Shared Resource widget and cannot request itself. No Shared Resource can call another Shared Resource.</ca:para> |
|---|
| 74 |
</ca:paras> |
|---|
| 75 |
</ca:sharedresources> |
|---|
| 76 |
<ca:embeddedhelp> |
|---|
| 77 |
<ca:paras> |
|---|
| 78 |
<ca:para>A Shared Resource is invisible to the user and is strictly a management utility for the Chameleon application.</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="SharedResource"</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> <!-- Shared Resource Attributes--></ca:line> |
|---|
| 95 |
<ca:line/> |
|---|
| 96 |
</ca:codeblock> |
|---|
| 97 |
<ca:codeblock bold="true"> |
|---|
| 98 |
<ca:line> NAME="[string]"</ca:line> |
|---|
| 99 |
</ca:codeblock> |
|---|
| 100 |
<ca:codeblock bold="false"> |
|---|
| 101 |
<ca:line> ENABLEJS="[TRUE|FALSE]"/></ca:line> |
|---|
| 102 |
</ca:codeblock> |
|---|
| 103 |
</ca:code> |
|---|
| 104 |
</ca:tagstructure> |
|---|
| 105 |
</ca:tagstructures> |
|---|
| 106 |
<ca:examples> |
|---|
| 107 |
<ca:widgetexamples> |
|---|
| 108 |
<ca:example title="Example #1: Simple"> |
|---|
| 109 |
<ca:description>The following example represents the "WaitImage" Shared Resource. This Shared Resource holds a list of multilingual images that are displayed when an application is in the middle of an extended process. In this example, this Shared Resource contains English and French wait image attribute sets.</ca:description> |
|---|
| 110 |
<ca:code> |
|---|
| 111 |
<ca:codeblock bold="false"> |
|---|
| 112 |
<ca:line><!-- WaitImage Shared Resource --></ca:line> |
|---|
| 113 |
<ca:line/> |
|---|
| 114 |
<ca:line><cwc2 type="SharedResource" name="WaitImage"></ca:line> |
|---|
| 115 |
<ca:line> <waitimage language="en-CA"</ca:line> |
|---|
| 116 |
<ca:line> waitimage="images/spinner.gif"</ca:line> |
|---|
| 117 |
<ca:line> waitimagewidth="216"</ca:line> |
|---|
| 118 |
<ca:line> waitimageheight="50"/></ca:line> |
|---|
| 119 |
<ca:line> <waitimage language="fr-CA"</ca:line> |
|---|
| 120 |
<ca:line> waitimage="images/spinner_f.gif"</ca:line> |
|---|
| 121 |
<ca:line> waitimagewidth="216"</ca:line> |
|---|
| 122 |
<ca:line> waitimageheight="50"/></ca:line> |
|---|
| 123 |
<ca:line></cwc2></ca:line> |
|---|
| 124 |
</ca:codeblock> |
|---|
| 125 |
</ca:code> |
|---|
| 126 |
</ca:example> |
|---|
| 127 |
<ca:example title="Example #2: Advanced"> |
|---|
| 128 |
<ca:description>The following example represents the default named "TextButtons" Shared Resource. If a widget does not call a specific button style Shared Resource, then the widget uses this button style if defined in the template.</ca:description> |
|---|
| 129 |
<ca:code> |
|---|
| 130 |
<ca:codeblock bold="false"> |
|---|
| 131 |
<ca:line><!-- Default button style for Text Buttons --></ca:line> |
|---|
| 132 |
<ca:line/> |
|---|
| 133 |
<ca:line><cwc2 type="SharedResource" name="TextButtons"></ca:line> |
|---|
| 134 |
<ca:line> <textbuttonbackgroundimage value=""/></ca:line> |
|---|
| 135 |
<ca:line> <imagewidth value="120"/></ca:line> |
|---|
| 136 |
<ca:line> <imageheight value="24"/></ca:line> |
|---|
| 137 |
<ca:line> <textbuttonpadding value="0"/></ca:line> |
|---|
| 138 |
<ca:line> <textbuttonnudge value="0"/></ca:line> |
|---|
| 139 |
<ca:line> <labelcolor value="111111"/></ca:line> |
|---|
| 140 |
<ca:line> <labelfont value="fonts/Vera.ttf"/></ca:line> |
|---|
| 141 |
<ca:line> <labelalign value="left"/></ca:line> |
|---|
| 142 |
<ca:line> <labelfontsize value="8"/></ca:line> |
|---|
| 143 |
<ca:line> <labelantialias value="true"/></ca:line> |
|---|
| 144 |
<ca:line> <usetextbuttoncache value="false"/></ca:line> |
|---|
| 145 |
<ca:line> <textbuttoncolor value="f0f0f0"/></ca:line> |
|---|
| 146 |
<ca:line> <textbuttonborder_topleft_image value="borders/border_tl_1.png"/></ca:line> |
|---|
| 147 |
<ca:line> <textbuttonborder_top_image value="borders/border_t_1.png"/></ca:line> |
|---|
| 148 |
<ca:line> <textbuttonborder_topright_image value="borders/border_tr_1.png"/></ca:line> |
|---|
| 149 |
<ca:line> <textbuttonborder_right_image value="borders/border_r_1.png"/></ca:line> |
|---|
| 150 |
<ca:line> <textbuttonborder_left_image value="borders/border_l_1.png"/></ca:line> |
|---|
| 151 |
<ca:line> <textbuttonborder_bottomright_image value="borders/border_br_1.png"/></ca:line> |
|---|
| 152 |
<ca:line> <textbuttonborder_bottom_image value="borders/border_b_1.png"/></ca:line> |
|---|
| 153 |
<ca:line> <textbuttonborder_bottomleft_image value="borders/border_bl_1.png"/></ca:line> |
|---|
| 154 |
<ca:line></cwc2></ca:line> |
|---|
| 155 |
</ca:codeblock> |
|---|
| 156 |
</ca:code> |
|---|
| 157 |
</ca:example> |
|---|
| 158 |
</ca:widgetexamples> |
|---|
| 159 |
<ca:sampleapps> |
|---|
| 160 |
<ca:sampleapp> |
|---|
| 161 |
<ca:name>Hawaii Demo</ca:name> |
|---|
| 162 |
<ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl> |
|---|
| 163 |
<ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description> |
|---|
| 164 |
</ca:sampleapp> |
|---|
| 165 |
</ca:sampleapps> |
|---|
| 166 |
<ca:scriptexamples/> |
|---|
| 167 |
</ca:examples> |
|---|
| 168 |
<ca:attributegroups> |
|---|
| 169 |
<ca:attributegroup> |
|---|
| 170 |
<ca:name>Base</ca:name> |
|---|
| 171 |
</ca:attributegroup> |
|---|
| 172 |
</ca:attributegroups> |
|---|
| 173 |
<ca:widgettag> |
|---|
| 174 |
<ca:attribute> |
|---|
| 175 |
<ca:name>NAME</ca:name> |
|---|
| 176 |
<ca:type> |
|---|
| 177 |
<ca:value>string</ca:value> |
|---|
| 178 |
</ca:type> |
|---|
| 179 |
<ca:class> |
|---|
| 180 |
<ca:value>Required</ca:value> |
|---|
| 181 |
</ca:class> |
|---|
| 182 |
<ca:description>Give the Shared Resource a name to help the widgets in the template find it. This name determines which attributes are found in the Shared Resource and also defines the structure of the Shared Resource. Widgets often have defined reserved words to look for specific attribute packages within the Shared Resource. These reserved words include "PopupCSS", "WaitImage", and "Projection".</ca:description> |
|---|
| 183 |
</ca:attribute> |
|---|
| 184 |
<ca:attribute> |
|---|
| 185 |
<ca:name>ENABLEJS</ca:name> |
|---|
| 186 |
<ca:type> |
|---|
| 187 |
<ca:value>boolean</ca:value> |
|---|
| 188 |
</ca:type> |
|---|
| 189 |
<ca:class> |
|---|
| 190 |
<ca:value>Widget Only</ca:value> |
|---|
| 191 |
</ca:class> |
|---|
| 192 |
<ca:default> |
|---|
| 193 |
<ca:value>false</ca:value> |
|---|
| 194 |
<ca:description/> |
|---|
| 195 |
</ca:default> |
|---|
| 196 |
<ca:possvalues type="list"> |
|---|
| 197 |
<ca:value>true</ca:value> |
|---|
| 198 |
<ca:value>false</ca:value> |
|---|
| 199 |
</ca:possvalues> |
|---|
| 200 |
<ca:description>Enables outputting the values in this sharedresource as a javascript Shared$esource. This is required only for specific widgets, and the documentation for those widgets will clearly specify that you need to set this value to true. If unsure, set this to false or remove it altogether.</ca:description> |
|---|
| 201 |
</ca:attribute> |
|---|
| 202 |
</ca:widgettag> |
|---|
| 203 |
<ca:formelements/> |
|---|
| 204 |
</ca:widgetdoc> |
|---|
