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 InfoTable</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 InfoTable</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 is a widget class that can build and render data in a nicely formated table with a title, column headers and data</p> |
27 |
<ul class="tags"> |
28 |
<li><span class="field">author:</span> Walter A. Boring IV</li> |
29 |
</ul> |
30 |
<p class="notes"> |
31 |
Located in <a class="field" href="_widgets_InfoTable_inc.html">/widgets/InfoTable.inc</a> (line <span class="field">23</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 |
--InfoTable</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="#$_cellpadding" title="details" class="var-name">$_cellpadding</a> |
61 |
</div> |
62 |
<div class="var-title"> |
63 |
<span class="var-type">mixed</span> |
64 |
<a href="#$_cellspacing" title="details" class="var-name">$_cellspacing</a> |
65 |
</div> |
66 |
<div class="var-title"> |
67 |
<span class="var-type">mixed</span> |
68 |
<a href="#$_headers" title="details" class="var-name">$_headers</a> |
69 |
</div> |
70 |
<div class="var-title"> |
71 |
<span class="var-type">mixed</span> |
72 |
<a href="#$_show_cellborders" title="details" class="var-name">$_show_cellborders</a> |
73 |
</div> |
74 |
<div class="var-title"> |
75 |
<span class="var-type">mixed</span> |
76 |
<a href="#$_show_vertical_cellborder" title="details" class="var-name">$_show_vertical_cellborder</a> |
77 |
</div> |
78 |
<div class="var-title"> |
79 |
<span class="var-type">mixed</span> |
80 |
<a href="#$_title_css_class" title="details" class="var-name">$_title_css_class</a> |
81 |
</div> |
82 |
<div class="var-title"> |
83 |
<span class="var-type">mixed</span> |
84 |
<a href="#$_title_text_align" title="details" class="var-name">$_title_text_align</a> |
85 |
</div> |
86 |
</div> |
87 |
</div> |
88 |
</div> |
89 |
|
90 |
<a name="sec-method-summary"></a> |
91 |
<div class="info-box"> |
92 |
<div class="info-box-title">Method Summary</span></div> |
93 |
<div class="nav-bar"> |
94 |
<a href="#sec-description">Description</a> | |
95 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
96 |
|
97 |
| |
98 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
99 |
</div> |
100 |
<div class="info-box-body"> |
101 |
<div class="method-summary"> |
102 |
|
103 |
<div class="method-definition"> |
104 |
<span class="method-result">InfoTable</span> |
105 |
<a href="#InfoTable" title="details" class="method-name">InfoTable</a> |
106 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<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">NULL</span>]) |
107 |
</div> |
108 |
|
109 |
<div class="method-definition"> |
110 |
<span class="method-result">void</span> |
111 |
<a href="#add_column_header" title="details" class="method-name">add_column_header</a> |
112 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$width</span>, [<span class="var-type">mixed</span> <span class="var-name">$align</span> = <span class="var-default">"center"</span>]) |
113 |
</div> |
114 |
|
115 |
<div class="method-definition"> |
116 |
<span class="method-result">void</span> |
117 |
<a href="#add_row" title="details" class="method-name">add_row</a> |
118 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
119 |
</div> |
120 |
|
121 |
<div class="method-definition"> |
122 |
<span class="method-result">int</span> |
123 |
<a href="#get_cellpadding" title="details" class="method-name">get_cellpadding</a> |
124 |
() |
125 |
</div> |
126 |
|
127 |
<div class="method-definition"> |
128 |
<span class="method-result">int</span> |
129 |
<a href="#get_cellspacing" title="details" class="method-name">get_cellspacing</a> |
130 |
() |
131 |
</div> |
132 |
|
133 |
<div class="method-definition"> |
134 |
<span class="method-result">string</span> |
135 |
<a href="#get_title_text_align" title="details" class="method-name">get_title_text_align</a> |
136 |
() |
137 |
</div> |
138 |
|
139 |
<div class="method-definition"> |
140 |
<span class="method-result">string</span> |
141 |
<a href="#get_vertical_cellborder" title="details" class="method-name">get_vertical_cellborder</a> |
142 |
() |
143 |
</div> |
144 |
|
145 |
<div class="method-definition"> |
146 |
<span class="method-result">string</span> |
147 |
<a href="#render" title="details" class="method-name">render</a> |
148 |
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
149 |
</div> |
150 |
|
151 |
<div class="method-definition"> |
152 |
<span class="method-result">void</span> |
153 |
<a href="#set_cellpadding" title="details" class="method-name">set_cellpadding</a> |
154 |
(<span class="var-type">int</span> <span class="var-name">$pad</span>) |
155 |
</div> |
156 |
|
157 |
<div class="method-definition"> |
158 |
<span class="method-result">void</span> |
159 |
<a href="#set_cellspacing" title="details" class="method-name">set_cellspacing</a> |
160 |
(<span class="var-type">int</span> <span class="var-name">$spacing</span>) |
161 |
</div> |
162 |
|
163 |
<div class="method-definition"> |
164 |
<span class="method-result">none</span> |
165 |
<a href="#set_show_cellborders" title="details" class="method-name">set_show_cellborders</a> |
166 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>]) |
167 |
</div> |
168 |
|
169 |
<div class="method-definition"> |
170 |
<span class="method-result">void</span> |
171 |
<a href="#set_title_text_align" title="details" class="method-name">set_title_text_align</a> |
172 |
([<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">"left"</span>]) |
173 |
</div> |
174 |
|
175 |
<div class="method-definition"> |
176 |
<span class="method-result">void</span> |
177 |
<a href="#set_vertical_cellborder" title="details" class="method-name">set_vertical_cellborder</a> |
178 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
179 |
</div> |
180 |
|
181 |
<div class="method-definition"> |
182 |
<span class="method-result"><a href="../phpHtmlLib/TRtag.html">TRtag</a></span> |
183 |
<a href="#_build_header" title="details" class="method-name">_build_header</a> |
184 |
() |
185 |
</div> |
186 |
|
187 |
<div class="method-definition"> |
188 |
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
189 |
<a href="#_build_td" title="details" class="method-name">_build_td</a> |
190 |
([<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">""</span>], <span class="var-type">int</span> <span class="var-name">$col_num</span>, <span class="var-type">int</span> <span class="var-name">$total_cols</span>) |
191 |
</div> |
192 |
|
193 |
<div class="method-definition"> |
194 |
<span class="method-result"><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a></span> |
195 |
<a href="#_build_title" title="details" class="method-name">_build_title</a> |
196 |
() |
197 |
</div> |
198 |
</div> |
199 |
</div> |
200 |
</div> |
201 |
|
202 |
<a name="sec-vars"></a> |
203 |
<div class="info-box"> |
204 |
<div class="info-box-title">Variables</div> |
205 |
<div class="nav-bar"> |
206 |
<a href="#sec-description">Description</a> | |
207 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
208 |
|
209 |
|
210 |
| |
211 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
212 |
|
213 |
</div> |
214 |
<div class="info-box-body"> |
215 |
<a name="var$_cellpadding" id="$_cellpadding"><!-- --></A> |
216 |
<div class="evenrow"> |
217 |
|
218 |
<div class="var-header"> |
219 |
<span class="var-title"> |
220 |
<span class="var-type">mixed</span> |
221 |
<span class="var-name">$_cellpadding</span> |
222 |
= <span class="var-default">2</span> (line <span class="line-number">34</span>) |
223 |
</span> |
224 |
</div> |
225 |
|
226 |
<!-- ========== Info from phpDoc block ========= --> |
227 |
<p class="short-description">this holds the default cellpadding</p> |
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
</div> |
234 |
<a name="var$_cellspacing" id="$_cellspacing"><!-- --></A> |
235 |
<div class="oddrow"> |
236 |
|
237 |
<div class="var-header"> |
238 |
<span class="var-title"> |
239 |
<span class="var-type">mixed</span> |
240 |
<span class="var-name">$_cellspacing</span> |
241 |
(line <span class="line-number">39</span>) |
242 |
</span> |
243 |
</div> |
244 |
|
245 |
<!-- ========== Info from phpDoc block ========= --> |
246 |
<p class="short-description">This holds the default cellspacing</p> |
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
</div> |
253 |
<a name="var$_headers" id="$_headers"><!-- --></A> |
254 |
<div class="evenrow"> |
255 |
|
256 |
<div class="var-header"> |
257 |
<span class="var-title"> |
258 |
<span class="var-type">mixed</span> |
259 |
<span class="var-name">$_headers</span> |
260 |
= <span class="var-default">array()</span> (line <span class="line-number">29</span>) |
261 |
</span> |
262 |
</div> |
263 |
|
264 |
<!-- ========== Info from phpDoc block ========= --> |
265 |
<p class="short-description">this holds the column header titles.</p> |
266 |
|
267 |
|
268 |
|
269 |
|
270 |
|
271 |
</div> |
272 |
<a name="var$_show_cellborders" id="$_show_cellborders"><!-- --></A> |
273 |
<div class="oddrow"> |
274 |
|
275 |
<div class="var-header"> |
276 |
<span class="var-title"> |
277 |
<span class="var-type">mixed</span> |
278 |
<span class="var-name">$_show_cellborders</span> |
279 |
= <span class="var-default"> TRUE</span> (line <span class="line-number">63</span>) |
280 |
</span> |
281 |
</div> |
282 |
|
283 |
<!-- ========== Info from phpDoc block ========= --> |
284 |
<p class="short-description">Show any internal borders?</p> |
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
</div> |
291 |
<a name="var$_show_vertical_cellborder" id="$_show_vertical_cellborder"><!-- --></A> |
292 |
<div class="evenrow"> |
293 |
|
294 |
<div class="var-header"> |
295 |
<span class="var-title"> |
296 |
<span class="var-type">mixed</span> |
297 |
<span class="var-name">$_show_vertical_cellborder</span> |
298 |
= <span class="var-default"> TRUE</span> (line <span class="line-number">57</span>) |
299 |
</span> |
300 |
</div> |
301 |
|
302 |
<!-- ========== Info from phpDoc block ========= --> |
303 |
<p class="short-description">Flag to tell the class to render</p> |
304 |
<p class="description"><p>the vertical cell border</p></p> |
305 |
|
306 |
|
307 |
|
308 |
|
309 |
|
310 |
</div> |
311 |
<a name="var$_title_css_class" id="$_title_css_class"><!-- --></A> |
312 |
<div class="oddrow"> |
313 |
|
314 |
<div class="var-header"> |
315 |
<span class="var-title"> |
316 |
<span class="var-type">mixed</span> |
317 |
<span class="var-name">$_title_css_class</span> |
318 |
= <span class="var-default"> "title"</span> (line <span class="line-number">45</span>) |
319 |
</span> |
320 |
</div> |
321 |
|
322 |
<!-- ========== Info from phpDoc block ========= --> |
323 |
<p class="short-description">The default class used for the</p> |
324 |
<p class="description"><p>title</p></p> |
325 |
|
326 |
|
327 |
|
328 |
|
329 |
|
330 |
</div> |
331 |
<a name="var$_title_text_align" id="$_title_text_align"><!-- --></A> |
332 |
<div class="evenrow"> |
333 |
|
334 |
<div class="var-header"> |
335 |
<span class="var-title"> |
336 |
<span class="var-type">mixed</span> |
337 |
<span class="var-name">$_title_text_align</span> |
338 |
= <span class="var-default"> "left"</span> (line <span class="line-number">51</span>) |
339 |
</span> |
340 |
</div> |
341 |
|
342 |
<!-- ========== Info from phpDoc block ========= --> |
343 |
<p class="short-description">The default alignment for the title text in the caption.</p> |
344 |
|
345 |
|
346 |
|
347 |
|
348 |
|
349 |
</div> |
350 |
|
351 |
<h4>Inherited Variables</h4> |
352 |
<A NAME='inherited_vars'><!-- --></A> |
353 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
354 |
<blockquote> |
355 |
<span class="var-title"> |
356 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
357 |
</span> |
358 |
<span class="var-title"> |
359 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
360 |
</span> |
361 |
</blockquote> |
362 |
|
363 |
</div> |
364 |
</div> |
365 |
|
366 |
<a name="sec-methods"></a> |
367 |
<div class="info-box"> |
368 |
<div class="info-box-title">Methods</div> |
369 |
<div class="nav-bar"> |
370 |
<a href="#sec-description">Description</a> | |
371 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
372 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
373 |
|
374 |
</div> |
375 |
<div class="info-box-body"> |
376 |
<A NAME='method_detail'></A> |
377 |
<a name="methodInfoTable" id="InfoTable"><!-- --></a> |
378 |
<div class="oddrow"> |
379 |
|
380 |
<div class="method-header"> |
381 |
<span class="method-title">Constructor InfoTable</span> (line <span class="line-number">74</span>) |
382 |
</div> |
383 |
|
384 |
<!-- ========== Info from phpDoc block ========= --> |
385 |
<p class="short-description">The constructor</p> |
386 |
|
387 |
<div class="method-signature"> |
388 |
<span class="method-result">InfoTable</span> |
389 |
<span class="method-name"> |
390 |
InfoTable |
391 |
</span> |
392 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<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">NULL</span>]) |
393 |
</div> |
394 |
|
395 |
<ul class="parameters"> |
396 |
<li> |
397 |
<span class="var-type">string</span> |
398 |
<span class="var-name">$title</span><span class="var-description">: - the title</span> </li> |
399 |
<li> |
400 |
<span class="var-type">string</span> |
401 |
<span class="var-name">$width</span><span class="var-description">: - the width of the table</span> </li> |
402 |
<li> |
403 |
<span class="var-type">string</span> |
404 |
<span class="var-name">$align</span><span class="var-description">: - the alignment</span> </li> |
405 |
</ul> |
406 |
|
407 |
|
408 |
</div> |
409 |
<a name="methodadd_column_header" id="add_column_header"><!-- --></a> |
410 |
<div class="evenrow"> |
411 |
|
412 |
<div class="method-header"> |
413 |
<span class="method-title">add_column_header</span> (line <span class="line-number">137</span>) |
414 |
</div> |
415 |
|
416 |
<!-- ========== Info from phpDoc block ========= --> |
417 |
<p class="short-description">This function is used to set the column header text for each column</p> |
418 |
|
419 |
<div class="method-signature"> |
420 |
<span class="method-result">void</span> |
421 |
<span class="method-name"> |
422 |
add_column_header |
423 |
</span> |
424 |
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$width</span>, [<span class="var-type">mixed</span> <span class="var-name">$align</span> = <span class="var-default">"center"</span>]) |
425 |
</div> |
426 |
|
427 |
<ul class="parameters"> |
428 |
<li> |
429 |
<span class="var-type">string</span> |
430 |
<span class="var-name">$title</span><span class="var-description">: - the title for the column</span> </li> |
431 |
<li> |
432 |
<span class="var-type">string</span> |
433 |
<span class="var-name">$width</span><span class="var-description">: - the alignment of the title</span> </li> |
434 |
</ul> |
435 |
|
436 |
|
437 |
</div> |
438 |
<a name="methodadd_row" id="add_row"><!-- --></a> |
439 |
<div class="oddrow"> |
440 |
|
441 |
<div class="method-header"> |
442 |
<span class="method-title">add_row</span> (line <span class="line-number">148</span>) |
443 |
</div> |
444 |
|
445 |
<!-- ========== Info from phpDoc block ========= --> |
446 |
<p class="short-description">This function is used to add a row to the table</p> |
447 |
|
448 |
<div class="method-signature"> |
449 |
<span class="method-result">void</span> |
450 |
<span class="method-name"> |
451 |
add_row |
452 |
</span> |
453 |
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
454 |
</div> |
455 |
|
456 |
<ul class="parameters"> |
457 |
<li> |
458 |
<span class="var-type">mixed</span> |
459 |
<span class="var-name">0</span><span class="var-description">: - n number of items to push</span> </li> |
460 |
</ul> |
461 |
|
462 |
|
463 |
</div> |
464 |
<a name="methodget_cellpadding" id="get_cellpadding"><!-- --></a> |
465 |
<div class="evenrow"> |
466 |
|
467 |
<div class="method-header"> |
468 |
<span class="method-title">get_cellpadding</span> (line <span class="line-number">174</span>) |
469 |
</div> |
470 |
|
471 |
<!-- ========== Info from phpDoc block ========= --> |
472 |
<p class="short-description">This gets the current value of the cellpadding</p> |
473 |
<ul class="tags"> |
474 |
<li><span class="field">return:</span> - the current cellpadding</li> |
475 |
</ul> |
476 |
|
477 |
<div class="method-signature"> |
478 |
<span class="method-result">int</span> |
479 |
<span class="method-name"> |
480 |
get_cellpadding |
481 |
</span> |
482 |
() |
483 |
</div> |
484 |
|
485 |
|
486 |
|
487 |
</div> |
488 |
<a name="methodget_cellspacing" id="get_cellspacing"><!-- --></a> |
489 |
<div class="oddrow"> |
490 |
|
491 |
<div class="method-header"> |
492 |
<span class="method-title">get_cellspacing</span> (line <span class="line-number">194</span>) |
493 |
</div> |
494 |
|
495 |
<!-- ========== Info from phpDoc block ========= --> |
496 |
<p class="short-description">This gets the current value of the cellspacing</p> |
497 |
<ul class="tags"> |
498 |
<li><span class="field">return:</span> - the current cellspacing</li> |
499 |
</ul> |
500 |
|
501 |
<div class="method-signature"> |
502 |
<span class="method-result">int</span> |
503 |
<span class="method-name"> |
504 |
get_cellspacing |
505 |
</span> |
506 |
() |
507 |
</div> |
508 |
|
509 |
|
510 |
|
511 |
</div> |
512 |
<a name="methodget_title_text_align" id="get_title_text_align"><!-- --></a> |
513 |
<div class="evenrow"> |
514 |
|
515 |
<div class="method-header"> |
516 |
<span class="method-title">get_title_text_align</span> (line <span class="line-number">214</span>) |
517 |
</div> |
518 |
|
519 |
<!-- ========== Info from phpDoc block ========= --> |
520 |
<p class="short-description">this function lets gets the default css class for the title</p> |
521 |
<ul class="tags"> |
522 |
<li><span class="field">return:</span> - the css class to use</li> |
523 |
</ul> |
524 |
|
525 |
<div class="method-signature"> |
526 |
<span class="method-result">string</span> |
527 |
<span class="method-name"> |
528 |
get_title_text_align |
529 |
</span> |
530 |
() |
531 |
</div> |
532 |
|
533 |
|
534 |
|
535 |
</div> |
536 |
<a name="methodget_vertical_cellborder" id="get_vertical_cellborder"><!-- --></a> |
537 |
<div class="oddrow"> |
538 |
|
539 |
<div class="method-header"> |
540 |
<span class="method-title">get_vertical_cellborder</span> (line <span class="line-number">235</span>) |
541 |
</div> |
542 |
|
543 |
<!-- ========== Info from phpDoc block ========= --> |
544 |
<p class="short-description">this function lets gets the default css class for the title</p> |
545 |
<ul class="tags"> |
546 |
<li><span class="field">return:</span> - the css class to use</li> |
547 |
</ul> |
548 |
|
549 |
<div class="method-signature"> |
550 |
<span class="method-result">string</span> |
551 |
<span class="method-name"> |
552 |
get_vertical_cellborder |
553 |
</span> |
554 |
() |
555 |
</div> |
556 |
|
557 |
|
558 |
|
559 |
</div> |
560 |
<a name="methodrender" id="render"><!-- --></a> |
561 |
<div class="evenrow"> |
562 |
|
563 |
<div class="method-header"> |
564 |
<span class="method-title">render</span> (line <span class="line-number">90</span>) |
565 |
</div> |
566 |
|
567 |
<!-- ========== Info from phpDoc block ========= --> |
568 |
<p class="short-description">This function renders the object.</p> |
569 |
<ul class="tags"> |
570 |
<li><span class="field">return:</span> the raw html output.</li> |
571 |
</ul> |
572 |
|
573 |
<div class="method-signature"> |
574 |
<span class="method-result">string</span> |
575 |
<span class="method-name"> |
576 |
render |
577 |
</span> |
578 |
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
579 |
</div> |
580 |
|
581 |
<ul class="parameters"> |
582 |
<li> |
583 |
<span class="var-type">int</span> |
584 |
<span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li> |
585 |
<li> |
586 |
<span class="var-type">int</span> |
587 |
<span class="var-name">$output_debug</span><span class="var-description">: - the output debug flag to maintain compatibility w/ the API.</span> </li> |
588 |
</ul> |
589 |
|
590 |
<hr class="separator" /> |
591 |
<div class="notes">Redefinition of:</div> |
592 |
<dl> |
593 |
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
594 |
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
595 |
</dl> |
596 |
|
597 |
</div> |
598 |
<a name="methodset_cellpadding" id="set_cellpadding"><!-- --></a> |
599 |
<div class="oddrow"> |
600 |
|
601 |
<div class="method-header"> |
602 |
<span class="method-title">set_cellpadding</span> (line <span class="line-number">164</span>) |
603 |
</div> |
604 |
|
605 |
<!-- ========== Info from phpDoc block ========= --> |
606 |
<p class="short-description">This sets the cellpadding attribute for this object.</p> |
607 |
|
608 |
<div class="method-signature"> |
609 |
<span class="method-result">void</span> |
610 |
<span class="method-name"> |
611 |
set_cellpadding |
612 |
</span> |
613 |
(<span class="var-type">int</span> <span class="var-name">$pad</span>) |
614 |
</div> |
615 |
|
616 |
<ul class="parameters"> |
617 |
<li> |
618 |
<span class="var-type">int</span> |
619 |
<span class="var-name">$pad</span><span class="var-description">: - the cellpadding value</span> </li> |
620 |
</ul> |
621 |
|
622 |
|
623 |
</div> |
624 |
<a name="methodset_cellspacing" id="set_cellspacing"><!-- --></a> |
625 |
<div class="evenrow"> |
626 |
|
627 |
<div class="method-header"> |
628 |
<span class="method-title">set_cellspacing</span> (line <span class="line-number">184</span>) |
629 |
</div> |
630 |
|
631 |
<!-- ========== Info from phpDoc block ========= --> |
632 |
<p class="short-description">This sets the cellspacing attribute for this object.</p> |
633 |
|
634 |
<div class="method-signature"> |
635 |
<span class="method-result">void</span> |
636 |
<span class="method-name"> |
637 |
set_cellspacing |
638 |
</span> |
639 |
(<span class="var-type">int</span> <span class="var-name">$spacing</span>) |
640 |
</div> |
641 |
|
642 |
<ul class="parameters"> |
643 |
<li> |
644 |
<span class="var-type">int</span> |
645 |
<span class="var-name">$spacing</span><span class="var-description">: - the cellspacing value</span> </li> |
646 |
</ul> |
647 |
|
648 |
|
649 |
</div> |
650 |
<a name="methodset_show_cellborders" id="set_show_cellborders"><!-- --></a> |
651 |
<div class="oddrow"> |
652 |
|
653 |
<div class="method-header"> |
654 |
<span class="method-title">set_show_cellborders</span> (line <span class="line-number">247</span>) |
655 |
</div> |
656 |
|
657 |
<!-- ========== Info from phpDoc block ========= --> |
658 |
<p class="short-description">This method is used to set the flag to allow showing of the internal borders or not.</p> |
659 |
|
660 |
<div class="method-signature"> |
661 |
<span class="method-result">none</span> |
662 |
<span class="method-name"> |
663 |
set_show_cellborders |
664 |
</span> |
665 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">true</span>]) |
666 |
</div> |
667 |
|
668 |
<ul class="parameters"> |
669 |
<li> |
670 |
<span class="var-type">boolean</span> |
671 |
<span class="var-name">$flag</span> </li> |
672 |
</ul> |
673 |
|
674 |
|
675 |
</div> |
676 |
<a name="methodset_title_text_align" id="set_title_text_align"><!-- --></a> |
677 |
<div class="evenrow"> |
678 |
|
679 |
<div class="method-header"> |
680 |
<span class="method-title">set_title_text_align</span> (line <span class="line-number">204</span>) |
681 |
</div> |
682 |
|
683 |
<!-- ========== Info from phpDoc block ========= --> |
684 |
<p class="short-description">this function lets you change the text alignment of the text in the title</p> |
685 |
|
686 |
<div class="method-signature"> |
687 |
<span class="method-result">void</span> |
688 |
<span class="method-name"> |
689 |
set_title_text_align |
690 |
</span> |
691 |
([<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">"left"</span>]) |
692 |
</div> |
693 |
|
694 |
<ul class="parameters"> |
695 |
<li> |
696 |
<span class="var-type">string</span> |
697 |
<span class="var-name">$align</span><span class="var-description">: - the alignment.</span> </li> |
698 |
</ul> |
699 |
|
700 |
|
701 |
</div> |
702 |
<a name="methodset_vertical_cellborder" id="set_vertical_cellborder"><!-- --></a> |
703 |
<div class="oddrow"> |
704 |
|
705 |
<div class="method-header"> |
706 |
<span class="method-title">set_vertical_cellborder</span> (line <span class="line-number">225</span>) |
707 |
</div> |
708 |
|
709 |
<!-- ========== Info from phpDoc block ========= --> |
710 |
<p class="short-description">this function sets the flag to tell the object to render (or not) the vertical cell borders</p> |
711 |
|
712 |
<div class="method-signature"> |
713 |
<span class="method-result">void</span> |
714 |
<span class="method-name"> |
715 |
set_vertical_cellborder |
716 |
</span> |
717 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
718 |
</div> |
719 |
|
720 |
<ul class="parameters"> |
721 |
<li> |
722 |
<span class="var-type">boolean</span> |
723 |
<span class="var-name">$flag</span> </li> |
724 |
</ul> |
725 |
|
726 |
|
727 |
</div> |
728 |
<a name="method_build_header" id="_build_header"><!-- --></a> |
729 |
<div class="evenrow"> |
730 |
|
731 |
<div class="method-header"> |
732 |
<span class="method-title">_build_header</span> (line <span class="line-number">277</span>) |
733 |
</div> |
734 |
|
735 |
<!-- ========== Info from phpDoc block ========= --> |
736 |
<p class="short-description">This function builds the table header</p> |
737 |
<ul class="tags"> |
738 |
<li><span class="field">return:</span> object</li> |
739 |
</ul> |
740 |
|
741 |
<div class="method-signature"> |
742 |
<span class="method-result"><a href="../phpHtmlLib/TRtag.html">TRtag</a></span> |
743 |
<span class="method-name"> |
744 |
_build_header |
745 |
</span> |
746 |
() |
747 |
</div> |
748 |
|
749 |
|
750 |
|
751 |
</div> |
752 |
<a name="method_build_td" id="_build_td"><!-- --></a> |
753 |
<div class="oddrow"> |
754 |
|
755 |
<div class="method-header"> |
756 |
<span class="method-title">_build_td</span> (line <span class="line-number">311</span>) |
757 |
</div> |
758 |
|
759 |
<!-- ========== Info from phpDoc block ========= --> |
760 |
<p class="short-description">this function builds a TD tag with the border styles set appropriatly</p> |
761 |
<ul class="tags"> |
762 |
<li><span class="field">return:</span> object.</li> |
763 |
</ul> |
764 |
|
765 |
<div class="method-signature"> |
766 |
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
767 |
<span class="method-name"> |
768 |
_build_td |
769 |
</span> |
770 |
([<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">""</span>], <span class="var-type">int</span> <span class="var-name">$col_num</span>, <span class="var-type">int</span> <span class="var-name">$total_cols</span>) |
771 |
</div> |
772 |
|
773 |
<ul class="parameters"> |
774 |
<li> |
775 |
<span class="var-type">int</span> |
776 |
<span class="var-name">$width</span><span class="var-description">: - the width</span> </li> |
777 |
<li> |
778 |
<span class="var-type">string</span> |
779 |
<span class="var-name">$align</span><span class="var-description">: - the alignment</span> </li> |
780 |
<li> |
781 |
<span class="var-type">int</span> |
782 |
<span class="var-name">$col_num</span><span class="var-description">: - the current col #</span> </li> |
783 |
<li> |
784 |
<span class="var-type">int</span> |
785 |
<span class="var-name">$total_cols</span><span class="var-description">: - the max cols</span> </li> |
786 |
</ul> |
787 |
|
788 |
|
789 |
</div> |
790 |
<a name="method_build_title" id="_build_title"><!-- --></a> |
791 |
<div class="evenrow"> |
792 |
|
793 |
<div class="method-header"> |
794 |
<span class="method-title">_build_title</span> (line <span class="line-number">265</span>) |
795 |
</div> |
796 |
|
797 |
<!-- ========== Info from phpDoc block ========= --> |
798 |
<p class="short-description">This function builds the title container</p> |
799 |
<ul class="tags"> |
800 |
<li><span class="field">return:</span> object</li> |
801 |
</ul> |
802 |
|
803 |
<div class="method-signature"> |
804 |
<span class="method-result"><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a></span> |
805 |
<span class="method-name"> |
806 |
_build_title |
807 |
</span> |
808 |
() |
809 |
</div> |
810 |
|
811 |
|
812 |
|
813 |
</div> |
814 |
<h4>Inherited Methods</h4> |
815 |
<a name='inherited_methods'><!-- --></a> |
816 |
<!-- =========== Summary =========== --> |
817 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
818 |
<blockquote> |
819 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
820 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
821 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
822 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
823 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
824 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
825 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
826 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
827 |
</blockquote> |
828 |
<!-- =========== Summary =========== --> |
829 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
830 |
<blockquote> |
831 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
832 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
833 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
834 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
835 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> |
836 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
837 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
838 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
839 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
840 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
841 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
842 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
843 |
</blockquote> |
844 |
|
845 |
</div> |
846 |
</div> |
847 |
|
848 |
|
849 |
<p class="notes" id="credit"> |
850 |
Documentation generated on Thu, 1 Apr 2004 09:39:01 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
851 |
</p> |
852 |
</div></body> |
853 |
</html> |