1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:02 -0800' --> |
6 |
<TITLE>Docs For Class InfoTable</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
<!-- Links --> |
11 |
<a NAME="top"></A> |
12 |
<table WIDTH="100%" class="links"> |
13 |
<TR> |
14 |
<TD class="font10"> |
15 |
Links: |
16 |
<A HREF="#children_summary" class="links" title="Classes extended from InfoTable">Child Classes</A> |
17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
</TD> |
24 |
</TR> |
25 |
</TABLE> |
26 |
<BR> |
27 |
<!-- Start of Class Data --> |
28 |
<H2> |
29 |
Class InfoTable |
30 |
</H2> (line <span class="linenumber">23</span>) |
31 |
<pre> |
32 |
<a href="../phpHtmlLib/Container.html">Container</a> |
33 |
| |
34 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
35 |
| |
36 |
--InfoTable</pre> |
37 |
<p> |
38 |
<b><i>Located in File: Program_Root/widgets/InfoTable.inc</i></b><br> |
39 |
</p> |
40 |
<hr> |
41 |
This is a widget class that can build and render data in a nicely formated table with a title, column headers and data |
42 |
<br /> |
43 |
|
44 |
<UL> |
45 |
<LI><b>author</b> - <CODE>Walter A. Boring IV</CODE></LI> |
46 |
</UL> |
47 |
<hr> |
48 |
<!-- =========== VAR SUMMARY =========== --> |
49 |
<A NAME='var_summary'><!-- --></A> |
50 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
51 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
52 |
<TD> |
53 |
<span CLASS="font12bold">Class Variable Summary</span> |
54 |
<A HREF="#top" CLASS="links">^TOP</A> |
55 |
</TD> |
56 |
</TR> |
57 |
|
58 |
<!-- =========== Summary =========== --> |
59 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
60 |
<TD> |
61 |
<CODE><B><A HREF="../phpHtmlLib/InfoTable.html#var$_cellpadding">$_cellpadding</A></B></CODE> |
62 |
<BR> |
63 |
<blockquote> this holds the default cellpadding </blockquote> |
64 |
<blockquote> Default Value: <CODE>->2<-</CODE> </blockquote> |
65 |
</TD> |
66 |
</TR> |
67 |
<!-- =========== Summary =========== --> |
68 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
69 |
<TD> |
70 |
<CODE><B><A HREF="../phpHtmlLib/InfoTable.html#var$_cellspacing">$_cellspacing</A></B></CODE> |
71 |
<BR> |
72 |
<blockquote> This holds the default cellspacing </blockquote> |
73 |
<blockquote> Default Value: <CODE>->0<-</CODE> </blockquote> |
74 |
</TD> |
75 |
</TR> |
76 |
<!-- =========== Summary =========== --> |
77 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
78 |
<TD> |
79 |
<CODE><B><A HREF="../phpHtmlLib/InfoTable.html#var$_headers">$_headers</A></B></CODE> |
80 |
<BR> |
81 |
<blockquote> this holds the column header titles. </blockquote> |
82 |
<blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote> |
83 |
</TD> |
84 |
</TR> |
85 |
<!-- =========== Summary =========== --> |
86 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
87 |
<TD> |
88 |
<CODE><B><A HREF="../phpHtmlLib/InfoTable.html#var$_show_vertical_cellborder">$_show_vertical_cellborder</A></B></CODE> |
89 |
<BR> |
90 |
<blockquote> Flag to tell the class to render </blockquote> |
91 |
<blockquote> Default Value: <CODE>-> TRUE<-</CODE> </blockquote> |
92 |
</TD> |
93 |
</TR> |
94 |
<!-- =========== Summary =========== --> |
95 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
96 |
<TD> |
97 |
<CODE><B><A HREF="../phpHtmlLib/InfoTable.html#var$_title_css_class">$_title_css_class</A></B></CODE> |
98 |
<BR> |
99 |
<blockquote> The default class used for the </blockquote> |
100 |
<blockquote> Default Value: <CODE>-> "title"<-</CODE> </blockquote> |
101 |
</TD> |
102 |
</TR> |
103 |
<!-- =========== Summary =========== --> |
104 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
105 |
<TD> |
106 |
<CODE><B><A HREF="../phpHtmlLib/InfoTable.html#var$_title_text_align">$_title_text_align</A></B></CODE> |
107 |
<BR> |
108 |
<blockquote> The default alignment for the title text in the caption. </blockquote> |
109 |
<blockquote> Default Value: <CODE>-> "left"<-</CODE> </blockquote> |
110 |
</TD> |
111 |
</TR> |
112 |
</TABLE> |
113 |
<hr> |
114 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
115 |
<A NAME='var_inherited_summary'><!-- --></A> |
116 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
117 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
118 |
<TD> |
119 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
120 |
<A HREF="#top" CLASS="links">^TOP</A> |
121 |
</TD> |
122 |
</TR> |
123 |
|
124 |
<!-- =========== Summary =========== --> |
125 |
<TR BGCOLOR='white'> |
126 |
<TD> |
127 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
128 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
129 |
<tr CLASS="tableheadingcolor"> |
130 |
<th>Variable</th> |
131 |
<th>Default Value</th> |
132 |
<th>Description</th> |
133 |
</tr> |
134 |
<tr> |
135 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td> |
136 |
<td CLASS="font10" STYLE="white-space: nowrap">->''<-</td> |
137 |
<td CLASS="font10">The title of the table.</td> |
138 |
</tr> |
139 |
<tr> |
140 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td> |
141 |
<td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td> |
142 |
<td CLASS="font10">the width of the widget</td> |
143 |
</tr> |
144 |
</table> |
145 |
<BR> |
146 |
</TD> |
147 |
</TR> |
148 |
<!-- =========== Summary =========== --> |
149 |
<TR BGCOLOR='white'> |
150 |
<TD> |
151 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
152 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
153 |
<tr CLASS="tableheadingcolor"> |
154 |
<th>Variable</th> |
155 |
<th>Default Value</th> |
156 |
<th>Description</th> |
157 |
</tr> |
158 |
<tr> |
159 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td> |
160 |
<td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td> |
161 |
<td CLASS="font10">The flags that tell us</td> |
162 |
</tr> |
163 |
</table> |
164 |
<BR> |
165 |
</TD> |
166 |
</TR> |
167 |
</TABLE> |
168 |
|
169 |
<hr> |
170 |
<!-- =========== METHOD SUMMARY =========== --> |
171 |
<A NAME='method_summary'><!-- --></A> |
172 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
173 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
174 |
<TD> |
175 |
<span class="font12bold">Method Summary</span> |
176 |
<A HREF="#top" CLASS="links">^TOP</A> |
177 |
</TD> |
178 |
</TR> |
179 |
|
180 |
<!-- =========== Summary =========== --> |
181 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
182 |
<TD> |
183 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodInfoTable'>void constructor InfoTable ( $title, [$width = "100%"], [$align = NULL] )</A></B></CODE> |
184 |
<BR> |
185 |
<blockquote> The constructor </blockquote> |
186 |
</TD> |
187 |
</TR> |
188 |
<!-- =========== Summary =========== --> |
189 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
190 |
<TD> |
191 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodadd_column_header'>void add_column_header ( $title, $width, [$align = "center"] )</A></B></CODE> |
192 |
<BR> |
193 |
<blockquote> This function is used to set the column header text for each column </blockquote> |
194 |
</TD> |
195 |
</TR> |
196 |
<!-- =========== Summary =========== --> |
197 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
198 |
<TD> |
199 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodadd_row'>void add_row ( )</A></B></CODE> |
200 |
<BR> |
201 |
<blockquote> This function is used to add a row to the table </blockquote> |
202 |
</TD> |
203 |
</TR> |
204 |
<!-- =========== Summary =========== --> |
205 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
206 |
<TD> |
207 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodget_cellpadding'>int get_cellpadding ( )</A></B></CODE> |
208 |
<BR> |
209 |
<blockquote> This gets the current value of the cellpadding </blockquote> |
210 |
</TD> |
211 |
</TR> |
212 |
<!-- =========== Summary =========== --> |
213 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
214 |
<TD> |
215 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodget_cellspacing'>int get_cellspacing ( )</A></B></CODE> |
216 |
<BR> |
217 |
<blockquote> This gets the current value of the cellspacing </blockquote> |
218 |
</TD> |
219 |
</TR> |
220 |
<!-- =========== Summary =========== --> |
221 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
222 |
<TD> |
223 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodget_title_text_align'>string get_title_text_align ( )</A></B></CODE> |
224 |
<BR> |
225 |
<blockquote> this function lets gets the default css class for the title </blockquote> |
226 |
</TD> |
227 |
</TR> |
228 |
<!-- =========== Summary =========== --> |
229 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
230 |
<TD> |
231 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodget_vertical_cellborder'>string get_vertical_cellborder ( )</A></B></CODE> |
232 |
<BR> |
233 |
<blockquote> this function lets gets the default css class for the title </blockquote> |
234 |
</TD> |
235 |
</TR> |
236 |
<!-- =========== Summary =========== --> |
237 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
238 |
<TD> |
239 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
240 |
<BR> |
241 |
<blockquote> This function renders the object. </blockquote> |
242 |
</TD> |
243 |
</TR> |
244 |
<!-- =========== Summary =========== --> |
245 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
246 |
<TD> |
247 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodset_cellpadding'>void set_cellpadding ( [$pad = 0] )</A></B></CODE> |
248 |
<BR> |
249 |
<blockquote> This sets the cellpadding attribute for this object. </blockquote> |
250 |
</TD> |
251 |
</TR> |
252 |
<!-- =========== Summary =========== --> |
253 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
254 |
<TD> |
255 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodset_cellspacing'>void set_cellspacing ( [$spacing = 0] )</A></B></CODE> |
256 |
<BR> |
257 |
<blockquote> This sets the cellspacing attribute for this object. </blockquote> |
258 |
</TD> |
259 |
</TR> |
260 |
<!-- =========== Summary =========== --> |
261 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
262 |
<TD> |
263 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodset_title_text_align'>void set_title_text_align ( [$align = "left"] )</A></B></CODE> |
264 |
<BR> |
265 |
<blockquote> this function lets you change the text alignment of the text in the title </blockquote> |
266 |
</TD> |
267 |
</TR> |
268 |
<!-- =========== Summary =========== --> |
269 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
270 |
<TD> |
271 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#methodset_vertical_cellborder'>void set_vertical_cellborder ( [$flag = TRUE] )</A></B></CODE> |
272 |
<BR> |
273 |
<blockquote> this function sets the flag to tell the object to render (or not) the vertical cell borders </blockquote> |
274 |
</TD> |
275 |
</TR> |
276 |
<!-- =========== Summary =========== --> |
277 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
278 |
<TD> |
279 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#method_build_header'><a href="../phpHtmlLib/TRtag.html">TRtag</a> _build_header ( )</A></B></CODE> |
280 |
<BR> |
281 |
<blockquote> This function builds the table header </blockquote> |
282 |
</TD> |
283 |
</TR> |
284 |
<!-- =========== Summary =========== --> |
285 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
286 |
<TD> |
287 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#method_build_td'><a href="../phpHtmlLib/TDtag.html">TDtag</a> _build_td ( [$width = ""], [$align = ""], $col_num, $total_cols )</A></B></CODE> |
288 |
<BR> |
289 |
<blockquote> this function builds a TD tag with the border styles set appropriatly </blockquote> |
290 |
</TD> |
291 |
</TR> |
292 |
<!-- =========== Summary =========== --> |
293 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
294 |
<TD> |
295 |
<CODE><B><A HREF='../phpHtmlLib/InfoTable.html#method_build_title'><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a> _build_title ( )</A></B></CODE> |
296 |
<BR> |
297 |
<blockquote> This function builds the title container </blockquote> |
298 |
</TD> |
299 |
</TR> |
300 |
</TABLE> |
301 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
302 |
<A NAME='functions_inherited'><!-- --></A> |
303 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
304 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
305 |
<TD> |
306 |
<span CLASS="font12bold">Inherited Method Summary</span> |
307 |
<A HREF="#top" CLASS="links">^TOP</A> |
308 |
</TD> |
309 |
</TR> |
310 |
|
311 |
<!-- =========== Summary =========== --> |
312 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
313 |
<TD> |
314 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
315 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
316 |
<tr CLASS="tableheadingcolor"> |
317 |
<th>Function</th> |
318 |
<th>Description</th> |
319 |
</tr> |
320 |
<tr> |
321 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td> |
322 |
<td CLASS="font10">This gets the alignment value for the outer table</td> |
323 |
<tr> |
324 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td> |
325 |
<td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td> |
326 |
<tr> |
327 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td> |
328 |
<td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td> |
329 |
<tr> |
330 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td> |
331 |
<td CLASS="font10">Function for accessing the title of this widget</td> |
332 |
<tr> |
333 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td> |
334 |
<td CLASS="font10">Function for getting the current widget width setting.</td> |
335 |
<tr> |
336 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td> |
337 |
<td CLASS="font10">This function sets the align attribute for the outer table.</td> |
338 |
<tr> |
339 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td> |
340 |
<td CLASS="font10">Set the title for the widget.</td> |
341 |
<tr> |
342 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td> |
343 |
<td CLASS="font10">Set the width for the widget.</td> |
344 |
</table> |
345 |
<br> |
346 |
</TD> |
347 |
</TR> |
348 |
<!-- =========== Summary =========== --> |
349 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
350 |
<TD> |
351 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
352 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
353 |
<tr CLASS="tableheadingcolor"> |
354 |
<th>Function</th> |
355 |
<th>Description</th> |
356 |
</tr> |
357 |
<tr> |
358 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td> |
359 |
<td CLASS="font10">The constructor.</td> |
360 |
<tr> |
361 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td> |
362 |
<td CLASS="font10">add content onto content stack</td> |
363 |
<tr> |
364 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td> |
365 |
<td CLASS="font10">Add content onto content stack so you can change the item later.</td> |
366 |
<tr> |
367 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td> |
368 |
<td CLASS="font10">counts the number of content objects</td> |
369 |
<tr> |
370 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td> |
371 |
<td CLASS="font10">This flag gets the current value of the indent flag</td> |
372 |
<tr> |
373 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td> |
374 |
<td CLASS="font10">Same as add().</td> |
375 |
<tr> |
376 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td> |
377 |
<td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td> |
378 |
<tr> |
379 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td> |
380 |
<td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td> |
381 |
<tr> |
382 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td> |
383 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
384 |
<tr> |
385 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td> |
386 |
<td CLASS="font10">This function turns on the collapse flag</td> |
387 |
<tr> |
388 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td> |
389 |
<td CLASS="font10">function to set the indent flag</td> |
390 |
<tr> |
391 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td> |
392 |
<td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td> |
393 |
</table> |
394 |
<br> |
395 |
</TD> |
396 |
</TR> |
397 |
</TABLE> |
398 |
<hr> |
399 |
<!-- ============ VARIABLE DETAIL =========== --> |
400 |
|
401 |
<A NAME='variable_detail'></A> |
402 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
403 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
404 |
<TD> |
405 |
<span CLASS="font12bold">Variable Detail</span> |
406 |
<A HREF="#top" CLASS="links">^TOP</A> |
407 |
</TD> |
408 |
</TR> |
409 |
</TABLE> |
410 |
|
411 |
<A NAME='var$_cellpadding'><!-- --></A><H3>$_cellpadding</H3> (line <span class="linenumber">34</span>)<br /> |
412 |
<b>Data type:</b> mixed<br>this holds the default cellpadding |
413 |
<br /> |
414 |
|
415 |
<UL> |
416 |
</UL> |
417 |
<HR> |
418 |
<A NAME='var$_cellspacing'><!-- --></A><H3>$_cellspacing</H3> (line <span class="linenumber">39</span>)<br /> |
419 |
<b>Data type:</b> mixed<br>This holds the default cellspacing |
420 |
<br /> |
421 |
|
422 |
<UL> |
423 |
</UL> |
424 |
<HR> |
425 |
<A NAME='var$_headers'><!-- --></A><H3>$_headers</H3> (line <span class="linenumber">29</span>)<br /> |
426 |
<b>Data type:</b> mixed<br>this holds the column header titles. |
427 |
<br /> |
428 |
|
429 |
<UL> |
430 |
</UL> |
431 |
<HR> |
432 |
<A NAME='var$_show_vertical_cellborder'><!-- --></A><H3>$_show_vertical_cellborder</H3> (line <span class="linenumber">57</span>)<br /> |
433 |
<b>Data type:</b> mixed<br>Flag to tell the class to render |
434 |
<br /> |
435 |
<p>the vertical cell border</p> |
436 |
<UL> |
437 |
</UL> |
438 |
<HR> |
439 |
<A NAME='var$_title_css_class'><!-- --></A><H3>$_title_css_class</H3> (line <span class="linenumber">45</span>)<br /> |
440 |
<b>Data type:</b> mixed<br>The default class used for the |
441 |
<br /> |
442 |
<p>title</p> |
443 |
<UL> |
444 |
</UL> |
445 |
<HR> |
446 |
<A NAME='var$_title_text_align'><!-- --></A><H3>$_title_text_align</H3> (line <span class="linenumber">51</span>)<br /> |
447 |
<b>Data type:</b> mixed<br>The default alignment for the title text in the caption. |
448 |
<br /> |
449 |
|
450 |
<UL> |
451 |
</UL> |
452 |
<HR> |
453 |
<hr> |
454 |
<!-- ============ METHOD DETAIL =========== --> |
455 |
|
456 |
<A NAME='method_detail'></A> |
457 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
458 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
459 |
<TD> |
460 |
<span class="font12bold">Method Detail</span> |
461 |
<A HREF="#top" CLASS="links">^TOP</A> |
462 |
</TD> |
463 |
</TR> |
464 |
</TABLE> |
465 |
<BR> |
466 |
<DIV CLASS="function"> |
467 |
<A NAME='methodInfoTable'><!-- --></A> |
468 |
<SPAN CLASS="font12bold">Constructor InfoTable</SPAN> (line <span class="linenumber">68</span>) |
469 |
<BR> |
470 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
471 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
472 |
<span class="font10bold" style="color: #0000FF">InfoTable( |
473 |
string |
474 |
$title, [string |
475 |
$width = "100%"], [string |
476 |
$align = NULL])</SPAN> |
477 |
<BR> |
478 |
|
479 |
<BR> |
480 |
<SPAN CLASS="font10bold">Description : </SPAN> |
481 |
The constructor |
482 |
<br /> |
483 |
|
484 |
<DL> |
485 |
<DT class="font10bold">Function Parameters:</DT> |
486 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - the title</DD> |
487 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width of the table</DD> |
488 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - the alignment</DD> |
489 |
|
490 |
<DT class="font10bold">Function Info:</DT> |
491 |
</DL> |
492 |
</DIV> |
493 |
<BR> |
494 |
<DIV CLASS="function"> |
495 |
<A NAME='methodadd_column_header'><!-- --></A> |
496 |
<SPAN CLASS="font12bold">add_column_header</SPAN> (line <span class="linenumber">131</span>) |
497 |
<BR> |
498 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
499 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
500 |
<span class="font10bold" style="color: #0000FF">add_column_header( |
501 |
string |
502 |
$title, string |
503 |
$width, [mixed |
504 |
$align = "center"])</SPAN> |
505 |
<BR> |
506 |
|
507 |
<BR> |
508 |
<SPAN CLASS="font10bold">Description : </SPAN> |
509 |
This function is used to set the column header text for each column |
510 |
<br /> |
511 |
|
512 |
<DL> |
513 |
<DT class="font10bold">Function Parameters:</DT> |
514 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - the title for the column</DD> |
515 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the alignment of the title</DD> |
516 |
|
517 |
<DT class="font10bold">Function Info:</DT> |
518 |
</DL> |
519 |
</DIV> |
520 |
<BR> |
521 |
<DIV CLASS="function"> |
522 |
<A NAME='methodadd_row'><!-- --></A> |
523 |
<SPAN CLASS="font12bold">add_row</SPAN> (line <span class="linenumber">142</span>) |
524 |
<BR> |
525 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
526 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
527 |
<span class="font10bold" style="color: #0000FF">add_row( |
528 |
mixed |
529 |
0)</SPAN> |
530 |
<BR> |
531 |
|
532 |
<BR> |
533 |
<SPAN CLASS="font10bold">Description : </SPAN> |
534 |
This function is used to add a row to the table |
535 |
<br /> |
536 |
|
537 |
<DL> |
538 |
<DT class="font10bold">Function Parameters:</DT> |
539 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">0</SPAN></SPAN> - n number of items to push</DD> |
540 |
|
541 |
<DT class="font10bold">Function Info:</DT> |
542 |
</DL> |
543 |
</DIV> |
544 |
<BR> |
545 |
<DIV CLASS="function"> |
546 |
<A NAME='methodget_cellpadding'><!-- --></A> |
547 |
<SPAN CLASS="font12bold">get_cellpadding</SPAN> (line <span class="linenumber">168</span>) |
548 |
<BR> |
549 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
550 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
551 |
<span class="font10bold" style="color: #0000FF">get_cellpadding( |
552 |
)</SPAN> |
553 |
<BR> |
554 |
|
555 |
<BR> |
556 |
<SPAN CLASS="font10bold">Description : </SPAN> |
557 |
This gets the current value of the cellpadding |
558 |
<br /> |
559 |
|
560 |
<DL> |
561 |
|
562 |
<DT class="font10bold">Function Info:</DT> |
563 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the current cellpadding</DD> |
564 |
</DL> |
565 |
</DIV> |
566 |
<BR> |
567 |
<DIV CLASS="function"> |
568 |
<A NAME='methodget_cellspacing'><!-- --></A> |
569 |
<SPAN CLASS="font12bold">get_cellspacing</SPAN> (line <span class="linenumber">188</span>) |
570 |
<BR> |
571 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
572 |
<span class="font10bold" style="color: #FF0000">int</SPAN> |
573 |
<span class="font10bold" style="color: #0000FF">get_cellspacing( |
574 |
)</SPAN> |
575 |
<BR> |
576 |
|
577 |
<BR> |
578 |
<SPAN CLASS="font10bold">Description : </SPAN> |
579 |
This gets the current value of the cellspacing |
580 |
<br /> |
581 |
|
582 |
<DL> |
583 |
|
584 |
<DT class="font10bold">Function Info:</DT> |
585 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the current cellspacing</DD> |
586 |
</DL> |
587 |
</DIV> |
588 |
<BR> |
589 |
<DIV CLASS="function"> |
590 |
<A NAME='methodget_title_text_align'><!-- --></A> |
591 |
<SPAN CLASS="font12bold">get_title_text_align</SPAN> (line <span class="linenumber">208</span>) |
592 |
<BR> |
593 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
594 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
595 |
<span class="font10bold" style="color: #0000FF">get_title_text_align( |
596 |
)</SPAN> |
597 |
<BR> |
598 |
|
599 |
<BR> |
600 |
<SPAN CLASS="font10bold">Description : </SPAN> |
601 |
this function lets gets the default css class for the title |
602 |
<br /> |
603 |
|
604 |
<DL> |
605 |
|
606 |
<DT class="font10bold">Function Info:</DT> |
607 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the css class to use</DD> |
608 |
</DL> |
609 |
</DIV> |
610 |
<BR> |
611 |
<DIV CLASS="function"> |
612 |
<A NAME='methodget_vertical_cellborder'><!-- --></A> |
613 |
<SPAN CLASS="font12bold">get_vertical_cellborder</SPAN> (line <span class="linenumber">229</span>) |
614 |
<BR> |
615 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
616 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
617 |
<span class="font10bold" style="color: #0000FF">get_vertical_cellborder( |
618 |
)</SPAN> |
619 |
<BR> |
620 |
|
621 |
<BR> |
622 |
<SPAN CLASS="font10bold">Description : </SPAN> |
623 |
this function lets gets the default css class for the title |
624 |
<br /> |
625 |
|
626 |
<DL> |
627 |
|
628 |
<DT class="font10bold">Function Info:</DT> |
629 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the css class to use</DD> |
630 |
</DL> |
631 |
</DIV> |
632 |
<BR> |
633 |
<DIV CLASS="function"> |
634 |
<A NAME='methodrender'><!-- --></A> |
635 |
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">84</span>) |
636 |
<BR> |
637 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
638 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
639 |
<span class="font10bold" style="color: #0000FF">render( |
640 |
[int |
641 |
$indent_level = 1], int |
642 |
$output_debug)</SPAN> |
643 |
<BR> |
644 |
|
645 |
<BR> |
646 |
<SPAN CLASS="font10bold">Description : </SPAN> |
647 |
This function renders the object. |
648 |
<br /> |
649 |
|
650 |
<DL> |
651 |
<DT class="font10bold">Function Parameters:</DT> |
652 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indentation level for the container.</DD> |
653 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$output_debug</SPAN></SPAN> - the output debug flag to maintain compatibility w/ the API.</DD> |
654 |
|
655 |
<DT class="font10bold">Function Info:</DT> |
656 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD> |
657 |
</DL> |
658 |
</DIV> |
659 |
<BR> |
660 |
<DIV CLASS="function"> |
661 |
<A NAME='methodset_cellpadding'><!-- --></A> |
662 |
<SPAN CLASS="font12bold">set_cellpadding</SPAN> (line <span class="linenumber">158</span>) |
663 |
<BR> |
664 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
665 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
666 |
<span class="font10bold" style="color: #0000FF">set_cellpadding( |
667 |
int |
668 |
$pad)</SPAN> |
669 |
<BR> |
670 |
|
671 |
<BR> |
672 |
<SPAN CLASS="font10bold">Description : </SPAN> |
673 |
This sets the cellpadding attribute for this object. |
674 |
<br /> |
675 |
|
676 |
<DL> |
677 |
<DT class="font10bold">Function Parameters:</DT> |
678 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$pad</SPAN></SPAN> - the cellpadding value</DD> |
679 |
|
680 |
<DT class="font10bold">Function Info:</DT> |
681 |
</DL> |
682 |
</DIV> |
683 |
<BR> |
684 |
<DIV CLASS="function"> |
685 |
<A NAME='methodset_cellspacing'><!-- --></A> |
686 |
<SPAN CLASS="font12bold">set_cellspacing</SPAN> (line <span class="linenumber">178</span>) |
687 |
<BR> |
688 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
689 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
690 |
<span class="font10bold" style="color: #0000FF">set_cellspacing( |
691 |
int |
692 |
$spacing)</SPAN> |
693 |
<BR> |
694 |
|
695 |
<BR> |
696 |
<SPAN CLASS="font10bold">Description : </SPAN> |
697 |
This sets the cellspacing attribute for this object. |
698 |
<br /> |
699 |
|
700 |
<DL> |
701 |
<DT class="font10bold">Function Parameters:</DT> |
702 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$spacing</SPAN></SPAN> - the cellspacing value</DD> |
703 |
|
704 |
<DT class="font10bold">Function Info:</DT> |
705 |
</DL> |
706 |
</DIV> |
707 |
<BR> |
708 |
<DIV CLASS="function"> |
709 |
<A NAME='methodset_title_text_align'><!-- --></A> |
710 |
<SPAN CLASS="font12bold">set_title_text_align</SPAN> (line <span class="linenumber">198</span>) |
711 |
<BR> |
712 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
713 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
714 |
<span class="font10bold" style="color: #0000FF">set_title_text_align( |
715 |
[string |
716 |
$align = "left"])</SPAN> |
717 |
<BR> |
718 |
|
719 |
<BR> |
720 |
<SPAN CLASS="font10bold">Description : </SPAN> |
721 |
this function lets you change the text alignment of the text in the title |
722 |
<br /> |
723 |
|
724 |
<DL> |
725 |
<DT class="font10bold">Function Parameters:</DT> |
726 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - the alignment.</DD> |
727 |
|
728 |
<DT class="font10bold">Function Info:</DT> |
729 |
</DL> |
730 |
</DIV> |
731 |
<BR> |
732 |
<DIV CLASS="function"> |
733 |
<A NAME='methodset_vertical_cellborder'><!-- --></A> |
734 |
<SPAN CLASS="font12bold">set_vertical_cellborder</SPAN> (line <span class="linenumber">219</span>) |
735 |
<BR> |
736 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
737 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
738 |
<span class="font10bold" style="color: #0000FF">set_vertical_cellborder( |
739 |
[boolean |
740 |
$flag = TRUE])</SPAN> |
741 |
<BR> |
742 |
|
743 |
<BR> |
744 |
<SPAN CLASS="font10bold">Description : </SPAN> |
745 |
this function sets the flag to tell the object to render (or not) the vertical cell borders |
746 |
<br /> |
747 |
|
748 |
<DL> |
749 |
<DT class="font10bold">Function Parameters:</DT> |
750 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> </DD> |
751 |
|
752 |
<DT class="font10bold">Function Info:</DT> |
753 |
</DL> |
754 |
</DIV> |
755 |
<BR> |
756 |
<DIV CLASS="function"> |
757 |
<A NAME='method_build_header'><!-- --></A> |
758 |
<SPAN CLASS="font12bold">_build_header</SPAN> (line <span class="linenumber">258</span>) |
759 |
<BR> |
760 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
761 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TRtag.html">TRtag</a></SPAN> |
762 |
<span class="font10bold" style="color: #0000FF">_build_header( |
763 |
)</SPAN> |
764 |
<BR> |
765 |
|
766 |
<BR> |
767 |
<SPAN CLASS="font10bold">Description : </SPAN> |
768 |
This function builds the table header |
769 |
<br /> |
770 |
|
771 |
<DL> |
772 |
|
773 |
<DT class="font10bold">Function Info:</DT> |
774 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
775 |
</DL> |
776 |
</DIV> |
777 |
<BR> |
778 |
<DIV CLASS="function"> |
779 |
<A NAME='method_build_td'><!-- --></A> |
780 |
<SPAN CLASS="font12bold">_build_td</SPAN> (line <span class="linenumber">292</span>) |
781 |
<BR> |
782 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
783 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN> |
784 |
<span class="font10bold" style="color: #0000FF">_build_td( |
785 |
[int |
786 |
$width = ""], [string |
787 |
$align = ""], int |
788 |
$col_num, int |
789 |
$total_cols)</SPAN> |
790 |
<BR> |
791 |
|
792 |
<BR> |
793 |
<SPAN CLASS="font10bold">Description : </SPAN> |
794 |
this function builds a TD tag with the border styles set appropriatly |
795 |
<br /> |
796 |
|
797 |
<DL> |
798 |
<DT class="font10bold">Function Parameters:</DT> |
799 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width</DD> |
800 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - the alignment</DD> |
801 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$col_num</SPAN></SPAN> - the current col #</DD> |
802 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$total_cols</SPAN></SPAN> - the max cols</DD> |
803 |
|
804 |
<DT class="font10bold">Function Info:</DT> |
805 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD> |
806 |
</DL> |
807 |
</DIV> |
808 |
<BR> |
809 |
<DIV CLASS="function"> |
810 |
<A NAME='method_build_title'><!-- --></A> |
811 |
<SPAN CLASS="font12bold">_build_title</SPAN> (line <span class="linenumber">246</span>) |
812 |
<BR> |
813 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
814 |
<span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a></SPAN> |
815 |
<span class="font10bold" style="color: #0000FF">_build_title( |
816 |
)</SPAN> |
817 |
<BR> |
818 |
|
819 |
<BR> |
820 |
<SPAN CLASS="font10bold">Description : </SPAN> |
821 |
This function builds the title container |
822 |
<br /> |
823 |
|
824 |
<DL> |
825 |
|
826 |
<DT class="font10bold">Function Info:</DT> |
827 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD> |
828 |
</DL> |
829 |
</DIV> |
830 |
<BR> |
831 |
<div id="credit"> |
832 |
<hr> |
833 |
Documention generated on Thu, 20 Feb 2003 16:23:02 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
834 |
</div> |
835 |
</body> |
836 |
</html> |