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