/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/DialogWidget.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/DialogWidget.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations)
Thu May 6 16:57:00 2004 UTC (20 years, 2 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
File MIME type: text/html
 updated all to v2.4.1 - Apr 01, 2004

1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class DialogWidget</title>
7 <link rel="stylesheet" href="../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12
13 <h2 class="class-name">Class DialogWidget</h2>
14
15 <a name="sec-description"></a>
16 <div class="info-box">
17 <div class="info-box-title">Description</div>
18 <div class="nav-bar">
19 <span class="disabled">Description</span> |
20 <a href="#sec-descendents">Descendents</a>
21 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
22 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">This is a base class for building generic Dialogs with messages and buttons.</p>
28 <ul class="tags">
29 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
30 </ul>
31 <p class="notes">
32 Located in <a class="field" href="_widgets_DialogWidget_inc.html">/widgets/DialogWidget.inc</a> (line <span class="field">22</span>)
33 </p>
34
35
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39 |
40 --DialogWidget</pre>
41
42 </div>
43 </div>
44
45 <a name="sec-descendents"></a>
46 <div class="info-box">
47 <div class="info-box-title">Direct descendents</div>
48 <div class="nav-bar">
49 <a href="#sec-description">Description</a> |
50 <span class="disabled">Descendents</span>
51 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
52 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
53
54 </div>
55 <div class="info-box-body">
56 <table cellpadding="2" cellspacing="0" class="class-table">
57 <tr>
58 <th class="class-table-header">Class</th>
59 <th class="class-table-header">Description</th>
60 </tr>
61 <tr>
62 <td style="padding-right: 2em"><a href="../phpHtmlLib/StandardDialogWidget.html">StandardDialogWidget</a></td>
63 <td>
64 This class is used to build a DialogWidget that can have 'blocks' for messages.
65 </td>
66 </tr>
67 </table>
68 </div>
69 </div>
70
71
72 <a name="sec-var-summary"></a>
73 <div class="info-box">
74 <div class="info-box-title">Variable Summary</span></div>
75 <div class="nav-bar">
76 <a href="#sec-description">Description</a> |
77 <a href="#sec-descendents">Descendents</a> |
78 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
79 |
80 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
81
82 </div>
83 <div class="info-box-body">
84 <div class="var-summary">
85 <div class="var-title">
86 <span class="var-type">mixed</span>
87 <a href="#$_buttons" title="details" class="var-name">$_buttons</a>
88 </div>
89 <div class="var-title">
90 <span class="var-type">mixed</span>
91 <a href="#$_cancel_url" title="details" class="var-name">$_cancel_url</a>
92 </div>
93 <div class="var-title">
94 <span class="var-type">mixed</span>
95 <a href="#$_show_cancel_button" title="details" class="var-name">$_show_cancel_button</a>
96 </div>
97 </div>
98 </div>
99 </div>
100
101 <a name="sec-method-summary"></a>
102 <div class="info-box">
103 <div class="info-box-title">Method Summary</span></div>
104 <div class="nav-bar">
105 <a href="#sec-description">Description</a> |
106 <a href="#sec-descendents">Descendents</a> |
107 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
108
109 |
110 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
111 </div>
112 <div class="info-box-body">
113 <div class="method-summary">
114
115 <div class="method-definition">
116 <span class="method-result">none</span>
117 <a href="#DialogWidget" title="details" class="method-name">DialogWidget</a>
118 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$align</span> = <span class="var-default">NULL</span>])
119 </div>
120
121 <div class="method-definition">
122 <span class="method-result">void</span>
123 <a href="#add" title="details" class="method-name">add</a>
124 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">0</span>)
125 </div>
126
127 <div class="method-definition">
128 <span class="method-result">void</span>
129 <a href="#add_button" title="details" class="method-name">add_button</a>
130 (<span class="var-type">string</span>&nbsp;<span class="var-name">$button</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">1</span>)
131 </div>
132
133 <div class="method-definition">
134 <span class="method-result">void</span>
135 <a href="#render" title="details" class="method-name">render</a>
136 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
137 </div>
138
139 <div class="method-definition">
140 <span class="method-result">void</span>
141 <a href="#set_cancel_url" title="details" class="method-name">set_cancel_url</a>
142 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
143 </div>
144
145 <div class="method-definition">
146 <span class="method-result">void</span>
147 <a href="#show_cancel_button" title="details" class="method-name">show_cancel_button</a>
148 (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
149 </div>
150
151 <div class="method-definition">
152 <span class="method-result">string</span>
153 <a href="#_build_cancel_url" title="details" class="method-name">_build_cancel_url</a>
154 ()
155 </div>
156
157 <div class="method-definition">
158 <span class="method-result">object -</span>
159 <a href="#_build_message_container" title="details" class="method-name">&amp;_build_message_container</a>
160 ()
161 </div>
162 </div>
163 </div>
164 </div>
165
166 <a name="sec-vars"></a>
167 <div class="info-box">
168 <div class="info-box-title">Variables</div>
169 <div class="nav-bar">
170 <a href="#sec-description">Description</a> |
171 <a href="#sec-descendents">Descendents</a> |
172 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
173
174
175 |
176 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
177
178 </div>
179 <div class="info-box-body">
180 <a name="var$_buttons" id="$_buttons"><!-- --></A>
181 <div class="evenrow">
182
183 <div class="var-header">
184 <span class="var-title">
185 <span class="var-type">mixed</span>
186 <span class="var-name">$_buttons</span>
187 = <span class="var-default">array()</span> (line <span class="line-number">29</span>)
188 </span>
189 </div>
190
191 <!-- ========== Info from phpDoc block ========= -->
192 <p class="short-description">Holds the list of buttons</p>
193 <p class="description"><p>for this widget dialog</p></p>
194
195
196
197
198
199 </div>
200 <a name="var$_cancel_url" id="$_cancel_url"><!-- --></A>
201 <div class="oddrow">
202
203 <div class="var-header">
204 <span class="var-title">
205 <span class="var-type">mixed</span>
206 <span class="var-name">$_cancel_url</span>
207 = <span class="var-default"> NULL</span> (line <span class="line-number">41</span>)
208 </span>
209 </div>
210
211 <!-- ========== Info from phpDoc block ========= -->
212 <p class="short-description">Holds the cancel action</p>
213
214
215
216
217
218 </div>
219 <a name="var$_show_cancel_button" id="$_show_cancel_button"><!-- --></A>
220 <div class="evenrow">
221
222 <div class="var-header">
223 <span class="var-title">
224 <span class="var-type">mixed</span>
225 <span class="var-name">$_show_cancel_button</span>
226 = <span class="var-default"> FALSE</span> (line <span class="line-number">35</span>)
227 </span>
228 </div>
229
230 <!-- ========== Info from phpDoc block ========= -->
231 <p class="short-description">Show or not to show the cancel button?</p>
232
233
234
235
236
237 </div>
238
239 <h4>Inherited Variables</h4>
240 <A NAME='inherited_vars'><!-- --></A>
241 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
242 <blockquote>
243 <span class="var-title">
244 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
245 </span>
246 <span class="var-title">
247 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
248 </span>
249 </blockquote>
250
251 </div>
252 </div>
253
254 <a name="sec-methods"></a>
255 <div class="info-box">
256 <div class="info-box-title">Methods</div>
257 <div class="nav-bar">
258 <a href="#sec-description">Description</a> |
259 <a href="#sec-descendents">Descendents</a> |
260 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
261 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
262
263 </div>
264 <div class="info-box-body">
265 <A NAME='method_detail'></A>
266 <a name="methodDialogWidget" id="DialogWidget"><!-- --></a>
267 <div class="oddrow">
268
269 <div class="method-header">
270 <span class="method-title">Constructor DialogWidget</span> (line <span class="line-number">51</span>)
271 </div>
272
273 <!-- ========== Info from phpDoc block ========= -->
274 <p class="short-description">The constructor</p>
275
276 <div class="method-signature">
277 <span class="method-result">none</span>
278 <span class="method-name">
279 DialogWidget
280 </span>
281 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$align</span> = <span class="var-default">NULL</span>])
282 </div>
283
284 <ul class="parameters">
285 <li>
286 <span class="var-type">string</span>
287 <span class="var-name">$title</span><span class="var-description">: the title</span> </li>
288 <li>
289 <span class="var-type">string</span>
290 <span class="var-name">$width</span><span class="var-description">: the width</span> </li>
291 </ul>
292
293
294 </div>
295 <a name="methodadd" id="add"><!-- --></a>
296 <div class="evenrow">
297
298 <div class="method-header">
299 <span class="method-title">add</span> (line <span class="line-number">85</span>)
300 </div>
301
302 <!-- ========== Info from phpDoc block ========= -->
303 <p class="short-description">Pushes a content into the data object</p>
304 <ul class="tags">
305 <li><span class="field">access:</span> public</li>
306 </ul>
307
308 <div class="method-signature">
309 <span class="method-result">void</span>
310 <span class="method-name">
311 add
312 </span>
313 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">0</span>)
314 </div>
315
316 <ul class="parameters">
317 <li>
318 <span class="var-type">mixed</span>
319 <span class="var-name">0</span><span class="var-description">: - either string, or tag object.</span> </li>
320 </ul>
321
322 <hr class="separator" />
323 <div class="notes">Redefinition of:</div>
324 <dl>
325 <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
326 <dd>add content onto content stack</dd>
327 </dl>
328
329 </div>
330 <a name="methodadd_button" id="add_button"><!-- --></a>
331 <div class="oddrow">
332
333 <div class="method-header">
334 <span class="method-title">add_button</span> (line <span class="line-number">103</span>)
335 </div>
336
337 <!-- ========== Info from phpDoc block ========= -->
338 <p class="short-description">Adds a single button to the dialog that will be display at the bottom of the widget</p>
339 <ul class="tags">
340 <li><span class="field">access:</span> public</li>
341 </ul>
342
343 <div class="method-signature">
344 <span class="method-result">void</span>
345 <span class="method-name">
346 add_button
347 </span>
348 (<span class="var-type">string</span>&nbsp;<span class="var-name">$button</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">1</span>)
349 </div>
350
351 <ul class="parameters">
352 <li>
353 <span class="var-type">string</span>
354 <span class="var-name">1</span><span class="var-description">: - button action, if NULL, then submit button is created</span> </li>
355 <li>
356 <span class="var-type">string</span>
357 <span class="var-name">$button</span><span class="var-description">: - button title</span> </li>
358 </ul>
359
360
361 <hr class="separator" />
362 <div class="notes">Redefined in descendants as:</div>
363 <ul class="redefinitions">
364 <li>
365 <a href="../phpHtmlLib/MessageBoxWidget.html#methodadd_button">MessageBoxWidget::add_button()</a>
366 : Adds a single button to the dialog that will be display at the bottom of the widget
367 </li>
368 </ul>
369 </div>
370 <a name="methodrender" id="render"><!-- --></a>
371 <div class="evenrow">
372
373 <div class="method-header">
374 <span class="method-title">render</span> (line <span class="line-number">62</span>)
375 </div>
376
377 <!-- ========== Info from phpDoc block ========= -->
378 <p class="short-description">Creates a container with title,</p>
379 <p class="description"><p>data and the buttons</p></p>
380
381 <div class="method-signature">
382 <span class="method-result">void</span>
383 <span class="method-name">
384 render
385 </span>
386 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
387 </div>
388
389
390 <hr class="separator" />
391 <div class="notes">Redefinition of:</div>
392 <dl>
393 <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
394 <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
395 </dl>
396
397 <hr class="separator" />
398 <div class="notes">Redefined in descendants as:</div>
399 <ul class="redefinitions">
400 <li>
401 <a href="../phpHtmlLib/MessageBoxWidget.html#methodrender">MessageBoxWidget::render()</a>
402 : We override the render function
403 </li>
404 </ul>
405 </div>
406 <a name="methodset_cancel_url" id="set_cancel_url"><!-- --></a>
407 <div class="oddrow">
408
409 <div class="method-header">
410 <span class="method-title">set_cancel_url</span> (line <span class="line-number">123</span>)
411 </div>
412
413 <!-- ========== Info from phpDoc block ========= -->
414 <p class="short-description">Sets the cancel action</p>
415
416 <div class="method-signature">
417 <span class="method-result">void</span>
418 <span class="method-name">
419 set_cancel_url
420 </span>
421 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
422 </div>
423
424 <ul class="parameters">
425 <li>
426 <span class="var-type">string</span>
427 <span class="var-name">$url</span><span class="var-description">: - action</span> </li>
428 </ul>
429
430
431 </div>
432 <a name="methodshow_cancel_button" id="show_cancel_button"><!-- --></a>
433 <div class="evenrow">
434
435 <div class="method-header">
436 <span class="method-title">show_cancel_button</span> (line <span class="line-number">114</span>)
437 </div>
438
439 <!-- ========== Info from phpDoc block ========= -->
440 <p class="short-description">Sets the flag to show or not to show the cancel button</p>
441
442 <div class="method-signature">
443 <span class="method-result">void</span>
444 <span class="method-name">
445 show_cancel_button
446 </span>
447 (<span class="var-type">bool</span>&nbsp;<span class="var-name">$flag</span>)
448 </div>
449
450 <ul class="parameters">
451 <li>
452 <span class="var-type">bool</span>
453 <span class="var-name">$flag</span><span class="var-description">: - flag</span> </li>
454 </ul>
455
456
457 </div>
458 <a name="method_build_cancel_url" id="_build_cancel_url"><!-- --></a>
459 <div class="oddrow">
460
461 <div class="method-header">
462 <span class="method-title">_build_cancel_url</span> (line <span class="line-number">165</span>)
463 </div>
464
465 <!-- ========== Info from phpDoc block ========= -->
466 <p class="short-description">Build the cancel url</p>
467
468 <div class="method-signature">
469 <span class="method-result">string</span>
470 <span class="method-name">
471 _build_cancel_url
472 </span>
473 ()
474 </div>
475
476
477
478 </div>
479 <a name="method_build_message_container" id="_build_message_container"><!-- --></a>
480 <div class="evenrow">
481
482 <div class="method-header">
483 <span class="method-title">_build_message_container</span> (line <span class="line-number">179</span>)
484 </div>
485
486 <!-- ========== Info from phpDoc block ========= -->
487 <p class="short-description">This method is used to add the message blocks to the appropriate container</p>
488 <ul class="tags">
489 <li><span class="field">return:</span> the container object with the messages.</li>
490 </ul>
491
492 <div class="method-signature">
493 <span class="method-result">object -</span>
494 <span class="method-name">
495 &amp;_build_message_container
496 </span>
497 ()
498 </div>
499
500
501
502 <hr class="separator" />
503 <div class="notes">Redefined in descendants as:</div>
504 <ul class="redefinitions">
505 <li>
506 <a href="../phpHtmlLib/StandardDialogWidget.html#method_build_message_container">StandardDialogWidget::_build_message_container()</a>
507 : This method is used to add the message blocks to the appropriate container
508 </li>
509 </ul>
510 </div>
511 <h4>Inherited Methods</h4>
512 <a name='inherited_methods'><!-- --></a>
513 <!-- =========== Summary =========== -->
514 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
515 <blockquote>
516 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
517 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
518 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
519 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
520 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
521 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
522 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
523 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
524 </blockquote>
525 <!-- =========== Summary =========== -->
526 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
527 <blockquote>
528 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
529 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
530 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
531 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
532 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
533 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
534 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
535 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
536 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
537 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
538 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
539 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
540 </blockquote>
541
542 </div>
543 </div>
544
545
546 <p class="notes" id="credit">
547 Documentation generated on Thu, 1 Apr 2004 09:38:16 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
548 </p>
549 </div></body>
550 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed