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

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

Parent Directory Parent Directory | Revision Log Revision Log

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