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

root/Chameleon/trunk/Chameleon/ErrorReport/ErrorReport.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>ErrorReport</ca:value>
36     </ca:name>
37     <ca:chameleonpack>
38       <ca:value>TBD</ca:value>
39     </ca:chameleonpack>
40     <ca:parentgroup>
41       <ca:value>Utility/Popup 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 ErrorReport widget is a utility widget used to display errors that have occurred during processing.  Normally, the errors are non-fatal but could be useful in debugging widgets or a new template.  If the ErrorReport widget is not in a template, the errors are output as HTML comments at the top of the application page and can be seen by viewing the HTML source of the page.</ca:para>
64       </ca:paras>
65     </ca:description>
66     <ca:dependancies>
67       <ca:dependancy type="None" title="">
68         <ca:para/>
69       </ca:dependancy>
70     </ca:dependancies>
71     <ca:sharedresources>
72       <ca:paras title="Style and PopUpCss">
73         <ca:para> The ErrorReport widget supports attributes from the Button Attributes and Popup Attributes Groups. This means ErrorReport 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>
74       </ca:paras>
75     </ca:sharedresources>
76     <ca:embeddedhelp>
77       <ca:paras>
78         <ca:para>This button is not normally visible to the user. If an error dialog is automatically opened while using an application, read the report and respond accordingly. (This could mean, among other things, contacting the application developer for help.) </ca:para>
79       </ca:paras>
80     </ca:embeddedhelp>
81     <ca:guinotes>
82     <ca:guinote type="Button" title="The Popup Window Launch">
83       <ca:para>The ErrorReport widget can be placed within an interface as a button, but doing so is really only useful to the application developer for debugging purposes.  The ErrorReport widget can be included in an application being tested but set to be invisible (i.e., visible=&quot;false&quot;) if you want users to be exposed to errors that occur.  For production applications, this widget should be either disabled or removed.  In this final case, errors can still be seen by viewing the HTML source of the application page.</ca:para>
84     </ca:guinote>
85     <ca:guinote type="Popup" title="The Error Message Board">
86       <ca:para>The error popup window is essentially a message board of captured errors from Chameleon. Other than reading its content and closing the popup window, there are no other means of interaction. </ca:para>
87     </ca:guinote>   
88     </ca:guinotes>
89    
90   </ca:descriptions> 
91   <ca:tagstructures>
92     <ca:tagstructure title="Widget Syntax">
93       <ca:description/>
94       <ca:code>
95         <ca:codeblock bold="true">
96           <ca:line>&lt;CWC2 TYPE="ErrorReport"</ca:line>
97         </ca:codeblock>
98         <ca:codeblock bold="false">
99           <ca:line>   ENABLED="[TRUE|FALSE]"</ca:line>
100           <ca:line>   FORMINDEX="[0 &lt; integer]"</ca:line>
101           <ca:line>   VISIBLE="[TRUE|FALSE]"</ca:line>
102           <ca:line/>
103           <ca:line>   &lt;!-- Popup Attribute Group--&gt;</ca:line>
104         </ca:codeblock>
105         <ca:codeblock bold="true">
106           <ca:line>   POPUPHEIGHT="[0 &lt; integer]"</ca:line>
107           <ca:line>   POPUPWIDTH="[0 &lt; integer]"</ca:line>
108         </ca:codeblock>
109         <ca:codeblock bold="false">
110           <ca:line>   MENUBAR="[TRUE|FALSE]"</ca:line>
111           <ca:line>   POPUPSTYLERESOURCE="[string]"</ca:line>
112           <ca:line>   RESIZABLE="[TRUE|FALSE]"</ca:line>
113           <ca:line>   SCROLLBARS="[TRUE|FALSE]"</ca:line>
114           <ca:line>   STATUS="[TRUE|FALSE]"</ca:line>
115           <ca:line>   TOOLBAR="[TRUE|FALSE]"</ca:line>
116           <ca:line></ca:line>
117           <ca:line>   &lt;!-- Button Attribute Group--&gt;</ca:line>
118           <ca:line></ca:line>
119           <ca:line>   BACKGROUNDIMAGE=&quot;[path]&quot;</ca:line>
120           <ca:line>   DEFAULT=&quot;[TRUE|FALSE]&quot;</ca:line>
121           <ca:line>   IMAGE=&quot;[path]&quot;</ca:line>
122           <ca:line>   IMAGEHEIGHT=&quot;[integer]&quot;</ca:line>
123           <ca:line>   IMAGETIP=&quot;[string]&quot;</ca:line>
124           <ca:line>   IMAGEWIDTH=&quot;[integer]&quot;</ca:line>
125           <ca:line>   LABELALIGN=&quot;[LEFT|CENTER|RIGHT]&quot;</ca:line>
126           <ca:line>   LABELANTIALIAS=&quot;[TRUE|FALSE]&quot;</ca:line>
127           <ca:line>   LABELCOLOR=&quot;[#RRGGBB]&quot;</ca:line>
128           <ca:line>   LABELFONT=&quot;[string]&quot;</ca:line>
129           <ca:line>   LABELFONTSIZE=&quot;[0 &lt; integer]&quot;</ca:line>
130           <ca:line>   ONCLICK=&quot;[string]&quot;</ca:line>
131           <ca:line>   STYLERESOURCE=&quot;[string]&quot;</ca:line>
132           <ca:line>   TEXTBUTTONBORDER=&quot;[path]&quot;</ca:line>
133           <ca:line>   TEXTBUTTONBORDER_BOTTOM_IMAGE=&quot;[path]&quot;</ca:line>
134           <ca:line>   TEXTBUTTONBORDER_BOTTOMLEFT_IMAGE=&quot;[path]&quot;</ca:line>
135           <ca:line>   TEXTBUTTONBORDER_BOTTOMRIGHT_IMAGE=&quot;[path]&quot;</ca:line>
136           <ca:line>   TEXTBUTTONBORDER_LEFT_IMAGE=&quot;[path]&quot;</ca:line>
137           <ca:line>   TEXTBUTTONBORDER_RIGHT_IMAGE=&quot;[path]&quot;</ca:line>
138           <ca:line>   TEXTBUTTONBORDER_TOP_IMAGE=&quot;[path]&quot;</ca:line>
139           <ca:line>   TEXTBUTTONBORDER_TOPLEFT_IMAGE=&quot;[path]&quot;</ca:line>
140           <ca:line>   TEXTBUTTONBORDER_TOPRIGHT_IMAGE=&quot;[path]&quot;</ca:line>
141           <ca:line>   TEXTBUTTONCOLOR=&quot;[#RRGGBB]&quot;</ca:line>
142           <ca:line>   TEXTBUTTONNUDGE=&quot;[integer]&quot;</ca:line>
143           <ca:line>   TEXTBUTTONPADDING=&quot;[0 &lt; integer]&quot;</ca:line>
144           <ca:line>   TOOLSET=&quot;[string]&quot;</ca:line>
145           <ca:line>   USETEXTBUTTONCACHE=&quot;[TRUE|FALSE]&quot;&gt;</ca:line>               
146           <ca:line></ca:line>
147           <ca:line>      &lt;!-- Button Subtag Group --&gt;</ca:line>
148           <ca:line></ca:line>
149           <ca:line>      &lt;IMAGE STATE=&quot;[NORMAL|SELECTED|HOVER|DISABLED]&quot;</ca:line>
150           <ca:line>         IMAGE=&quot;[path]&quot;/&gt;</ca:line> 
151         </ca:codeblock> 
152         <ca:codeblock bold="true">
153           <ca:line>&lt;/CWC2&gt;</ca:line>
154         </ca:codeblock>     
155       </ca:code>
156     </ca:tagstructure>
157   </ca:tagstructures>
158   <ca:examples>
159     <ca:widgetexamples>
160       <ca:example title="Example #1: Simple">
161         <ca:description>Since the ErrorReport widget uses the Popup Attribute Group, it inherits the Popup Attribute Group's required attributes, POPUPWIDTH and POPUPHEIGHT. </ca:description>
162         <ca:code>
163           <ca:codeblock bold="false">
164             <ca:line>&lt;cwc2 type="ErrorReport" </ca:line>
165             <ca:line>   popupwidth="500" </ca:line>
166             <ca:line>   popupheight="400"/&gt; </ca:line>
167           </ca:codeblock>
168         </ca:code>
169       </ca:example>
170       <ca:example title="Example #2: Advanced">
171         <ca:description>The following example uses both the Popup and Button Attribute Groups. The widget tag configuration produces a button for the ErrorReport popup. Please note that this widget tag uses two different TextButton Shared Resources. The first TextButton resource styles the button that launches the popup from the application interface, and the second resource holds the text button styles for the buttons found within the popup window. In this case, PopupButtons styles the "Close" button in the ErrorReport popup window.</ca:description>
172         <ca:code>
173           <ca:codeblock bold="false">
174             <ca:line>&lt;cwc2 type="ErrorReport" </ca:line>
175             <ca:line>   popupwidth="500" </ca:line>
176             <ca:line>   popupheight="400" </ca:line>
177             <ca:line>   toolbar="false" </ca:line>
178             <ca:line>   status="false" </ca:line>
179             <ca:line>   menubar="false" </ca:line>
180             <ca:line>   visible="true" </ca:line>
181             <ca:line>   image="icons/icon_warning.png" </ca:line>
182             <ca:line>   imagetip="Display Error Report" </ca:line>
183             <ca:line>   label="Error Report" </ca:line>
184             <ca:line>   styleresource="TextButtons" </ca:line>
185             <ca:line>   popupstyleresource="PopupButtons"&gt;</ca:line>
186             <ca:line>     &lt;image state="normal"/&gt;</ca:line>
187             <ca:line>     &lt;image state="hover"/&gt;</ca:line>
188             <ca:line>     &lt;image state="selected"/&gt;</ca:line>
189           <ca:line> &lt;/cwc2&gt; </ca:line>
190           </ca:codeblock>
191         </ca:code>
192       </ca:example>
193     </ca:widgetexamples>
194     <ca:sharedresourceexamples>
195       <ca:example title="">
196         <ca:description/>
197         <ca:code>
198           <ca:codeblock bold="false">
199             <ca:line/>
200           </ca:codeblock>
201         </ca:code>
202       </ca:example>
203     </ca:sharedresourceexamples>
204     <ca:sampleapps>
205       <ca:sampleapp>
206         <ca:name>Hawaii Demo</ca:name>
207         <ca:appurl>www.mapsherpa.com/hawaii2/</ca:appurl>
208         <ca:description>The Hawaii Demo uses the latest 1.99 Chameleon version.</ca:description>
209       </ca:sampleapp>
210     </ca:sampleapps>
211     <ca:scriptexamples/>
212   </ca:examples>
213   <ca:attributegroups>
214     <ca:attributegroup>
215       <ca:name>Base</ca:name>
216       <ca:name>Button</ca:name>
217       <ca:name>Popup</ca:name>
218     </ca:attributegroup>
219   </ca:attributegroups>
220   <ca:widgettag/>
221   <ca:jsfunctions>
222     <ca:jsfunction>
223       <ca:name>DisplayErrors</ca:name>
224       <ca:scope>
225         <ca:value>Private</ca:value>
226       </ca:scope>
227       <ca:description>Popup a window displaying error messages that occurred.</ca:description>
228     </ca:jsfunction>
229   </ca:jsfunctions>
230 </ca:widgetdoc>
Note: See TracBrowser for help on using the browser.