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 ButtonPanel</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 ButtonPanel</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-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 class defines a bottom button panel for a dialog box window It is a BaseWidget child with a specific css style class and border This row is separated by vertical top line</p> |
27 |
<ul class="tags"> |
28 |
<li><span class="field">author:</span> Suren Markosian</li> |
29 |
</ul> |
30 |
<p class="notes"> |
31 |
Located in <a class="field" href="_widgets_ButtonPanel_inc.html">/widgets/ButtonPanel.inc</a> (line <span class="field">19</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 |
--ButtonPanel</pre> |
40 |
|
41 |
</div> |
42 |
</div> |
43 |
|
44 |
|
45 |
|
46 |
<a name="sec-var-summary"></a> |
47 |
<div class="info-box"> |
48 |
<div class="info-box-title">Variable Summary</span></div> |
49 |
<div class="nav-bar"> |
50 |
<a href="#sec-description">Description</a> | |
51 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
52 |
| |
53 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
54 |
|
55 |
</div> |
56 |
<div class="info-box-body"> |
57 |
<div class="var-summary"> |
58 |
<div class="var-title"> |
59 |
<span class="var-type">mixed</span> |
60 |
<a href="#$data" title="details" class="var-name">$data</a> |
61 |
</div> |
62 |
</div> |
63 |
</div> |
64 |
</div> |
65 |
|
66 |
<a name="sec-method-summary"></a> |
67 |
<div class="info-box"> |
68 |
<div class="info-box-title">Method Summary</span></div> |
69 |
<div class="nav-bar"> |
70 |
<a href="#sec-description">Description</a> | |
71 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
72 |
|
73 |
| |
74 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
75 |
</div> |
76 |
<div class="info-box-body"> |
77 |
<div class="method-summary"> |
78 |
|
79 |
<div class="method-definition"> |
80 |
<span class="method-result">none.</span> |
81 |
<a href="#ButtonPanel" title="details" class="method-name">ButtonPanel</a> |
82 |
([<span class="var-type">string</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">"center"</span>]) |
83 |
</div> |
84 |
|
85 |
<div class="method-definition"> |
86 |
<span class="method-result">void</span> |
87 |
<a href="#add" title="details" class="method-name">add</a> |
88 |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
89 |
</div> |
90 |
|
91 |
<div class="method-definition"> |
92 |
<span class="method-result">void</span> |
93 |
<a href="#render" title="details" class="method-name">render</a> |
94 |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
95 |
</div> |
96 |
|
97 |
<div class="method-definition"> |
98 |
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
99 |
<a href="#_build_wrapper" title="details" class="method-name">&_build_wrapper</a> |
100 |
() |
101 |
</div> |
102 |
</div> |
103 |
</div> |
104 |
</div> |
105 |
|
106 |
<a name="sec-vars"></a> |
107 |
<div class="info-box"> |
108 |
<div class="info-box-title">Variables</div> |
109 |
<div class="nav-bar"> |
110 |
<a href="#sec-description">Description</a> | |
111 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
112 |
|
113 |
|
114 |
| |
115 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
116 |
|
117 |
</div> |
118 |
<div class="info-box-body"> |
119 |
<a name="var$data" id="$data"><!-- --></A> |
120 |
<div class="oddrow"> |
121 |
|
122 |
<div class="var-header"> |
123 |
<span class="var-title"> |
124 |
<span class="var-type">mixed</span> |
125 |
<span class="var-name">$data</span> |
126 |
(line <span class="line-number">25</span>) |
127 |
</span> |
128 |
</div> |
129 |
|
130 |
<!-- ========== Info from phpDoc block ========= --> |
131 |
<p class="short-description">Holds all the buttons</p> |
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 |
</div> |
138 |
|
139 |
<h4>Inherited Variables</h4> |
140 |
<A NAME='inherited_vars'><!-- --></A> |
141 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
142 |
<blockquote> |
143 |
<span class="var-title"> |
144 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
145 |
</span> |
146 |
<span class="var-title"> |
147 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
148 |
</span> |
149 |
</blockquote> |
150 |
|
151 |
</div> |
152 |
</div> |
153 |
|
154 |
<a name="sec-methods"></a> |
155 |
<div class="info-box"> |
156 |
<div class="info-box-title">Methods</div> |
157 |
<div class="nav-bar"> |
158 |
<a href="#sec-description">Description</a> | |
159 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
160 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
161 |
|
162 |
</div> |
163 |
<div class="info-box-body"> |
164 |
<A NAME='method_detail'></A> |
165 |
<a name="methodButtonPanel" id="ButtonPanel"><!-- --></a> |
166 |
<div class="evenrow"> |
167 |
|
168 |
<div class="method-header"> |
169 |
<span class="method-title">Constructor ButtonPanel</span> (line <span class="line-number">33</span>) |
170 |
</div> |
171 |
|
172 |
<!-- ========== Info from phpDoc block ========= --> |
173 |
|
174 |
<div class="method-signature"> |
175 |
<span class="method-result">none.</span> |
176 |
<span class="method-name"> |
177 |
ButtonPanel |
178 |
</span> |
179 |
([<span class="var-type">string</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">"center"</span>]) |
180 |
</div> |
181 |
|
182 |
<ul class="parameters"> |
183 |
<li> |
184 |
<span class="var-type">string</span> |
185 |
<span class="var-name">$width</span><span class="var-description">: the width of the button panel</span> </li> |
186 |
<li> |
187 |
<span class="var-type">string</span> |
188 |
<span class="var-name">$align</span><span class="var-description">: the alignment.</span> </li> |
189 |
</ul> |
190 |
|
191 |
|
192 |
</div> |
193 |
<a name="methodadd" id="add"><!-- --></a> |
194 |
<div class="oddrow"> |
195 |
|
196 |
<div class="method-header"> |
197 |
<span class="method-title">add</span> (line <span class="line-number">44</span>) |
198 |
</div> |
199 |
|
200 |
<!-- ========== Info from phpDoc block ========= --> |
201 |
<p class="short-description">Push content onto the data object</p> |
202 |
<p class="description"><p>adds a button to the data</p></p> |
203 |
|
204 |
<div class="method-signature"> |
205 |
<span class="method-result">void</span> |
206 |
<span class="method-name"> |
207 |
add |
208 |
</span> |
209 |
(<span class="var-type">mixed</span> <span class="var-name">$content</span>) |
210 |
</div> |
211 |
|
212 |
<ul class="parameters"> |
213 |
<li> |
214 |
<span class="var-type">mixed</span> |
215 |
<span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span> </li> |
216 |
</ul> |
217 |
|
218 |
<hr class="separator" /> |
219 |
<div class="notes">Redefinition of:</div> |
220 |
<dl> |
221 |
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt> |
222 |
<dd>add content onto content stack</dd> |
223 |
</dl> |
224 |
|
225 |
</div> |
226 |
<a name="methodrender" id="render"><!-- --></a> |
227 |
<div class="evenrow"> |
228 |
|
229 |
<div class="method-header"> |
230 |
<span class="method-title">render</span> (line <span class="line-number">57</span>) |
231 |
</div> |
232 |
|
233 |
<!-- ========== Info from phpDoc block ========= --> |
234 |
<p class="short-description">render the entire table.</p> |
235 |
|
236 |
<div class="method-signature"> |
237 |
<span class="method-result">void</span> |
238 |
<span class="method-name"> |
239 |
render |
240 |
</span> |
241 |
(<span class="var-type">mixed</span> <span class="var-name">$indent_level</span>, <span class="var-type">mixed</span> <span class="var-name">$output_debug</span>) |
242 |
</div> |
243 |
|
244 |
|
245 |
<hr class="separator" /> |
246 |
<div class="notes">Redefinition of:</div> |
247 |
<dl> |
248 |
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
249 |
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
250 |
</dl> |
251 |
|
252 |
</div> |
253 |
<a name="method_build_wrapper" id="_build_wrapper"><!-- --></a> |
254 |
<div class="oddrow"> |
255 |
|
256 |
<div class="method-header"> |
257 |
<span class="method-title">_build_wrapper</span> (line <span class="line-number">74</span>) |
258 |
</div> |
259 |
|
260 |
<!-- ========== Info from phpDoc block ========= --> |
261 |
<p class="short-description">Builds the outer wrapper for the panel</p> |
262 |
<ul class="tags"> |
263 |
<li><span class="field">return:</span> object</li> |
264 |
</ul> |
265 |
|
266 |
<div class="method-signature"> |
267 |
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
268 |
<span class="method-name"> |
269 |
&_build_wrapper |
270 |
</span> |
271 |
() |
272 |
</div> |
273 |
|
274 |
|
275 |
|
276 |
</div> |
277 |
<h4>Inherited Methods</h4> |
278 |
<a name='inherited_methods'><!-- --></a> |
279 |
<!-- =========== Summary =========== --> |
280 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
281 |
<blockquote> |
282 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
283 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
284 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
285 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
286 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
287 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
288 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
289 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
290 |
</blockquote> |
291 |
<!-- =========== Summary =========== --> |
292 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
293 |
<blockquote> |
294 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
295 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
296 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
297 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
298 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
299 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
300 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
301 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
302 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
303 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
304 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
305 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
306 |
</blockquote> |
307 |
|
308 |
</div> |
309 |
</div> |
310 |
|
311 |
|
312 |
<p class="notes" id="credit"> |
313 |
Documentation generated on Thu, 1 Apr 2004 09:38:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
314 |
</p> |
315 |
</div></body> |
316 |
</html> |