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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Thu Jan 30 03:29:29 2003 UTC (22 years, 9 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 jonen 1.1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2     <!--NewPage-->
3     <HTML>
4     <HEAD>
5     <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:32 -0800' -->
6     <TITLE>Docs For Class InfoTable</TITLE>
7     <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8     </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10    
11    
12     <!-- Links -->
13     <a NAME="top"></A>
14     <table WIDTH="100%" class="links">
15     <TR>
16     <TD class="font10">
17     Links:
18     <A HREF="#children_summary" class="links" title="Classes extended from InfoTable">Child Classes</A>
19     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21     <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22     <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23     <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24     <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25     </TD>
26     </TR>
27     </TABLE>
28     <BR>
29    
30     <!-- Start of Class Data -->
31     <H2>
32     Class InfoTable
33     </H2>
34    
35     <pre>
36     <pre><a href="../phpHtmlLib/Container.html">Container</a>
37     |
38     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39     |
40     --InfoTable</pre>
41     </pre>
42    
43     <A NAME="children_summary"</A>
44     <H3>
45     Classes extended from InfoTable: <A HREF="#top" CLASS="links">^TOP</A>
46     </H3>
47    
48     <p>
49     <b><i>Located in File: Program_Root/widgets/InfoTable.inc</i></b><br>
50     </p>
51     <hr>
52     <!-- ========== Info from phpDoc block ========= -->
53     This is a widget class that can build
54     <BR>
55     and render data in a nicely formated table
56     with a title, column headers and data
57    
58     <UL>
59    
60     <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
61    
62     <LI><b>Author</b> - <CODE>Walter A. Boring IV</CODE></LI>
63    
64     </UL>
65    
66     <hr>
67     <!-- =========== VAR SUMMARY =========== -->
68     <A NAME='var_summary'><!-- --></A>
69     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
70     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
71     <TD>
72     <span CLASS="font12bold">Class Variable Summary</span>
73     <A HREF="#top" CLASS="links">^TOP</A>
74     </TD>
75     </TR>
76    
77    
78     <!-- =========== Summary =========== -->
79     <TR BGCOLOR='white' CLASS='TableRowColor'>
80     <TD>
81     <CODE><B><A HREF='InfoTable.html#$_cellpadding'>$_cellpadding</A></B></CODE>
82     <BR>
83     <blockquote> this holds the default cellpadding </blockquote>
84     <blockquote> Default Value: <CODE>->2<-</CODE> </blockquote>
85     </TD>
86     </TR>
87    
88     <!-- =========== Summary =========== -->
89     <TR BGCOLOR='white' CLASS='TableRowColor'>
90     <TD>
91     <CODE><B><A HREF='InfoTable.html#$_cellspacing'>$_cellspacing</A></B></CODE>
92     <BR>
93     <blockquote> This holds the default cellspacing </blockquote>
94     <blockquote> Default Value: <CODE>->0<-</CODE> </blockquote>
95     </TD>
96     </TR>
97    
98     <!-- =========== Summary =========== -->
99     <TR BGCOLOR='white' CLASS='TableRowColor'>
100     <TD>
101     <CODE><B><A HREF='InfoTable.html#$_headers'>$_headers</A></B></CODE>
102     <BR>
103     <blockquote> this holds the column header
104     titles. </blockquote>
105     <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
106     </TD>
107     </TR>
108    
109     <!-- =========== Summary =========== -->
110     <TR BGCOLOR='white' CLASS='TableRowColor'>
111     <TD>
112     <CODE><B><A HREF='InfoTable.html#$_show_vertical_cellborder'>$_show_vertical_cellborder</A></B></CODE>
113     <BR>
114     <blockquote> Flag to tell the class to render </blockquote>
115     <blockquote> Default Value: <CODE>->TRUE<-</CODE> </blockquote>
116     </TD>
117     </TR>
118    
119     <!-- =========== Summary =========== -->
120     <TR BGCOLOR='white' CLASS='TableRowColor'>
121     <TD>
122     <CODE><B><A HREF='InfoTable.html#$_title_css_class'>$_title_css_class</A></B></CODE>
123     <BR>
124     <blockquote> The default class used for the </blockquote>
125     <blockquote> Default Value: <CODE>->title<-</CODE> </blockquote>
126     </TD>
127     </TR>
128    
129     <!-- =========== Summary =========== -->
130     <TR BGCOLOR='white' CLASS='TableRowColor'>
131     <TD>
132     <CODE><B><A HREF='InfoTable.html#$_title_text_align'>$_title_text_align</A></B></CODE>
133     <BR>
134     <blockquote> The default alignment for the
135     title text in the caption. </blockquote>
136     <blockquote> Default Value: <CODE>->left<-</CODE> </blockquote>
137     </TD>
138     </TR>
139    
140     </TABLE>
141    
142     <hr>
143     <!-- =========== VAR INHERITED SUMMARY =========== -->
144     <A NAME='var_inherited_summary'><!-- --></A>
145     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
146     <TR CLASS='TableHeadingColor'>
147     <TD>
148     <span CLASS="font12bold">Inherited Class Variable Summary</span>
149     <A HREF="#top" CLASS="links">^TOP</A>
150     </TD>
151     </TR>
152    
153    
154     <!-- =========== Summary =========== -->
155     <TR BGCOLOR='white'>
156     <TD>
157     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
158     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
159     <tr CLASS="tableheadingcolor">
160     <th>Variable</th>
161     <th>Default Value</th>
162     <th>Description</th>
163     </tr>
164    
165     <tr>
166     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
167     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
168     <td CLASS="font10">The title of the table.</td>
169     </tr>
170    
171     <tr>
172     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
173     <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
174     <td CLASS="font10">the width of the widget</td>
175     </tr>
176    
177     </table>
178     <BR>
179     </TD>
180     </TR>
181    
182     <!-- =========== Summary =========== -->
183     <TR BGCOLOR='white'>
184     <TD>
185     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
186     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
187     <tr CLASS="tableheadingcolor">
188     <th>Variable</th>
189     <th>Default Value</th>
190     <th>Description</th>
191     </tr>
192    
193     <tr>
194     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
195     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
196     <td CLASS="font10">Flag for pretty (indented) output</td>
197     </tr>
198    
199     <tr>
200     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
201     <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
202     <td CLASS="font10">Do we render a newline after the
203     contents has been rendered?</td>
204     </tr>
205    
206     </table>
207     <BR>
208     </TD>
209     </TR>
210    
211     </TABLE>
212    
213     <hr>
214     <!-- =========== INHERITED METHOD SUMMARY =========== -->
215     <A NAME='functions_inherited'><!-- --></A>
216     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
217     <TR CLASS='TableHeadingColor'>
218     <TD>
219     <span CLASS="font12bold">Inherited Method Summary</span>
220     <A HREF="#top" CLASS="links">^TOP</A>
221     </TD>
222     </TR>
223    
224    
225     <!-- =========== Summary =========== -->
226     <TR BGCOLOR='white' CLASS='TableRowColor'>
227     <TD>
228     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
229     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
230     <tr CLASS="tableheadingcolor">
231     <th>Function</th>
232     <th>Description</th>
233     </tr>
234    
235     <tr>
236     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
237     <td CLASS="font10">This gets the alignment value
238     for the outer table</td>
239    
240     <tr>
241     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
242     <td CLASS="font10">This function provides the</td>
243    
244     <tr>
245     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
246     <td CLASS="font10">Function for returning the raw javascript
247     that is required for this widget.</td>
248    
249     <tr>
250     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
251     <td CLASS="font10">Function for accessing the
252     title of this widget</td>
253    
254     <tr>
255     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
256     <td CLASS="font10">Function for getting the current
257     widget width setting.</td>
258    
259     <tr>
260     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
261     <td CLASS="font10">This function sets the align attribute
262     for the outer table.</td>
263    
264     <tr>
265     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
266     <td CLASS="font10">Set the title for the widget.</td>
267    
268     <tr>
269     <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
270     <td CLASS="font10">Set the width for the widget.</td>
271    
272     </table>
273     <br>
274     </TD>
275     </TR>
276    
277     <!-- =========== Summary =========== -->
278     <TR BGCOLOR='white' CLASS='TableRowColor'>
279     <TD>
280     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
281     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
282     <tr CLASS="tableheadingcolor">
283     <th>Function</th>
284     <th>Description</th>
285     </tr>
286    
287     <tr>
288     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
289     <td CLASS="font10">The constructor.</td>
290    
291     <tr>
292     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
293     <td CLASS="font10">add content onto content stack</td>
294    
295     <tr>
296     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
297     <td CLASS="font10">Add content onto content stack
298     so you can change the item later.</td>
299    
300     <tr>
301     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
302     <td CLASS="font10">counts the number of content objects</td>
303    
304     <tr>
305     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
306     <td CLASS="font10">This flag gets the current value
307     of the indent flag</td>
308    
309     <tr>
310     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
311     <td CLASS="font10">Same as add().</td>
312    
313     <tr>
314     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
315     <td CLASS="font10">Same as add_reference
316     NOTE : only exists for compatibility with 1.1.x</td>
317    
318     <tr>
319     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
320     <td CLASS="font10">This function is compatible with the
321     rest of the phpHtmllib API spec.</td>
322    
323     <tr>
324     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
325     <td CLASS="font10">destroy existing content and start with new content.</td>
326    
327     <tr>
328     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
329     <td CLASS="font10">This function turns on the collapse flag</td>
330    
331     <tr>
332     <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
333     <td CLASS="font10">function to set the indent flag</td>
334    
335     </table>
336     <br>
337     </TD>
338     </TR>
339    
340     </TABLE>
341    
342     <hr>
343     <!-- should have constructor at some point -->
344     <!-- =========== Method SUMMARY =========== -->
345     <A NAME='Method_summary'><!-- --></A>
346     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
347     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
348     <TD>
349     <span class="font12bold">Method Summary</span>
350     <A HREF="#top" CLASS="links">^TOP</A>
351     </TD>
352     </TR>
353    
354    
355     <!-- =========== Summary =========== -->
356     <TR BGCOLOR='white' CLASS='TableRowColor'>
357     <TD>
358     <CODE><B><A HREF='InfoTable.html#constructor InfoTable'>void constructor InfoTable ( $title, [$width = "100%"], [$align = NULL] )</A></B></CODE>
359     <BR>
360     <blockquote> The constructor </blockquote>
361     </TD>
362     </TR>
363    
364     <!-- =========== Summary =========== -->
365     <TR BGCOLOR='white' CLASS='TableRowColor'>
366     <TD>
367     <CODE><B><A HREF='InfoTable.html#add_column_header'>void add_column_header ( $title, $width, [$align = "center"] )</A></B></CODE>
368     <BR>
369     <blockquote> This function is used to set the column
370     header text for each column </blockquote>
371     </TD>
372     </TR>
373    
374     <!-- =========== Summary =========== -->
375     <TR BGCOLOR='white' CLASS='TableRowColor'>
376     <TD>
377     <CODE><B><A HREF='InfoTable.html#add_row'>void add_row ( )</A></B></CODE>
378     <BR>
379     <blockquote> This function is used to add a row to the table </blockquote>
380     </TD>
381     </TR>
382    
383     <!-- =========== Summary =========== -->
384     <TR BGCOLOR='white' CLASS='TableRowColor'>
385     <TD>
386     <CODE><B><A HREF='InfoTable.html#get_cellpadding'>int get_cellpadding ( )</A></B></CODE>
387     <BR>
388     <blockquote> This gets the current value of the
389     cellpadding </blockquote>
390     </TD>
391     </TR>
392    
393     <!-- =========== Summary =========== -->
394     <TR BGCOLOR='white' CLASS='TableRowColor'>
395     <TD>
396     <CODE><B><A HREF='InfoTable.html#get_cellspacing'>int get_cellspacing ( )</A></B></CODE>
397     <BR>
398     <blockquote> This gets the current value of the
399     cellspacing </blockquote>
400     </TD>
401     </TR>
402    
403     <!-- =========== Summary =========== -->
404     <TR BGCOLOR='white' CLASS='TableRowColor'>
405     <TD>
406     <CODE><B><A HREF='InfoTable.html#get_title_text_align'>string get_title_text_align ( )</A></B></CODE>
407     <BR>
408     <blockquote> this function lets gets the
409     default css class for the title </blockquote>
410     </TD>
411     </TR>
412    
413     <!-- =========== Summary =========== -->
414     <TR BGCOLOR='white' CLASS='TableRowColor'>
415     <TD>
416     <CODE><B><A HREF='InfoTable.html#get_vertical_cellborder'>string get_vertical_cellborder ( )</A></B></CODE>
417     <BR>
418     <blockquote> this function lets gets the
419     default css class for the title </blockquote>
420     </TD>
421     </TR>
422    
423     <!-- =========== Summary =========== -->
424     <TR BGCOLOR='white' CLASS='TableRowColor'>
425     <TD>
426     <CODE><B><A HREF='InfoTable.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>
427     <BR>
428     <blockquote> This function renders the object. </blockquote>
429     </TD>
430     </TR>
431    
432     <!-- =========== Summary =========== -->
433     <TR BGCOLOR='white' CLASS='TableRowColor'>
434     <TD>
435     <CODE><B><A HREF='InfoTable.html#set_cellpadding'>void set_cellpadding ( [$pad = 0] )</A></B></CODE>
436     <BR>
437     <blockquote> This sets the cellpadding attribute
438     for this object. </blockquote>
439     </TD>
440     </TR>
441    
442     <!-- =========== Summary =========== -->
443     <TR BGCOLOR='white' CLASS='TableRowColor'>
444     <TD>
445     <CODE><B><A HREF='InfoTable.html#set_cellspacing'>void set_cellspacing ( [$spacing = 0] )</A></B></CODE>
446     <BR>
447     <blockquote> This sets the cellspacing attribute
448     for this object. </blockquote>
449     </TD>
450     </TR>
451    
452     <!-- =========== Summary =========== -->
453     <TR BGCOLOR='white' CLASS='TableRowColor'>
454     <TD>
455     <CODE><B><A HREF='InfoTable.html#set_title_text_align'>void set_title_text_align ( [$align = "left"] )</A></B></CODE>
456     <BR>
457     <blockquote> this function lets you change the
458     text alignment of the text in the title </blockquote>
459     </TD>
460     </TR>
461    
462     <!-- =========== Summary =========== -->
463     <TR BGCOLOR='white' CLASS='TableRowColor'>
464     <TD>
465     <CODE><B><A HREF='InfoTable.html#set_vertical_cellborder'>void set_vertical_cellborder ( [$flag = TRUE] )</A></B></CODE>
466     <BR>
467     <blockquote> this function sets the flag to tell </blockquote>
468     </TD>
469     </TR>
470    
471     <!-- =========== Summary =========== -->
472     <TR BGCOLOR='white' CLASS='TableRowColor'>
473     <TD>
474     <CODE><B><A HREF='InfoTable.html#_build_header'><a href="../phpHtmlLib/TRtag.html">TRtag</a> _build_header ( )</A></B></CODE>
475     <BR>
476     <blockquote> This function builds the table header </blockquote>
477     </TD>
478     </TR>
479    
480     <!-- =========== Summary =========== -->
481     <TR BGCOLOR='white' CLASS='TableRowColor'>
482     <TD>
483     <CODE><B><A HREF='InfoTable.html#_build_td'><a href="../phpHtmlLib/TDtag.html">TDtag</a> _build_td ( $width, $align, $col_num, $total_cols )</A></B></CODE>
484     <BR>
485     <blockquote> this function builds a TD tag with the border styles
486     set appropriatly </blockquote>
487     </TD>
488     </TR>
489    
490     <!-- =========== Summary =========== -->
491     <TR BGCOLOR='white' CLASS='TableRowColor'>
492     <TD>
493     <CODE><B><A HREF='InfoTable.html#_build_title'><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a> _build_title ( )</A></B></CODE>
494     <BR>
495     <blockquote> This function builds the title
496     container </blockquote>
497     </TD>
498     </TR>
499    
500     </TABLE>
501    
502     <hr>
503     <!-- ============ VARIABLE DETAIL =========== -->
504    
505     <A NAME='variable_detail'></A>
506     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
507     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
508     <TD>
509     <span CLASS="font12bold">Variable Detail</span>
510     <A HREF="#top" CLASS="links">^TOP</A>
511     </TD>
512     </TR>
513     </TABLE>
514    
515    
516     <A NAME='$_cellpadding'><!-- --></A><H3>$_cellpadding</H3>
517     <b>Data type:</b> mixed<br>
518     <!-- ========== Info from phpDoc block ========= -->
519     this holds the default cellpadding
520     <BR>
521    
522    
523     <UL>
524    
525     </UL>
526    
527     <HR>
528    
529     <A NAME='$_cellspacing'><!-- --></A><H3>$_cellspacing</H3>
530     <b>Data type:</b> mixed<br>
531     <!-- ========== Info from phpDoc block ========= -->
532     This holds the default cellspacing
533     <BR>
534    
535    
536     <UL>
537    
538     </UL>
539    
540     <HR>
541    
542     <A NAME='$_headers'><!-- --></A><H3>$_headers</H3>
543     <b>Data type:</b> mixed<br>
544     <!-- ========== Info from phpDoc block ========= -->
545     this holds the column header
546     titles.
547     <BR>
548    
549    
550     <UL>
551    
552     </UL>
553    
554     <HR>
555    
556     <A NAME='$_show_vertical_cellborder'><!-- --></A><H3>$_show_vertical_cellborder</H3>
557     <b>Data type:</b> mixed<br>
558     <!-- ========== Info from phpDoc block ========= -->
559     Flag to tell the class to render
560     <BR>
561     the vertical cell border
562    
563     <UL>
564    
565     </UL>
566    
567     <HR>
568    
569     <A NAME='$_title_css_class'><!-- --></A><H3>$_title_css_class</H3>
570     <b>Data type:</b> mixed<br>
571     <!-- ========== Info from phpDoc block ========= -->
572     The default class used for the
573     <BR>
574     title
575    
576     <UL>
577    
578     </UL>
579    
580     <HR>
581    
582     <A NAME='$_title_text_align'><!-- --></A><H3>$_title_text_align</H3>
583     <b>Data type:</b> mixed<br>
584     <!-- ========== Info from phpDoc block ========= -->
585     The default alignment for the
586     title text in the caption.
587     <BR>
588    
589    
590     <UL>
591    
592     </UL>
593    
594     <HR>
595    
596    
597     <hr>
598     <!-- ============ FUNCTION DETAIL =========== -->
599    
600     <A NAME='function_detail'></A>
601     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
602     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
603     <TD>
604     <span class="font12bold">Method Detail</span>
605     <A HREF="#top" CLASS="links">^TOP</A>
606     </TD>
607     </TR>
608     </TABLE>
609     <BR>
610    
611     <DIV CLASS="function">
612     <A NAME='constructor InfoTable'><!-- --></A>
613     <SPAN CLASS="font12bold">constructor InfoTable</SPAN>
614     <BR>
615     <SPAN CLASS="font10bold">Useage : </SPAN>
616     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
617     <span class="font10bold" style="color: #0000FF">constructor InfoTable ( $title, [$width = "100%"], [$align = NULL] )</SPAN>
618     <BR>
619    
620     <BR>
621     <SPAN CLASS="font10bold">Description : </SPAN>
622     <!-- ========== Info from phpDoc block ========= -->
623     The constructor
624     <BR>
625    
626     <DL>
627     <DT class="font10bold">Function Parameters:</DT>
628    
629     <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>
630    
631     <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>
632    
633     <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>
634    
635    
636     <DT class="font10bold">Function Info:</DT>
637    
638     </DL>
639    
640     </DIV>
641     <BR>
642    
643     <DIV CLASS="function">
644     <A NAME='add_column_header'><!-- --></A>
645     <SPAN CLASS="font12bold">add_column_header</SPAN>
646     <BR>
647     <SPAN CLASS="font10bold">Useage : </SPAN>
648     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
649     <span class="font10bold" style="color: #0000FF">add_column_header ( $title, $width, [$align = "center"] )</SPAN>
650     <BR>
651    
652     <BR>
653     <SPAN CLASS="font10bold">Description : </SPAN>
654     <!-- ========== Info from phpDoc block ========= -->
655     This function is used to set the column
656     header text for each column
657     <BR>
658    
659     <DL>
660     <DT class="font10bold">Function Parameters:</DT>
661    
662     <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>
663    
664     <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>
665    
666    
667     <DT class="font10bold">Function Info:</DT>
668    
669     </DL>
670    
671     </DIV>
672     <BR>
673    
674     <DIV CLASS="function">
675     <A NAME='add_row'><!-- --></A>
676     <SPAN CLASS="font12bold">add_row</SPAN>
677     <BR>
678     <SPAN CLASS="font10bold">Useage : </SPAN>
679     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
680     <span class="font10bold" style="color: #0000FF">add_row ( )</SPAN>
681     <BR>
682    
683     <BR>
684     <SPAN CLASS="font10bold">Description : </SPAN>
685     <!-- ========== Info from phpDoc block ========= -->
686     This function is used to add a row to the table
687     <BR>
688    
689     <DL>
690     <DT class="font10bold">Function Parameters:</DT>
691    
692     <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>
693    
694    
695     <DT class="font10bold">Function Info:</DT>
696    
697     </DL>
698    
699     </DIV>
700     <BR>
701    
702     <DIV CLASS="function">
703     <A NAME='get_cellpadding'><!-- --></A>
704     <SPAN CLASS="font12bold">get_cellpadding</SPAN>
705     <BR>
706     <SPAN CLASS="font10bold">Useage : </SPAN>
707     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
708     <span class="font10bold" style="color: #0000FF">get_cellpadding ( )</SPAN>
709     <BR>
710    
711     <BR>
712     <SPAN CLASS="font10bold">Description : </SPAN>
713     <!-- ========== Info from phpDoc block ========= -->
714     This gets the current value of the
715     cellpadding
716     <BR>
717    
718     <DL>
719     <DT class="font10bold">Function Parameters:</DT>
720    
721    
722     <DT class="font10bold">Function Info:</DT>
723    
724     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current cellpadding</DD>
725    
726     </DL>
727    
728     </DIV>
729     <BR>
730    
731     <DIV CLASS="function">
732     <A NAME='get_cellspacing'><!-- --></A>
733     <SPAN CLASS="font12bold">get_cellspacing</SPAN>
734     <BR>
735     <SPAN CLASS="font10bold">Useage : </SPAN>
736     <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;
737     <span class="font10bold" style="color: #0000FF">get_cellspacing ( )</SPAN>
738     <BR>
739    
740     <BR>
741     <SPAN CLASS="font10bold">Description : </SPAN>
742     <!-- ========== Info from phpDoc block ========= -->
743     This gets the current value of the
744     cellspacing
745     <BR>
746    
747     <DL>
748     <DT class="font10bold">Function Parameters:</DT>
749    
750    
751     <DT class="font10bold">Function Info:</DT>
752    
753     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the current cellspacing</DD>
754    
755     </DL>
756    
757     </DIV>
758     <BR>
759    
760     <DIV CLASS="function">
761     <A NAME='get_title_text_align'><!-- --></A>
762     <SPAN CLASS="font12bold">get_title_text_align</SPAN>
763     <BR>
764     <SPAN CLASS="font10bold">Useage : </SPAN>
765     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
766     <span class="font10bold" style="color: #0000FF">get_title_text_align ( )</SPAN>
767     <BR>
768    
769     <BR>
770     <SPAN CLASS="font10bold">Description : </SPAN>
771     <!-- ========== Info from phpDoc block ========= -->
772     this function lets gets the
773     default css class for the title
774     <BR>
775    
776     <DL>
777     <DT class="font10bold">Function Parameters:</DT>
778    
779    
780     <DT class="font10bold">Function Info:</DT>
781    
782     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the css class to use</DD>
783    
784     </DL>
785    
786     </DIV>
787     <BR>
788    
789     <DIV CLASS="function">
790     <A NAME='get_vertical_cellborder'><!-- --></A>
791     <SPAN CLASS="font12bold">get_vertical_cellborder</SPAN>
792     <BR>
793     <SPAN CLASS="font10bold">Useage : </SPAN>
794     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
795     <span class="font10bold" style="color: #0000FF">get_vertical_cellborder ( )</SPAN>
796     <BR>
797    
798     <BR>
799     <SPAN CLASS="font10bold">Description : </SPAN>
800     <!-- ========== Info from phpDoc block ========= -->
801     this function lets gets the
802     default css class for the title
803     <BR>
804    
805     <DL>
806     <DT class="font10bold">Function Parameters:</DT>
807    
808    
809     <DT class="font10bold">Function Info:</DT>
810    
811     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the css class to use</DD>
812    
813     </DL>
814    
815     </DIV>
816     <BR>
817    
818     <DIV CLASS="function">
819     <A NAME='render'><!-- --></A>
820     <SPAN CLASS="font12bold">render</SPAN>
821     <BR>
822     <SPAN CLASS="font10bold">Useage : </SPAN>
823     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
824     <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN>
825     <BR>
826    
827     <BR>
828     <SPAN CLASS="font10bold">Description : </SPAN>
829     <!-- ========== Info from phpDoc block ========= -->
830     This function renders the object.
831     <BR>
832    
833     <DL>
834     <DT class="font10bold">Function Parameters:</DT>
835    
836     <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
837     the container.</DD>
838    
839     <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
840     maintain compatibility w/ the API.</DD>
841    
842    
843     <DT class="font10bold">Function Info:</DT>
844    
845     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD>
846    
847     </DL>
848    
849     </DIV>
850     <BR>
851    
852     <DIV CLASS="function">
853     <A NAME='set_cellpadding'><!-- --></A>
854     <SPAN CLASS="font12bold">set_cellpadding</SPAN>
855     <BR>
856     <SPAN CLASS="font10bold">Useage : </SPAN>
857     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
858     <span class="font10bold" style="color: #0000FF">set_cellpadding ( [$pad = 0] )</SPAN>
859     <BR>
860    
861     <BR>
862     <SPAN CLASS="font10bold">Description : </SPAN>
863     <!-- ========== Info from phpDoc block ========= -->
864     This sets the cellpadding attribute
865     for this object.
866     <BR>
867    
868     <DL>
869     <DT class="font10bold">Function Parameters:</DT>
870    
871     <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>
872    
873    
874     <DT class="font10bold">Function Info:</DT>
875    
876     </DL>
877    
878     </DIV>
879     <BR>
880    
881     <DIV CLASS="function">
882     <A NAME='set_cellspacing'><!-- --></A>
883     <SPAN CLASS="font12bold">set_cellspacing</SPAN>
884     <BR>
885     <SPAN CLASS="font10bold">Useage : </SPAN>
886     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
887     <span class="font10bold" style="color: #0000FF">set_cellspacing ( [$spacing = 0] )</SPAN>
888     <BR>
889    
890     <BR>
891     <SPAN CLASS="font10bold">Description : </SPAN>
892     <!-- ========== Info from phpDoc block ========= -->
893     This sets the cellspacing attribute
894     for this object.
895     <BR>
896    
897     <DL>
898     <DT class="font10bold">Function Parameters:</DT>
899    
900     <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>
901    
902    
903     <DT class="font10bold">Function Info:</DT>
904    
905     </DL>
906    
907     </DIV>
908     <BR>
909    
910     <DIV CLASS="function">
911     <A NAME='set_title_text_align'><!-- --></A>
912     <SPAN CLASS="font12bold">set_title_text_align</SPAN>
913     <BR>
914     <SPAN CLASS="font10bold">Useage : </SPAN>
915     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
916     <span class="font10bold" style="color: #0000FF">set_title_text_align ( [$align = "left"] )</SPAN>
917     <BR>
918    
919     <BR>
920     <SPAN CLASS="font10bold">Description : </SPAN>
921     <!-- ========== Info from phpDoc block ========= -->
922     this function lets you change the
923     text alignment of the text in the title
924     <BR>
925    
926     <DL>
927     <DT class="font10bold">Function Parameters:</DT>
928    
929     <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>
930    
931    
932     <DT class="font10bold">Function Info:</DT>
933    
934     </DL>
935    
936     </DIV>
937     <BR>
938    
939     <DIV CLASS="function">
940     <A NAME='set_vertical_cellborder'><!-- --></A>
941     <SPAN CLASS="font12bold">set_vertical_cellborder</SPAN>
942     <BR>
943     <SPAN CLASS="font10bold">Useage : </SPAN>
944     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
945     <span class="font10bold" style="color: #0000FF">set_vertical_cellborder ( [$flag = TRUE] )</SPAN>
946     <BR>
947    
948     <BR>
949     <SPAN CLASS="font10bold">Description : </SPAN>
950     <!-- ========== Info from phpDoc block ========= -->
951     this function sets the flag to tell
952     <BR>
953     the object to render (or not) the
954     vertical cell borders
955     <DL>
956     <DT class="font10bold">Function Parameters:</DT>
957    
958     <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>
959    
960    
961     <DT class="font10bold">Function Info:</DT>
962    
963     </DL>
964    
965     </DIV>
966     <BR>
967    
968     <DIV CLASS="function">
969     <A NAME='_build_header'><!-- --></A>
970     <SPAN CLASS="font12bold">_build_header</SPAN>
971     <BR>
972     <SPAN CLASS="font10bold">Useage : </SPAN>
973     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TRtag.html">TRtag</a></SPAN>&nbsp;
974     <span class="font10bold" style="color: #0000FF">_build_header ( )</SPAN>
975     <BR>
976    
977     <BR>
978     <SPAN CLASS="font10bold">Description : </SPAN>
979     <!-- ========== Info from phpDoc block ========= -->
980     This function builds the table header
981     <BR>
982    
983     <DL>
984     <DT class="font10bold">Function Parameters:</DT>
985    
986    
987     <DT class="font10bold">Function Info:</DT>
988    
989     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
990    
991     </DL>
992    
993     </DIV>
994     <BR>
995    
996     <DIV CLASS="function">
997     <A NAME='_build_td'><!-- --></A>
998     <SPAN CLASS="font12bold">_build_td</SPAN>
999     <BR>
1000     <SPAN CLASS="font10bold">Useage : </SPAN>
1001     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
1002     <span class="font10bold" style="color: #0000FF">_build_td ( $width, $align, $col_num, $total_cols )</SPAN>
1003     <BR>
1004    
1005     <BR>
1006     <SPAN CLASS="font10bold">Description : </SPAN>
1007     <!-- ========== Info from phpDoc block ========= -->
1008     this function builds a TD tag with the border styles
1009     set appropriatly
1010     <BR>
1011    
1012     <DL>
1013     <DT class="font10bold">Function Parameters:</DT>
1014    
1015     <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>
1016    
1017     <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>
1018    
1019     <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>
1020    
1021     <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>
1022    
1023    
1024     <DT class="font10bold">Function Info:</DT>
1025    
1026     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD>
1027    
1028     </DL>
1029    
1030     </DIV>
1031     <BR>
1032    
1033     <DIV CLASS="function">
1034     <A NAME='_build_title'><!-- --></A>
1035     <SPAN CLASS="font12bold">_build_title</SPAN>
1036     <BR>
1037     <SPAN CLASS="font10bold">Useage : </SPAN>
1038     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a></SPAN>&nbsp;
1039     <span class="font10bold" style="color: #0000FF">_build_title ( )</SPAN>
1040     <BR>
1041    
1042     <BR>
1043     <SPAN CLASS="font10bold">Description : </SPAN>
1044     <!-- ========== Info from phpDoc block ========= -->
1045     This function builds the title
1046     container
1047     <BR>
1048    
1049     <DL>
1050     <DT class="font10bold">Function Parameters:</DT>
1051    
1052    
1053     <DT class="font10bold">Function Info:</DT>
1054    
1055     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
1056    
1057     </DL>
1058    
1059     </DIV>
1060     <BR>
1061    
1062    
1063     <hr>
1064     </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed