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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Feb 22 20:56:17 2003 UTC (21 years, 10 months ago) by jonen
Branch: MAIN
Changes since 1.1: +1444 -976 lines
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.2 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 jonen 1.1 <!--NewPage-->
3     <HTML>
4     <HEAD>
5 jonen 1.2 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:37 -0800' -->
6 jonen 1.1 <TITLE>Docs For Class DefaultGUIDatalist</TITLE>
7 jonen 1.2 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 jonen 1.1 </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 DefaultGUIDatalist">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 jonen 1.2 <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 jonen 1.1 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 jonen 1.2 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 jonen 1.1 </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class DefaultGUIDatalist
30 jonen 1.2 </H2> (line <span class="linenumber">28</span>)
31 jonen 1.1 <pre>
32 jonen 1.2 <a href="../phpHtmlLib/Container.html">Container</a>
33 jonen 1.1 |
34     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
35     |
36     --<a href="../phpHtmlLib/DataList.html">DataList</a>
37     |
38     --DefaultGUIDatalist</pre>
39     <p>
40     <b><i>Located in File: Program_Root/widgets/data_list/DefaultGUIDataList.inc</i></b><br>
41     </p>
42     <hr>
43 jonen 1.2 This class is the Default phpHtmlLib GUI interface child of the DataList class. This child simply does the job of rendering the html/layout for a DataList.
44     <br />
45     <p>You can use this as an example of how to build your own look/feel for your DataList.</p>
46 jonen 1.1 <UL>
47 jonen 1.2 <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 jonen 1.1 <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 jonen 1.2 <!-- =========== Summary =========== -->
61     <TR BGCOLOR='white' CLASS='TableRowColor'>
62     <TD>
63     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_action_column">$_action_column</A></B></CODE>
64     <BR>
65     <blockquote> This holds the action column settings if any. </blockquote>
66     <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
67     </TD>
68     </TR>
69     <!-- =========== Summary =========== -->
70     <TR BGCOLOR='white' CLASS='TableRowColor'>
71     <TD>
72     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_action_count">$_action_count</A></B></CODE>
73     <BR>
74     <blockquote> holds the cntr for the action </blockquote>
75     <blockquote> Default Value: <CODE>->&nbsp;0<-</CODE> </blockquote>
76     </TD>
77     </TR>
78     <!-- =========== Summary =========== -->
79     <TR BGCOLOR='white' CLASS='TableRowColor'>
80     <TD>
81     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_align">$_align</A></B></CODE>
82     <BR>
83     <blockquote> The overall alignment </blockquote>
84     <blockquote> Default Value: <CODE>->&nbsp;"center"<-</CODE> </blockquote>
85     </TD>
86     </TR>
87     <!-- =========== Summary =========== -->
88     <TR BGCOLOR='white' CLASS='TableRowColor'>
89     <TD>
90     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_allow_select_all">$_allow_select_all</A></B></CODE>
91     <BR>
92     <blockquote> This variable tells us whether to display select all checkbox </blockquote>
93     <blockquote> Default Value: <CODE>->&nbsp;TRUE<-</CODE> </blockquote>
94     </TD>
95     </TR>
96     <!-- =========== Summary =========== -->
97     <TR BGCOLOR='white' CLASS='TableRowColor'>
98     <TD>
99     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_default_checked_items">$_default_checked_items</A></B></CODE>
100     <BR>
101     <blockquote> This variable holds the array of default </blockquote>
102     <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
103     </TD>
104     </TR>
105     <!-- =========== Summary =========== -->
106     <TR BGCOLOR='white' CLASS='TableRowColor'>
107     <TD>
108     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_hidden_checkbox_items">$_hidden_checkbox_items</A></B></CODE>
109     <BR>
110     <blockquote> This array holds the list of hidden checkbox[] items. </blockquote>
111     <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
112     </TD>
113     </TR>
114     <!-- =========== Summary =========== -->
115     <TR BGCOLOR='white' CLASS='TableRowColor'>
116     <TD>
117     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_show_actionbar">$_show_actionbar</A></B></CODE>
118     <BR>
119     <blockquote> Do we show action bar row? </blockquote>
120     <blockquote> Default Value: <CODE>->&nbsp;TRUE<-</CODE> </blockquote>
121     </TD>
122     </TR>
123     <!-- =========== Summary =========== -->
124     <TR BGCOLOR='white' CLASS='TableRowColor'>
125     <TD>
126     <CODE><B><A HREF="../phpHtmlLib/DefaultGUIDatalist.html#var$_visible_checkbox_items">$_visible_checkbox_items</A></B></CODE>
127     <BR>
128     <blockquote> this array keeps track of the list of rendered visible checkbox[] items. So we can not render the hidden version of it. </blockquote>
129     <blockquote> Default Value: <CODE>->array()<-</CODE> </blockquote>
130     </TD>
131     </TR>
132     </TABLE>
133 jonen 1.1 <hr>
134     <!-- =========== VAR INHERITED SUMMARY =========== -->
135     <A NAME='var_inherited_summary'><!-- --></A>
136     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
137 jonen 1.2 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
138 jonen 1.1 <TD>
139     <span CLASS="font12bold">Inherited Class Variable Summary</span>
140     <A HREF="#top" CLASS="links">^TOP</A>
141     </TD>
142     </TR>
143    
144 jonen 1.2 <!-- =========== Summary =========== -->
145 jonen 1.1 <TR BGCOLOR='white'>
146     <TD>
147     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
148     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
149     <tr CLASS="tableheadingcolor">
150     <th>Variable</th>
151     <th>Default Value</th>
152     <th>Description</th>
153     </tr>
154 jonen 1.2 <tr>
155     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></td>
156     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
157     <td CLASS="font10">Do we want to alternate the row colors? This helps to see each row easier.</td>
158     </tr>
159     <tr>
160     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></td>
161     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
162     <td CLASS="font10">Flag to let us know that</td>
163     </tr>
164     <tr>
165     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></td>
166 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
167 jonen 1.2 <td CLASS="font10">The column descriptions for the data we are working on</td>
168 jonen 1.1 </tr>
169 jonen 1.2 <tr>
170     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></td>
171     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
172     <td CLASS="font10">Holds our reference/copy of the DataListSource object which is used to access the data that this object uses</td>
173     </tr>
174     <tr>
175     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></td>
176     <td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td>
177     <td CLASS="font10">Holds the db column name that we want to order by default.</td>
178     </tr>
179     <tr>
180     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></td>
181     <td CLASS="font10" STYLE="white-space: nowrap">-> "false"<-</td>
182 jonen 1.1 <td CLASS="font10">Holds a flag to let us know to</td>
183     </tr>
184 jonen 1.2 <tr>
185     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></td>
186     <td CLASS="font10" STYLE="white-space: nowrap">-> 10<-</td>
187     <td CLASS="font10">The number of rows of data to show per "page".</td>
188     </tr>
189     <tr>
190     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></td>
191     <td CLASS="font10" STYLE="white-space: nowrap">->array("method" =&gt; "GET",
192     "target" =&gt; "",
193     "action" =&gt; "",
194     "name" =&gt; "")<-</td>
195 jonen 1.1 <td CLASS="font10">This holds the form attributes</td>
196     </tr>
197 jonen 1.2 <tr>
198     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></td>
199     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
200 jonen 1.1 <td CLASS="font10">Build everything inside a form?</td>
201     </tr>
202 jonen 1.2 <tr>
203     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></td>
204     <td CLASS="font10" STYLE="white-space: nowrap">-> ''<-</td>
205     <td CLASS="font10">prefix for all list variable names, so we can potentially have more then 1 list per page.</td>
206     </tr>
207     <tr>
208     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></td>
209     <td CLASS="font10" STYLE="white-space: nowrap">-> "/phphtmllib/images/widgets"<-</td>
210     <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>
211     </tr>
212     <tr>
213     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></td>
214     <td CLASS="font10" STYLE="white-space: nowrap">-> 200<-</td>
215     <td CLASS="font10">The max number of rows to show when the user does the "EXPAND" command.</td>
216     </tr>
217     <tr>
218     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></td>
219     <td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td>
220 jonen 1.1 <td CLASS="font10">Keeps track of the # of columns we have</td>
221     </tr>
222 jonen 1.2 <tr>
223     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></td>
224 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->1<-</td>
225 jonen 1.2 <td CLASS="font10">This value holds the number of pages of data we have to display.</td>
226     </tr>
227     <tr>
228     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></td>
229 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
230 jonen 1.2 <td CLASS="font10">This holds a list of name=&gt;value vars that the caller/child wants to propogate automatically.</td>
231 jonen 1.1 </tr>
232 jonen 1.2 <tr>
233     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></td>
234     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
235     <td CLASS="font10">Flag to let us know that search is enabled.</td>
236     </tr>
237     <tr>
238     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></td>
239     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
240 jonen 1.1 <td CLASS="font10">Holds the object block that is the</td>
241     </tr>
242 jonen 1.2 <tr>
243     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></td>
244     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
245     <td CLASS="font10">flag to let us know if we want to show the results or not.</td>
246     </tr>
247     <tr>
248     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></td>
249     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
250 jonen 1.1 <td CLASS="font10">Flag to enable simple search modifyer.</td>
251     </tr>
252 jonen 1.2 <tr>
253     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></td>
254     <td CLASS="font10" STYLE="white-space: nowrap">->array("offsetVar" =&gt; "offset",
255     "orderbyVar" =&gt; "orderby",
256     "reverseorderVar" =&gt; "reverseorder",
257     "numrowsVar" =&gt; "numrows",
258     "showallVar" =&gt; "showall",
259     "search_fieldVar" =&gt; "search_field",
260     "search_valueVar" =&gt; "search_value",
261     "search_typeVar" =&gt; "search_type",
262     "simple_search_modifierVar" =&gt; "simple_search_modifier")<-</td>
263     <td CLASS="font10">Holds an array of all the form vars we need for this class to work.</td>
264 jonen 1.1 </tr>
265 jonen 1.2 </table>
266 jonen 1.1 <BR>
267     </TD>
268     </TR>
269 jonen 1.2 <!-- =========== Summary =========== -->
270 jonen 1.1 <TR BGCOLOR='white'>
271     <TD>
272     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
273     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
274     <tr CLASS="tableheadingcolor">
275     <th>Variable</th>
276     <th>Default Value</th>
277     <th>Description</th>
278     </tr>
279 jonen 1.2 <tr>
280     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td>
281     <td CLASS="font10" STYLE="white-space: nowrap">->''<-</td>
282 jonen 1.1 <td CLASS="font10">The title of the table.</td>
283     </tr>
284 jonen 1.2 <tr>
285     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td>
286     <td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td>
287 jonen 1.1 <td CLASS="font10">the width of the widget</td>
288     </tr>
289 jonen 1.2 </table>
290 jonen 1.1 <BR>
291     </TD>
292     </TR>
293 jonen 1.2 <!-- =========== Summary =========== -->
294 jonen 1.1 <TR BGCOLOR='white'>
295     <TD>
296     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
297     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
298     <tr CLASS="tableheadingcolor">
299     <th>Variable</th>
300     <th>Default Value</th>
301     <th>Description</th>
302     </tr>
303 jonen 1.2 <tr>
304     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
305     <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
306     <td CLASS="font10">The flags that tell us</td>
307 jonen 1.1 </tr>
308 jonen 1.2 </table>
309 jonen 1.1 <BR>
310     </TD>
311     </TR>
312 jonen 1.2 </TABLE>
313 jonen 1.1
314     <hr>
315 jonen 1.2 <!-- =========== METHOD SUMMARY =========== -->
316     <A NAME='method_summary'><!-- --></A>
317     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
318     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
319 jonen 1.1 <TD>
320 jonen 1.2 <span class="font12bold">Method Summary</span>
321 jonen 1.1 <A HREF="#top" CLASS="links">^TOP</A>
322     </TD>
323     </TR>
324    
325 jonen 1.2 <!-- =========== Summary =========== -->
326 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
327     <TD>
328 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodactionbar_cell'><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a> actionbar_cell ( )</A></B></CODE>
329     <BR>
330     <blockquote> this is the method that builds the contents for the middle actionbar td cell. </blockquote>
331 jonen 1.1 </TD>
332     </TR>
333 jonen 1.2 <!-- =========== Summary =========== -->
334 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
335     <TD>
336 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodaction_button'><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a> action_button ( $name, $action )</A></B></CODE>
337     <BR>
338     <blockquote> This function builds an action button that will modify the form action, to post to a different script to handle the data </blockquote>
339 jonen 1.1 </TD>
340     </TR>
341 jonen 1.2 <!-- =========== Summary =========== -->
342 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
343     <TD>
344 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodadd_action_column'>void add_action_column ( $type, $col, $db_field, [$title = NULL] )</A></B></CODE>
345     <BR>
346     <blockquote> This function adds an action column. This adds a column of either checkboxes or radio buttons. </blockquote>
347 jonen 1.1 </TD>
348     </TR>
349 jonen 1.2 <!-- =========== Summary =========== -->
350     <TR BGCOLOR='white' CLASS='TableRowColor'>
351 jonen 1.1 <TD>
352 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodallow_select_all'>void allow_select_all ( $flag )</A></B></CODE>
353     <BR>
354     <blockquote> Sets the flag for rendering the select all checkbox </blockquote>
355 jonen 1.1 </TD>
356     </TR>
357 jonen 1.2 <!-- =========== Summary =========== -->
358 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
359     <TD>
360 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodbuild_column_header'>mixed build_column_header ( $col_name, $col_data, $col_num )</A></B></CODE>
361 jonen 1.1 <BR>
362 jonen 1.2 <blockquote> This function builds the object/text </blockquote>
363 jonen 1.1 </TD>
364     </TR>
365 jonen 1.2 <!-- =========== Summary =========== -->
366 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
367     <TD>
368 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodchild_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag, $row_data )</A></B></CODE>
369 jonen 1.1 <BR>
370     <blockquote> </blockquote>
371     </TD>
372     </TR>
373 jonen 1.2 <!-- =========== Summary =========== -->
374 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
375     <TD>
376 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_column_header'>void child_build_column_header ( $name, $col, $cnt )</A></B></CODE>
377 jonen 1.1 <BR>
378     <blockquote> </blockquote>
379     </TD>
380     </TR>
381 jonen 1.2 <!-- =========== Summary =========== -->
382 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
383     <TD>
384 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodchild_build_search_table'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> child_build_search_table ( )</A></B></CODE>
385 jonen 1.1 <BR>
386 jonen 1.2 <blockquote> This builds the table that holds the search capability. </blockquote>
387 jonen 1.1 </TD>
388     </TR>
389 jonen 1.2 <!-- =========== Summary =========== -->
390 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
391     <TD>
392 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodchild_get_gui'>void child_get_gui ( )</A></B></CODE>
393 jonen 1.1 <BR>
394     <blockquote> </blockquote>
395     </TD>
396     </TR>
397 jonen 1.2 <!-- =========== Summary =========== -->
398     <TR BGCOLOR='white' CLASS='TableRowColor'>
399     <TD>
400     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodget_default_checked_items'>array get_default_checked_items ( )</A></B></CODE>
401     <BR>
402     <blockquote> This function returns the array of default checked items to be marked as checked in the checkbox action column </blockquote>
403     </TD>
404     </TR>
405     <!-- =========== Summary =========== -->
406 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
407     <TD>
408 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodgui_init'>void gui_init ( )</A></B></CODE>
409 jonen 1.1 <BR>
410     <blockquote> </blockquote>
411     </TD>
412     </TR>
413 jonen 1.2 <!-- =========== Summary =========== -->
414     <TR BGCOLOR='white' CLASS='TableRowColor'>
415     <TD>
416     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodis_action_checked'>boolean is_action_checked ( $value, $row_data )</A></B></CODE>
417     <BR>
418     <blockquote> This function is provided to give the child class the ability to precheck/select a particular column. </blockquote>
419     </TD>
420     </TR>
421     <!-- =========== Summary =========== -->
422     <TR BGCOLOR='white' CLASS='TableRowColor'>
423     <TD>
424     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodis_action_enabled'>boolean is_action_enabled ( $value, $row_data )</A></B></CODE>
425     <BR>
426     <blockquote> This function is provided to give the child class the ability to enable/disable a particular checkbox. </blockquote>
427     </TD>
428     </TR>
429     <!-- =========== Summary =========== -->
430     <TR BGCOLOR='white' CLASS='TableRowColor'>
431     <TD>
432     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodsave_checked_items'>void save_checked_items ( )</A></B></CODE>
433     <BR>
434     <blockquote> set the flag to tell the object to </blockquote>
435     </TD>
436     </TR>
437     <!-- =========== Summary =========== -->
438     <TR BGCOLOR='white' CLASS='TableRowColor'>
439     <TD>
440     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodset_actionbar'>void set_actionbar ( [$flag = TRUE] )</A></B></CODE>
441     <BR>
442     <blockquote> This allows the caller to turn on/off the rendering of the bottom action bar row </blockquote>
443     </TD>
444     </TR>
445     <!-- =========== Summary =========== -->
446     <TR BGCOLOR='white' CLASS='TableRowColor'>
447     <TD>
448     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodset_align'>void set_align ( $align )</A></B></CODE>
449     <BR>
450     <blockquote> this function is used to set the overall alignment of the widget </blockquote>
451     </TD>
452     </TR>
453     <!-- =========== Summary =========== -->
454     <TR BGCOLOR='white' CLASS='TableRowColor'>
455     <TD>
456     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodset_default_checked_items'>void set_default_checked_items ( $items )</A></B></CODE>
457     <BR>
458     <blockquote> This function is used to set the default list </blockquote>
459     </TD>
460     </TR>
461     <!-- =========== Summary =========== -->
462     <TR BGCOLOR='white' CLASS='TableRowColor'>
463     <TD>
464     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodset_global_prefix'>void set_global_prefix ( $prefix )</A></B></CODE>
465     <BR>
466     <blockquote> 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. </blockquote>
467     </TD>
468     </TR>
469     <!-- =========== Summary =========== -->
470     <TR BGCOLOR='white' CLASS='TableRowColor'>
471     <TD>
472     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodshow_actionbar'>boolean show_actionbar ( )</A></B></CODE>
473     <BR>
474     <blockquote> This function gets the current value of the show actionbar flag setting. </blockquote>
475     </TD>
476     </TR>
477     <!-- =========== Summary =========== -->
478     <TR BGCOLOR='white' CLASS='TableRowColor'>
479     <TD>
480     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#methodwrap_column_item'><a href="../phpHtmlLib/TDtag.html">TDtag</a> wrap_column_item ( $obj, $col_name )</A></B></CODE>
481     <BR>
482     <blockquote> This function ensures that the data we place in a column is aligned according to what the user wants. </blockquote>
483     </TD>
484     </TR>
485     <!-- =========== Summary =========== -->
486     <TR BGCOLOR='white' CLASS='TableRowColor'>
487     <TD>
488     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_build_actionbar'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> _build_actionbar ( )</A></B></CODE>
489     <BR>
490     <blockquote> This function renders the action bar at the bottom of the data list. </blockquote>
491     </TD>
492     </TR>
493     <!-- =========== Summary =========== -->
494     <TR BGCOLOR='white' CLASS='TableRowColor'>
495     <TD>
496     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_build_actionbar_arrow_cell'><a href="../phpHtmlLib/TDtag.html">TDtag</a> _build_actionbar_arrow_cell ( $col )</A></B></CODE>
497     <BR>
498     <blockquote> This function builds a TD with the appropriate action arrow. </blockquote>
499     </TD>
500     </TR>
501     <!-- =========== Summary =========== -->
502     <TR BGCOLOR='white' CLASS='TableRowColor'>
503     <TD>
504     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_build_actionbar_data_cell'>TDtag; _build_actionbar_data_cell ( )</A></B></CODE>
505     <BR>
506     <blockquote> This function builds the user's data cell </blockquote>
507     </TD>
508     </TR>
509     <!-- =========== Summary =========== -->
510 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
511     <TD>
512 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_build_action_column'>HTMLTag _build_action_column ( $col, [$header_flag = FALSE], [$row_data = NULL] )</A></B></CODE>
513 jonen 1.1 <BR>
514 jonen 1.2 <blockquote> This builds an action column cell </blockquote>
515 jonen 1.1 </TD>
516     </TR>
517 jonen 1.2 <!-- =========== Summary =========== -->
518 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
519     <TD>
520 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_build_search_title'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> _build_search_title ( )</A></B></CODE>
521 jonen 1.1 <BR>
522     <blockquote> This function builds the search title table </blockquote>
523     </TD>
524     </TR>
525 jonen 1.2 <!-- =========== Summary =========== -->
526 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
527     <TD>
528 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_build_simple_search_form'><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a> _build_simple_search_form ( )</A></B></CODE>
529 jonen 1.1 <BR>
530     <blockquote> This function builds the simple search TD </blockquote>
531     </TD>
532     </TR>
533 jonen 1.2 <!-- =========== Summary =========== -->
534     <TR BGCOLOR='white' CLASS='TableRowColor'>
535     <TD>
536     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_checkbox_javascript'><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a> _checkbox_javascript ( )</A></B></CODE>
537     <BR>
538     <blockquote> This function builds the JS needed for the checkbox action column </blockquote>
539     </TD>
540     </TR>
541     <!-- =========== Summary =========== -->
542     <TR BGCOLOR='white' CLASS='TableRowColor'>
543     <TD>
544     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_has_action_column'>boolean _has_action_column ( $col )</A></B></CODE>
545     <BR>
546     <blockquote> This function tests to see if the child wants to render an action column </blockquote>
547     </TD>
548     </TR>
549     <!-- =========== Summary =========== -->
550     <TR BGCOLOR='white' CLASS='TableRowColor'>
551     <TD>
552     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_is_col_checked'>boolean. _is_col_checked ( $value, $row_data )</A></B></CODE>
553     <BR>
554     <blockquote> This method checks to see if a particular row has been checked in the action column </blockquote>
555     </TD>
556     </TR>
557     <!-- =========== Summary =========== -->
558     <TR BGCOLOR='white' CLASS='TableRowColor'>
559     <TD>
560     <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_javascript'>mixed _javascript ( )</A></B></CODE>
561     <BR>
562     <blockquote> This function returns any Javascript required for this widget </blockquote>
563     </TD>
564     </TR>
565     <!-- =========== Summary =========== -->
566     <TR BGCOLOR='white' CLASS='TableRowColor'>
567 jonen 1.1 <TD>
568 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/DefaultGUIDatalist.html#method_save_checked_items_enabled'>boolean _save_checked_items_enabled ( )</A></B></CODE>
569     <BR>
570     <blockquote> This tests the object flag to </blockquote>
571 jonen 1.1 </TD>
572     </TR>
573 jonen 1.2 </TABLE>
574     <!-- =========== INHERITED METHOD SUMMARY =========== -->
575     <A NAME='functions_inherited'><!-- --></A>
576 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
577     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
578     <TD>
579 jonen 1.2 <span CLASS="font12bold">Inherited Method Summary</span>
580 jonen 1.1 <A HREF="#top" CLASS="links">^TOP</A>
581     </TD>
582     </TR>
583    
584 jonen 1.2 <!-- =========== Summary =========== -->
585     <TR BGCOLOR='white' CLASS='TableRowColor'>
586     <TD>
587     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
588     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
589     <tr CLASS="tableheadingcolor">
590     <th>Function</th>
591     <th>Description</th>
592     </tr>
593     <tr>
594     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></td>
595     <td CLASS="font10">The constructor</td>
596     <tr>
597     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></td>
598     <td CLASS="font10">This function adds a header item to the column headers from a list of parameters.</td>
599     <tr>
600     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></td>
601     <td CLASS="font10">Disable the advanced search</td>
602     <tr>
603     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></td>
604     <td CLASS="font10">Enable the advanced search</td>
605     <tr>
606     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></td>
607     <td CLASS="font10">This builds the base url used by the column headers as well as the page tool links.</td>
608     <tr>
609     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></td>
610     <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>
611     <tr>
612     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></td>
613     <td CLASS="font10">This builds a url for a particular column header.</td>
614     <tr>
615     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></td>
616     <td CLASS="font10">This function is responsible for calling the child class's methods for building the GUI container.</td>
617     <tr>
618     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></td>
619     <td CLASS="font10">This builds a query string var for the orderby value.</td>
620     <tr>
621     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></td>
622     <td CLASS="font10">This builds a query string var for the reverseorder value.</td>
623     <tr>
624     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></td>
625     <td CLASS="font10">This builds a query string var for the searchfield value.</td>
626     <tr>
627     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></td>
628     <td CLASS="font10">This builds a query string var for the searchfield value.</td>
629     <tr>
630     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></td>
631     <td CLASS="font10">this function is used to build a sub query string</td>
632     <tr>
633     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></td>
634     <td CLASS="font10">This function builds the 'tool' images that allow you to walk through the data list itself.</td>
635     <tr>
636     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></td>
637     <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>
638     <tr>
639     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></td>
640     <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>
641     <tr>
642     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></td>
643     <td CLASS="font10">This function builds the search block that lives above the results</td>
644     <tr>
645     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></td>
646     <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>
647     <tr>
648     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></td>
649     <td CLASS="font10">This function is used to set up any</td>
650     <tr>
651     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></td>
652     <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>
653     <tr>
654     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></td>
655     <td CLASS="font10">This function returns the current page that the item list is on.</td>
656     <tr>
657     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></td>
658     <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>
659     <tr>
660     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></td>
661     <td CLASS="font10">This function gets the current default number of rows to display setting.</td>
662     <tr>
663     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></td>
664     <td CLASS="font10">This function is used to get the form action</td>
665     <tr>
666     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></td>
667     <td CLASS="font10">This function is used to get the form method</td>
668     <tr>
669     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></td>
670     <td CLASS="font10">This function is used to get the form name</td>
671     <tr>
672     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></td>
673     <td CLASS="font10">Return the state of the form render</td>
674     <tr>
675     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></td>
676     <td CLASS="font10">This function is used to get the form target</td>
677     <tr>
678     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></td>
679     <td CLASS="font10">returns the current variable prefix string being used.</td>
680     <tr>
681     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></td>
682     <td CLASS="font10">This function returns the path to the images used in this class</td>
683     <tr>
684     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></td>
685     <td CLASS="font10">This calculates the last page # for this list of items</td>
686     <tr>
687     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></td>
688     <td CLASS="font10">This returns the Maximum # of rows to display when in expand mode</td>
689     <tr>
690     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></td>
691     <td CLASS="font10">This function returns the # of pages that are available for this list of items.</td>
692     <tr>
693     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></td>
694     <td CLASS="font10">This function builds the string that describes the current page out of n pages the list is showing</td>
695     <tr>
696     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></td>
697     <td CLASS="font10">gets the value of the search modifier flag.</td>
698     <tr>
699     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></td>
700     <td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td>
701     <tr>
702     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></td>
703     <td CLASS="font10">This returns the status of the advanced search flag.</td>
704     <tr>
705     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></td>
706     <td CLASS="font10">get the status of the search ability.</td>
707     <tr>
708     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></td>
709     <td CLASS="font10">This function returns the number of rows that the query found.</td>
710     <tr>
711     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></td>
712     <td CLASS="font10">This function returns the current value of the offset variable. This is an offset into the query return data set.</td>
713     <tr>
714     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></td>
715     <td CLASS="font10">This function returns the value of the current orderby variable.</td>
716     <tr>
717     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></td>
718     <td CLASS="font10">This function renders the final</td>
719     <tr>
720     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></td>
721     <td CLASS="font10">This function returns the current value of the reverse order member variable.</td>
722     <tr>
723     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></td>
724     <td CLASS="font10">Disable the search ability.</td>
725     <tr>
726     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></td>
727     <td CLASS="font10">Enable the search ability.</td>
728     <tr>
729     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></td>
730     <td CLASS="font10">returns the current value of the search field name</td>
731     <tr>
732     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></td>
733     <td CLASS="font10">returns the type of search being used</td>
734     <tr>
735     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></td>
736     <td CLASS="font10">returns the current value of te search field value.</td>
737     <tr>
738     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></td>
739     <td CLASS="font10">This function is used to make safe any query string value that is used</td>
740     <tr>
741     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></td>
742     <td CLASS="font10"></td>
743     <tr>
744     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></td>
745     <td CLASS="font10">This function is used to set the DataListSource object for this instance</td>
746     <tr>
747     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></td>
748     <td CLASS="font10">This function sets the default # of rows per page to display. By default its 10.</td>
749     <tr>
750     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></td>
751     <td CLASS="font10">Sets the form action</td>
752     <tr>
753     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></td>
754     <td CLASS="font10">This function is used to set the form method</td>
755     <tr>
756     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></td>
757     <td CLASS="font10">This function is used to set the form name</td>
758     <tr>
759     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></td>
760     <td CLASS="font10">Sets whether to the output into a form</td>
761     <tr>
762     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></td>
763     <td CLASS="font10">This function is used to set the form target</td>
764     <tr>
765     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></td>
766     <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>
767     <tr>
768     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></td>
769     <td CLASS="font10">This function returns the path to the images used in this class</td>
770     <tr>
771     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></td>
772     <td CLASS="font10">This sets the maximum # of rows to display when in expand mode</td>
773     <tr>
774     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></td>
775     <td CLASS="font10">This function is used to set the message displayed when no data is found</td>
776     <tr>
777     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></td>
778     <td CLASS="font10">This function sets the # of rows to display per page.</td>
779     <tr>
780     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></td>
781     <td CLASS="font10">This function is used to set/change the offset for this list.</td>
782     <tr>
783     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></td>
784     <td CLASS="font10">This function sets the reverse order flag to a new value.</td>
785     <tr>
786     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></td>
787     <td CLASS="font10">This function sets the save variables that the user/child wants to automatically propogate</td>
788     <tr>
789     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></td>
790     <td CLASS="font10">This function sets the search type</td>
791     <tr>
792     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></td>
793     <td CLASS="font10">This function is used to set the value of the _show_results_flag</td>
794     <tr>
795     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></td>
796     <td CLASS="font10">Set the simple search modifyer flag.</td>
797     <tr>
798     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodshowall">DataList::showall()</a></td>
799     <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>
800     <tr>
801     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></td>
802     <td CLASS="font10">returns the current value of the simple search modifier</td>
803     <tr>
804     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></td>
805     <td CLASS="font10">A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</td>
806     <tr>
807     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></td>
808     <td CLASS="font10">This function builds the list of</td>
809     <tr>
810     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></td>
811     <td CLASS="font10">this method builds some hidden form fields to automatically be placed inside the form.</td>
812     <tr>
813     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></td>
814     <td CLASS="font10">This builds the simple search modifier select box.</td>
815     <tr>
816     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></td>
817     <td CLASS="font10">This function is used to build the url for a tool link.</td>
818     <tr>
819     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></td>
820     <td CLASS="font10">general DataListSource object checker.</td>
821     <tr>
822     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></td>
823     <td CLASS="font10">This function is used to make sure that the string we are placing in a cell has been "cleaned"</td>
824     <tr>
825     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></td>
826     <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>
827     <tr>
828     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></td>
829     <td CLASS="font10">Function used to get the current value of one of the control vars for this class</td>
830     <tr>
831     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></td>
832     <td CLASS="font10">This method gets the array of searchable header fields (columns)</td>
833     <tr>
834     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></td>
835     <td CLASS="font10">This function provides a way to automatically add javascript to this object.</td>
836     <tr>
837     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></td>
838     <td CLASS="font10">This function stores the url for each of the tool urls, so we can push these out for mozilla.</td>
839     <tr>
840     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></td>
841     <td CLASS="font10">This function is used to set the value of the control var</td>
842     <tr>
843     <td CLASS="font10bold"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></td>
844     <td CLASS="font10">This function is used to let render() know that we should show the results or not.</td>
845     </table>
846     <br>
847     </TD>
848     </TR>
849     <!-- =========== Summary =========== -->
850     <TR BGCOLOR='white' CLASS='TableRowColor'>
851     <TD>
852     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
853     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
854     <tr CLASS="tableheadingcolor">
855     <th>Function</th>
856     <th>Description</th>
857     </tr>
858     <tr>
859     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td>
860     <td CLASS="font10">This gets the alignment value for the outer table</td>
861     <tr>
862     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td>
863     <td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td>
864     <tr>
865     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td>
866     <td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td>
867     <tr>
868     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td>
869     <td CLASS="font10">Function for accessing the title of this widget</td>
870     <tr>
871     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td>
872     <td CLASS="font10">Function for getting the current widget width setting.</td>
873     <tr>
874     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td>
875     <td CLASS="font10">This function sets the align attribute for the outer table.</td>
876     <tr>
877     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td>
878     <td CLASS="font10">Set the title for the widget.</td>
879     <tr>
880     <td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td>
881     <td CLASS="font10">Set the width for the widget.</td>
882     </table>
883     <br>
884     </TD>
885     </TR>
886     <!-- =========== Summary =========== -->
887     <TR BGCOLOR='white' CLASS='TableRowColor'>
888     <TD>
889     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
890     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
891     <tr CLASS="tableheadingcolor">
892     <th>Function</th>
893     <th>Description</th>
894     </tr>
895     <tr>
896     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
897     <td CLASS="font10">The constructor.</td>
898     <tr>
899     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
900     <td CLASS="font10">add content onto content stack</td>
901     <tr>
902     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
903     <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
904     <tr>
905     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
906     <td CLASS="font10">counts the number of content objects</td>
907     <tr>
908     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
909     <td CLASS="font10">This flag gets the current value of the indent flag</td>
910     <tr>
911     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
912     <td CLASS="font10">Same as add().</td>
913     <tr>
914     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
915     <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
916     <tr>
917     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
918     <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
919     <tr>
920     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
921     <td CLASS="font10">destroy existing content and start with new content.</td>
922     <tr>
923     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
924     <td CLASS="font10">This function turns on the collapse flag</td>
925     <tr>
926     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
927     <td CLASS="font10">function to set the indent flag</td>
928     <tr>
929     <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
930     <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>
931     </table>
932     <br>
933     </TD>
934     </TR>
935     </TABLE>
936     <hr>
937     <!-- ============ VARIABLE DETAIL =========== -->
938    
939     <A NAME='variable_detail'></A>
940     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
941     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
942     <TD>
943     <span CLASS="font12bold">Variable Detail</span>
944     <A HREF="#top" CLASS="links">^TOP</A>
945     </TD>
946     </TR>
947     </TABLE>
948    
949     <A NAME='var$_action_column'><!-- --></A><H3>$_action_column</H3> (line <span class="linenumber">42</span>)<br />
950     <b>Data type:</b> mixed<br>This holds the action column settings if any.
951     <br />
952    
953     <UL>
954     </UL>
955     <HR>
956     <A NAME='var$_action_count'><!-- --></A><H3>$_action_count</H3> (line <span class="linenumber">48</span>)<br />
957     <b>Data type:</b> mixed<br>holds the cntr for the action
958     <br />
959     <p>checkbox name</p>
960     <UL>
961     </UL>
962     <HR>
963     <A NAME='var$_align'><!-- --></A><H3>$_align</H3> (line <span class="linenumber">36</span>)<br />
964     <b>Data type:</b> mixed<br>The overall alignment
965     <br />
966     <p>DEFAULT: "center"</p>
967     <UL>
968     </UL>
969     <HR>
970     <A NAME='var$_allow_select_all'><!-- --></A><H3>$_allow_select_all</H3> (line <span class="linenumber">85</span>)<br />
971     <b>Data type:</b> mixed<br>This variable tells us whether to display select all checkbox
972     <br />
973    
974     <UL>
975     </UL>
976     <HR>
977     <A NAME='var$_default_checked_items'><!-- --></A><H3>$_default_checked_items</H3> (line <span class="linenumber">74</span>)<br />
978     <b>Data type:</b> mixed<br>This variable holds the array of default
979     <br />
980     <p>selected items. This is populated inside the user_setup() function to pre-populate the list of selected items for a the checkbox action column.</p>
981     <UL>
982     </UL>
983     <HR>
984     <A NAME='var$_hidden_checkbox_items'><!-- --></A><H3>$_hidden_checkbox_items</H3> (line <span class="linenumber">55</span>)<br />
985     <b>Data type:</b> mixed<br>This array holds the list of hidden checkbox[] items.
986     <br />
987    
988     <UL>
989     </UL>
990     <HR>
991     <A NAME='var$_show_actionbar'><!-- --></A><H3>$_show_actionbar</H3> (line <span class="linenumber">80</span>)<br />
992     <b>Data type:</b> mixed<br>Do we show action bar row?
993     <br />
994    
995     <UL>
996     </UL>
997     <HR>
998     <A NAME='var$_visible_checkbox_items'><!-- --></A><H3>$_visible_checkbox_items</H3> (line <span class="linenumber">63</span>)<br />
999     <b>Data type:</b> mixed<br>this array keeps track of the list of rendered visible checkbox[] items. So we can not render the hidden version of it.
1000     <br />
1001    
1002     <UL>
1003     </UL>
1004     <HR>
1005     <hr>
1006     <!-- ============ METHOD DETAIL =========== -->
1007    
1008     <A NAME='method_detail'></A>
1009     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
1010     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
1011     <TD>
1012     <span class="font12bold">Method Detail</span>
1013     <A HREF="#top" CLASS="links">^TOP</A>
1014     </TD>
1015     </TR>
1016     </TABLE>
1017     <BR>
1018 jonen 1.1 <DIV CLASS="function">
1019 jonen 1.2 <A NAME='methodactionbar_cell'><!-- --></A>
1020     <SPAN CLASS="font12bold">actionbar_cell</SPAN> (line <span class="linenumber">827</span>)
1021 jonen 1.1 <BR>
1022 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1023     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN>&nbsp;
1024     <span class="font10bold" style="color: #0000FF">actionbar_cell(
1025     )</SPAN>
1026 jonen 1.1 <BR>
1027    
1028     <BR>
1029     <SPAN CLASS="font10bold">Description : </SPAN>
1030 jonen 1.2 this is the method that builds the contents for the middle actionbar td cell.
1031     <br />
1032     <p>NOTE this function is meant to be overriden by the child class.</p>
1033     <DL>
1034    
1035     <DT class="font10bold">Function Info:</DT>
1036     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1037     </DL>
1038     </DIV>
1039     <BR>
1040     <DIV CLASS="function">
1041     <A NAME='methodaction_button'><!-- --></A>
1042     <SPAN CLASS="font12bold">action_button</SPAN> (line <span class="linenumber">840</span>)
1043     <BR>
1044     <SPAN CLASS="font10bold">Usage : </SPAN>
1045     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></SPAN>&nbsp;
1046     <span class="font10bold" style="color: #0000FF">action_button(
1047     string
1048     $name, string
1049     $action)</SPAN>
1050     <BR>
1051    
1052 jonen 1.1 <BR>
1053 jonen 1.2 <SPAN CLASS="font10bold">Description : </SPAN>
1054     This function builds an action button that will modify the form action, to post to a different script to handle the data
1055     <br />
1056    
1057 jonen 1.1 <DL>
1058 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1059     <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">$name</SPAN></SPAN> - the button name</DD>
1060     <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">$action</SPAN></SPAN> - the script that gets called.</DD>
1061    
1062     <DT class="font10bold">Function Info:</DT>
1063     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1064     </DL>
1065     </DIV>
1066     <BR>
1067     <DIV CLASS="function">
1068     <A NAME='methodadd_action_column'><!-- --></A>
1069     <SPAN CLASS="font12bold">add_action_column</SPAN> (line <span class="linenumber">467</span>)
1070     <BR>
1071     <SPAN CLASS="font10bold">Usage : </SPAN>
1072     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1073     <span class="font10bold" style="color: #0000FF">add_action_column(
1074     string
1075     $type, string
1076     $col, string
1077     $db_field, [string
1078     $title = NULL])</SPAN>
1079     <BR>
1080 jonen 1.1
1081 jonen 1.2 <BR>
1082     <SPAN CLASS="font10bold">Description : </SPAN>
1083     This function adds an action column. This adds a column of either checkboxes or radio buttons.
1084     <br />
1085 jonen 1.1
1086 jonen 1.2 <DL>
1087     <DT class="font10bold">Function Parameters:</DT>
1088     <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">$type</SPAN></SPAN> - type of column 'checkbox' or 'radio'</DD>
1089     <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</SPAN></SPAN> - which column it lives in 'FIRST' or 'LAST'</DD>
1090     <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">$db_field</SPAN></SPAN> - which db field is associated with this.</DD>
1091     <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 to use for the column. NOTE: if this is set, then there will NOT be a global checkbox that can be used to select/deslect all at once.</DD>
1092    
1093     <DT class="font10bold">Function Info:</DT>
1094     </DL>
1095 jonen 1.1 </DIV>
1096     <BR>
1097     <DIV CLASS="function">
1098 jonen 1.2 <A NAME='methodallow_select_all'><!-- --></A>
1099     <SPAN CLASS="font12bold">allow_select_all</SPAN> (line <span class="linenumber">561</span>)
1100 jonen 1.1 <BR>
1101 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1102 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1103 jonen 1.2 <span class="font10bold" style="color: #0000FF">allow_select_all(
1104     bool
1105     $flag)</SPAN>
1106 jonen 1.1 <BR>
1107 jonen 1.2
1108 jonen 1.1 <BR>
1109     <SPAN CLASS="font10bold">Description : </SPAN>
1110 jonen 1.2 Sets the flag for rendering the select all checkbox
1111     <br />
1112 jonen 1.1
1113 jonen 1.2 <DL>
1114     <DT class="font10bold">Function Parameters:</DT>
1115     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">bool</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> flag</DD>
1116    
1117     <DT class="font10bold">Function Info:</DT>
1118     </DL>
1119     </DIV>
1120     <BR>
1121     <DIV CLASS="function">
1122     <A NAME='methodbuild_column_header'><!-- --></A>
1123     <SPAN CLASS="font12bold">build_column_header</SPAN> (line <span class="linenumber">255</span>)
1124     <BR>
1125     <SPAN CLASS="font10bold">Usage : </SPAN>
1126     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
1127     <span class="font10bold" style="color: #0000FF">build_column_header(
1128     string
1129     $col_name, array
1130     $col_data, int
1131     $col_num)</SPAN>
1132 jonen 1.1 <BR>
1133    
1134 jonen 1.2 <BR>
1135     <SPAN CLASS="font10bold">Description : </SPAN>
1136     This function builds the object/text
1137     <br />
1138     <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>
1139 jonen 1.1 <DL>
1140 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1141     <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>
1142     <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>
1143     <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>
1144    
1145     <DT class="font10bold">Function Info:</DT>
1146     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - either an Atag object or raw text.</DD>
1147     </DL>
1148     </DIV>
1149     <BR>
1150     <DIV CLASS="function">
1151     <A NAME='methodchild_add_row_cell'><!-- --></A>
1152     <SPAN CLASS="font12bold">child_add_row_cell</SPAN> (line <span class="linenumber">197</span>)
1153     <BR>
1154     <SPAN CLASS="font10bold">Usage : </SPAN>
1155     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1156     <span class="font10bold" style="color: #0000FF">child_add_row_cell(
1157     mixed
1158     $obj, mixed
1159     $col_name, mixed
1160     $last_in_row_flag, mixed
1161     $row_data)</SPAN>
1162     <BR>
1163 jonen 1.1
1164 jonen 1.2 <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
1165     <BR>
1166     <SPAN CLASS="font10bold">Description : </SPAN>
1167    
1168     <br />
1169    
1170     <DL>
1171 jonen 1.1
1172 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1173     </DL>
1174 jonen 1.1 </DIV>
1175     <BR>
1176     <DIV CLASS="function">
1177 jonen 1.2 <A NAME='methodchild_build_column_header'><!-- --></A>
1178     <SPAN CLASS="font12bold">child_build_column_header</SPAN> (line <span class="linenumber">164</span>)
1179 jonen 1.1 <BR>
1180 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1181 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1182 jonen 1.2 <span class="font10bold" style="color: #0000FF">child_build_column_header(
1183     mixed
1184     $name, mixed
1185     $col, mixed
1186     $cnt)</SPAN>
1187 jonen 1.1 <BR>
1188 jonen 1.2
1189     <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
1190 jonen 1.1 <BR>
1191     <SPAN CLASS="font10bold">Description : </SPAN>
1192    
1193 jonen 1.2 <br />
1194    
1195     <DL>
1196    
1197     <DT class="font10bold">Function Info:</DT>
1198     </DL>
1199     </DIV>
1200     <BR>
1201     <DIV CLASS="function">
1202     <A NAME='methodchild_build_search_table'><!-- --></A>
1203     <SPAN CLASS="font12bold">child_build_search_table</SPAN> (line <span class="linenumber">355</span>)
1204     <BR>
1205     <SPAN CLASS="font10bold">Usage : </SPAN>
1206     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN>&nbsp;
1207     <span class="font10bold" style="color: #0000FF">child_build_search_table(
1208     )</SPAN>
1209 jonen 1.1 <BR>
1210    
1211 jonen 1.2 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a> This function builds the search block that lives above the results
1212     <BR>
1213     <SPAN CLASS="font10bold">Description : </SPAN>
1214     This builds the table that holds the search capability.
1215     <br />
1216    
1217 jonen 1.1 <DL>
1218    
1219 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1220     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object.</DD>
1221     </DL>
1222     </DIV>
1223     <BR>
1224     <DIV CLASS="function">
1225     <A NAME='methodchild_get_gui'><!-- --></A>
1226     <SPAN CLASS="font12bold">child_get_gui</SPAN> (line <span class="linenumber">235</span>)
1227     <BR>
1228     <SPAN CLASS="font10bold">Usage : </SPAN>
1229     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1230     <span class="font10bold" style="color: #0000FF">child_get_gui(
1231     )</SPAN>
1232     <BR>
1233    
1234     <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
1235     <BR>
1236     <SPAN CLASS="font10bold">Description : </SPAN>
1237    
1238     <br />
1239    
1240     <DL>
1241 jonen 1.1
1242 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1243     </DL>
1244 jonen 1.1 </DIV>
1245     <BR>
1246 jonen 1.2 <DIV CLASS="function">
1247     <A NAME='methodget_default_checked_items'><!-- --></A>
1248     <SPAN CLASS="font12bold">get_default_checked_items</SPAN> (line <span class="linenumber">493</span>)
1249     <BR>
1250     <SPAN CLASS="font10bold">Usage : </SPAN>
1251     <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
1252     <span class="font10bold" style="color: #0000FF">get_default_checked_items(
1253     )</SPAN>
1254     <BR>
1255    
1256     <BR>
1257     <SPAN CLASS="font10bold">Description : </SPAN>
1258     This function returns the array of default checked items to be marked as checked in the checkbox action column
1259     <br />
1260    
1261     <DL>
1262 jonen 1.1
1263 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1264     </DL>
1265     </DIV>
1266     <BR>
1267 jonen 1.1 <DIV CLASS="function">
1268 jonen 1.2 <A NAME='methodgui_init'><!-- --></A>
1269     <SPAN CLASS="font12bold">gui_init</SPAN> (line <span class="linenumber">103</span>)
1270 jonen 1.1 <BR>
1271 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1272     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1273     <span class="font10bold" style="color: #0000FF">gui_init(
1274     )</SPAN>
1275 jonen 1.1 <BR>
1276 jonen 1.2
1277     <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.
1278 jonen 1.1 <BR>
1279     <SPAN CLASS="font10bold">Description : </SPAN>
1280 jonen 1.2
1281     <br />
1282    
1283     <DL>
1284    
1285     <DT class="font10bold">Function Info:</DT>
1286     </DL>
1287     </DIV>
1288     <BR>
1289     <DIV CLASS="function">
1290     <A NAME='methodis_action_checked'><!-- --></A>
1291     <SPAN CLASS="font12bold">is_action_checked</SPAN> (line <span class="linenumber">698</span>)
1292     <BR>
1293     <SPAN CLASS="font10bold">Usage : </SPAN>
1294     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1295     <span class="font10bold" style="color: #0000FF">is_action_checked(
1296     string
1297     $value, array
1298     $row_data)</SPAN>
1299 jonen 1.1 <BR>
1300    
1301 jonen 1.2 <BR>
1302     <SPAN CLASS="font10bold">Description : </SPAN>
1303     This function is provided to give the child class the ability to precheck/select a particular column.
1304     <br />
1305    
1306 jonen 1.1 <DL>
1307 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1308     <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">$value</SPAN></SPAN> - the item to look for.</DD>
1309     <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">$row_data</SPAN></SPAN> - the row's data.</DD>
1310    
1311     <DT class="font10bold">Function Info:</DT>
1312     </DL>
1313     </DIV>
1314     <BR>
1315     <DIV CLASS="function">
1316     <A NAME='methodis_action_enabled'><!-- --></A>
1317     <SPAN CLASS="font12bold">is_action_enabled</SPAN> (line <span class="linenumber">711</span>)
1318     <BR>
1319     <SPAN CLASS="font10bold">Usage : </SPAN>
1320     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1321     <span class="font10bold" style="color: #0000FF">is_action_enabled(
1322     string
1323     $value, array
1324     $row_data)</SPAN>
1325     <BR>
1326 jonen 1.1
1327 jonen 1.2 <BR>
1328     <SPAN CLASS="font10bold">Description : </SPAN>
1329     This function is provided to give the child class the ability to enable/disable a particular checkbox.
1330     <br />
1331 jonen 1.1
1332 jonen 1.2 <DL>
1333     <DT class="font10bold">Function Parameters:</DT>
1334     <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">$value</SPAN></SPAN> - the item to look for.</DD>
1335     <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">$row_data</SPAN></SPAN> - the row's data.</DD>
1336    
1337     <DT class="font10bold">Function Info:</DT>
1338     </DL>
1339 jonen 1.1 </DIV>
1340     <BR>
1341     <DIV CLASS="function">
1342 jonen 1.2 <A NAME='methodsave_checked_items'><!-- --></A>
1343     <SPAN CLASS="font12bold">save_checked_items</SPAN> (line <span class="linenumber">502</span>)
1344 jonen 1.1 <BR>
1345 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1346 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1347 jonen 1.2 <span class="font10bold" style="color: #0000FF">save_checked_items(
1348     )</SPAN>
1349 jonen 1.1 <BR>
1350 jonen 1.2
1351 jonen 1.1 <BR>
1352     <SPAN CLASS="font10bold">Description : </SPAN>
1353 jonen 1.2 set the flag to tell the object to
1354     <br />
1355     <p>save the checked items</p>
1356     <DL>
1357    
1358     <DT class="font10bold">Function Info:</DT>
1359     </DL>
1360     </DIV>
1361     <BR>
1362     <DIV CLASS="function">
1363     <A NAME='methodset_actionbar'><!-- --></A>
1364     <SPAN CLASS="font12bold">set_actionbar</SPAN> (line <span class="linenumber">542</span>)
1365     <BR>
1366     <SPAN CLASS="font10bold">Usage : </SPAN>
1367     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1368     <span class="font10bold" style="color: #0000FF">set_actionbar(
1369     [boolean
1370     $flag = TRUE])</SPAN>
1371     <BR>
1372 jonen 1.1
1373     <BR>
1374 jonen 1.2 <SPAN CLASS="font10bold">Description : </SPAN>
1375     This allows the caller to turn on/off the rendering of the bottom action bar row
1376     <br />
1377 jonen 1.1
1378     <DL>
1379 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
1380     <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> - TRUE = on FALSE = off</DD>
1381    
1382     <DT class="font10bold">Function Info:</DT>
1383     </DL>
1384     </DIV>
1385     <BR>
1386     <DIV CLASS="function">
1387     <A NAME='methodset_align'><!-- --></A>
1388     <SPAN CLASS="font12bold">set_align</SPAN> (line <span class="linenumber">160</span>)
1389     <BR>
1390     <SPAN CLASS="font10bold">Usage : </SPAN>
1391     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1392     <span class="font10bold" style="color: #0000FF">set_align(
1393     string
1394     $align)</SPAN>
1395     <BR>
1396 jonen 1.1
1397 jonen 1.2 <BR>
1398     <SPAN CLASS="font10bold">Description : </SPAN>
1399     this function is used to set the overall alignment of the widget
1400     <br />
1401 jonen 1.1
1402 jonen 1.2 <DL>
1403     <DT class="font10bold">Function Parameters:</DT>
1404     <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 align value</DD>
1405    
1406     <DT class="font10bold">Function Info:</DT>
1407     </DL>
1408 jonen 1.1 </DIV>
1409     <BR>
1410 jonen 1.2 <DIV CLASS="function">
1411     <A NAME='methodset_default_checked_items'><!-- --></A>
1412     <SPAN CLASS="font12bold">set_default_checked_items</SPAN> (line <span class="linenumber">482</span>)
1413     <BR>
1414     <SPAN CLASS="font10bold">Usage : </SPAN>
1415     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1416     <span class="font10bold" style="color: #0000FF">set_default_checked_items(
1417     array
1418     $items)</SPAN>
1419     <BR>
1420 jonen 1.1
1421 jonen 1.2 <BR>
1422     <SPAN CLASS="font10bold">Description : </SPAN>
1423     This function is used to set the default list
1424     <br />
1425     <p>of selected checkbox items. This is used so the user can pre-populate the list of checked items in the checkbox action column</p>
1426     <DL>
1427     <DT class="font10bold">Function Parameters:</DT>
1428     <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">$items</SPAN></SPAN> - the array of checked items</DD>
1429    
1430     <DT class="font10bold">Function Info:</DT>
1431     </DL>
1432     </DIV>
1433     <BR>
1434 jonen 1.1 <DIV CLASS="function">
1435 jonen 1.2 <A NAME='methodset_global_prefix'><!-- --></A>
1436     <SPAN CLASS="font12bold">set_global_prefix</SPAN> (line <span class="linenumber">96</span>)
1437 jonen 1.1 <BR>
1438 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1439 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1440 jonen 1.2 <span class="font10bold" style="color: #0000FF">set_global_prefix(
1441     string
1442     $prefix)</SPAN>
1443 jonen 1.1 <BR>
1444 jonen 1.2
1445     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a> 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.
1446 jonen 1.1 <BR>
1447     <SPAN CLASS="font10bold">Description : </SPAN>
1448 jonen 1.2 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.
1449     <br />
1450    
1451     <DL>
1452     <DT class="font10bold">Function Parameters:</DT>
1453     <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">$prefix</SPAN></SPAN> - the prefix for all vars.</DD>
1454    
1455     <DT class="font10bold">Function Info:</DT>
1456     </DL>
1457     </DIV>
1458     <BR>
1459     <DIV CLASS="function">
1460     <A NAME='methodshow_actionbar'><!-- --></A>
1461     <SPAN CLASS="font12bold">show_actionbar</SPAN> (line <span class="linenumber">552</span>)
1462     <BR>
1463     <SPAN CLASS="font10bold">Usage : </SPAN>
1464     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1465     <span class="font10bold" style="color: #0000FF">show_actionbar(
1466     )</SPAN>
1467     <BR>
1468 jonen 1.1
1469     <BR>
1470 jonen 1.2 <SPAN CLASS="font10bold">Description : </SPAN>
1471     This function gets the current value of the show actionbar flag setting.
1472     <br />
1473 jonen 1.1
1474     <DL>
1475    
1476 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1477     </DL>
1478     </DIV>
1479     <BR>
1480     <DIV CLASS="function">
1481     <A NAME='methodwrap_column_item'><!-- --></A>
1482     <SPAN CLASS="font12bold">wrap_column_item</SPAN> (line <span class="linenumber">318</span>)
1483     <BR>
1484     <SPAN CLASS="font10bold">Usage : </SPAN>
1485     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
1486     <span class="font10bold" style="color: #0000FF">wrap_column_item(
1487     mixed
1488     $obj, string
1489     $col_name, int
1490     2, int
1491     3)</SPAN>
1492     <BR>
1493    
1494     <BR>
1495     <SPAN CLASS="font10bold">Description : </SPAN>
1496     This function ensures that the data we place in a column is aligned according to what the user wants.
1497     <br />
1498 jonen 1.1
1499 jonen 1.2 <DL>
1500     <DT class="font10bold">Function Parameters:</DT>
1501     <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>
1502     <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>
1503     <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>
1504     <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>
1505    
1506     <DT class="font10bold">Function Info:</DT>
1507     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1508     </DL>
1509 jonen 1.1 </DIV>
1510     <BR>
1511 jonen 1.2 <DIV CLASS="function">
1512     <A NAME='method_build_actionbar'><!-- --></A>
1513     <SPAN CLASS="font12bold">_build_actionbar</SPAN> (line <span class="linenumber">721</span>)
1514     <BR>
1515     <SPAN CLASS="font10bold">Usage : </SPAN>
1516     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN>&nbsp;
1517     <span class="font10bold" style="color: #0000FF">_build_actionbar(
1518     )</SPAN>
1519     <BR>
1520    
1521     <BR>
1522     <SPAN CLASS="font10bold">Description : </SPAN>
1523     This function renders the action bar at the bottom of the data list.
1524     <br />
1525    
1526     <DL>
1527 jonen 1.1
1528 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1529     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1530     </DL>
1531     </DIV>
1532     <BR>
1533 jonen 1.1 <DIV CLASS="function">
1534 jonen 1.2 <A NAME='method_build_actionbar_arrow_cell'><!-- --></A>
1535     <SPAN CLASS="font12bold">_build_actionbar_arrow_cell</SPAN> (line <span class="linenumber">757</span>)
1536 jonen 1.1 <BR>
1537 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1538 jonen 1.1 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
1539 jonen 1.2 <span class="font10bold" style="color: #0000FF">_build_actionbar_arrow_cell(
1540     string
1541     $col)</SPAN>
1542 jonen 1.1 <BR>
1543    
1544     <BR>
1545     <SPAN CLASS="font10bold">Description : </SPAN>
1546 jonen 1.2 This function builds a TD with the appropriate action arrow.
1547     <br />
1548    
1549     <DL>
1550     <DT class="font10bold">Function Parameters:</DT>
1551     <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</SPAN></SPAN> - FIRST or LAST</DD>
1552    
1553     <DT class="font10bold">Function Info:</DT>
1554     </DL>
1555     </DIV>
1556 jonen 1.1 <BR>
1557 jonen 1.2 <DIV CLASS="function">
1558     <A NAME='method_build_actionbar_data_cell'><!-- --></A>
1559     <SPAN CLASS="font12bold">_build_actionbar_data_cell</SPAN> (line <span class="linenumber">792</span>)
1560     <BR>
1561     <SPAN CLASS="font10bold">Usage : </SPAN>
1562     <span class="font10bold" style="color: #FF0000">TDtag;</SPAN>&nbsp;
1563     <span class="font10bold" style="color: #0000FF">_build_actionbar_data_cell(
1564     )</SPAN>
1565     <BR>
1566    
1567     <BR>
1568     <SPAN CLASS="font10bold">Description : </SPAN>
1569     This function builds the user's data cell
1570     <br />
1571 jonen 1.1
1572     <DL>
1573    
1574 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1575     </DL>
1576     </DIV>
1577     <BR>
1578     <DIV CLASS="function">
1579     <A NAME='method_build_action_column'><!-- --></A>
1580     <SPAN CLASS="font12bold">_build_action_column</SPAN> (line <span class="linenumber">576</span>)
1581     <BR>
1582     <SPAN CLASS="font10bold">Usage : </SPAN>
1583     <span class="font10bold" style="color: #FF0000">HTMLTag</SPAN>&nbsp;
1584     <span class="font10bold" style="color: #0000FF">_build_action_column(
1585     string
1586     $col, [boolean
1587     $header_flag = FALSE], [array
1588     $row_data = NULL])</SPAN>
1589     <BR>
1590 jonen 1.1
1591 jonen 1.2 <BR>
1592     <SPAN CLASS="font10bold">Description : </SPAN>
1593     This builds an action column cell
1594     <br />
1595    
1596     <DL>
1597     <DT class="font10bold">Function Parameters:</DT>
1598     <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</SPAN></SPAN> - the column to test for FIRST or LAST</DD>
1599     <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">$header_flag</SPAN></SPAN> - lets us know this is for the header or a cell.</DD>
1600     <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">$row_data</SPAN></SPAN> - the row's data.</DD>
1601    
1602     <DT class="font10bold">Function Info:</DT>
1603     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1604     </DL>
1605 jonen 1.1 </DIV>
1606     <BR>
1607     <DIV CLASS="function">
1608 jonen 1.2 <A NAME='method_build_search_title'><!-- --></A>
1609     <SPAN CLASS="font12bold">_build_search_title</SPAN> (line <span class="linenumber">387</span>)
1610 jonen 1.1 <BR>
1611 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1612 jonen 1.1 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN>&nbsp;
1613 jonen 1.2 <span class="font10bold" style="color: #0000FF">_build_search_title(
1614     )</SPAN>
1615 jonen 1.1 <BR>
1616    
1617     <BR>
1618     <SPAN CLASS="font10bold">Description : </SPAN>
1619     This function builds the search title table
1620 jonen 1.2 <br />
1621    
1622     <DL>
1623    
1624     <DT class="font10bold">Function Info:</DT>
1625     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - object</DD>
1626     </DL>
1627     </DIV>
1628     <BR>
1629     <DIV CLASS="function">
1630     <A NAME='method_build_simple_search_form'><!-- --></A>
1631     <SPAN CLASS="font12bold">_build_simple_search_form</SPAN> (line <span class="linenumber">406</span>)
1632     <BR>
1633     <SPAN CLASS="font10bold">Usage : </SPAN>
1634     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN>&nbsp;
1635     <span class="font10bold" style="color: #0000FF">_build_simple_search_form(
1636     )</SPAN>
1637     <BR>
1638    
1639 jonen 1.1 <BR>
1640 jonen 1.2 <SPAN CLASS="font10bold">Description : </SPAN>
1641     This function builds the simple search TD
1642     <br />
1643 jonen 1.1
1644     <DL>
1645    
1646 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1647     </DL>
1648     </DIV>
1649     <BR>
1650     <DIV CLASS="function">
1651     <A NAME='method_checkbox_javascript'><!-- --></A>
1652     <SPAN CLASS="font12bold">_checkbox_javascript</SPAN> (line <span class="linenumber">880</span>)
1653     <BR>
1654     <SPAN CLASS="font10bold">Usage : </SPAN>
1655     <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></SPAN>&nbsp;
1656     <span class="font10bold" style="color: #0000FF">_checkbox_javascript(
1657     )</SPAN>
1658     <BR>
1659    
1660     <BR>
1661     <SPAN CLASS="font10bold">Description : </SPAN>
1662     This function builds the JS needed for the checkbox action column
1663     <br />
1664 jonen 1.1
1665 jonen 1.2 <DL>
1666    
1667     <DT class="font10bold">Function Info:</DT>
1668     </DL>
1669 jonen 1.1 </DIV>
1670     <BR>
1671 jonen 1.2 <DIV CLASS="function">
1672     <A NAME='method_has_action_column'><!-- --></A>
1673     <SPAN CLASS="font12bold">_has_action_column</SPAN> (line <span class="linenumber">526</span>)
1674     <BR>
1675     <SPAN CLASS="font10bold">Usage : </SPAN>
1676     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1677     <span class="font10bold" style="color: #0000FF">_has_action_column(
1678     string
1679     $col)</SPAN>
1680     <BR>
1681 jonen 1.1
1682 jonen 1.2 <BR>
1683     <SPAN CLASS="font10bold">Description : </SPAN>
1684     This function tests to see if the child wants to render an action column
1685     <br />
1686    
1687     <DL>
1688     <DT class="font10bold">Function Parameters:</DT>
1689     <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</SPAN></SPAN> - the column to test for FIRST or LAST</DD>
1690    
1691     <DT class="font10bold">Function Info:</DT>
1692     </DL>
1693     </DIV>
1694     <BR>
1695 jonen 1.1 <DIV CLASS="function">
1696 jonen 1.2 <A NAME='method_is_col_checked'><!-- --></A>
1697     <SPAN CLASS="font12bold">_is_col_checked</SPAN> (line <span class="linenumber">667</span>)
1698 jonen 1.1 <BR>
1699 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
1700     <span class="font10bold" style="color: #FF0000">boolean.</SPAN>&nbsp;
1701     <span class="font10bold" style="color: #0000FF">_is_col_checked(
1702     string
1703     $value, array
1704     $row_data)</SPAN>
1705 jonen 1.1 <BR>
1706    
1707     <BR>
1708     <SPAN CLASS="font10bold">Description : </SPAN>
1709 jonen 1.2 This method checks to see if a particular row has been checked in the action column
1710     <br />
1711    
1712     <DL>
1713     <DT class="font10bold">Function Parameters:</DT>
1714     <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">$value</SPAN></SPAN> - the item to look for</DD>
1715     <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">$row_data</SPAN></SPAN> - the row's data.</DD>
1716    
1717     <DT class="font10bold">Function Info:</DT>
1718     </DL>
1719     </DIV>
1720     <BR>
1721     <DIV CLASS="function">
1722     <A NAME='method_javascript'><!-- --></A>
1723     <SPAN CLASS="font12bold">_javascript</SPAN> (line <span class="linenumber">861</span>)
1724     <BR>
1725     <SPAN CLASS="font10bold">Usage : </SPAN>
1726     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
1727     <span class="font10bold" style="color: #0000FF">_javascript(
1728     )</SPAN>
1729     <BR>
1730    
1731     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a> This function provides a way to automatically add javascript to this object.
1732 jonen 1.1 <BR>
1733 jonen 1.2 <SPAN CLASS="font10bold">Description : </SPAN>
1734     This function returns any Javascript required for this widget
1735     <br />
1736 jonen 1.1
1737     <DL>
1738    
1739 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1740     </DL>
1741 jonen 1.1 </DIV>
1742     <BR>
1743 jonen 1.2 <DIV CLASS="function">
1744     <A NAME='method_save_checked_items_enabled'><!-- --></A>
1745     <SPAN CLASS="font12bold">_save_checked_items_enabled</SPAN> (line <span class="linenumber">514</span>)
1746     <BR>
1747     <SPAN CLASS="font10bold">Usage : </SPAN>
1748     <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;
1749     <span class="font10bold" style="color: #0000FF">_save_checked_items_enabled(
1750     )</SPAN>
1751     <BR>
1752 jonen 1.1
1753 jonen 1.2 <BR>
1754     <SPAN CLASS="font10bold">Description : </SPAN>
1755     This tests the object flag to
1756     <br />
1757     <p>see if the child class wants to automatically save the checked items</p>
1758     <DL>
1759 jonen 1.1
1760 jonen 1.2 <DT class="font10bold">Function Info:</DT>
1761     </DL>
1762     </DIV>
1763     <BR>
1764     <div id="credit">
1765     <hr>
1766     Documention generated on Thu, 20 Feb 2003 16:22:37 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
1767     </div>
1768     </body>
1769     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed