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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 20:56:34 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.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:07 -0800' -->
6     <TITLE>Docs For Class SimpleGUIDataList</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 SimpleGUIDataList">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 SimpleGUIDataList
30     </H2> (line <span class="linenumber">15</span>)
31     <pre>
32     <a href="../phpHtmlLib/Container.html">Container</a>
33     |
34     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
35     |
36     --<a href="../phpHtmlLib/DataList.html">DataList</a>
37     |
38     --SimpleGUIDataList</pre>
39     <p>
40     <b><i>Located in File: Program_Root/widgets/data_list/SimpleGUIDataList.inc</i></b><br>
41     </p>
42     <hr>
43     This object is the base class that can be
44     <br />
45     <p>used to build a widget that shows lists of data from any source via the DataListSource object. It fetches/builds/gets its data from the DataListSource object, which can be written to support any data source (MySQL, Oracle, comma delimited file, xml, etc.)</p><p>This base class MUST be extended by a child to actually render the list. The job of the DataList class is to provide the basic API and abstraction mechanism to handling searching, showing, sorting lists of data.</p><p>Each column of data is associated with a title and a name. The title is what is shown to the user for that column. The name is the mapping between the column and the DataListSource. Each column can be marked as sortable and searchable. If a column is sortable, the title is a link that can be clicked on to sort. The sorting is done in the DataListSource object ( via the sql query, or sort() functions depending on the data source itself)</p><p>The DataList object will build the title, the search block (if any), the datalist controls (the links/imges for first, prev, next, last, all). Then the data columns/labels. Then it will fetch each of the rows of data to display from the DataListSource.</p><p>The logic of the output calls follows in the order:</p><p>title search table/block datalist controls (first, prev, next, last, all) data columns/labels data rows x through y</p><p>REQUIREMENTS: You must use/define a DataListSource object. You MUST override/extend the following methods:</p><p>* get_data_source() - used to set the DataListSource by this class. * user_setup() - used to set the columns to show and any options used by the DataList class and DataListSource object.</p><p>UI ABSTRACTION METHODS These methods allow for some level of abstraction for the layout/look/feel of the actual list of data.</p><p>* gui_init() - the function gives the child class a chance to do any building of the objects that will hold the search area, column headers and the rows of data.</p><p>* child_build_column_header() - This method is responsible for building and inserting the column header title into the UI object.</p><p>* child_add_row_cell() - This function is responsible for adding the cell in the current row. The method is responsible for keeping track of the location in its UI object for the current row.</p><p>* child_get_gui() - This method returns the entire UI in 1 object or container. At this point the entire UI has been constructed, the entire list of data has been walked and inserted.</p>
46     <UL>
47     <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
48     </UL>
49     <hr>
50     <!-- =========== VAR SUMMARY =========== -->
51     <A NAME='var_summary'><!-- --></A>
52     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
53     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
54     <TD>
55     <span CLASS="font12bold">Class Variable Summary</span>
56     <A HREF="#top" CLASS="links">^TOP</A>
57     </TD>
58     </TR>
59    
60     </TABLE>
61     <hr>
62     <!-- =========== VAR INHERITED SUMMARY =========== -->
63     <A NAME='var_inherited_summary'><!-- --></A>
64     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
65     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
66     <TD>
67     <span CLASS="font12bold">Inherited Class Variable Summary</span>
68     <A HREF="#top" CLASS="links">^TOP</A>
69     </TD>
70     </TR>
71    
72     <!-- =========== Summary =========== -->
73     <TR BGCOLOR='white'>
74     <TD>
75     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
76     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
77     <tr CLASS="tableheadingcolor">
78     <th>Variable</th>
79     <th>Default Value</th>
80     <th>Description</th>
81     </tr>
82     <tr>
83     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></td>
84     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
85     <td CLASS="font10">Do we want to alternate the row colors? This helps to see each row easier.</td>
86     </tr>
87     <tr>
88     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></td>
89     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
90     <td CLASS="font10">Flag to let us know that</td>
91     </tr>
92     <tr>
93     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></td>
94     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
95     <td CLASS="font10">The column descriptions for the data we are working on</td>
96     </tr>
97     <tr>
98     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></td>
99     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
100     <td CLASS="font10">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</td>
101     </tr>
102     <tr>
103     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></td>
104     <td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td>
105     <td CLASS="font10">Holds the db column name that we want to order by default.</td>
106     </tr>
107     <tr>
108     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></td>
109     <td CLASS="font10" STYLE="white-space: nowrap">-> "false"<-</td>
110     <td CLASS="font10">Holds a flag to let us know to</td>
111     </tr>
112     <tr>
113     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></td>
114     <td CLASS="font10" STYLE="white-space: nowrap">-> 10<-</td>
115     <td CLASS="font10">The number of rows of data to show per "page".</td>
116     </tr>
117     <tr>
118     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></td>
119     <td CLASS="font10" STYLE="white-space: nowrap">->array("method" =&gt; "GET",
120     "target" =&gt; "",
121     "action" =&gt; "",
122     "name" =&gt; "")<-</td>
123     <td CLASS="font10">This holds the form attributes</td>
124     </tr>
125     <tr>
126     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></td>
127     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
128     <td CLASS="font10">Build everything inside a form?</td>
129     </tr>
130     <tr>
131     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></td>
132     <td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td>
133     <td CLASS="font10">prefix for all list variable names, so we can potentially have more then 1 list per page.</td>
134     </tr>
135     <tr>
136     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></td>
137     <td CLASS="font10" STYLE="white-space: nowrap">-> "/phphtmllib/images/widgets"<-</td>
138     <td CLASS="font10">This stores the base path to where the tool link images live. This lets you specify a new path to where your images live.</td>
139     </tr>
140     <tr>
141     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></td>
142     <td CLASS="font10" STYLE="white-space: nowrap">-> 200<-</td>
143     <td CLASS="font10">The max number of rows to show when the user does the "EXPAND" command.</td>
144     </tr>
145     <tr>
146     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></td>
147     <td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td>
148     <td CLASS="font10">Keeps track of the # of columns we have</td>
149     </tr>
150     <tr>
151     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></td>
152     <td CLASS="font10" STYLE="white-space: nowrap">->1<-</td>
153     <td CLASS="font10">This value holds the number of pages of data we have to display.</td>
154     </tr>
155     <tr>
156     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></td>
157     <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
158     <td CLASS="font10">This holds a list of name=&gt;value vars that the caller/child wants to propogate automatically.</td>
159     </tr>
160     <tr>
161     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></td>
162     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
163     <td CLASS="font10">Flag to let us know that search is enabled.</td>
164     </tr>
165     <tr>
166     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></td>
167     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
168     <td CLASS="font10">Holds the object block that is the</td>
169     </tr>
170     <tr>
171     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></td>
172     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
173     <td CLASS="font10">flag to let us know if we want to show the results or not.</td>
174     </tr>
175     <tr>
176     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></td>
177     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
178     <td CLASS="font10">Flag to enable simple search modifyer.</td>
179     </tr>
180     <tr>
181     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></td>
182     <td CLASS="font10" STYLE="white-space: nowrap">->array("offsetVar" =&gt; "offset",
183     "orderbyVar" =&gt; "orderby",
184     "reverseorderVar" =&gt; "reverseorder",
185     "numrowsVar" =&gt; "numrows",
186     "showallVar" =&gt; "showall",
187     "search_fieldVar" =&gt; "search_field",
188     "search_valueVar" =&gt; "search_value",
189     "search_typeVar" =&gt; "search_type",
190     "simple_search_modifierVar" =&gt; "simple_search_modifier")<-</td>
191     <td CLASS="font10">Holds an array of all the form vars we need for this class to work.</td>
192     </tr>
193     </table>
194     <BR>
195     </TD>
196     </TR>
197     <!-- =========== Summary =========== -->
198     <TR BGCOLOR='white'>
199     <TD>
200     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
201     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
202     <tr CLASS="tableheadingcolor">
203     <th>Variable</th>
204     <th>Default Value</th>
205     <th>Description</th>
206     </tr>
207     <tr>
208     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td>
209     <td CLASS="font10" STYLE="white-space: nowrap">->''<-</td>
210     <td CLASS="font10">The title of the table.</td>
211     </tr>
212     <tr>
213     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td>
214     <td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td>
215     <td CLASS="font10">the width of the widget</td>
216     </tr>
217     </table>
218     <BR>
219     </TD>
220     </TR>
221     <!-- =========== Summary =========== -->
222     <TR BGCOLOR='white'>
223     <TD>
224     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
225     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
226     <tr CLASS="tableheadingcolor">
227     <th>Variable</th>
228     <th>Default Value</th>
229     <th>Description</th>
230     </tr>
231     <tr>
232     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
233     <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
234     <td CLASS="font10">The flags that tell us</td>
235     </tr>
236     </table>
237     <BR>
238     </TD>
239     </TR>
240     </TABLE>
241    
242     <hr>
243     <!-- =========== METHOD SUMMARY =========== -->
244     <A NAME='method_summary'><!-- --></A>
245     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
246     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
247     <TD>
248     <span class="font12bold">Method Summary</span>
249     <A HREF="#top" CLASS="links">^TOP</A>
250     </TD>
251     </TR>
252    
253     <!-- =========== Summary =========== -->
254     <TR BGCOLOR='white' CLASS='TableRowColor'>
255     <TD>
256     <CODE><B><A HREF='../phpHtmlLib/SimpleGUIDataList.html#methodbuild_column_header'>mixed build_column_header ( $col_name, $col_data, $col_num )</A></B></CODE>
257     <BR>
258     <blockquote> This function builds the object/text </blockquote>
259     </TD>
260     </TR>
261     <!-- =========== Summary =========== -->
262     <TR BGCOLOR='white' CLASS='TableRowColor'>
263     <TD>
264     <CODE><B><A HREF='../phpHtmlLib/SimpleGUIDataList.html#methodchild_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag, $row_data )</A></B></CODE>
265     <BR>
266     <blockquote> </blockquote>
267     </TD>
268     </TR>
269     <!-- =========== Summary =========== -->
270     <TR BGCOLOR='white' CLASS='TableRowColor'>
271     <TD>
272     <CODE><B><A HREF='../phpHtmlLib/SimpleGUIDataList.html#methodchild_build_column_header'>void child_build_column_header ( $name, $col, $cnt )</A></B></CODE>
273     <BR>
274     <blockquote> </blockquote>
275     </TD>
276     </TR>
277     <!-- =========== Summary =========== -->
278     <TR BGCOLOR='white' CLASS='TableRowColor'>
279     <TD>
280     <CODE><B><A HREF='../phpHtmlLib/SimpleGUIDataList.html#methodchild_get_gui'>void child_get_gui ( )</A></B></CODE>
281     <BR>
282     <blockquote> </blockquote>
283     </TD>
284     </TR>
285     <!-- =========== Summary =========== -->
286     <TR BGCOLOR='white' CLASS='TableRowColor'>
287     <TD>
288     <CODE><B><A HREF='../phpHtmlLib/SimpleGUIDataList.html#methodgui_init'>void gui_init ( )</A></B></CODE>
289     <BR>
290     <blockquote> Initialize the gui layout </blockquote>
291     </TD>
292     </TR>
293     <!-- =========== Summary =========== -->
294     <TR BGCOLOR='white' CLASS='TableRowColor'>
295     <TD>
296     <CODE><B><A HREF='../phpHtmlLib/SimpleGUIDataList.html#methodwrap_column_item'><a href="../phpHtmlLib/TDtag.html">TDtag</a> wrap_column_item ( $obj, $col_name )</A></B></CODE>
297     <BR>
298     <blockquote> This function ensures that the data we place in a column is aligned according to what the user wants. </blockquote>
299     </TD>
300     </TR>
301     </TABLE>
302     <!-- =========== INHERITED METHOD SUMMARY =========== -->
303     <A NAME='functions_inherited'><!-- --></A>
304     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
305     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
306     <TD>
307     <span CLASS="font12bold">Inherited Method Summary</span>
308     <A HREF="#top" CLASS="links">^TOP</A>
309     </TD>
310     </TR>
311    
312     <!-- =========== Summary =========== -->
313     <TR BGCOLOR='white' CLASS='TableRowColor'>
314     <TD>
315     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
316     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
317     <tr CLASS="tableheadingcolor">
318     <th>Function</th>
319     <th>Description</th>
320     </tr>
321     <tr>
322     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></td>
323     <td CLASS="font10">The constructor</td>
324     <tr>
325     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></td>
326     <td CLASS="font10">This function adds a header item to the column headers from a list of parameters.</td>
327     <tr>
328     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></td>
329     <td CLASS="font10">Disable the advanced search</td>
330     <tr>
331     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></td>
332     <td CLASS="font10">Enable the advanced search</td>
333     <tr>
334     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></td>
335     <td CLASS="font10">This builds the base url used by the column headers as well as the page tool links.</td>
336     <tr>
337     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></td>
338     <td CLASS="font10">This is the basic function for letting us do a mapping between the column name in the header, to the value found in the DB.</td>
339     <tr>
340     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></td>
341     <td CLASS="font10">This builds a url for a particular column header.</td>
342     <tr>
343     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></td>
344     <td CLASS="font10">This function is responsible for calling the child class's methods for building the GUI container.</td>
345     <tr>
346     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></td>
347     <td CLASS="font10">This builds a query string var for the orderby value.</td>
348     <tr>
349     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></td>
350     <td CLASS="font10">This builds a query string var for the reverseorder value.</td>
351     <tr>
352     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></td>
353     <td CLASS="font10">This builds a query string var for the searchfield value.</td>
354     <tr>
355     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></td>
356     <td CLASS="font10">This builds a query string var for the searchfield value.</td>
357     <tr>
358     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></td>
359     <td CLASS="font10">this function is used to build a sub query string</td>
360     <tr>
361     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></td>
362     <td CLASS="font10">This function builds the 'tool' images that allow you to walk through the data list itself.</td>
363     <tr>
364     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></td>
365     <td CLASS="font10">This method is supposed to be written by the child class to add the cell data to the current row in the UI</td>
366     <tr>
367     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></td>
368     <td CLASS="font10">This method is supposed to be written by the child class to build and add the column title to the UI</td>
369     <tr>
370     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></td>
371     <td CLASS="font10">This function builds the search block that lives above the results</td>
372     <tr>
373     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></td>
374     <td CLASS="font10">This function is called after all of the data has been added to the UI object. It just returns the container that is the entire UI for the DataList</td>
375     <tr>
376     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></td>
377     <td CLASS="font10">This function is used to set up any</td>
378     <tr>
379     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></td>
380     <td CLASS="font10">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</td>
381     <tr>
382     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></td>
383     <td CLASS="font10">This function returns the current page that the item list is on.</td>
384     <tr>
385     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></td>
386     <td CLASS="font10">This function is called automatically by the DataList constructor. It must be extended by the child class to actually set the DataListSource object.</td>
387     <tr>
388     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></td>
389     <td CLASS="font10">This function gets the current default number of rows to display setting.</td>
390     <tr>
391     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></td>
392     <td CLASS="font10">This function is used to get the form action</td>
393     <tr>
394     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></td>
395     <td CLASS="font10">This function is used to get the form method</td>
396     <tr>
397     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></td>
398     <td CLASS="font10">This function is used to get the form name</td>
399     <tr>
400     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></td>
401     <td CLASS="font10">Return the state of the form render</td>
402     <tr>
403     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></td>
404     <td CLASS="font10">This function is used to get the form target</td>
405     <tr>
406     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></td>
407     <td CLASS="font10">returns the current variable prefix string being used.</td>
408     <tr>
409     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></td>
410     <td CLASS="font10">This function returns the path to the images used in this class</td>
411     <tr>
412     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></td>
413     <td CLASS="font10">This calculates the last page # for this list of items</td>
414     <tr>
415     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></td>
416     <td CLASS="font10">This returns the Maximum # of rows to display when in expand mode</td>
417     <tr>
418     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></td>
419     <td CLASS="font10">This function returns the # of pages that are available for this list of items.</td>
420     <tr>
421     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></td>
422     <td CLASS="font10">This function builds the string that describes the current page out of n pages the list is showing</td>
423     <tr>
424     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></td>
425     <td CLASS="font10">gets the value of the search modifier flag.</td>
426     <tr>
427     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></td>
428     <td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td>
429     <tr>
430     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></td>
431     <td CLASS="font10">This returns the status of the advanced search flag.</td>
432     <tr>
433     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></td>
434     <td CLASS="font10">get the status of the search ability.</td>
435     <tr>
436     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></td>
437     <td CLASS="font10">This function returns the number of rows that the query found.</td>
438     <tr>
439     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></td>
440     <td CLASS="font10">This function returns the current value of the offset variable. This is an offset into the query return data set.</td>
441     <tr>
442     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></td>
443     <td CLASS="font10">This function returns the value of the current orderby variable.</td>
444     <tr>
445     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></td>
446     <td CLASS="font10">This function renders the final</td>
447     <tr>
448     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></td>
449     <td CLASS="font10">This function returns the current value of the reverse order member variable.</td>
450     <tr>
451     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></td>
452     <td CLASS="font10">Disable the search ability.</td>
453     <tr>
454     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></td>
455     <td CLASS="font10">Enable the search ability.</td>
456     <tr>
457     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></td>
458     <td CLASS="font10">returns the current value of the search field name</td>
459     <tr>
460     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></td>
461     <td CLASS="font10">returns the type of search being used</td>
462     <tr>
463     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></td>
464     <td CLASS="font10">returns the current value of te search field value.</td>
465     <tr>
466     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></td>
467     <td CLASS="font10">This function is used to make safe any query string value that is used</td>
468     <tr>
469     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></td>
470     <td CLASS="font10"></td>
471     <tr>
472     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></td>
473     <td CLASS="font10">This function is used to set the DataListSource object for this instance</td>
474     <tr>
475     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></td>
476     <td CLASS="font10">This function sets the default # of rows per page to display. By default its 10.</td>
477     <tr>
478     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></td>
479     <td CLASS="font10">Sets the form action</td>
480     <tr>
481     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></td>
482     <td CLASS="font10">This function is used to set the form method</td>
483     <tr>
484     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></td>
485     <td CLASS="font10">This function is used to set the form name</td>
486     <tr>
487     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></td>
488     <td CLASS="font10">Sets whether to the output into a form</td>
489     <tr>
490     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></td>
491     <td CLASS="font10">This function is used to set the form target</td>
492     <tr>
493     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></td>
494     <td CLASS="font10">This function sets a prefix for all variables that are used in the item list table on a page. This allows you to have multiple itemlists on a single html page.</td>
495     <tr>
496     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></td>
497     <td CLASS="font10">This function returns the path to the images used in this class</td>
498     <tr>
499     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></td>
500     <td CLASS="font10">This sets the maximum # of rows to display when in expand mode</td>
501     <tr>
502     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></td>
503     <td CLASS="font10">This function is used to set the message displayed when no data is found</td>
504     <tr>
505     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></td>
506     <td CLASS="font10">This function sets the # of rows to display per page.</td>
507     <tr>
508     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></td>
509     <td CLASS="font10">This function is used to set/change the offset for this list.</td>
510     <tr>
511     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></td>
512     <td CLASS="font10">This function sets the reverse order flag to a new value.</td>
513     <tr>
514     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></td>
515     <td CLASS="font10">This function sets the save variables that the user/child wants to automatically propogate</td>
516     <tr>
517     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></td>
518     <td CLASS="font10">This function sets the search type</td>
519     <tr>
520     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></td>
521     <td CLASS="font10">This function is used to set the value of the _show_results_flag</td>
522     <tr>
523     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></td>
524     <td CLASS="font10">Set the simple search modifyer flag.</td>
525     <tr>
526     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodshowall">DataList::showall()</a></td>
527     <td CLASS="font10">returns the current value of the showall flag. This tells us if they want the entire list of data back from the DB.</td>
528     <tr>
529     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></td>
530     <td CLASS="font10">returns the current value of the simple search modifier</td>
531     <tr>
532     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></td>
533     <td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td>
534     <tr>
535     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></td>
536     <td CLASS="font10">This function builds the list of</td>
537     <tr>
538     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></td>
539     <td CLASS="font10">this method builds some hidden form fields to automatically be placed inside the form.</td>
540     <tr>
541     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></td>
542     <td CLASS="font10">This builds the simple search modifier select box.</td>
543     <tr>
544     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></td>
545     <td CLASS="font10">This function is used to build the url for a tool link.</td>
546     <tr>
547     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></td>
548     <td CLASS="font10">general DataListSource object checker.</td>
549     <tr>
550     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></td>
551     <td CLASS="font10">This function is used to make sure that the string we are placing in a cell has been "cleaned"</td>
552     <tr>
553     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></td>
554     <td CLASS="font10">This does some magic filtering on the data that we display in a column. This helps to prevent nast data that may have html tags in it.</td>
555     <tr>
556     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></td>
557     <td CLASS="font10">Function used to get the current value of one of the control vars for this class</td>
558     <tr>
559     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></td>
560     <td CLASS="font10">This method gets the array of searchable header fields (columns)</td>
561     <tr>
562     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></td>
563     <td CLASS="font10">This function provides a way to automatically add javascript to this object.</td>
564     <tr>
565     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></td>
566     <td CLASS="font10">This function stores the url for each of the tool urls, so we can push these out for mozilla.</td>
567     <tr>
568     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></td>
569     <td CLASS="font10">This function is used to set the value of the control var</td>
570     <tr>
571     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></td>
572     <td CLASS="font10">This function is used to let render() know that we should show the results or not.</td>
573     </table>
574     <br>
575     </TD>
576     </TR>
577     <!-- =========== Summary =========== -->
578     <TR BGCOLOR='white' CLASS='TableRowColor'>
579     <TD>
580     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
581     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
582     <tr CLASS="tableheadingcolor">
583     <th>Function</th>
584     <th>Description</th>
585     </tr>
586     <tr>
587     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td>
588     <td CLASS="font10">This gets the alignment value for the outer table</td>
589     <tr>
590     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td>
591     <td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td>
592     <tr>
593     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td>
594     <td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td>
595     <tr>
596     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td>
597     <td CLASS="font10">Function for accessing the title of this widget</td>
598     <tr>
599     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td>
600     <td CLASS="font10">Function for getting the current widget width setting.</td>
601     <tr>
602     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td>
603     <td CLASS="font10">This function sets the align attribute for the outer table.</td>
604     <tr>
605     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td>
606     <td CLASS="font10">Set the title for the widget.</td>
607     <tr>
608     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td>
609     <td CLASS="font10">Set the width for the widget.</td>
610     </table>
611     <br>
612     </TD>
613     </TR>
614     <!-- =========== Summary =========== -->
615     <TR BGCOLOR='white' CLASS='TableRowColor'>
616     <TD>
617     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
618     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
619     <tr CLASS="tableheadingcolor">
620     <th>Function</th>
621     <th>Description</th>
622     </tr>
623     <tr>
624     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
625     <td CLASS="font10">The constructor.</td>
626     <tr>
627     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
628     <td CLASS="font10">add content onto content stack</td>
629     <tr>
630     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
631     <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
632     <tr>
633     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
634     <td CLASS="font10">counts the number of content objects</td>
635     <tr>
636     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
637     <td CLASS="font10">This flag gets the current value of the indent flag</td>
638     <tr>
639     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
640     <td CLASS="font10">Same as add().</td>
641     <tr>
642     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
643     <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
644     <tr>
645     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
646     <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
647     <tr>
648     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
649     <td CLASS="font10">destroy existing content and start with new content.</td>
650     <tr>
651     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
652     <td CLASS="font10">This function turns on the collapse flag</td>
653     <tr>
654     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
655     <td CLASS="font10">function to set the indent flag</td>
656     <tr>
657     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
658     <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>
659     </table>
660     <br>
661     </TD>
662     </TR>
663     </TABLE>
664     <hr>
665     <!-- ============ VARIABLE DETAIL =========== -->
666    
667     <A NAME='variable_detail'></A>
668     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
669     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
670     <TD>
671     <span CLASS="font12bold">Variable Detail</span>
672     <A HREF="#top" CLASS="links">^TOP</A>
673     </TD>
674     </TR>
675     </TABLE>
676    
677     <hr>
678     <!-- ============ METHOD DETAIL =========== -->
679    
680     <A NAME='method_detail'></A>
681     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
682     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
683     <TD>
684     <span class="font12bold">Method Detail</span>
685     <A HREF="#top" CLASS="links">^TOP</A>
686     </TD>
687     </TR>
688     </TABLE>
689     <BR>
690     <DIV CLASS="function">
691     <A NAME='methodbuild_column_header'><!-- --></A>
692     <SPAN CLASS="font12bold">build_column_header</SPAN> (line <span class="linenumber">74</span>)
693     <BR>
694     <SPAN CLASS="font10bold">Usage : </SPAN>
695     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
696     <span class="font10bold" style="color: #0000FF">build_column_header(
697     string
698     $col_name, array
699     $col_data, int
700     $col_num)</SPAN>
701     <BR>
702    
703     <BR>
704     <SPAN CLASS="font10bold">Description : </SPAN>
705     This function builds the object/text
706     <br />
707     <p>to be used for a column header. It can either be an href because its sortable, or it can just be text, because its not sortable.</p>
708     <DL>
709     <DT class="font10bold">Function Parameters:</DT>
710     <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">$col_name</SPAN></SPAN> - the column name to build from the headers.</DD>
711     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$col_data</SPAN></SPAN> - the column's data.</DD>
712     <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 column # we are working on.</DD>
713    
714     <DT class="font10bold">Function Info:</DT>
715     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - either an Atag object or raw text.</DD>
716     </DL>
717     </DIV>
718     <BR>
719     <DIV CLASS="function">
720     <A NAME='methodchild_add_row_cell'><!-- --></A>
721     <SPAN CLASS="font12bold">child_add_row_cell</SPAN> (line <span class="linenumber">48</span>)
722     <BR>
723     <SPAN CLASS="font10bold">Usage : </SPAN>
724     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
725     <span class="font10bold" style="color: #0000FF">child_add_row_cell(
726     mixed
727     $obj, mixed
728     $col_name, mixed
729     $last_in_row_flag, mixed
730     $row_data)</SPAN>
731     <BR>
732    
733     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a> This method is supposed to be written by the child class to add the cell data to the current row in the UI
734     <BR>
735     <SPAN CLASS="font10bold">Description : </SPAN>
736    
737     <br />
738    
739     <DL>
740    
741     <DT class="font10bold">Function Info:</DT>
742     </DL>
743     </DIV>
744     <BR>
745     <DIV CLASS="function">
746     <A NAME='methodchild_build_column_header'><!-- --></A>
747     <SPAN CLASS="font12bold">child_build_column_header</SPAN> (line <span class="linenumber">42</span>)
748     <BR>
749     <SPAN CLASS="font10bold">Usage : </SPAN>
750     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
751     <span class="font10bold" style="color: #0000FF">child_build_column_header(
752     mixed
753     $name, mixed
754     $col, mixed
755     $cnt)</SPAN>
756     <BR>
757    
758     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a> This method is supposed to be written by the child class to build and add the column title to the UI
759     <BR>
760     <SPAN CLASS="font10bold">Description : </SPAN>
761    
762     <br />
763    
764     <DL>
765    
766     <DT class="font10bold">Function Info:</DT>
767     </DL>
768     </DIV>
769     <BR>
770     <DIV CLASS="function">
771     <A NAME='methodchild_get_gui'><!-- --></A>
772     <SPAN CLASS="font12bold">child_get_gui</SPAN> (line <span class="linenumber">38</span>)
773     <BR>
774     <SPAN CLASS="font10bold">Usage : </SPAN>
775     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
776     <span class="font10bold" style="color: #0000FF">child_get_gui(
777     )</SPAN>
778     <BR>
779    
780     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a> This function is called after all of the data has been added to the UI object. It just returns the container that is the entire UI for the DataList
781     <BR>
782     <SPAN CLASS="font10bold">Description : </SPAN>
783    
784     <br />
785    
786     <DL>
787    
788     <DT class="font10bold">Function Info:</DT>
789     </DL>
790     </DIV>
791     <BR>
792     <DIV CLASS="function">
793     <A NAME='methodgui_init'><!-- --></A>
794     <SPAN CLASS="font12bold">gui_init</SPAN> (line <span class="linenumber">21</span>)
795     <BR>
796     <SPAN CLASS="font10bold">Usage : </SPAN>
797     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
798     <span class="font10bold" style="color: #0000FF">gui_init(
799     )</SPAN>
800     <BR>
801    
802     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a> A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.
803     <BR>
804     <SPAN CLASS="font10bold">Description : </SPAN>
805     Initialize the gui layout
806     <br />
807    
808     <DL>
809    
810     <DT class="font10bold">Function Info:</DT>
811     </DL>
812     </DIV>
813     <BR>
814     <DIV CLASS="function">
815     <A NAME='methodwrap_column_item'><!-- --></A>
816     <SPAN CLASS="font12bold">wrap_column_item</SPAN> (line <span class="linenumber">99</span>)
817     <BR>
818     <SPAN CLASS="font10bold">Usage : </SPAN>
819     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
820     <span class="font10bold" style="color: #0000FF">wrap_column_item(
821     mixed
822     $obj, string
823     $col_name, int
824     2, int
825     3)</SPAN>
826     <BR>
827    
828     <BR>
829     <SPAN CLASS="font10bold">Description : </SPAN>
830     This function ensures that the data we place in a column is aligned according to what the user wants.
831     <br />
832    
833     <DL>
834     <DT class="font10bold">Function Parameters:</DT>
835     <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">2</SPAN></SPAN> - $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)</DD>
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">3</SPAN></SPAN> - the column # we are working on.</DD>
837     <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">$obj</SPAN></SPAN> - $obj - the data for the td.</DD>
838     <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">$col_name</SPAN></SPAN> - $col_name - the name of the column header for this row to render.</DD>
839    
840     <DT class="font10bold">Function Info:</DT>
841     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
842     </DL>
843     </DIV>
844     <BR>
845     <div id="credit">
846     <hr>
847     Documention generated on Thu, 20 Feb 2003 16:23:07 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
848     </div>
849     </body>
850     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed