|
1 <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
2 <html lang="en" xml:lang="en"> |
|
3 <head> |
|
4 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> |
|
5 <meta name="copyright" content="(C) Copyright 2005" /> |
|
6 <meta name="DC.rights.owner" content="(C) Copyright 2005" /> |
|
7 <meta content="concept" name="DC.Type" /> |
|
8 <meta name="DC.Title" content="WRTKit UIManager Class" /> |
|
9 <meta scheme="URI" name="DC.Relation" content="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html" /> |
|
10 <meta content="XHTML" name="DC.Format" /> |
|
11 <meta content="GUID-937146C8-3889-40F5-B9F7-0F774AC9F5FE" name="DC.Identifier" /> |
|
12 <meta content="en" name="DC.Language" /> |
|
13 <link href="commonltr.css" type="text/css" rel="stylesheet" /> |
|
14 <title> |
|
15 WRTKit UIManager Class</title> |
|
16 </head> |
|
17 <body id="GUID-937146C8-3889-40F5-B9F7-0F774AC9F5FE"><a name="GUID-937146C8-3889-40F5-B9F7-0F774AC9F5FE"><!-- --></a> |
|
18 |
|
19 |
|
20 |
|
21 <h1 class="topictitle1"> |
|
22 WRTKit UIManager Class</h1> |
|
23 |
|
24 <div> |
|
25 |
|
26 <div class="section"><h2 class="sectiontitle"> |
|
27 Description</h2> |
|
28 |
|
29 |
|
30 <p> |
|
31 |
|
32 The UIManager class manages a set of views and related user interface elements |
|
33 such as the scrollbar that indicates the scroll position for the current view, |
|
34 as well as notification popup dialogs. |
|
35 </p> |
|
36 |
|
37 <p> |
|
38 |
|
39 A typical WRTKit user interface consists of one or more views that are commanded |
|
40 to be displayed using the UIManager. When a view is commanded to be shown, the |
|
41 UIManager will remove the currently displayed view (if any) and attach the |
|
42 requested view. The UIManager creates and maintains the state of a scrollbar so |
|
43 that it matches the scrolling position and viewport extent at any given |
|
44 time, regardless of what goes on in the view (e.g. added or removed content), |
|
45 screen rotations and resizes, etc. |
|
46 </p> |
|
47 |
|
48 </div> |
|
49 |
|
50 </div> |
|
51 |
|
52 <div> |
|
53 <div class="familylinks"> |
|
54 <div class="parentlink"><strong>Parent topic:</strong> <a href="WRTKit_API_Reference-GUID-00e47c27-0a1a-443f-ae85-cf3381635170.html">WRTKit API Reference</a></div> |
|
55 </div> |
|
56 </div> |
|
57 <div class="nested1" id="GUID-1F6C6376-EC85-4F79-AFAE-89F4C6078C7A"><a name="GUID-1F6C6376-EC85-4F79-AFAE-89F4C6078C7A"><!-- --></a> |
|
58 |
|
59 <h2 class="topictitle2"> |
|
60 Constructor</h2> |
|
61 |
|
62 <div> |
|
63 |
|
64 <div class="section"><h3 class="sectiontitle"> |
|
65 Syntax</h3> |
|
66 |
|
67 |
|
68 <pre> |
|
69 [UIManager] new UIManager(HTMLElement viewParentElement, HTMLElement scrollbarParentElement)</pre> |
|
70 |
|
71 </div> |
|
72 |
|
73 <div class="section"><h3 class="sectiontitle"> |
|
74 Description</h3> |
|
75 |
|
76 |
|
77 <p> |
|
78 |
|
79 Creates a new instance of the ContentPanel class. |
|
80 </p> |
|
81 |
|
82 </div> |
|
83 |
|
84 <div class="section"><h3 class="sectiontitle"> |
|
85 Arguments</h3> |
|
86 |
|
87 |
|
88 <br /><ul> |
|
89 |
|
90 <li> |
|
91 |
|
92 <p> |
|
93 viewParentElement</p> |
|
94 |
|
95 |
|
96 |
|
97 <p> |
|
98 |
|
99 The HTML element to attachs views to. Normally this argument would be |
|
100 omitted, which causes the UIManager to create its own view parent alement |
|
101 that attaches to the document body element. You only need to supply an |
|
102 HTML element to this argument in rare cases when it's not desirable to |
|
103 have views take up the entire document area. |
|
104 </p> |
|
105 |
|
106 |
|
107 </li> |
|
108 |
|
109 <li> |
|
110 |
|
111 <p> |
|
112 scrollbarParentElement</p> |
|
113 |
|
114 |
|
115 |
|
116 <p> |
|
117 |
|
118 The HTML element to attachs the scrollbar to. Normally this argument would be |
|
119 omitted, which causes the UIManager to create its own scrollbar parent alement |
|
120 that attaches to the document body element. You only need to supply an |
|
121 HTML element to this argument in rare cases when it's not desirable to |
|
122 have the scrollbar in its default location. |
|
123 </p> |
|
124 |
|
125 |
|
126 </li> |
|
127 |
|
128 </ul> |
|
129 |
|
130 </div> |
|
131 |
|
132 <div class="section"><h3 class="sectiontitle"> |
|
133 Return value</h3> |
|
134 |
|
135 |
|
136 <p> |
|
137 |
|
138 A new instance of the UIManager class. |
|
139 </p> |
|
140 |
|
141 </div> |
|
142 |
|
143 </div> |
|
144 |
|
145 </div> |
|
146 |
|
147 <div class="nested1" id="GUID-C31ACB4A-D7B2-4CA5-B0B5-025E289293E5"><a name="GUID-C31ACB4A-D7B2-4CA5-B0B5-025E289293E5"><!-- --></a> |
|
148 |
|
149 <h2 class="topictitle2"> |
|
150 getView()</h2> |
|
151 |
|
152 <div> |
|
153 |
|
154 <div class="section"><h3 class="sectiontitle"> |
|
155 Syntax</h3> |
|
156 |
|
157 |
|
158 <pre> |
|
159 [String] UIManager.getView(void)</pre> |
|
160 |
|
161 </div> |
|
162 |
|
163 <div class="section"><h3 class="sectiontitle"> |
|
164 Description</h3> |
|
165 |
|
166 |
|
167 <p> |
|
168 |
|
169 Retrieves the current view. |
|
170 </p> |
|
171 |
|
172 </div> |
|
173 |
|
174 <div class="section"><h3 class="sectiontitle"> |
|
175 Arguments</h3> |
|
176 |
|
177 |
|
178 <p> |
|
179 |
|
180 This method does not take any arguments. |
|
181 </p> |
|
182 |
|
183 </div> |
|
184 |
|
185 <div class="section"><h3 class="sectiontitle"> |
|
186 Return value</h3> |
|
187 |
|
188 |
|
189 <p> |
|
190 |
|
191 The current view or null if none. |
|
192 </p> |
|
193 |
|
194 </div> |
|
195 |
|
196 </div> |
|
197 |
|
198 </div> |
|
199 |
|
200 <div class="nested1" id="GUID-34ECA4D5-EFA3-41C0-A391-B4F0A97D39BB"><a name="GUID-34ECA4D5-EFA3-41C0-A391-B4F0A97D39BB"><!-- --></a> |
|
201 |
|
202 <h2 class="topictitle2"> |
|
203 setView()</h2> |
|
204 |
|
205 <div> |
|
206 |
|
207 <div class="section"><h3 class="sectiontitle"> |
|
208 Syntax</h3> |
|
209 |
|
210 |
|
211 <pre> |
|
212 [void] UIManager.setView(View view)</pre> |
|
213 |
|
214 </div> |
|
215 |
|
216 <div class="section"><h3 class="sectiontitle"> |
|
217 Description</h3> |
|
218 |
|
219 |
|
220 <p> |
|
221 |
|
222 Sets the view to display. Calling this method removes the current view and |
|
223 displays the specified one instead. If null is passed as the argument to this |
|
224 method then the current view is removed but no new view is displayed instead. |
|
225 </p> |
|
226 |
|
227 </div> |
|
228 |
|
229 <div class="section"><h3 class="sectiontitle"> |
|
230 Arguments</h3> |
|
231 |
|
232 |
|
233 <br /><ul> |
|
234 |
|
235 <li> |
|
236 |
|
237 <p> |
|
238 view</p> |
|
239 |
|
240 |
|
241 |
|
242 <p> |
|
243 |
|
244 The new view to display or null to simply remove the current view. |
|
245 </p> |
|
246 |
|
247 |
|
248 </li> |
|
249 |
|
250 </ul> |
|
251 |
|
252 </div> |
|
253 |
|
254 <div class="section"><h3 class="sectiontitle"> |
|
255 Return value</h3> |
|
256 |
|
257 |
|
258 <p> |
|
259 |
|
260 This method does not return a value. |
|
261 </p> |
|
262 |
|
263 </div> |
|
264 |
|
265 </div> |
|
266 |
|
267 </div> |
|
268 |
|
269 <div class="nested1" id="GUID-9416DD56-09E0-4231-8B45-446C14C6E56E"><a name="GUID-9416DD56-09E0-4231-8B45-446C14C6E56E"><!-- --></a> |
|
270 |
|
271 <h2 class="topictitle2"> |
|
272 showNotification()</h2> |
|
273 |
|
274 <div> |
|
275 |
|
276 <div class="section"><h3 class="sectiontitle"> |
|
277 Syntax</h3> |
|
278 |
|
279 |
|
280 <pre> |
|
281 [void] UIManager.showNotification(Integer displayTime, String type, String text, Float progress)</pre> |
|
282 |
|
283 </div> |
|
284 |
|
285 <div class="section"><h3 class="sectiontitle"> |
|
286 Description</h3> |
|
287 |
|
288 |
|
289 <p> |
|
290 |
|
291 Displays a notification popup dialog. If a dialog is already showing then calling this |
|
292 method again will change the content of the already displayed notification popup. |
|
293 </p> |
|
294 |
|
295 </div> |
|
296 |
|
297 <div class="section"><h3 class="sectiontitle"> |
|
298 Arguments</h3> |
|
299 |
|
300 |
|
301 <br /><ul> |
|
302 |
|
303 <li> |
|
304 |
|
305 <p> |
|
306 displayTime</p> |
|
307 |
|
308 |
|
309 |
|
310 <p> |
|
311 |
|
312 The duration that the dialog should be displayed before automatically hiding. |
|
313 Specified in milliseconds (i.e. 1000ms = 1s). If the notification dialog should |
|
314 not automatically hide then a negative value can be specified. |
|
315 </p> |
|
316 |
|
317 |
|
318 </li> |
|
319 |
|
320 <li> |
|
321 |
|
322 <p> |
|
323 type</p> |
|
324 |
|
325 |
|
326 |
|
327 <p> |
|
328 |
|
329 Type of notification to display. This argument affects the look of the dialog |
|
330 and should have a value of either "info", "warning" or "wait". "Info" should be |
|
331 used for informational popups, "warning" for errors and other warning messages |
|
332 and "wait" for progress dialogs. If the argument is null then no type icon |
|
333 will be shown in the dialog. |
|
334 </p> |
|
335 |
|
336 |
|
337 </li> |
|
338 |
|
339 <li> |
|
340 |
|
341 <p> |
|
342 text</p> |
|
343 |
|
344 |
|
345 |
|
346 <p> |
|
347 |
|
348 The text to display in the popup dialog. If the argument is null then no text |
|
349 will be shown, however this is not recommended as it would be unclear to the |
|
350 user. |
|
351 </p> |
|
352 |
|
353 |
|
354 </li> |
|
355 |
|
356 <li> |
|
357 |
|
358 <p> |
|
359 progress</p> |
|
360 |
|
361 |
|
362 |
|
363 <p> |
|
364 |
|
365 This argument should be omitted except when a progress dialog is desired, i.e. |
|
366 when used with the "wait" type. The value of progress should be a floating |
|
367 point number between 0.0 and 1.0, where 0.0 means "0% progress" and 1.0 means |
|
368 "100% progress". A negative number means "unknown progress" and results in a |
|
369 different progress bar style than for known progress. |
|
370 </p> |
|
371 |
|
372 |
|
373 </li> |
|
374 |
|
375 </ul> |
|
376 |
|
377 </div> |
|
378 |
|
379 <div class="section"><h3 class="sectiontitle"> |
|
380 Return value</h3> |
|
381 |
|
382 |
|
383 <p> |
|
384 |
|
385 This method does not return a value. |
|
386 </p> |
|
387 |
|
388 </div> |
|
389 |
|
390 </div> |
|
391 |
|
392 </div> |
|
393 |
|
394 <div class="nested1" id="GUID-E37D4CC9-0EA4-4850-9F68-BA5C65B1A223"><a name="GUID-E37D4CC9-0EA4-4850-9F68-BA5C65B1A223"><!-- --></a> |
|
395 |
|
396 <h2 class="topictitle2"> |
|
397 hideNotification()</h2> |
|
398 |
|
399 <div> |
|
400 |
|
401 <div class="section"><h3 class="sectiontitle"> |
|
402 Syntax</h3> |
|
403 |
|
404 |
|
405 <pre> |
|
406 [void] UIManager.hideNotification()</pre> |
|
407 |
|
408 </div> |
|
409 |
|
410 <div class="section"><h3 class="sectiontitle"> |
|
411 Description</h3> |
|
412 |
|
413 |
|
414 <p> |
|
415 |
|
416 Hides the currently displayed notification popup dialog, if any. If this method |
|
417 is called when no notification dialog is displayed then the method call is simply |
|
418 ignored but no harm is done. |
|
419 </p> |
|
420 |
|
421 </div> |
|
422 |
|
423 <div class="section"><h3 class="sectiontitle"> |
|
424 Arguments</h3> |
|
425 |
|
426 |
|
427 <p> |
|
428 |
|
429 This method does not take any arguments. |
|
430 </p> |
|
431 |
|
432 </div> |
|
433 |
|
434 <div class="section"><h3 class="sectiontitle"> |
|
435 Return value</h3> |
|
436 |
|
437 |
|
438 <p> |
|
439 |
|
440 This method does not return a value. |
|
441 </p> |
|
442 |
|
443 </div> |
|
444 |
|
445 </div> |
|
446 |
|
447 </div> |
|
448 |
|
449 |
|
450 </body> |
|
451 </html> |