NCCOOS Trac Projects: Top | Web | Platforms | Processing | Viz | Sprints | Sandbox | (Wind)

root/Chameleon/trunk/Chameleon/ProjectionLabel/ProjectionLabel.en-ca.doc.xml

Revision 13 (checked in by jcleary, 17 years ago)

Latest Chameleon code checkout from previous repository

Line 
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>ProjectionLabel</ca:value>
36     </ca:name>
37     <ca:chameleonpack>
38       <ca:value>TBD</ca:value>
39     </ca:chameleonpack>
40     <ca:parentgroup>
41       <ca:value>Label Widget</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 ProjectionLabel widget is used to display the name of the current projection from those defined in a common Shared Resource called "projection".</ca:para>
64       </ca:paras>
65     </ca:description>
66     <ca:dependancies>
67       <ca:dependancy type="Data" title="Map Projection">
68         <ca:para>The map must have a valid map projection in order to identify the map projection. </ca:para>
69       </ca:dependancy>
70     </ca:dependancies>
71     <ca:sharedresources>
72       <ca:paras title="Projection">
73         <ca:para>The Projection Shared Resource is an extension of the "ProjectionLabel" widget. The Projection Shared Resource provides a list of Projection titles for EPSG codes. If the application allows dynamically changing the map projection, then the projection title can change as well.  If the application is using a projection that is not defined in the Shared Resource, the application displays the EPSG code instead of a human-readable name.</ca:para>
74       </ca:paras>
75     </ca:sharedresources>
76     <ca:embeddedhelp>
77       <ca:paras>
78         <ca:para>
79     The ProjectLabel widget displays the name of the projection that the map is being displayed in.
80   </ca:para>
81       </ca:paras>
82     </ca:embeddedhelp>
83   </ca:descriptions>
84   <ca:tagstructures>
85     <ca:tagstructure title="Widget Syntax">
86       <ca:description/>
87       <ca:code>
88         <ca:codeblock bold="true">
89           <ca:line>&lt;CWC2 TYPE="ProjectionLabel"</ca:line>
90         </ca:codeblock>
91         <ca:codeblock bold="false">
92           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
93           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
94           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
95           <ca:line/>
96           <ca:line>   &lt;!-- ProjectionLabel Attributes--&gt;</ca:line>
97           <ca:line/>
98           <ca:line>   WIDGETCLASS="[string]"</ca:line>
99           <ca:line>   WIDGETSTYLE="[string]"</ca:line>
100           <ca:line>   TEXTFIELDSIZE="[0 &lt; integer]"</ca:line>
101           <ca:line/>
102           <ca:line>   &lt;!-- Label Attribute Group--&gt;</ca:line>
103           <ca:line/>         
104           <ca:line>   LABEL="[string]"</ca:line>
105           <ca:line>   LABELCLASS="[string]"</ca:line>
106           <ca:line>   LABELHALIGN="[LEFT|CENTER|RIGHT]"</ca:line>
107           <ca:line>   LABELPOSITION="[0 &lt; integer &lt; 8]"</ca:line>
108           <ca:line>   LABELSTYLE="[path]"</ca:line>
109           <ca:line>   LABELVALIGN="[TOP|MIDDLE|BOTTOM]"/&gt;</ca:line>
110         </ca:codeblock>
111       </ca:code>
112     </ca:tagstructure>
113   </ca:tagstructures>
114  
115   <ca:examples>
116     <ca:widgetexamples>
117       <ca:example title="Example #1: Simple">
118         <ca:description>To display the map projection, simply define the widget TYPE. The following example includes adding a descriptive label to the ProjectionLabel output.</ca:description>
119         <ca:code>
120           <ca:codeblock bold="false">
121             <ca:line>&lt;cwc2 type="ProjectionLabel"</ca:line>
122             <ca:line>   label="Projection:" </ca:line>
123             <ca:line>   labelclass="label"/&gt; </ca:line>
124           </ca:codeblock>
125         </ca:code>
126       </ca:example>
127       <ca:example title="Example #2: Advanced">
128         <ca:description>The following example uses the widgetclass attribute to style the projection value. The Label Attribute Group can be used to style the projection label.</ca:description>
129         <ca:code>
130           <ca:codeblock bold="false">
131             <ca:line>&lt;cwc2 type="ProjectionLabel"</ca:line>
132             <ca:line>   label="Projection:" </ca:line>
133             <ca:line>   labelclass="label" </ca:line>
134             <ca:line>   widgetclass="inputBox"/&gt;</ca:line>
135           </ca:codeblock>
136         </ca:code>
137       </ca:example>
138     </ca:widgetexamples>
139
140     <ca:sampleapps>
141       <ca:sampleapp>
142         <ca:name>Hawaii Demo</ca:name>
143         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
144         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
145       </ca:sampleapp>
146     </ca:sampleapps>
147     <ca:scriptexamples/>
148   </ca:examples>
149   <ca:attributegroups>
150     <ca:attributegroup>
151       <ca:name>Base</ca:name>
152       <ca:name>Label</ca:name>
153     </ca:attributegroup>
154   </ca:attributegroups>
155   <ca:widgettag>
156     <ca:attribute>
157       <ca:name>WIDGETCLASS</ca:name>
158       <ca:type>
159         <ca:value>string</ca:value>
160       </ca:type>
161       <ca:class>
162         <ca:value>Widget Only</ca:value>
163       </ca:class>
164       <ca:default>
165         <ca:value>CWCProjectionLabelWidgetClass</ca:value>
166         <ca:description/>
167       </ca:default>
168       <ca:description>The CSS class to control the style of the projection label text.</ca:description>
169     </ca:attribute>
170     <ca:attribute>
171       <ca:name>WIDGETSTYLE</ca:name>
172       <ca:type>
173         <ca:value>string</ca:value>
174       </ca:type>
175       <ca:class>
176         <ca:value>Widget Only</ca:value>
177       </ca:class>
178       <ca:default>
179         <ca:value>NULL</ca:value>
180         <ca:description/>
181       </ca:default>
182       <ca:description>The CSS style to control the style of the projection label text.</ca:description>
183     </ca:attribute>
184     <ca:attribute>
185       <ca:name>TEXTFIELDSIZE</ca:name>
186       <ca:type>
187         <ca:value>integer</ca:value>
188       </ca:type>
189       <ca:class>
190         <ca:value>Widget Only</ca:value>
191       </ca:class>
192       <ca:default>
193         <ca:value>0</ca:value>
194         <ca:description/>
195       </ca:default>
196       <ca:possvalues type="range">
197         <ca:minimum>0</ca:minimum>
198         <ca:maximum>2147483647</ca:maximum>
199       </ca:possvalues>
200       <ca:description>The size (in characters) to make the projection label input when in JSAPI mode.</ca:description>
201     </ca:attribute>
202   </ca:widgettag>
203   <ca:formelements/>
204 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.