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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu Jan 30 03:29:38 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:30 -0800' -->
6 <TITLE>Docs For Class DefaultGUIDatalist</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from DefaultGUIDatalist">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class DefaultGUIDatalist
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
39 |
40 --<a href="../phpHtmlLib/DataList.html">DataList</a>
41 |
42 --DefaultGUIDatalist</pre>
43 </pre>
44
45 <A NAME="children_summary"</A>
46 <H3>
47 Classes extended from DefaultGUIDatalist: <A HREF="#top" CLASS="links">^TOP</A>
48 </H3>
49
50 <p>
51 <b><i>Located in File: Program_Root/widgets/data_list/DefaultGUIDataList.inc</i></b><br>
52 </p>
53 <hr>
54 <!-- ========== Info from phpDoc block ========= -->
55 This class is the Default phpHtmlLib GUI interface
56 child of the DataList class.
57 <BR>
58 This child simply does
59 the job of rendering the html/layout for a DataList.
60 You can use this as an example of how to build your
61 own look/feel for your DataList.
62
63 <UL>
64
65 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
66
67 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
68
69 </UL>
70
71 <hr>
72 <!-- =========== VAR SUMMARY =========== -->
73 <A NAME='var_summary'><!-- --></A>
74 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
75 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
76 <TD>
77 <span CLASS="font12bold">Class Variable Summary</span>
78 <A HREF="#top" CLASS="links">^TOP</A>
79 </TD>
80 </TR>
81
82
83 </TABLE>
84
85 <hr>
86 <!-- =========== VAR INHERITED SUMMARY =========== -->
87 <A NAME='var_inherited_summary'><!-- --></A>
88 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
89 <TR CLASS='TableHeadingColor'>
90 <TD>
91 <span CLASS="font12bold">Inherited Class Variable Summary</span>
92 <A HREF="#top" CLASS="links">^TOP</A>
93 </TD>
94 </TR>
95
96
97 <!-- =========== Summary =========== -->
98 <TR BGCOLOR='white'>
99 <TD>
100 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
101 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
102 <tr CLASS="tableheadingcolor">
103 <th>Variable</th>
104 <th>Default Value</th>
105 <th>Description</th>
106 </tr>
107
108 <tr>
109 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$alternating_row_colors'>$alternating_row_colors</A></td>
110 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
111 <td CLASS="font10">Do we want to alternate the row colors?
112 This helps to see each row easier.</td>
113 </tr>
114
115 <tr>
116 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_advanced_search_flag'>$_advanced_search_flag</A></td>
117 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
118 <td CLASS="font10">Flag to let us know that
119 advanced search is enabled</td>
120 </tr>
121
122 <tr>
123 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_columns'>$_columns</A></td>
124 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
125 <td CLASS="font10">The column descriptions
126 for the data we are working on</td>
127 </tr>
128
129 <tr>
130 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_datasource'>$_datasource</A></td>
131 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
132 <td CLASS="font10">Holds our reference/copy of the</td>
133 </tr>
134
135 <tr>
136 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_default_orderby'>$_default_orderby</A></td>
137 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
138 <td CLASS="font10">Holds the db column name that
139 we want to order by default.</td>
140 </tr>
141
142 <tr>
143 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_default_reverseorder'>$_default_reverseorder</A></td>
144 <td CLASS="font10" STYLE="white-space: nowrap">->false<-</td>
145 <td CLASS="font10">Holds a flag to let us know to</td>
146 </tr>
147
148 <tr>
149 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_default_rows_per_page'>$_default_rows_per_page</A></td>
150 <td CLASS="font10" STYLE="white-space: nowrap">->10<-</td>
151 <td CLASS="font10">The number of rows of data
152 to show per &quot;page&quot;.</td>
153 </tr>
154
155 <tr>
156 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_form_attributes'>$_form_attributes</A></td>
157 <td CLASS="font10" STYLE="white-space: nowrap">->array(&quot;method&quot; =&gt; &quot;GET&quot;,
158 &quot;target&quot; =&gt; &quot;&quot;,
159 &quot;action&quot; =&gt; &quot;&quot;,
160 &quot;name&quot; =&gt; &quot;&quot;)<-</td>
161 <td CLASS="font10">This holds the form attributes</td>
162 </tr>
163
164 <tr>
165 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_form_render_flag'>$_form_render_flag</A></td>
166 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
167 <td CLASS="font10">Build everything inside a form?</td>
168 </tr>
169
170 <tr>
171 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_global_prefix'>$_global_prefix</A></td>
172 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
173 <td CLASS="font10">prefix for all list variable
174 names, so we can potentially
175 have more then 1 list per page.</td>
176 </tr>
177
178 <tr>
179 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_image_path'>$_image_path</A></td>
180 <td CLASS="font10" STYLE="white-space: nowrap">->/phphtmllib/images/widgets<-</td>
181 <td CLASS="font10">This stores the base path to where the
182 tool link images live.</td>
183 </tr>
184
185 <tr>
186 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_max_rows'>$_max_rows</A></td>
187 <td CLASS="font10" STYLE="white-space: nowrap">->200<-</td>
188 <td CLASS="font10">The max number of rows to
189 show when the user does the
190 &quot;EXPAND&quot; command.</td>
191 </tr>
192
193 <tr>
194 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_numrowsVar'>$_numrowsVar</A></td>
195 <td CLASS="font10" STYLE="white-space: nowrap">->numrows<-</td>
196 <td CLASS="font10">The number of rows variable name</td>
197 </tr>
198
199 <tr>
200 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_num_columns'>$_num_columns</A></td>
201 <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>
202 <td CLASS="font10">Keeps track of the # of columns we have</td>
203 </tr>
204
205 <tr>
206 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_num_pages'>$_num_pages</A></td>
207 <td CLASS="font10" STYLE="white-space: nowrap">->1<-</td>
208 <td CLASS="font10">This value holds the number
209 of pages of data we have
210 to display.</td>
211 </tr>
212
213 <tr>
214 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_offsetVar'>$_offsetVar</A></td>
215 <td CLASS="font10" STYLE="white-space: nowrap">->offset<-</td>
216 <td CLASS="font10">The offset variable name</td>
217 </tr>
218
219 <tr>
220 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_orderbyVar'>$_orderbyVar</A></td>
221 <td CLASS="font10" STYLE="white-space: nowrap">->orderby<-</td>
222 <td CLASS="font10">The order by variable name</td>
223 </tr>
224
225 <tr>
226 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_reverseorderVar'>$_reverseorderVar</A></td>
227 <td CLASS="font10" STYLE="white-space: nowrap">->reverseorder<-</td>
228 <td CLASS="font10">The reverseorder variable name</td>
229 </tr>
230
231 <tr>
232 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_save_vars'>$_save_vars</A></td>
233 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
234 <td CLASS="font10">This holds a list of</td>
235 </tr>
236
237 <tr>
238 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_search_fieldVar'>$_search_fieldVar</A></td>
239 <td CLASS="font10" STYLE="white-space: nowrap">->search_field<-</td>
240 <td CLASS="font10">The search field variable</td>
241 </tr>
242
243 <tr>
244 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_search_flag'>$_search_flag</A></td>
245 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
246 <td CLASS="font10">Flag to let us know that search
247 is enabled.</td>
248 </tr>
249
250 <tr>
251 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_search_table'>$_search_table</A></td>
252 <td CLASS="font10" STYLE="white-space: nowrap">->NULL<-</td>
253 <td CLASS="font10">Holds the object block that is the</td>
254 </tr>
255
256 <tr>
257 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_search_typeVar'>$_search_typeVar</A></td>
258 <td CLASS="font10" STYLE="white-space: nowrap">->search_type<-</td>
259 <td CLASS="font10">The type of search</td>
260 </tr>
261
262 <tr>
263 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_search_valueVar'>$_search_valueVar</A></td>
264 <td CLASS="font10" STYLE="white-space: nowrap">->search_value<-</td>
265 <td CLASS="font10">The search value</td>
266 </tr>
267
268 <tr>
269 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_showallVar'>$_showallVar</A></td>
270 <td CLASS="font10" STYLE="white-space: nowrap">->showall<-</td>
271 <td CLASS="font10">This var to tell us to show all
272 data or not.</td>
273 </tr>
274
275 <tr>
276 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_show_results_flag'>$_show_results_flag</A></td>
277 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
278 <td CLASS="font10">flag to let us know if we want to show
279 the results or not.</td>
280 </tr>
281
282 <tr>
283 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_simple_search_modifier'>$_simple_search_modifier</A></td>
284 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
285 <td CLASS="font10">Flag to enable simple search modifyer.</td>
286 </tr>
287
288 <tr>
289 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#$_simple_search_modifierVar'>$_simple_search_modifierVar</A></td>
290 <td CLASS="font10" STYLE="white-space: nowrap">->simple_search_modifier<-</td>
291 <td CLASS="font10">The simple search modifier
292 var name.</td>
293 </tr>
294
295 </table>
296 <BR>
297 </TD>
298 </TR>
299
300 <!-- =========== Summary =========== -->
301 <TR BGCOLOR='white'>
302 <TD>
303 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
304 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
305 <tr CLASS="tableheadingcolor">
306 <th>Variable</th>
307 <th>Default Value</th>
308 <th>Description</th>
309 </tr>
310
311 <tr>
312 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
313 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
314 <td CLASS="font10">The title of the table.</td>
315 </tr>
316
317 <tr>
318 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
319 <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
320 <td CLASS="font10">the width of the widget</td>
321 </tr>
322
323 </table>
324 <BR>
325 </TD>
326 </TR>
327
328 <!-- =========== Summary =========== -->
329 <TR BGCOLOR='white'>
330 <TD>
331 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
332 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
333 <tr CLASS="tableheadingcolor">
334 <th>Variable</th>
335 <th>Default Value</th>
336 <th>Description</th>
337 </tr>
338
339 <tr>
340 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
341 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
342 <td CLASS="font10">Flag for pretty (indented) output</td>
343 </tr>
344
345 <tr>
346 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
347 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
348 <td CLASS="font10">Do we render a newline after the
349 contents has been rendered?</td>
350 </tr>
351
352 </table>
353 <BR>
354 </TD>
355 </TR>
356
357 </TABLE>
358
359 <hr>
360 <!-- =========== INHERITED METHOD SUMMARY =========== -->
361 <A NAME='functions_inherited'><!-- --></A>
362 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
363 <TR CLASS='TableHeadingColor'>
364 <TD>
365 <span CLASS="font12bold">Inherited Method Summary</span>
366 <A HREF="#top" CLASS="links">^TOP</A>
367 </TD>
368 </TR>
369
370
371 <!-- =========== Summary =========== -->
372 <TR BGCOLOR='white' CLASS='TableRowColor'>
373 <TD>
374 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/DataList.html">DataList</a></span>
375 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
376 <tr CLASS="tableheadingcolor">
377 <th>Function</th>
378 <th>Description</th>
379 </tr>
380
381 <tr>
382 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#constructor DataList'>constructor DataList ( [$title = ], [$width = "100%"], [$default_orderby = ''], [$default_reverseorder = FALSE] )</A></td>
383 <td CLASS="font10">The constructor</td>
384
385 <tr>
386 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#add_header_item'>add_header_item ( $label, [$size = 100], [$data_name = NULL], [$sortable = FALSE], [$searchable = FALSE], [$align = "left"], $sortorder, [$max_text_length = ""NULL] )</A></td>
387 <td CLASS="font10">This function adds a header item to the column headers
388 from a list of parameters.</td>
389
390 <tr>
391 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#advanced_search_disable'>advanced_search_disable ( )</A></td>
392 <td CLASS="font10">Disable the advanced search
393 capability</td>
394
395 <tr>
396 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#advanced_search_enable'>advanced_search_enable ( )</A></td>
397 <td CLASS="font10">Enable the advanced search</td>
398
399 <tr>
400 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_base_url'>build_base_url ( )</A></td>
401 <td CLASS="font10">This builds the base url used
402 by the column headers as well
403 as the page tool links.</td>
404
405 <tr>
406 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_column_item'>build_column_item ( $row_data, $col_name )</A></td>
407 <td CLASS="font10">This is the basic function for letting us
408 do a mapping between the column name in
409 the header, to the value found in the DB.</td>
410
411 <tr>
412 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_column_item'>build_column_item ( $row_data, $col_name )</A></td>
413 <td CLASS="font10">This is the basic function for letting us
414 do a mapping between the column name in
415 the header, to the value found in the DB.</td>
416
417 <tr>
418 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_column_url'>build_column_url ( $col_name )</A></td>
419 <td CLASS="font10">This builds a url for a particular
420 column header.</td>
421
422 <tr>
423 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_gui'>build_gui ( )</A></td>
424 <td CLASS="font10">This function is responsible for calling the child</td>
425
426 <tr>
427 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_orderby_querystring'>build_orderby_querystring ( )</A></td>
428 <td CLASS="font10">This builds a query string var for the
429 orderby value.</td>
430
431 <tr>
432 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_reverseorder_querystring'>build_reverseorder_querystring ( )</A></td>
433 <td CLASS="font10">This builds a query string var for the
434 reverseorder value.</td>
435
436 <tr>
437 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_searchfield_querystring'>build_searchfield_querystring ( )</A></td>
438 <td CLASS="font10">This builds a query string var for the
439 searchfield value.</td>
440
441 <tr>
442 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_searchvalue_querystring'>build_searchvalue_querystring ( )</A></td>
443 <td CLASS="font10">This builds a query string var for the
444 searchfield value.</td>
445
446 <tr>
447 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_state_vars_query_string'>build_state_vars_query_string ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</A></td>
448 <td CLASS="font10">this function is used to build a sub query string
449 of all of the query string vars to save the
450 state of the DBItemList.</td>
451
452 <tr>
453 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#build_tool_link'>build_tool_link ( $which )</A></td>
454 <td CLASS="font10">This function builds the 'tool' images that
455 allow you to walk through the data list itself.</td>
456
457 <tr>
458 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#child_add_row_cell'>child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</A></td>
459 <td CLASS="font10">This method is supposed to be written by</td>
460
461 <tr>
462 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#child_build_column_header'>child_build_column_header ( $title, $col_data, $col_count )</A></td>
463 <td CLASS="font10">This method is supposed to be written by</td>
464
465 <tr>
466 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#child_build_search_table'>child_build_search_table ( )</A></td>
467 <td CLASS="font10">This function builds the search
468 block that lives above the results</td>
469
470 <tr>
471 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#child_get_gui'>child_get_gui ( )</A></td>
472 <td CLASS="font10">This function is called after all of the data has
473 been added to the UI object.</td>
474
475 <tr>
476 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#data_prefetch'>data_prefetch ( )</A></td>
477 <td CLASS="font10">This function is used to set up any</td>
478
479 <tr>
480 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#filter_column_string'>filter_column_string ( $data )</A></td>
481 <td CLASS="font10">This does some magic filtering on the data
482 that we display in a column.</td>
483
484 <tr>
485 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_current_page'>get_current_page ( )</A></td>
486 <td CLASS="font10">This function returns the current
487 page that the item list is on.</td>
488
489 <tr>
490 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_data_source'>get_data_source ( )</A></td>
491 <td CLASS="font10">This function is called automatically by
492 the DataList constructor.</td>
493
494 <tr>
495 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_default_num_rows'>get_default_num_rows ( )</A></td>
496 <td CLASS="font10">This function gets the current default
497 number of rows to display setting.</td>
498
499 <tr>
500 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_form_action'>get_form_action ( )</A></td>
501 <td CLASS="font10">This function is used to get
502 the form action</td>
503
504 <tr>
505 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_form_method'>get_form_method ( )</A></td>
506 <td CLASS="font10">This function is used to get
507 the form method</td>
508
509 <tr>
510 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_form_name'>get_form_name ( )</A></td>
511 <td CLASS="font10">This function is used to get
512 the form name</td>
513
514 <tr>
515 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_form_render'>get_form_render ( )</A></td>
516 <td CLASS="font10">Return the state of the form render</td>
517
518 <tr>
519 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_form_target'>get_form_target ( )</A></td>
520 <td CLASS="font10">This function is used to get
521 the form target</td>
522
523 <tr>
524 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_global_prefix'>get_global_prefix ( )</A></td>
525 <td CLASS="font10">returns the current variable prefix
526 string being used.</td>
527
528 <tr>
529 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_image_path'>get_image_path ( )</A></td>
530 <td CLASS="font10">This function returns the path to the
531 images used in this class</td>
532
533 <tr>
534 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_last_page'>get_last_page ( )</A></td>
535 <td CLASS="font10">This calculates the last page #
536 for this list of items</td>
537
538 <tr>
539 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_max_rows'>get_max_rows ( )</A></td>
540 <td CLASS="font10">This returns the Maximum # of rows to
541 display when in expand mode</td>
542
543 <tr>
544 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_num_pages'>get_num_pages ( )</A></td>
545 <td CLASS="font10">This function returns the #
546 of pages that are available
547 for this list of items.</td>
548
549 <tr>
550 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_page_info'>get_page_info ( )</A></td>
551 <td CLASS="font10">This function builds the string</td>
552
553 <tr>
554 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#get_simple_search_modifier'>get_simple_search_modifier ( )</A></td>
555 <td CLASS="font10">gets the value of the search modifier
556 flag.</td>
557
558 <tr>
559 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#gui_init'>gui_init ( )</A></td>
560 <td CLASS="font10">A subclass can override this function
561 to setup the class variables after
562 the constructor.</td>
563
564 <tr>
565 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#is_advanced_search_enabled'>is_advanced_search_enabled ( )</A></td>
566 <td CLASS="font10">This returns the status of the
567 advanced search flag.</td>
568
569 <tr>
570 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#is_search_enabled'>is_search_enabled ( )</A></td>
571 <td CLASS="font10">get the status of the search
572 ability.</td>
573
574 <tr>
575 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#numrows'>numrows ( )</A></td>
576 <td CLASS="font10">This function returns the number of rows
577 that the query found.</td>
578
579 <tr>
580 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#offset'>offset ( )</A></td>
581 <td CLASS="font10">This function returns the current value
582 of the offset variable.</td>
583
584 <tr>
585 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#orderby'>orderby ( )</A></td>
586 <td CLASS="font10">This function returns the value of the
587 current orderby variable.</td>
588
589 <tr>
590 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#render'>render ( $indent_level, $output_debug )</A></td>
591 <td CLASS="font10">This function renders the final
592 widget</td>
593
594 <tr>
595 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#reverseorder'>reverseorder ( )</A></td>
596 <td CLASS="font10">This function returns the current value of
597 the reverse order member variable.</td>
598
599 <tr>
600 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#search_disable'>search_disable ( )</A></td>
601 <td CLASS="font10">Disable the search ability.</td>
602
603 <tr>
604 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#search_enable'>search_enable ( )</A></td>
605 <td CLASS="font10">Enable the search ability.</td>
606
607 <tr>
608 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#search_field'>search_field ( )</A></td>
609 <td CLASS="font10">returns the current value of
610 the search field name</td>
611
612 <tr>
613 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#search_type'>search_type ( )</A></td>
614 <td CLASS="font10">returns the type of search being used</td>
615
616 <tr>
617 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#search_value'>search_value ( )</A></td>
618 <td CLASS="font10">returns the current value of
619 te search field value.</td>
620
621 <tr>
622 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#search_value_filter'>search_value_filter ( $value )</A></td>
623 <td CLASS="font10">This function is used to make safe
624 any query string value that is used</td>
625
626 <tr>
627 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#setup_columns'>setup_columns ( )</A></td>
628 <td CLASS="font10"></td>
629
630 <tr>
631 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_data_source'>set_data_source ( $datasource )</A></td>
632 <td CLASS="font10">This function is used to set the
633 DataListSource object for this instance</td>
634
635 <tr>
636 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_default_num_rows'>set_default_num_rows ( $num_rows )</A></td>
637 <td CLASS="font10">This function sets the default # of rows
638 per page to display.</td>
639
640 <tr>
641 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_form_action'>set_form_action ( $action )</A></td>
642 <td CLASS="font10">Sets the form action</td>
643
644 <tr>
645 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_form_method'>set_form_method ( $method )</A></td>
646 <td CLASS="font10">This function is used to set the
647 form method</td>
648
649 <tr>
650 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_form_name'>set_form_name ( $name )</A></td>
651 <td CLASS="font10">This function is used to set the
652 form name</td>
653
654 <tr>
655 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_form_render'>set_form_render ( $flag )</A></td>
656 <td CLASS="font10">Sets whether to the output into a form</td>
657
658 <tr>
659 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_form_target'>set_form_target ( $target )</A></td>
660 <td CLASS="font10">This function is used to set the
661 form target</td>
662
663 <tr>
664 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_global_prefix'>set_global_prefix ( $prefix )</A></td>
665 <td CLASS="font10">This function sets a prefix for all
666 variables that are used in the item list
667 table on a page.</td>
668
669 <tr>
670 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_image_path'>set_image_path ( $path )</A></td>
671 <td CLASS="font10">This function returns the path to the
672 images used in this class</td>
673
674 <tr>
675 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_max_rows'>set_max_rows ( $max )</A></td>
676 <td CLASS="font10">This sets the maximum # of rows to
677 display when in expand mode</td>
678
679 <tr>
680 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_not_found_message'>set_not_found_message ( $mesg )</A></td>
681 <td CLASS="font10">This function is used to set the
682 message displayed when no data is found</td>
683
684 <tr>
685 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_numrows'>set_numrows ( $new_numrows )</A></td>
686 <td CLASS="font10">This function sets the # of rows to display
687 per page.</td>
688
689 <tr>
690 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_offset'>set_offset ( $new_offset )</A></td>
691 <td CLASS="font10">This function is used to set/change
692 the offset for this list.</td>
693
694 <tr>
695 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_reverseorder'>set_reverseorder ( $new_value )</A></td>
696 <td CLASS="font10">This function sets the reverse order flag
697 to a new value.</td>
698
699 <tr>
700 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_save_vars'>set_save_vars ( $vars )</A></td>
701 <td CLASS="font10">This function sets the save variables</td>
702
703 <tr>
704 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_save_vars'>set_save_vars ( $vars )</A></td>
705 <td CLASS="font10">This function sets the save variables</td>
706
707 <tr>
708 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_search_type'>set_search_type ( $type )</A></td>
709 <td CLASS="font10">This function sets the search type</td>
710
711 <tr>
712 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_show_results'>set_show_results ( [$flag = TRUE] )</A></td>
713 <td CLASS="font10">This function is used to set the value
714 of the _show_results_flag</td>
715
716 <tr>
717 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#set_simple_search_modifier'>set_simple_search_modifier ( [$modifier = SEARCH_ALL] )</A></td>
718 <td CLASS="font10">Set the simple search modifyer</td>
719
720 <tr>
721 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#showall'>showall ( )</A></td>
722 <td CLASS="font10">returns the current value of the showall
723 flag.</td>
724
725 <tr>
726 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#simple_search_modifier_value'>simple_search_modifier_value ( )</A></td>
727 <td CLASS="font10">returns the current value of the
728 simple search modifier</td>
729
730 <tr>
731 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#user_setup'>user_setup ( )</A></td>
732 <td CLASS="font10">A subclass can override this function
733 to setup the class variables after
734 the constructor.</td>
735
736 <tr>
737 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_build_save_vars'>_build_save_vars ( )</A></td>
738 <td CLASS="font10">this method builds some hidden
739 form fields to automatically
740 be placed inside the form.</td>
741
742 <tr>
743 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_build_simple_search_modifier'>_build_simple_search_modifier ( )</A></td>
744 <td CLASS="font10">This builds the simple search modifier
745 select box.</td>
746
747 <tr>
748 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_build_tool_url'>_build_tool_url ( $offset, [$showall_flag = FALSE], [$showall_value = 0] )</A></td>
749 <td CLASS="font10">This function is used to build the url
750 for a tool link.</td>
751
752 <tr>
753 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_check_datasource'>_check_datasource ( $function_name )</A></td>
754 <td CLASS="font10">general DataListSource object checker.</td>
755
756 <tr>
757 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_clean_string'>_clean_string ( $obj, $col_name )</A></td>
758 <td CLASS="font10">This function is used to make sure that the string we are
759 placing in a cell has been &quot;cleaned&quot;</td>
760
761 <tr>
762 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_filter_column_string'>_filter_column_string ( $data )</A></td>
763 <td CLASS="font10">This does some magic filtering on the data
764 that we display in a column.</td>
765
766 <tr>
767 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_get_searchable_fields'>_get_searchable_fields ( )</A></td>
768 <td CLASS="font10">This method gets the array of
769 searchable header fields (columns)</td>
770
771 <tr>
772 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_javascript'>_javascript ( )</A></td>
773 <td CLASS="font10">This function provides a way to automatically
774 add javascript to this object.</td>
775
776 <tr>
777 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_save_mozilla_nav_link'>_save_mozilla_nav_link ( $which, $url )</A></td>
778 <td CLASS="font10">This function stores the url for each of the tool
779 urls, so we can push these out for mozilla.</td>
780
781 <tr>
782 <td CLASS="font10bold"><A HREF='../phpHtmlLib/DataList.html#_show_results'>_show_results ( )</A></td>
783 <td CLASS="font10">This function is used to let render() know
784 that we should show the results or not.</td>
785
786 </table>
787 <br>
788 </TD>
789 </TR>
790
791 <!-- =========== Summary =========== -->
792 <TR BGCOLOR='white' CLASS='TableRowColor'>
793 <TD>
794 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
795 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
796 <tr CLASS="tableheadingcolor">
797 <th>Function</th>
798 <th>Description</th>
799 </tr>
800
801 <tr>
802 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
803 <td CLASS="font10">This gets the alignment value
804 for the outer table</td>
805
806 <tr>
807 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
808 <td CLASS="font10">This function provides the</td>
809
810 <tr>
811 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
812 <td CLASS="font10">Function for returning the raw javascript
813 that is required for this widget.</td>
814
815 <tr>
816 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
817 <td CLASS="font10">Function for accessing the
818 title of this widget</td>
819
820 <tr>
821 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
822 <td CLASS="font10">Function for getting the current
823 widget width setting.</td>
824
825 <tr>
826 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
827 <td CLASS="font10">This function sets the align attribute
828 for the outer table.</td>
829
830 <tr>
831 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
832 <td CLASS="font10">Set the title for the widget.</td>
833
834 <tr>
835 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
836 <td CLASS="font10">Set the width for the widget.</td>
837
838 </table>
839 <br>
840 </TD>
841 </TR>
842
843 <!-- =========== Summary =========== -->
844 <TR BGCOLOR='white' CLASS='TableRowColor'>
845 <TD>
846 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
847 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
848 <tr CLASS="tableheadingcolor">
849 <th>Function</th>
850 <th>Description</th>
851 </tr>
852
853 <tr>
854 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
855 <td CLASS="font10">The constructor.</td>
856
857 <tr>
858 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
859 <td CLASS="font10">add content onto content stack</td>
860
861 <tr>
862 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
863 <td CLASS="font10">Add content onto content stack
864 so you can change the item later.</td>
865
866 <tr>
867 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
868 <td CLASS="font10">counts the number of content objects</td>
869
870 <tr>
871 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
872 <td CLASS="font10">This flag gets the current value
873 of the indent flag</td>
874
875 <tr>
876 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
877 <td CLASS="font10">Same as add().</td>
878
879 <tr>
880 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
881 <td CLASS="font10">Same as add_reference
882 NOTE : only exists for compatibility with 1.1.x</td>
883
884 <tr>
885 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
886 <td CLASS="font10">This function is compatible with the
887 rest of the phpHtmllib API spec.</td>
888
889 <tr>
890 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
891 <td CLASS="font10">destroy existing content and start with new content.</td>
892
893 <tr>
894 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
895 <td CLASS="font10">This function turns on the collapse flag</td>
896
897 <tr>
898 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
899 <td CLASS="font10">function to set the indent flag</td>
900
901 </table>
902 <br>
903 </TD>
904 </TR>
905
906 </TABLE>
907
908 <hr>
909 <!-- should have constructor at some point -->
910 <!-- =========== Method SUMMARY =========== -->
911 <A NAME='Method_summary'><!-- --></A>
912 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
913 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
914 <TD>
915 <span class="font12bold">Method Summary</span>
916 <A HREF="#top" CLASS="links">^TOP</A>
917 </TD>
918 </TR>
919
920
921 <!-- =========== Summary =========== -->
922 <TR BGCOLOR='white' CLASS='TableRowColor'>
923 <TD>
924 <CODE><B><A HREF='DefaultGUIDatalist.html#build_column_header'>mixed build_column_header ( $col_name, $col_data, $col_num )</A></B></CODE>
925 <BR>
926 <blockquote> This function builds the object/text
927 to be used for a column header. </blockquote>
928 </TD>
929 </TR>
930
931 <!-- =========== Summary =========== -->
932 <TR BGCOLOR='white' CLASS='TableRowColor'>
933 <TD>
934 <CODE><B><A HREF='DefaultGUIDatalist.html#child_add_row_cell'>void child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</A></B></CODE>
935 <BR>
936 <blockquote> </blockquote>
937 </TD>
938 </TR>
939
940 <!-- =========== Summary =========== -->
941 <TR BGCOLOR='white' CLASS='TableRowColor'>
942 <TD>
943 <CODE><B><A HREF='DefaultGUIDatalist.html#child_build_column_header'>void child_build_column_header ( $name, $col, $cnt )</A></B></CODE>
944 <BR>
945 <blockquote> </blockquote>
946 </TD>
947 </TR>
948
949 <!-- =========== Summary =========== -->
950 <TR BGCOLOR='white' CLASS='TableRowColor'>
951 <TD>
952 <CODE><B><A HREF='DefaultGUIDatalist.html#child_build_search_table'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> child_build_search_table ( )</A></B></CODE>
953 <BR>
954 <blockquote> This builds the table that holds the search
955 capability. </blockquote>
956 </TD>
957 </TR>
958
959 <!-- =========== Summary =========== -->
960 <TR BGCOLOR='white' CLASS='TableRowColor'>
961 <TD>
962 <CODE><B><A HREF='DefaultGUIDatalist.html#child_get_gui'>void child_get_gui ( )</A></B></CODE>
963 <BR>
964 <blockquote> </blockquote>
965 </TD>
966 </TR>
967
968 <!-- =========== Summary =========== -->
969 <TR BGCOLOR='white' CLASS='TableRowColor'>
970 <TD>
971 <CODE><B><A HREF='DefaultGUIDatalist.html#gui_init'>void gui_init ( )</A></B></CODE>
972 <BR>
973 <blockquote> </blockquote>
974 </TD>
975 </TR>
976
977 <!-- =========== Summary =========== -->
978 <TR BGCOLOR='white' CLASS='TableRowColor'>
979 <TD>
980 <CODE><B><A HREF='DefaultGUIDatalist.html#wrap_column_item'><a href="../phpHtmlLib/TDtag.html">TDtag</a> wrap_column_item ( $obj, $col_name )</A></B></CODE>
981 <BR>
982 <blockquote> This function ensures that the data we place
983 in a column is aligned according to what the
984 user wants. </blockquote>
985 </TD>
986 </TR>
987
988 <!-- =========== Summary =========== -->
989 <TR BGCOLOR='white' CLASS='TableRowColor'>
990 <TD>
991 <CODE><B><A HREF='DefaultGUIDatalist.html#_build_search_title'><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a> _build_search_title ( )</A></B></CODE>
992 <BR>
993 <blockquote> This function builds the search title table </blockquote>
994 </TD>
995 </TR>
996
997 <!-- =========== Summary =========== -->
998 <TR BGCOLOR='white' CLASS='TableRowColor'>
999 <TD>
1000 <CODE><B><A HREF='DefaultGUIDatalist.html#_build_simple_search_form'><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a> _build_simple_search_form ( )</A></B></CODE>
1001 <BR>
1002 <blockquote> This function builds the simple search TD </blockquote>
1003 </TD>
1004 </TR>
1005
1006 </TABLE>
1007
1008 <hr>
1009 <!-- ============ VARIABLE DETAIL =========== -->
1010
1011 <A NAME='variable_detail'></A>
1012 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
1013 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
1014 <TD>
1015 <span CLASS="font12bold">Variable Detail</span>
1016 <A HREF="#top" CLASS="links">^TOP</A>
1017 </TD>
1018 </TR>
1019 </TABLE>
1020
1021
1022
1023 <hr>
1024 <!-- ============ FUNCTION DETAIL =========== -->
1025
1026 <A NAME='function_detail'></A>
1027 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
1028 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
1029 <TD>
1030 <span class="font12bold">Method Detail</span>
1031 <A HREF="#top" CLASS="links">^TOP</A>
1032 </TD>
1033 </TR>
1034 </TABLE>
1035 <BR>
1036
1037 <DIV CLASS="function">
1038 <A NAME='build_column_header'><!-- --></A>
1039 <SPAN CLASS="font12bold">build_column_header</SPAN>
1040 <BR>
1041 <SPAN CLASS="font10bold">Useage : </SPAN>
1042 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
1043 <span class="font10bold" style="color: #0000FF">build_column_header ( $col_name, $col_data, $col_num )</SPAN>
1044 <BR>
1045
1046 <BR>
1047 <SPAN CLASS="font10bold">Description : </SPAN>
1048 <!-- ========== Info from phpDoc block ========= -->
1049 This function builds the object/text
1050 to be used for a column header.
1051 <BR>
1052 It can
1053 either be an href because its sortable,
1054 or it can just be text, because its not
1055 sortable.
1056 <DL>
1057 <DT class="font10bold">Function Parameters:</DT>
1058
1059 <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_name</SPAN></SPAN> the column # we are working on.</DD>
1060
1061 <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>
1062
1063
1064 <DT class="font10bold">Function Info:</DT>
1065
1066 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - either an Atag object or
1067 raw text.</DD>
1068
1069 </DL>
1070
1071 </DIV>
1072 <BR>
1073
1074 <DIV CLASS="function">
1075 <A NAME='child_add_row_cell'><!-- --></A>
1076 <SPAN CLASS="font12bold">child_add_row_cell</SPAN>
1077 <BR>
1078 <SPAN CLASS="font10bold">Useage : </SPAN>
1079 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1080 <span class="font10bold" style="color: #0000FF">child_add_row_cell ( $obj, $col_name, $last_in_row_flag )</SPAN>
1081 <BR>
1082 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#child_add_row_cell">DataList::child_add_row_cell()</a>
1083 <BR>
1084 <SPAN CLASS="font10bold">Description : </SPAN>
1085 <!-- ========== Info from phpDoc block ========= -->
1086
1087 <BR>
1088
1089 <DL>
1090 <DT class="font10bold">Function Parameters:</DT>
1091
1092
1093 <DT class="font10bold">Function Info:</DT>
1094
1095 </DL>
1096
1097 </DIV>
1098 <BR>
1099
1100 <DIV CLASS="function">
1101 <A NAME='child_build_column_header'><!-- --></A>
1102 <SPAN CLASS="font12bold">child_build_column_header</SPAN>
1103 <BR>
1104 <SPAN CLASS="font10bold">Useage : </SPAN>
1105 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1106 <span class="font10bold" style="color: #0000FF">child_build_column_header ( $name, $col, $cnt )</SPAN>
1107 <BR>
1108 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#child_build_column_header">DataList::child_build_column_header()</a>
1109 <BR>
1110 <SPAN CLASS="font10bold">Description : </SPAN>
1111 <!-- ========== Info from phpDoc block ========= -->
1112
1113 <BR>
1114
1115 <DL>
1116 <DT class="font10bold">Function Parameters:</DT>
1117
1118
1119 <DT class="font10bold">Function Info:</DT>
1120
1121 </DL>
1122
1123 </DIV>
1124 <BR>
1125
1126 <DIV CLASS="function">
1127 <A NAME='child_build_search_table'><!-- --></A>
1128 <SPAN CLASS="font12bold">child_build_search_table</SPAN>
1129 <BR>
1130 <SPAN CLASS="font10bold">Useage : </SPAN>
1131 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN>&nbsp;
1132 <span class="font10bold" style="color: #0000FF">child_build_search_table ( )</SPAN>
1133 <BR>
1134 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#child_build_search_table">DataList::child_build_search_table()</a>
1135 <BR>
1136 <SPAN CLASS="font10bold">Description : </SPAN>
1137 <!-- ========== Info from phpDoc block ========= -->
1138 This builds the table that holds the search
1139 capability.
1140 <BR>
1141
1142 <DL>
1143 <DT class="font10bold">Function Parameters:</DT>
1144
1145
1146 <DT class="font10bold">Function Info:</DT>
1147
1148 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object.</DD>
1149
1150 </DL>
1151
1152 </DIV>
1153 <BR>
1154
1155 <DIV CLASS="function">
1156 <A NAME='child_get_gui'><!-- --></A>
1157 <SPAN CLASS="font12bold">child_get_gui</SPAN>
1158 <BR>
1159 <SPAN CLASS="font10bold">Useage : </SPAN>
1160 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1161 <span class="font10bold" style="color: #0000FF">child_get_gui ( )</SPAN>
1162 <BR>
1163 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#child_get_gui">DataList::child_get_gui()</a>
1164 <BR>
1165 <SPAN CLASS="font10bold">Description : </SPAN>
1166 <!-- ========== Info from phpDoc block ========= -->
1167
1168 <BR>
1169
1170 <DL>
1171 <DT class="font10bold">Function Parameters:</DT>
1172
1173
1174 <DT class="font10bold">Function Info:</DT>
1175
1176 </DL>
1177
1178 </DIV>
1179 <BR>
1180
1181 <DIV CLASS="function">
1182 <A NAME='gui_init'><!-- --></A>
1183 <SPAN CLASS="font12bold">gui_init</SPAN>
1184 <BR>
1185 <SPAN CLASS="font10bold">Useage : </SPAN>
1186 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1187 <span class="font10bold" style="color: #0000FF">gui_init ( )</SPAN>
1188 <BR>
1189 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/DataList.html#gui_init">DataList::gui_init()</a>
1190 <BR>
1191 <SPAN CLASS="font10bold">Description : </SPAN>
1192 <!-- ========== Info from phpDoc block ========= -->
1193
1194 <BR>
1195
1196 <DL>
1197 <DT class="font10bold">Function Parameters:</DT>
1198
1199
1200 <DT class="font10bold">Function Info:</DT>
1201
1202 </DL>
1203
1204 </DIV>
1205 <BR>
1206
1207 <DIV CLASS="function">
1208 <A NAME='wrap_column_item'><!-- --></A>
1209 <SPAN CLASS="font12bold">wrap_column_item</SPAN>
1210 <BR>
1211 <SPAN CLASS="font10bold">Useage : </SPAN>
1212 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
1213 <span class="font10bold" style="color: #0000FF">wrap_column_item ( $obj, $col_name )</SPAN>
1214 <BR>
1215
1216 <BR>
1217 <SPAN CLASS="font10bold">Description : </SPAN>
1218 <!-- ========== Info from phpDoc block ========= -->
1219 This function ensures that the data we place
1220 in a column is aligned according to what the
1221 user wants.
1222 <BR>
1223
1224 <DL>
1225 <DT class="font10bold">Function Parameters:</DT>
1226
1227 <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">$obj</SPAN></SPAN> - the column # we are working on.</DD>
1228
1229 <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 name of the column header
1230 for this row to render.</DD>
1231
1232 <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">$odd_row</SPAN></SPAN> - - tells us if this cell lives in
1233 an odd # row (for alternating row colors)</DD>
1234
1235
1236 <DT class="font10bold">Function Info:</DT>
1237
1238 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
1239
1240 </DL>
1241
1242 </DIV>
1243 <BR>
1244
1245 <DIV CLASS="function">
1246 <A NAME='_build_search_title'><!-- --></A>
1247 <SPAN CLASS="font12bold">_build_search_title</SPAN>
1248 <BR>
1249 <SPAN CLASS="font10bold">Useage : </SPAN>
1250 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></SPAN>&nbsp;
1251 <span class="font10bold" style="color: #0000FF">_build_search_title ( )</SPAN>
1252 <BR>
1253
1254 <BR>
1255 <SPAN CLASS="font10bold">Description : </SPAN>
1256 <!-- ========== Info from phpDoc block ========= -->
1257 This function builds the search title table
1258 <BR>
1259
1260 <DL>
1261 <DT class="font10bold">Function Parameters:</DT>
1262
1263
1264 <DT class="font10bold">Function Info:</DT>
1265
1266 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
1267
1268 </DL>
1269
1270 </DIV>
1271 <BR>
1272
1273 <DIV CLASS="function">
1274 <A NAME='_build_simple_search_form'><!-- --></A>
1275 <SPAN CLASS="font12bold">_build_simple_search_form</SPAN>
1276 <BR>
1277 <SPAN CLASS="font10bold">Useage : </SPAN>
1278 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></SPAN>&nbsp;
1279 <span class="font10bold" style="color: #0000FF">_build_simple_search_form ( )</SPAN>
1280 <BR>
1281
1282 <BR>
1283 <SPAN CLASS="font10bold">Description : </SPAN>
1284 <!-- ========== Info from phpDoc block ========= -->
1285 This function builds the simple search TD
1286 <BR>
1287
1288 <DL>
1289 <DT class="font10bold">Function Parameters:</DT>
1290
1291
1292 <DT class="font10bold">Function Info:</DT>
1293
1294 </DL>
1295
1296 </DIV>
1297 <BR>
1298
1299
1300 <hr>
1301 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed