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 StandardDialogWidget</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 StandardDialogWidget</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-vars">Vars</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 class is used to build a DialogWidget that can have 'blocks' for messages.</p> |
28 |
<ul class="tags"> |
29 |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
30 |
</ul> |
31 |
<p class="notes"> |
32 |
Located in <a class="field" href="_widgets_StandardDialogWidget_inc.html">/widgets/StandardDialogWidget.inc</a> (line <span class="field">23</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 |
--<a href="../phpHtmlLib/DialogWidget.html">DialogWidget</a> |
41 |
| |
42 |
--StandardDialogWidget</pre> |
43 |
|
44 |
</div> |
45 |
</div> |
46 |
|
47 |
<a name="sec-descendents"></a> |
48 |
<div class="info-box"> |
49 |
<div class="info-box-title">Direct descendents</div> |
50 |
<div class="nav-bar"> |
51 |
<a href="#sec-description">Description</a> | |
52 |
<span class="disabled">Descendents</span> |
53 |
| <a href="#sec-vars">Vars</a> |
54 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
55 |
|
56 |
</div> |
57 |
<div class="info-box-body"> |
58 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
59 |
<tr> |
60 |
<th class="class-table-header">Class</th> |
61 |
<th class="class-table-header">Description</th> |
62 |
</tr> |
63 |
<tr> |
64 |
<td style="padding-right: 2em"><a href="../phpHtmlLib/MessageBoxWidget.html">MessageBoxWidget</a></td> |
65 |
<td> |
66 |
This class is used to build a DialogWidget that can have 'blocks' for messages. |
67 |
</td> |
68 |
</tr> |
69 |
</table> |
70 |
</div> |
71 |
</div> |
72 |
|
73 |
|
74 |
|
75 |
<a name="sec-method-summary"></a> |
76 |
<div class="info-box"> |
77 |
<div class="info-box-title">Method Summary</span></div> |
78 |
<div class="nav-bar"> |
79 |
<a href="#sec-description">Description</a> | |
80 |
<a href="#sec-descendents">Descendents</a> | |
81 |
<a href="#sec-vars">Vars</a> |
82 |
|
83 |
| |
84 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
85 |
</div> |
86 |
<div class="info-box-body"> |
87 |
<div class="method-summary"> |
88 |
|
89 |
<div class="method-definition"> |
90 |
<span class="method-result">void</span> |
91 |
<a href="#add_block" title="details" class="method-name">add_block</a> |
92 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">mixed</span> <span class="var-name">$content</span>) |
93 |
</div> |
94 |
|
95 |
<div class="method-definition"> |
96 |
<span class="method-result">object -</span> |
97 |
<a href="#_build_message_container" title="details" class="method-name">&_build_message_container</a> |
98 |
() |
99 |
</div> |
100 |
</div> |
101 |
</div> |
102 |
</div> |
103 |
|
104 |
<a name="sec-vars"></a> |
105 |
<div class="info-box"> |
106 |
<div class="info-box-title">Variables</div> |
107 |
<div class="nav-bar"> |
108 |
<a href="#sec-description">Description</a> | |
109 |
<a href="#sec-descendents">Descendents</a> | |
110 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
111 |
|
112 |
|
113 |
| |
114 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
115 |
|
116 |
</div> |
117 |
<div class="info-box-body"> |
118 |
|
119 |
<h4>Inherited Variables</h4> |
120 |
<A NAME='inherited_vars'><!-- --></A> |
121 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DialogWidget.html">DialogWidget</a></span></p> |
122 |
<blockquote> |
123 |
<span class="var-title"> |
124 |
<span class="var-name"><a href="../phpHtmlLib/DialogWidget.html#var$_buttons">DialogWidget::$_buttons</a></span><br> |
125 |
</span> |
126 |
<span class="var-title"> |
127 |
<span class="var-name"><a href="../phpHtmlLib/DialogWidget.html#var$_cancel_url">DialogWidget::$_cancel_url</a></span><br> |
128 |
</span> |
129 |
<span class="var-title"> |
130 |
<span class="var-name"><a href="../phpHtmlLib/DialogWidget.html#var$_show_cancel_button">DialogWidget::$_show_cancel_button</a></span><br> |
131 |
</span> |
132 |
</blockquote> |
133 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
134 |
<blockquote> |
135 |
<span class="var-title"> |
136 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
137 |
</span> |
138 |
<span class="var-title"> |
139 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
140 |
</span> |
141 |
</blockquote> |
142 |
|
143 |
</div> |
144 |
</div> |
145 |
|
146 |
<a name="sec-methods"></a> |
147 |
<div class="info-box"> |
148 |
<div class="info-box-title">Methods</div> |
149 |
<div class="nav-bar"> |
150 |
<a href="#sec-description">Description</a> | |
151 |
<a href="#sec-descendents">Descendents</a> | |
152 |
<a href="#sec-vars">Vars</a> |
153 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
154 |
|
155 |
</div> |
156 |
<div class="info-box-body"> |
157 |
<A NAME='method_detail'></A> |
158 |
<a name="methodadd_block" id="add_block"><!-- --></a> |
159 |
<div class="oddrow"> |
160 |
|
161 |
<div class="method-header"> |
162 |
<span class="method-title">add_block</span> (line <span class="line-number">35</span>) |
163 |
</div> |
164 |
|
165 |
<!-- ========== Info from phpDoc block ========= --> |
166 |
<p class="short-description">Pushes a block content onto the data object Each pushed block is separated by some white space defined in $_block_spacing</p> |
167 |
<ul class="tags"> |
168 |
<li><span class="field">access:</span> public</li> |
169 |
</ul> |
170 |
|
171 |
<div class="method-signature"> |
172 |
<span class="method-result">void</span> |
173 |
<span class="method-name"> |
174 |
add_block |
175 |
</span> |
176 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">mixed</span> <span class="var-name">$content</span>) |
177 |
</div> |
178 |
|
179 |
<ul class="parameters"> |
180 |
<li> |
181 |
<span class="var-type">string</span> |
182 |
<span class="var-name">$title</span><span class="var-description">: - block title</span> </li> |
183 |
<li> |
184 |
<span class="var-type">mixed</span> |
185 |
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li> |
186 |
</ul> |
187 |
|
188 |
|
189 |
</div> |
190 |
<a name="method_build_message_container" id="_build_message_container"><!-- --></a> |
191 |
<div class="evenrow"> |
192 |
|
193 |
<div class="method-header"> |
194 |
<span class="method-title">_build_message_container</span> (line <span class="line-number">47</span>) |
195 |
</div> |
196 |
|
197 |
<!-- ========== Info from phpDoc block ========= --> |
198 |
<p class="short-description">This method is used to add the message blocks to the appropriate container</p> |
199 |
<ul class="tags"> |
200 |
<li><span class="field">return:</span> the container object with the messages.</li> |
201 |
</ul> |
202 |
|
203 |
<div class="method-signature"> |
204 |
<span class="method-result">object -</span> |
205 |
<span class="method-name"> |
206 |
&_build_message_container |
207 |
</span> |
208 |
() |
209 |
</div> |
210 |
|
211 |
|
212 |
<hr class="separator" /> |
213 |
<div class="notes">Redefinition of:</div> |
214 |
<dl> |
215 |
<dt><a href="../phpHtmlLib/DialogWidget.html#method_build_message_container">DialogWidget::_build_message_container()</a></dt> |
216 |
<dd>This method is used to add the message blocks to the appropriate container</dd> |
217 |
</dl> |
218 |
|
219 |
</div> |
220 |
<h4>Inherited Methods</h4> |
221 |
<a name='inherited_methods'><!-- --></a> |
222 |
<!-- =========== Summary =========== --> |
223 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/DialogWidget.html">DialogWidget</a></span></p> |
224 |
<blockquote> |
225 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodDialogWidget">DialogWidget::DialogWidget()</a></span><br> |
226 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodadd">DialogWidget::add()</a></span><br> |
227 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodadd_button">DialogWidget::add_button()</a></span><br> |
228 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodrender">DialogWidget::render()</a></span><br> |
229 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodset_cancel_url">DialogWidget::set_cancel_url()</a></span><br> |
230 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodshow_cancel_button">DialogWidget::show_cancel_button()</a></span><br> |
231 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#method_build_cancel_url">DialogWidget::_build_cancel_url()</a></span><br> |
232 |
<span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#method_build_message_container">DialogWidget::_build_message_container()</a></span><br> |
233 |
</blockquote> |
234 |
<!-- =========== Summary =========== --> |
235 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
236 |
<blockquote> |
237 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
238 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
239 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
240 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
241 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
242 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
243 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
244 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
245 |
</blockquote> |
246 |
<!-- =========== Summary =========== --> |
247 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
248 |
<blockquote> |
249 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
250 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
251 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
252 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
253 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
254 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
255 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
256 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
257 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
258 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
259 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
260 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
261 |
</blockquote> |
262 |
|
263 |
</div> |
264 |
</div> |
265 |
|
266 |
|
267 |
<p class="notes" id="credit"> |
268 |
Documentation generated on Thu, 1 Apr 2004 09:39:13 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
269 |
</p> |
270 |
</div></body> |
271 |
</html> |