1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<head> |
<head> |
5 |
<!-- template designed by Marco Von Ballmoos --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<title>Docs For Class DefaultGUIDatalist</title> |
<title>Docs For Class DefaultGUIDatalist</title> |
7 |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
</head> |
</head> |
10 |
<body> |
<body> |
11 |
<div class="page-body"> |
<div class="page-body"> |
12 |
<h2 class="class-name">Class DefaultGUIDatalist</h2> |
<h2 class="class-name">Class DefaultGUIDatalist</h2> |
13 |
|
|
14 |
<a name="sec-description"></a> |
<a name="sec-description"></a> |
15 |
<div class="info-box"> |
<div class="info-box"> |
16 |
<div class="info-box-title">Description</div> |
<div class="info-box-title">Description</div> |
17 |
<div class="nav-bar"> |
<div class="nav-bar"> |
18 |
<span class="disabled">Description</span> | |
<span class="disabled">Description</span> | |
19 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
20 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
21 |
|
|
22 |
</div> |
</div> |
23 |
<div class="info-box-body"> |
<div class="info-box-body"> |
24 |
<!-- ========== Info from phpDoc block ========= --> |
<!-- ========== Info from phpDoc block ========= --> |
25 |
<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> |
<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 |
<p class="description"><p>You can use this as an example of how to build your own look/feel for your DataList.</p></p> |
<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 |
<ul class="tags"> |
<ul class="tags"> |
28 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
29 |
</ul> |
</ul> |
30 |
<p class="notes"> |
<p class="notes"> |
31 |
Located in <a class="field" href="_widgets_data_list_DefaultGUIDataList_inc.html">Program_Root/widgets/data_list/DefaultGUIDataList.inc</a> (line <span class="field">28</span>) |
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 |
</p> |
</p> |
33 |
|
|
34 |
|
|
35 |
<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 |
| |
| |
|
--DefaultGUIDatalist</pre> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
|
|
|
<a name="sec-var-summary"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Variable Summary</span></div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
|
|
| |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<div class="var-summary"> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_action_column" title="details" class="var-name">$_action_column</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_action_count" title="details" class="var-name">$_action_count</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_align" title="details" class="var-name">$_align</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_allow_select_all" title="details" class="var-name">$_allow_select_all</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_cur_col_cntr" title="details" class="var-name">$_cur_col_cntr</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_default_checked_items" title="details" class="var-name">$_default_checked_items</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_hidden_checkbox_items" title="details" class="var-name">$_hidden_checkbox_items</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_search_text" title="details" class="var-name">$_search_text</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_show_actionbar" title="details" class="var-name">$_show_actionbar</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$_visible_checkbox_items" title="details" class="var-name">$_visible_checkbox_items</a> |
|
|
</div> |
|
|
<div class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<a href="#$__page_info" title="details" class="var-name">$__page_info</a> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-method-summary"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Method Summary</span></div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
|
|
|
|
| |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<div class="method-summary"> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
|
|
<a href="#actionbar_cell" title="details" class="method-name">actionbar_cell</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
|
|
<a href="#action_button" title="details" class="method-name">action_button</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$action</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#add_action_column" title="details" class="method-name">add_action_column</a> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#allow_select_all" title="details" class="method-name">allow_select_all</a> |
|
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">mixed</span> |
|
|
<a href="#build_column_header" title="details" class="method-name">build_column_header</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
|
|
<a href="#build_gui" title="details" class="method-name">build_gui</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
|
|
<a href="#child_build_search_table" title="details" class="method-name">child_build_search_table</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">array</span> |
|
|
<a href="#get_default_checked_items" title="details" class="method-name">get_default_checked_items</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#is_action_checked" title="details" class="method-name">is_action_checked</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#is_action_enabled" title="details" class="method-name">is_action_enabled</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#save_checked_items" title="details" class="method-name">save_checked_items</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_actionbar" title="details" class="method-name">set_actionbar</a> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_align" title="details" class="method-name">set_align</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_default_checked_items" title="details" class="method-name">set_default_checked_items</a> |
|
|
(<span class="var-type">array</span> <span class="var-name">$items</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">void</span> |
|
|
<a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#show_actionbar" title="details" class="method-name">show_actionbar</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
|
|
<a href="#wrap_column_item" title="details" class="method-name">wrap_column_item</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
|
|
<a href="#_build_actionbar" title="details" class="method-name">_build_actionbar</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
|
|
<a href="#_build_actionbar_arrow_cell" title="details" class="method-name">_build_actionbar_arrow_cell</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">TDtag;</span> |
|
|
<a href="#_build_actionbar_data_cell" title="details" class="method-name">_build_actionbar_data_cell</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">HTMLTag</span> |
|
|
<a href="#_build_action_column" title="details" class="method-name">_build_action_column</a> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
|
|
<a href="#_build_search_title" title="details" class="method-name">_build_search_title</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
|
|
<a href="#_build_simple_search_form" title="details" class="method-name">_build_simple_search_form</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
|
|
<a href="#_checkbox_javascript" title="details" class="method-name">_checkbox_javascript</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#_has_action_column" title="details" class="method-name">_has_action_column</a> |
|
|
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean.</span> |
|
|
<a href="#_is_col_checked" title="details" class="method-name">_is_col_checked</a> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">mixed</span> |
|
|
<a href="#_javascript" title="details" class="method-name">_javascript</a> |
|
|
() |
|
|
</div> |
|
|
|
|
|
<div class="method-definition"> |
|
|
<span class="method-result">boolean</span> |
|
|
<a href="#_save_checked_items_enabled" title="details" class="method-name">_save_checked_items_enabled</a> |
|
|
() |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-vars"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Variables</div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
|
|
|
|
|
|
|
|
| |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<a name="var$_action_column" id="$_action_column"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_action_column</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">42</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This holds the action column settings if any.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_action_count" id="$_action_count"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_action_count</span> |
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">48</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">holds the cntr for the action</p> |
|
|
<p class="description"><p>checkbox name</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_align" id="$_align"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_align</span> |
|
|
= <span class="var-default"> "center"</span> (line <span class="line-number">36</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">The overall alignment</p> |
|
|
<p class="description"><p>DEFAULT: "center"</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_allow_select_all" id="$_allow_select_all"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_allow_select_all</span> |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">86</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This variable tells us whether to display</p> |
|
|
<p class="description"><p>select all checkbox</p></p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_cur_col_cntr" id="$_cur_col_cntr"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_cur_col_cntr</span> |
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">107</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_default_checked_items" id="$_default_checked_items"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_default_checked_items</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">74</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This variable holds the array of default</p> |
|
|
<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> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_hidden_checkbox_items" id="$_hidden_checkbox_items"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_hidden_checkbox_items</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">55</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This array holds the list of hidden checkbox[] items.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_search_text" id="$_search_text"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_search_text</span> |
|
|
= <span class="var-default">array("title" => "Search",<br /> "find" => "Find",<br /> "button" => "Search")</span> (line <span class="line-number">96</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this array holds some strings for the search functionality. This enables some level of localization for other languages.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_show_actionbar" id="$_show_actionbar"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_show_actionbar</span> |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">80</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Do we show action bar row?</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$_visible_checkbox_items" id="$_visible_checkbox_items"><!-- --></A> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$_visible_checkbox_items</span> |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">63</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="var$__page_info" id="$__page_info"><!-- --></A> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="var-header"> |
|
|
<span class="var-title"> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$__page_info</span> |
|
|
= <span class="var-default"> ""</span> (line <span class="line-number">104</span>) |
|
|
</span> |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">for a reference so the row_filter affects the paging information.</p> |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<h4>Inherited Variables</h4> |
|
|
<A NAME='inherited_vars'><!-- --></A> |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
|
|
<blockquote> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></span><br> |
|
|
</span> |
|
|
</blockquote> |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
|
|
<blockquote> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
|
|
</span> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
|
|
</span> |
|
|
</blockquote> |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
|
|
<blockquote> |
|
|
<span class="var-title"> |
|
|
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
|
|
</span> |
|
|
</blockquote> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<a name="sec-methods"></a> |
|
|
<div class="info-box"> |
|
|
<div class="info-box-title">Methods</div> |
|
|
<div class="nav-bar"> |
|
|
<a href="#sec-description">Description</a> | |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
|
|
|
|
|
</div> |
|
|
<div class="info-box-body"> |
|
|
<A NAME='method_detail'></A> |
|
|
<a name="methodactionbar_cell" id="actionbar_cell"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">actionbar_cell</span> (line <span class="line-number">863</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this is the method that builds the contents for the middle actionbar td cell.</p> |
|
|
<p class="description"><p>NOTE this function is meant to be overriden by the child class.</p></p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
|
|
<span class="method-name"> |
|
|
actionbar_cell |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodaction_button" id="action_button"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">action_button</span> (line <span class="line-number">876</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
|
|
<span class="method-name"> |
|
|
action_button |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$action</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$name</span><span class="var-description">: <p>- the button name</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$action</span><span class="var-description">: <p>- the script that gets called.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodadd_action_column" id="add_action_column"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">add_action_column</span> (line <span class="line-number">503</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function adds an action column. This adds a column of either checkboxes or radio buttons.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
add_action_column |
|
|
</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>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$type</span><span class="var-description">: <p>- type of column 'checkbox' or 'radio'</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col</span><span class="var-description">: <p>- which column it lives in 'FIRST' or 'LAST'</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$db_field</span><span class="var-description">: <p>- which db field is associated with this.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$title</span><span class="var-description">: <p>- 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.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodallow_select_all" id="allow_select_all"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">allow_select_all</span> (line <span class="line-number">597</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">Sets the flag for rendering the select all checkbox</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
allow_select_all |
|
|
</span> |
|
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">bool</span> |
|
|
<span class="var-name">$flag</span><span class="var-description">: <p>flag</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_column_header" id="build_column_header"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_column_header</span> (line <span class="line-number">291</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the object/text</p> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>- either an Atag object or raw text.</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">mixed</span> |
|
|
<span class="method-name"> |
|
|
build_column_header |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- the column name to build from the headers.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$col_data</span><span class="var-description">: <p>- the column's data.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">$col_num</span><span class="var-description">: <p>the column # we are working on.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodbuild_gui" id="build_gui"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">build_gui</span> (line <span class="line-number">264</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
|
|
<span class="method-name"> |
|
|
build_gui |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></dt> |
|
|
<dd>This function is responsible for calling the child class's methods for building the GUI container.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">219</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
child_add_row_cell |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></dt> |
|
|
<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> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_build_column_header</span> (line <span class="line-number">186</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
child_build_column_header |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></dt> |
|
|
<dd>This method is supposed to be written by the child class to build and add the column title to the UI</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_build_search_table</span> (line <span class="line-number">391</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds the table that holds the search capability.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object.</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
|
|
<span class="method-name"> |
|
|
child_build_search_table |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></dt> |
|
|
<dd>This function builds the search block that lives above the results</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">child_get_gui</span> (line <span class="line-number">270</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
child_get_gui |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></dt> |
|
|
<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> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodget_default_checked_items" id="get_default_checked_items"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">get_default_checked_items</span> (line <span class="line-number">529</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns the array of default checked items to be marked as checked in the checkbox action column</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">array</span> |
|
|
<span class="method-name"> |
|
|
get_default_checked_items |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodgui_init" id="gui_init"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">gui_init</span> (line <span class="line-number">125</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
gui_init |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></dt> |
|
|
<dd>A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodis_action_checked" id="is_action_checked"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">is_action_checked</span> (line <span class="line-number">734</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is provided to give the child class the ability to precheck/select a particular column.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
is_action_checked |
|
|
</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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$value</span><span class="var-description">: <p>- the item to look for.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodis_action_enabled" id="is_action_enabled"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">is_action_enabled</span> (line <span class="line-number">747</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is provided to give the child class the ability to enable/disable a particular checkbox.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
is_action_enabled |
|
|
</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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$value</span><span class="var-description">: <p>- the item to look for.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodsave_checked_items" id="save_checked_items"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">save_checked_items</span> (line <span class="line-number">538</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">set the flag to tell the object to</p> |
|
|
<p class="description"><p>save the checked items</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
save_checked_items |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_actionbar" id="set_actionbar"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_actionbar</span> (line <span class="line-number">578</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This allows the caller to turn on/off the rendering of the bottom action bar row</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_actionbar |
|
|
</span> |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$flag</span><span class="var-description">: <p>- TRUE = on FALSE = off</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_align" id="set_align"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_align</span> (line <span class="line-number">182</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">this function is used to set the overall alignment of the widget</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_align |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$align</span><span class="var-description">: <p>- the align value</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></dt> |
|
|
<dd>This function sets the align attribute for the outer table.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodset_default_checked_items" id="set_default_checked_items"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_default_checked_items</span> (line <span class="line-number">518</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function is used to set the default list</p> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_default_checked_items |
|
|
</span> |
|
|
(<span class="var-type">array</span> <span class="var-name">$items</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$items</span><span class="var-description">: <p>- the array of checked items</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">set_global_prefix</span> (line <span class="line-number">118</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<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> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">void</span> |
|
|
<span class="method-name"> |
|
|
set_global_prefix |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$prefix</span><span class="var-description">: <p>- the prefix for all vars.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></dt> |
|
|
<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> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="methodshow_actionbar" id="show_actionbar"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">show_actionbar</span> (line <span class="line-number">588</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function gets the current value of the show actionbar flag setting.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
show_actionbar |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="methodwrap_column_item" id="wrap_column_item"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">wrap_column_item</span> (line <span class="line-number">354</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function ensures that the data we place in a column is aligned according to what the user wants.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
|
|
<span class="method-name"> |
|
|
wrap_column_item |
|
|
</span> |
|
|
(<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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">2</span><span class="var-description">: <p>- $odd_row - tells us if this cell lives in an odd # row (for alternating row colors)</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">int</span> |
|
|
<span class="var-name">3</span><span class="var-description">: <p>- the column # we are working on.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">mixed</span> |
|
|
<span class="var-name">$obj</span><span class="var-description">: <p>- $obj - the data for the td.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col_name</span><span class="var-description">: <p>- $col_name - the name of the column header for this row to render.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_actionbar" id="_build_actionbar"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_actionbar</span> (line <span class="line-number">757</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function renders the action bar at the bottom of the data list.</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
|
|
<span class="method-name"> |
|
|
_build_actionbar |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_actionbar_arrow_cell" id="_build_actionbar_arrow_cell"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_actionbar_arrow_cell</span> (line <span class="line-number">793</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds a TD with the appropriate action arrow.</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
|
|
<span class="method-name"> |
|
|
_build_actionbar_arrow_cell |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col</span><span class="var-description">: <p>- FIRST or LAST</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_actionbar_data_cell" id="_build_actionbar_data_cell"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_actionbar_data_cell</span> (line <span class="line-number">828</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the user's data cell</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">TDtag;</span> |
|
|
<span class="method-name"> |
|
|
_build_actionbar_data_cell |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_action_column" id="_build_action_column"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_action_column</span> (line <span class="line-number">612</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This builds an action column cell</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">HTMLTag</span> |
|
|
<span class="method-name"> |
|
|
_build_action_column |
|
|
</span> |
|
|
(<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>]) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col</span><span class="var-description">: <p>- the column to test for FIRST or LAST</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">boolean</span> |
|
|
<span class="var-name">$header_flag</span><span class="var-description">: <p>- lets us know this is for the header or a cell.</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_search_title" id="_build_search_title"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_search_title</span> (line <span class="line-number">423</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the search title table</p> |
|
|
<ul class="tags"> |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
|
|
</ul> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
|
|
<span class="method-name"> |
|
|
_build_search_title |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_build_simple_search_form" id="_build_simple_search_form"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_build_simple_search_form</span> (line <span class="line-number">441</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the simple search TD</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
|
|
<span class="method-name"> |
|
|
_build_simple_search_form |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_checkbox_javascript" id="_checkbox_javascript"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_checkbox_javascript</span> (line <span class="line-number">916</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function builds the JS needed for the checkbox action column</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
|
|
<span class="method-name"> |
|
|
_checkbox_javascript |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_has_action_column" id="_has_action_column"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_has_action_column</span> (line <span class="line-number">562</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function tests to see if the child wants to render an action column</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
_has_action_column |
|
|
</span> |
|
|
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$col</span><span class="var-description">: <p>- the column to test for FIRST or LAST</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_is_col_checked" id="_is_col_checked"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_is_col_checked</span> (line <span class="line-number">703</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This method checks to see if a particular row has been checked in the action column</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean.</span> |
|
|
<span class="method-name"> |
|
|
_is_col_checked |
|
|
</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>) |
|
|
</div> |
|
|
|
|
|
<ul class="parameters"> |
|
|
<li> |
|
|
<span class="var-type">string</span> |
|
|
<span class="var-name">$value</span><span class="var-description">: <p>- the item to look for</p></span> </li> |
|
|
<li> |
|
|
<span class="var-type">array</span> |
|
|
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
|
|
</ul> |
|
|
|
|
|
|
|
|
</div> |
|
|
<a name="method_javascript" id="_javascript"><!-- --></a> |
|
|
<div class="oddrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_javascript</span> (line <span class="line-number">897</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This function returns any Javascript required for this widget</p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">mixed</span> |
|
|
<span class="method-name"> |
|
|
_javascript |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
<hr class="separator" /> |
|
|
<div class="notes">Redefinition of:</div> |
|
|
<dl> |
|
|
<dt><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></dt> |
|
|
<dd>This function provides a way to automatically add javascript to this object.</dd> |
|
|
</dl> |
|
|
|
|
|
</div> |
|
|
<a name="method_save_checked_items_enabled" id="_save_checked_items_enabled"><!-- --></a> |
|
|
<div class="evenrow"> |
|
|
|
|
|
<div class="method-header"> |
|
|
<span class="method-title">_save_checked_items_enabled</span> (line <span class="line-number">550</span>) |
|
|
</div> |
|
|
|
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
<p class="short-description">This tests the object flag to</p> |
|
|
<p class="description"><p>see if the child class wants to automatically save the checked items</p></p> |
|
|
|
|
|
<div class="method-signature"> |
|
|
<span class="method-result">boolean</span> |
|
|
<span class="method-name"> |
|
|
_save_checked_items_enabled |
|
|
</span> |
|
|
() |
|
|
</div> |
|
|
|
|
|
|
|
|
|
|
|
</div> |
|
|
<h4>Inherited Methods</h4> |
|
|
<a name='inherited_methods'><!-- --></a> |
|
|
<!-- =========== Summary =========== --> |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
|
|
<blockquote> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddo_action">DataList::do_action()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodshowall">DataList::showall()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></span><br> |
|
|
</blockquote> |
|
|
<!-- =========== Summary =========== --> |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
|
|
<blockquote> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
|
|
</blockquote> |
|
|
<!-- =========== Summary =========== --> |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
|
|
<blockquote> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
|
|
</blockquote> |
|
|
|
|
|
</div> |
|
|
</div> |
|
|
|
|
|
<p class="notes" id="credit"> |
|
|
Documention generated on Thu, 31 Jul 2003 18:32:24 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
|
|
</p> |
|
|
</div></body> |
|
|
</html> |
|
41 |
|
--DefaultGUIDatalist</pre> |
42 |
|
|
43 |
|
</div> |
44 |
|
</div> |
45 |
|
|
46 |
|
|
47 |
|
|
48 |
|
<a name="sec-var-summary"></a> |
49 |
|
<div class="info-box"> |
50 |
|
<div class="info-box-title">Variable Summary</span></div> |
51 |
|
<div class="nav-bar"> |
52 |
|
<a href="#sec-description">Description</a> | |
53 |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
54 |
|
| |
55 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
56 |
|
|
57 |
|
</div> |
58 |
|
<div class="info-box-body"> |
59 |
|
<div class="var-summary"> |
60 |
|
<div class="var-title"> |
61 |
|
<span class="var-type">mixed</span> |
62 |
|
<a href="#$_action_column" title="details" class="var-name">$_action_column</a> |
63 |
|
</div> |
64 |
|
<div class="var-title"> |
65 |
|
<span class="var-type">mixed</span> |
66 |
|
<a href="#$_action_count" title="details" class="var-name">$_action_count</a> |
67 |
|
</div> |
68 |
|
<div class="var-title"> |
69 |
|
<span class="var-type">mixed</span> |
70 |
|
<a href="#$_align" title="details" class="var-name">$_align</a> |
71 |
|
</div> |
72 |
|
<div class="var-title"> |
73 |
|
<span class="var-type">mixed</span> |
74 |
|
<a href="#$_allow_select_all" title="details" class="var-name">$_allow_select_all</a> |
75 |
|
</div> |
76 |
|
<div class="var-title"> |
77 |
|
<span class="var-type">mixed</span> |
78 |
|
<a href="#$_collapsable_search" title="details" class="var-name">$_collapsable_search</a> |
79 |
|
</div> |
80 |
|
<div class="var-title"> |
81 |
|
<span class="var-type">mixed</span> |
82 |
|
<a href="#$_cur_col_cntr" title="details" class="var-name">$_cur_col_cntr</a> |
83 |
|
</div> |
84 |
|
<div class="var-title"> |
85 |
|
<span class="var-type">mixed</span> |
86 |
|
<a href="#$_default_checked_items" title="details" class="var-name">$_default_checked_items</a> |
87 |
|
</div> |
88 |
|
<div class="var-title"> |
89 |
|
<span class="var-type">mixed</span> |
90 |
|
<a href="#$_hidden_checkbox_items" title="details" class="var-name">$_hidden_checkbox_items</a> |
91 |
|
</div> |
92 |
|
<div class="var-title"> |
93 |
|
<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 |
|
<div class="var-title"> |
97 |
|
<span class="var-type">mixed</span> |
98 |
|
<a href="#$_search_text" title="details" class="var-name">$_search_text</a> |
99 |
|
</div> |
100 |
|
<div class="var-title"> |
101 |
|
<span class="var-type">mixed</span> |
102 |
|
<a href="#$_search_tree_open" title="details" class="var-name">$_search_tree_open</a> |
103 |
|
</div> |
104 |
|
<div class="var-title"> |
105 |
|
<span class="var-type">mixed</span> |
106 |
|
<a href="#$_show_actionbar" title="details" class="var-name">$_show_actionbar</a> |
107 |
|
</div> |
108 |
|
<div class="var-title"> |
109 |
|
<span class="var-type">mixed</span> |
110 |
|
<a href="#$_visible_checkbox_items" title="details" class="var-name">$_visible_checkbox_items</a> |
111 |
|
</div> |
112 |
|
<div class="var-title"> |
113 |
|
<span class="var-type">mixed</span> |
114 |
|
<a href="#$__page_info" title="details" class="var-name">$__page_info</a> |
115 |
|
</div> |
116 |
|
</div> |
117 |
|
</div> |
118 |
|
</div> |
119 |
|
|
120 |
|
<a name="sec-method-summary"></a> |
121 |
|
<div class="info-box"> |
122 |
|
<div class="info-box-title">Method Summary</span></div> |
123 |
|
<div class="nav-bar"> |
124 |
|
<a href="#sec-description">Description</a> | |
125 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
126 |
|
|
127 |
|
| |
128 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
129 |
|
</div> |
130 |
|
<div class="info-box-body"> |
131 |
|
<div class="method-summary"> |
132 |
|
|
133 |
|
<div class="method-definition"> |
134 |
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
135 |
|
<a href="#actionbar_cell" title="details" class="method-name">actionbar_cell</a> |
136 |
|
() |
137 |
|
</div> |
138 |
|
|
139 |
|
<div class="method-definition"> |
140 |
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
141 |
|
<a href="#action_button" title="details" class="method-name">action_button</a> |
142 |
|
(<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 |
|
</div> |
144 |
|
|
145 |
|
<div class="method-definition"> |
146 |
|
<span class="method-result">void</span> |
147 |
|
<a href="#add_action_column" title="details" class="method-name">add_action_column</a> |
148 |
|
(<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 |
|
</div> |
150 |
|
|
151 |
|
<div class="method-definition"> |
152 |
|
<span class="method-result">void</span> |
153 |
|
<a href="#allow_select_all" title="details" class="method-name">allow_select_all</a> |
154 |
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
155 |
|
</div> |
156 |
|
|
157 |
|
<div class="method-definition"> |
158 |
|
<span class="method-result">mixed</span> |
159 |
|
<a href="#build_column_header" title="details" class="method-name">build_column_header</a> |
160 |
|
(<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 |
|
</div> |
162 |
|
|
163 |
|
<div class="method-definition"> |
164 |
|
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
165 |
|
<a href="#build_gui" title="details" class="method-name">build_gui</a> |
166 |
|
() |
167 |
|
</div> |
168 |
|
|
169 |
|
<div class="method-definition"> |
170 |
|
<span class="method-result">void</span> |
171 |
|
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
172 |
|
(<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 |
|
</div> |
174 |
|
|
175 |
|
<div class="method-definition"> |
176 |
|
<span class="method-result">void</span> |
177 |
|
<a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a> |
178 |
|
(<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 |
|
</div> |
180 |
|
|
181 |
|
<div class="method-definition"> |
182 |
|
<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 |
|
() |
185 |
|
</div> |
186 |
|
|
187 |
|
<div class="method-definition"> |
188 |
|
<span class="method-result">void</span> |
189 |
|
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
190 |
|
() |
191 |
|
</div> |
192 |
|
|
193 |
|
<div class="method-definition"> |
194 |
|
<span class="method-result">array</span> |
195 |
|
<a href="#get_default_checked_items" title="details" class="method-name">get_default_checked_items</a> |
196 |
|
() |
197 |
|
</div> |
198 |
|
|
199 |
|
<div class="method-definition"> |
200 |
|
<span class="method-result">void</span> |
201 |
|
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
202 |
|
() |
203 |
|
</div> |
204 |
|
|
205 |
|
<div class="method-definition"> |
206 |
|
<span class="method-result">boolean</span> |
207 |
|
<a href="#is_action_checked" title="details" class="method-name">is_action_checked</a> |
208 |
|
(<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 |
|
</div> |
210 |
|
|
211 |
|
<div class="method-definition"> |
212 |
|
<span class="method-result">boolean</span> |
213 |
|
<a href="#is_action_enabled" title="details" class="method-name">is_action_enabled</a> |
214 |
|
(<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 |
|
</div> |
216 |
|
|
217 |
|
<div class="method-definition"> |
218 |
|
<span class="method-result">void</span> |
219 |
|
<a href="#save_checked_items" title="details" class="method-name">save_checked_items</a> |
220 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
221 |
|
</div> |
222 |
|
|
223 |
|
<div class="method-definition"> |
224 |
|
<span class="method-result">void</span> |
225 |
|
<a href="#set_actionbar" title="details" class="method-name">set_actionbar</a> |
226 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
227 |
|
</div> |
228 |
|
|
229 |
|
<div class="method-definition"> |
230 |
|
<span class="method-result">void</span> |
231 |
|
<a href="#set_align" title="details" class="method-name">set_align</a> |
232 |
|
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
233 |
|
</div> |
234 |
|
|
235 |
|
<div class="method-definition"> |
236 |
|
<span class="method-result">void</span> |
237 |
|
<a href="#set_default_checked_items" title="details" class="method-name">set_default_checked_items</a> |
238 |
|
(<span class="var-type">array</span> <span class="var-name">$items</span>) |
239 |
|
</div> |
240 |
|
|
241 |
|
<div class="method-definition"> |
242 |
|
<span class="method-result">void</span> |
243 |
|
<a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a> |
244 |
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
245 |
|
</div> |
246 |
|
|
247 |
|
<div class="method-definition"> |
248 |
|
<span class="method-result">void</span> |
249 |
|
<a href="#set_search_collapse" title="details" class="method-name">set_search_collapse</a> |
250 |
|
([<span class="var-type">bool</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
251 |
|
</div> |
252 |
|
|
253 |
|
<div class="method-definition"> |
254 |
|
<span class="method-result">boolean</span> |
255 |
|
<a href="#show_actionbar" title="details" class="method-name">show_actionbar</a> |
256 |
|
() |
257 |
|
</div> |
258 |
|
|
259 |
|
<div class="method-definition"> |
260 |
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
261 |
|
<a href="#wrap_column_item" title="details" class="method-name">wrap_column_item</a> |
262 |
|
(<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 |
|
</div> |
264 |
|
|
265 |
|
<div class="method-definition"> |
266 |
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
267 |
|
<a href="#_build_actionbar" title="details" class="method-name">_build_actionbar</a> |
268 |
|
() |
269 |
|
</div> |
270 |
|
|
271 |
|
<div class="method-definition"> |
272 |
|
<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 |
|
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
275 |
|
</div> |
276 |
|
|
277 |
|
<div class="method-definition"> |
278 |
|
<span class="method-result">TDtag;</span> |
279 |
|
<a href="#_build_actionbar_data_cell" title="details" class="method-name">_build_actionbar_data_cell</a> |
280 |
|
() |
281 |
|
</div> |
282 |
|
|
283 |
|
<div class="method-definition"> |
284 |
|
<span class="method-result">HTMLTag</span> |
285 |
|
<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 |
|
</div> |
288 |
|
|
289 |
|
<div class="method-definition"> |
290 |
|
<span class="method-result">void</span> |
291 |
|
<a href="#_build_default_vars" title="details" class="method-name">_build_default_vars</a> |
292 |
|
() |
293 |
|
</div> |
294 |
|
|
295 |
|
<div class="method-definition"> |
296 |
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
297 |
|
<a href="#_build_search_title" title="details" class="method-name">_build_search_title</a> |
298 |
|
() |
299 |
|
</div> |
300 |
|
|
301 |
|
<div class="method-definition"> |
302 |
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
303 |
|
<a href="#_build_simple_search_form" title="details" class="method-name">_build_simple_search_form</a> |
304 |
|
() |
305 |
|
</div> |
306 |
|
|
307 |
|
<div class="method-definition"> |
308 |
|
<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 |
|
() |
311 |
|
</div> |
312 |
|
|
313 |
|
<div class="method-definition"> |
314 |
|
<span class="method-result">boolean</span> |
315 |
|
<a href="#_has_action_column" title="details" class="method-name">_has_action_column</a> |
316 |
|
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
317 |
|
</div> |
318 |
|
|
319 |
|
<div class="method-definition"> |
320 |
|
<span class="method-result">boolean.</span> |
321 |
|
<a href="#_is_col_checked" title="details" class="method-name">_is_col_checked</a> |
322 |
|
(<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 |
|
</div> |
324 |
|
|
325 |
|
<div class="method-definition"> |
326 |
|
<span class="method-result">mixed</span> |
327 |
|
<a href="#_javascript" title="details" class="method-name">_javascript</a> |
328 |
|
() |
329 |
|
</div> |
330 |
|
|
331 |
|
<div class="method-definition"> |
332 |
|
<span class="method-result">boolean</span> |
333 |
|
<a href="#_save_checked_items_enabled" title="details" class="method-name">_save_checked_items_enabled</a> |
334 |
|
() |
335 |
|
</div> |
336 |
|
|
337 |
|
<div class="method-definition"> |
338 |
|
<span class="method-result">string</span> |
339 |
|
<a href="#_search_javascript" title="details" class="method-name">_search_javascript</a> |
340 |
|
() |
341 |
|
</div> |
342 |
|
</div> |
343 |
|
</div> |
344 |
|
</div> |
345 |
|
|
346 |
|
<a name="sec-vars"></a> |
347 |
|
<div class="info-box"> |
348 |
|
<div class="info-box-title">Variables</div> |
349 |
|
<div class="nav-bar"> |
350 |
|
<a href="#sec-description">Description</a> | |
351 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
352 |
|
|
353 |
|
|
354 |
|
| |
355 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
356 |
|
|
357 |
|
</div> |
358 |
|
<div class="info-box-body"> |
359 |
|
<a name="var$_action_column" id="$_action_column"><!-- --></A> |
360 |
|
<div class="evenrow"> |
361 |
|
|
362 |
|
<div class="var-header"> |
363 |
|
<span class="var-title"> |
364 |
|
<span class="var-type">mixed</span> |
365 |
|
<span class="var-name">$_action_column</span> |
366 |
|
= <span class="var-default">array()</span> (line <span class="line-number">42</span>) |
367 |
|
</span> |
368 |
|
</div> |
369 |
|
|
370 |
|
<!-- ========== Info from phpDoc block ========= --> |
371 |
|
<p class="short-description">This holds the action column settings if any.</p> |
372 |
|
|
373 |
|
|
374 |
|
|
375 |
|
|
376 |
|
|
377 |
|
</div> |
378 |
|
<a name="var$_action_count" id="$_action_count"><!-- --></A> |
379 |
|
<div class="oddrow"> |
380 |
|
|
381 |
|
<div class="var-header"> |
382 |
|
<span class="var-title"> |
383 |
|
<span class="var-type">mixed</span> |
384 |
|
<span class="var-name">$_action_count</span> |
385 |
|
= <span class="var-default"> 0</span> (line <span class="line-number">48</span>) |
386 |
|
</span> |
387 |
|
</div> |
388 |
|
|
389 |
|
<!-- ========== Info from phpDoc block ========= --> |
390 |
|
<p class="short-description">holds the cntr for the action</p> |
391 |
|
<p class="description"><p>checkbox name</p></p> |
392 |
|
|
393 |
|
|
394 |
|
|
395 |
|
|
396 |
|
|
397 |
|
</div> |
398 |
|
<a name="var$_align" id="$_align"><!-- --></A> |
399 |
|
<div class="evenrow"> |
400 |
|
|
401 |
|
<div class="var-header"> |
402 |
|
<span class="var-title"> |
403 |
|
<span class="var-type">mixed</span> |
404 |
|
<span class="var-name">$_align</span> |
405 |
|
= <span class="var-default"> "center"</span> (line <span class="line-number">36</span>) |
406 |
|
</span> |
407 |
|
</div> |
408 |
|
|
409 |
|
<!-- ========== Info from phpDoc block ========= --> |
410 |
|
<p class="short-description">The overall alignment</p> |
411 |
|
<p class="description"><p>DEFAULT: "center"</p></p> |
412 |
|
|
413 |
|
|
414 |
|
|
415 |
|
|
416 |
|
|
417 |
|
</div> |
418 |
|
<a name="var$_allow_select_all" id="$_allow_select_all"><!-- --></A> |
419 |
|
<div class="oddrow"> |
420 |
|
|
421 |
|
<div class="var-header"> |
422 |
|
<span class="var-title"> |
423 |
|
<span class="var-type">mixed</span> |
424 |
|
<span class="var-name">$_allow_select_all</span> |
425 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">92</span>) |
426 |
|
</span> |
427 |
|
</div> |
428 |
|
|
429 |
|
<!-- ========== Info from phpDoc block ========= --> |
430 |
|
<p class="short-description">This variable tells us whether to display</p> |
431 |
|
<p class="description"><p>select all checkbox</p></p> |
432 |
|
|
433 |
|
|
434 |
|
|
435 |
|
|
436 |
|
|
437 |
|
</div> |
438 |
|
<a name="var$_collapsable_search" id="$_collapsable_search"><!-- --></A> |
439 |
|
<div class="evenrow"> |
440 |
|
|
441 |
|
<div class="var-header"> |
442 |
|
<span class="var-title"> |
443 |
|
<span class="var-type">mixed</span> |
444 |
|
<span class="var-name">$_collapsable_search</span> |
445 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">114</span>) |
446 |
|
</span> |
447 |
|
</div> |
448 |
|
|
449 |
|
<!-- ========== Info from phpDoc block ========= --> |
450 |
|
<p class="short-description">If true, allows search block to be collapsed/expanded.</p> |
451 |
|
<p class="description"><p>NOTE: This doesn't stay collapsed between pages, when using GET as the form method.</p></p> |
452 |
|
|
453 |
|
|
454 |
|
|
455 |
|
|
456 |
|
|
457 |
|
</div> |
458 |
|
<a name="var$_cur_col_cntr" id="$_cur_col_cntr"><!-- --></A> |
459 |
|
<div class="oddrow"> |
460 |
|
|
461 |
|
<div class="var-header"> |
462 |
|
<span class="var-title"> |
463 |
|
<span class="var-type">mixed</span> |
464 |
|
<span class="var-name">$_cur_col_cntr</span> |
465 |
|
= <span class="var-default"> 0</span> (line <span class="line-number">129</span>) |
466 |
|
</span> |
467 |
|
</div> |
468 |
|
|
469 |
|
<!-- ========== Info from phpDoc block ========= --> |
470 |
|
|
471 |
|
|
472 |
|
|
473 |
|
|
474 |
|
|
475 |
|
</div> |
476 |
|
<a name="var$_default_checked_items" id="$_default_checked_items"><!-- --></A> |
477 |
|
<div class="evenrow"> |
478 |
|
|
479 |
|
<div class="var-header"> |
480 |
|
<span class="var-title"> |
481 |
|
<span class="var-type">mixed</span> |
482 |
|
<span class="var-name">$_default_checked_items</span> |
483 |
|
= <span class="var-default">array()</span> (line <span class="line-number">80</span>) |
484 |
|
</span> |
485 |
|
</div> |
486 |
|
|
487 |
|
<!-- ========== Info from phpDoc block ========= --> |
488 |
|
<p class="short-description">This variable holds the array of default</p> |
489 |
|
<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 |
|
|
491 |
|
|
492 |
|
|
493 |
|
|
494 |
|
|
495 |
|
</div> |
496 |
|
<a name="var$_hidden_checkbox_items" id="$_hidden_checkbox_items"><!-- --></A> |
497 |
|
<div class="oddrow"> |
498 |
|
|
499 |
|
<div class="var-header"> |
500 |
|
<span class="var-title"> |
501 |
|
<span class="var-type">mixed</span> |
502 |
|
<span class="var-name">$_hidden_checkbox_items</span> |
503 |
|
= <span class="var-default">array()</span> (line <span class="line-number">55</span>) |
504 |
|
</span> |
505 |
|
</div> |
506 |
|
|
507 |
|
<!-- ========== Info from phpDoc block ========= --> |
508 |
|
<p class="short-description">This array holds the list of hidden checkbox[] items.</p> |
509 |
|
|
510 |
|
|
511 |
|
|
512 |
|
|
513 |
|
|
514 |
|
</div> |
515 |
|
<a name="var$_save_checked_items_flag" id="$_save_checked_items_flag"><!-- --></A> |
516 |
|
<div class="evenrow"> |
517 |
|
|
518 |
|
<div class="var-header"> |
519 |
|
<span class="var-title"> |
520 |
|
<span class="var-type">mixed</span> |
521 |
|
<span class="var-name">$_save_checked_items_flag</span> |
522 |
|
= <span class="var-default"> FALSE</span> (line <span class="line-number">70</span>) |
523 |
|
</span> |
524 |
|
</div> |
525 |
|
|
526 |
|
<!-- ========== Info from phpDoc block ========= --> |
527 |
|
<p class="short-description">this flag tells us to save the checked items between pages By default this is off.</p> |
528 |
|
|
529 |
|
|
530 |
|
|
531 |
|
|
532 |
|
|
533 |
|
</div> |
534 |
|
<a name="var$_search_text" id="$_search_text"><!-- --></A> |
535 |
|
<div class="oddrow"> |
536 |
|
|
537 |
|
<div class="var-header"> |
538 |
|
<span class="var-title"> |
539 |
|
<span class="var-type">mixed</span> |
540 |
|
<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 |
|
</span> |
543 |
|
</div> |
544 |
|
|
545 |
|
<!-- ========== Info from phpDoc block ========= --> |
546 |
|
<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 |
|
|
549 |
|
|
550 |
|
|
551 |
|
|
552 |
|
</div> |
553 |
|
<a name="var$_search_tree_open" id="$_search_tree_open"><!-- --></A> |
554 |
|
<div class="evenrow"> |
555 |
|
|
556 |
|
<div class="var-header"> |
557 |
|
<span class="var-title"> |
558 |
|
<span class="var-type">mixed</span> |
559 |
|
<span class="var-name">$_search_tree_open</span> |
560 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">120</span>) |
561 |
|
</span> |
562 |
|
</div> |
563 |
|
|
564 |
|
<!-- ========== Info from phpDoc block ========= --> |
565 |
|
<p class="short-description">Initial state of the search tree</p> |
566 |
|
|
567 |
|
|
568 |
|
|
569 |
|
|
570 |
|
|
571 |
|
</div> |
572 |
|
<a name="var$_show_actionbar" id="$_show_actionbar"><!-- --></A> |
573 |
|
<div class="oddrow"> |
574 |
|
|
575 |
|
<div class="var-header"> |
576 |
|
<span class="var-title"> |
577 |
|
<span class="var-type">mixed</span> |
578 |
|
<span class="var-name">$_show_actionbar</span> |
579 |
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">86</span>) |
580 |
|
</span> |
581 |
|
</div> |
582 |
|
|
583 |
|
<!-- ========== Info from phpDoc block ========= --> |
584 |
|
<p class="short-description">Do we show action bar row?</p> |
585 |
|
|
586 |
|
|
587 |
|
|
588 |
|
|
589 |
|
|
590 |
|
</div> |
591 |
|
<a name="var$_visible_checkbox_items" id="$_visible_checkbox_items"><!-- --></A> |
592 |
|
<div class="evenrow"> |
593 |
|
|
594 |
|
<div class="var-header"> |
595 |
|
<span class="var-title"> |
596 |
|
<span class="var-type">mixed</span> |
597 |
|
<span class="var-name">$_visible_checkbox_items</span> |
598 |
|
= <span class="var-default">array()</span> (line <span class="line-number">63</span>) |
599 |
|
</span> |
600 |
|
</div> |
601 |
|
|
602 |
|
<!-- ========== Info from phpDoc block ========= --> |
603 |
|
<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 |
|
|
605 |
|
|
606 |
|
|
607 |
|
|
608 |
|
|
609 |
|
</div> |
610 |
|
<a name="var$__page_info" id="$__page_info"><!-- --></A> |
611 |
|
<div class="oddrow"> |
612 |
|
|
613 |
|
<div class="var-header"> |
614 |
|
<span class="var-title"> |
615 |
|
<span class="var-type">mixed</span> |
616 |
|
<span class="var-name">$__page_info</span> |
617 |
|
= <span class="var-default"> ""</span> (line <span class="line-number">126</span>) |
618 |
|
</span> |
619 |
|
</div> |
620 |
|
|
621 |
|
<!-- ========== Info from phpDoc block ========= --> |
622 |
|
<p class="short-description">for a reference so the row_filter affects the paging information.</p> |
623 |
|
|
624 |
|
|
625 |
|
|
626 |
|
|
627 |
|
|
628 |
|
</div> |
629 |
|
<h4>Inherited Variables</h4> |
630 |
|
<A NAME='inherited_vars'><!-- --></A> |
631 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
632 |
|
<blockquote> |
633 |
|
<span class="var-title"> |
634 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></span><br> |
635 |
|
</span> |
636 |
|
<span class="var-title"> |
637 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></span><br> |
638 |
|
</span> |
639 |
|
<span class="var-title"> |
640 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></span><br> |
641 |
|
</span> |
642 |
|
<span class="var-title"> |
643 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></span><br> |
644 |
|
</span> |
645 |
|
<span class="var-title"> |
646 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></span><br> |
647 |
|
</span> |
648 |
|
<span class="var-title"> |
649 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></span><br> |
650 |
|
</span> |
651 |
|
<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 |
|
</span> |
654 |
|
<span class="var-title"> |
655 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></span><br> |
656 |
|
</span> |
657 |
|
<span class="var-title"> |
658 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></span><br> |
659 |
|
</span> |
660 |
|
<span class="var-title"> |
661 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></span><br> |
662 |
|
</span> |
663 |
|
<span class="var-title"> |
664 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></span><br> |
665 |
|
</span> |
666 |
|
<span class="var-title"> |
667 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></span><br> |
668 |
|
</span> |
669 |
|
<span class="var-title"> |
670 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></span><br> |
671 |
|
</span> |
672 |
|
<span class="var-title"> |
673 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></span><br> |
674 |
|
</span> |
675 |
|
<span class="var-title"> |
676 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></span><br> |
677 |
|
</span> |
678 |
|
<span class="var-title"> |
679 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></span><br> |
680 |
|
</span> |
681 |
|
<span class="var-title"> |
682 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></span><br> |
683 |
|
</span> |
684 |
|
<span class="var-title"> |
685 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_all_rows">DataList::$_show_all_rows</a></span><br> |
686 |
|
</span> |
687 |
|
<span class="var-title"> |
688 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></span><br> |
689 |
|
</span> |
690 |
|
<span class="var-title"> |
691 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></span><br> |
692 |
|
</span> |
693 |
|
<span class="var-title"> |
694 |
|
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></span><br> |
695 |
|
</span> |
696 |
|
</blockquote> |
697 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
698 |
|
<blockquote> |
699 |
|
<span class="var-title"> |
700 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
701 |
|
</span> |
702 |
|
<span class="var-title"> |
703 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
704 |
|
</span> |
705 |
|
</blockquote> |
706 |
|
|
707 |
|
</div> |
708 |
|
</div> |
709 |
|
|
710 |
|
<a name="sec-methods"></a> |
711 |
|
<div class="info-box"> |
712 |
|
<div class="info-box-title">Methods</div> |
713 |
|
<div class="nav-bar"> |
714 |
|
<a href="#sec-description">Description</a> | |
715 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
716 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
717 |
|
|
718 |
|
</div> |
719 |
|
<div class="info-box-body"> |
720 |
|
<A NAME='method_detail'></A> |
721 |
|
<a name="methodactionbar_cell" id="actionbar_cell"><!-- --></a> |
722 |
|
<div class="evenrow"> |
723 |
|
|
724 |
|
<div class="method-header"> |
725 |
|
<span class="method-title">actionbar_cell</span> (line <span class="line-number">961</span>) |
726 |
|
</div> |
727 |
|
|
728 |
|
<!-- ========== Info from phpDoc block ========= --> |
729 |
|
<p class="short-description">this is the method that builds the contents for the middle actionbar td cell.</p> |
730 |
|
<p class="description"><p>NOTE this function is meant to be overriden by the child class.</p></p> |
731 |
|
<ul class="tags"> |
732 |
|
<li><span class="field">return:</span> object</li> |
733 |
|
</ul> |
734 |
|
|
735 |
|
<div class="method-signature"> |
736 |
|
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
737 |
|
<span class="method-name"> |
738 |
|
actionbar_cell |
739 |
|
</span> |
740 |
|
() |
741 |
|
</div> |
742 |
|
|
743 |
|
|
744 |
|
|
745 |
|
</div> |
746 |
|
<a name="methodaction_button" id="action_button"><!-- --></a> |
747 |
|
<div class="oddrow"> |
748 |
|
|
749 |
|
<div class="method-header"> |
750 |
|
<span class="method-title">action_button</span> (line <span class="line-number">974</span>) |
751 |
|
</div> |
752 |
|
|
753 |
|
<!-- ========== 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 |
|
<ul class="tags"> |
756 |
|
<li><span class="field">return:</span> object</li> |
757 |
|
</ul> |
758 |
|
|
759 |
|
<div class="method-signature"> |
760 |
|
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
761 |
|
<span class="method-name"> |
762 |
|
action_button |
763 |
|
</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 |
|
</div> |
766 |
|
|
767 |
|
<ul class="parameters"> |
768 |
|
<li> |
769 |
|
<span class="var-type">string</span> |
770 |
|
<span class="var-name">$name</span><span class="var-description">: - the button name</span> </li> |
771 |
|
<li> |
772 |
|
<span class="var-type">string</span> |
773 |
|
<span class="var-name">$action</span><span class="var-description">: - the script that gets called.</span> </li> |
774 |
|
</ul> |
775 |
|
|
776 |
|
|
777 |
|
</div> |
778 |
|
<a name="methodadd_action_column" id="add_action_column"><!-- --></a> |
779 |
|
<div class="evenrow"> |
780 |
|
|
781 |
|
<div class="method-header"> |
782 |
|
<span class="method-title">add_action_column</span> (line <span class="line-number">592</span>) |
783 |
|
</div> |
784 |
|
|
785 |
|
<!-- ========== Info from phpDoc block ========= --> |
786 |
|
<p class="short-description">This function adds an action column. This adds a column of either checkboxes or radio buttons.</p> |
787 |
|
|
788 |
|
<div class="method-signature"> |
789 |
|
<span class="method-result">void</span> |
790 |
|
<span class="method-name"> |
791 |
|
add_action_column |
792 |
|
</span> |
793 |
|
(<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 |
|
</div> |
795 |
|
|
796 |
|
<ul class="parameters"> |
797 |
|
<li> |
798 |
|
<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 |
|
<li> |
801 |
|
<span class="var-type">string</span> |
802 |
|
<span class="var-name">$col</span><span class="var-description">: - which column it lives in 'FIRST' or 'LAST'</span> </li> |
803 |
|
<li> |
804 |
|
<span class="var-type">string</span> |
805 |
|
<span class="var-name">$db_field</span><span class="var-description">: - which db field is associated with this.</span> </li> |
806 |
|
<li> |
807 |
|
<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 |
|
</ul> |
810 |
|
|
811 |
|
|
812 |
|
</div> |
813 |
|
<a name="methodallow_select_all" id="allow_select_all"><!-- --></a> |
814 |
|
<div class="oddrow"> |
815 |
|
|
816 |
|
<div class="method-header"> |
817 |
|
<span class="method-title">allow_select_all</span> (line <span class="line-number">696</span>) |
818 |
|
</div> |
819 |
|
|
820 |
|
<!-- ========== Info from phpDoc block ========= --> |
821 |
|
<p class="short-description">Sets the flag for rendering the select all checkbox</p> |
822 |
|
|
823 |
|
<div class="method-signature"> |
824 |
|
<span class="method-result">void</span> |
825 |
|
<span class="method-name"> |
826 |
|
allow_select_all |
827 |
|
</span> |
828 |
|
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
829 |
|
</div> |
830 |
|
|
831 |
|
<ul class="parameters"> |
832 |
|
<li> |
833 |
|
<span class="var-type">bool</span> |
834 |
|
<span class="var-name">$flag</span><span class="var-description">: flag</span> </li> |
835 |
|
</ul> |
836 |
|
|
837 |
|
|
838 |
|
</div> |
839 |
|
<a name="methodbuild_column_header" id="build_column_header"><!-- --></a> |
840 |
|
<div class="evenrow"> |
841 |
|
|
842 |
|
<div class="method-header"> |
843 |
|
<span class="method-title">build_column_header</span> (line <span class="line-number">341</span>) |
844 |
|
</div> |
845 |
|
|
846 |
|
<!-- ========== Info from phpDoc block ========= --> |
847 |
|
<p class="short-description">This function builds the object/text</p> |
848 |
|
<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 |
|
<ul class="tags"> |
850 |
|
<li><span class="field">return:</span> - either an Atag object or raw text.</li> |
851 |
|
</ul> |
852 |
|
|
853 |
|
<div class="method-signature"> |
854 |
|
<span class="method-result">mixed</span> |
855 |
|
<span class="method-name"> |
856 |
|
build_column_header |
857 |
|
</span> |
858 |
|
(<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 |
|
|
861 |
|
<ul class="parameters"> |
862 |
|
<li> |
863 |
|
<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 |
|
<li> |
866 |
|
<span class="var-type">array</span> |
867 |
|
<span class="var-name">$col_data</span><span class="var-description">: - the column's data.</span> </li> |
868 |
|
<li> |
869 |
|
<span class="var-type">int</span> |
870 |
|
<span class="var-name">$col_num</span><span class="var-description">: the column # we are working on.</span> </li> |
871 |
|
</ul> |
872 |
|
|
873 |
|
|
874 |
|
</div> |
875 |
|
<a name="methodbuild_gui" id="build_gui"><!-- --></a> |
876 |
|
<div class="oddrow"> |
877 |
|
|
878 |
|
<div class="method-header"> |
879 |
|
<span class="method-title">build_gui</span> (line <span class="line-number">300</span>) |
880 |
|
</div> |
881 |
|
|
882 |
|
<!-- ========== Info from phpDoc block ========= --> |
883 |
|
<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 |
|
<ul class="tags"> |
885 |
|
<li><span class="field">return:</span> object</li> |
886 |
|
</ul> |
887 |
|
|
888 |
|
<div class="method-signature"> |
889 |
|
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
890 |
|
<span class="method-name"> |
891 |
|
build_gui |
892 |
|
</span> |
893 |
|
() |
894 |
|
</div> |
895 |
|
|
896 |
|
|
897 |
|
<hr class="separator" /> |
898 |
|
<div class="notes">Redefinition of:</div> |
899 |
|
<dl> |
900 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></dt> |
901 |
|
<dd>This function is responsible for calling the child class's methods for building the GUI container.</dd> |
902 |
|
</dl> |
903 |
|
|
904 |
|
</div> |
905 |
|
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
906 |
|
<div class="evenrow"> |
907 |
|
|
908 |
|
<div class="method-header"> |
909 |
|
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">255</span>) |
910 |
|
</div> |
911 |
|
|
912 |
|
<!-- ========== Info from phpDoc block ========= --> |
913 |
|
|
914 |
|
<div class="method-signature"> |
915 |
|
<span class="method-result">void</span> |
916 |
|
<span class="method-name"> |
917 |
|
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 |
|
</div> |
921 |
|
|
922 |
|
|
923 |
|
<hr class="separator" /> |
924 |
|
<div class="notes">Redefinition of:</div> |
925 |
|
<dl> |
926 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></dt> |
927 |
|
<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 |
|
</dl> |
929 |
|
|
930 |
|
</div> |
931 |
|
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
932 |
|
<div class="oddrow"> |
933 |
|
|
934 |
|
<div class="method-header"> |
935 |
|
<span class="method-title">child_build_column_header</span> (line <span class="line-number">222</span>) |
936 |
|
</div> |
937 |
|
|
938 |
|
<!-- ========== Info from phpDoc block ========= --> |
939 |
|
|
940 |
|
<div class="method-signature"> |
941 |
|
<span class="method-result">void</span> |
942 |
|
<span class="method-name"> |
943 |
|
child_build_column_header |
944 |
|
</span> |
945 |
|
(<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 |
|
</div> |
947 |
|
|
948 |
|
|
949 |
|
<hr class="separator" /> |
950 |
|
<div class="notes">Redefinition of:</div> |
951 |
|
<dl> |
952 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></dt> |
953 |
|
<dd>This method is supposed to be written by the child class to build and add the column title to the UI</dd> |
954 |
|
</dl> |
955 |
|
|
956 |
|
</div> |
957 |
|
<a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a> |
958 |
|
<div class="evenrow"> |
959 |
|
|
960 |
|
<div class="method-header"> |
961 |
|
<span class="method-title">child_build_search_table</span> (line <span class="line-number">441</span>) |
962 |
|
</div> |
963 |
|
|
964 |
|
<!-- ========== Info from phpDoc block ========= --> |
965 |
|
<p class="short-description">This builds the table that holds the search capability.</p> |
966 |
|
<ul class="tags"> |
967 |
|
<li><span class="field">return:</span> object.</li> |
968 |
|
</ul> |
969 |
|
|
970 |
|
<div class="method-signature"> |
971 |
|
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
972 |
|
<span class="method-name"> |
973 |
|
child_build_search_table |
974 |
|
</span> |
975 |
|
() |
976 |
|
</div> |
977 |
|
|
978 |
|
|
979 |
|
<hr class="separator" /> |
980 |
|
<div class="notes">Redefinition of:</div> |
981 |
|
<dl> |
982 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></dt> |
983 |
|
<dd>This function builds the search block that lives above the results</dd> |
984 |
|
</dl> |
985 |
|
|
986 |
|
</div> |
987 |
|
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
988 |
|
<div class="oddrow"> |
989 |
|
|
990 |
|
<div class="method-header"> |
991 |
|
<span class="method-title">child_get_gui</span> (line <span class="line-number">306</span>) |
992 |
|
</div> |
993 |
|
|
994 |
|
<!-- ========== Info from phpDoc block ========= --> |
995 |
|
|
996 |
|
<div class="method-signature"> |
997 |
|
<span class="method-result">void</span> |
998 |
|
<span class="method-name"> |
999 |
|
child_get_gui |
1000 |
|
</span> |
1001 |
|
() |
1002 |
|
</div> |
1003 |
|
|
1004 |
|
|
1005 |
|
<hr class="separator" /> |
1006 |
|
<div class="notes">Redefinition of:</div> |
1007 |
|
<dl> |
1008 |
|
<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 |
|
</dl> |
1011 |
|
|
1012 |
|
</div> |
1013 |
|
<a name="methodget_default_checked_items" id="get_default_checked_items"><!-- --></a> |
1014 |
|
<div class="evenrow"> |
1015 |
|
|
1016 |
|
<div class="method-header"> |
1017 |
|
<span class="method-title">get_default_checked_items</span> (line <span class="line-number">618</span>) |
1018 |
|
</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 |
|
|
1023 |
|
<div class="method-signature"> |
1024 |
|
<span class="method-result">array</span> |
1025 |
|
<span class="method-name"> |
1026 |
|
get_default_checked_items |
1027 |
|
</span> |
1028 |
|
() |
1029 |
|
</div> |
1030 |
|
|
1031 |
|
|
1032 |
|
|
1033 |
|
</div> |
1034 |
|
<a name="methodgui_init" id="gui_init"><!-- --></a> |
1035 |
|
<div class="oddrow"> |
1036 |
|
|
1037 |
|
<div class="method-header"> |
1038 |
|
<span class="method-title">gui_init</span> (line <span class="line-number">158</span>) |
1039 |
|
</div> |
1040 |
|
|
1041 |
|
<!-- ========== Info from phpDoc block ========= --> |
1042 |
|
|
1043 |
|
<div class="method-signature"> |
1044 |
|
<span class="method-result">void</span> |
1045 |
|
<span class="method-name"> |
1046 |
|
gui_init |
1047 |
|
</span> |
1048 |
|
() |
1049 |
|
</div> |
1050 |
|
|
1051 |
|
|
1052 |
|
<hr class="separator" /> |
1053 |
|
<div class="notes">Redefinition of:</div> |
1054 |
|
<dl> |
1055 |
|
<dt><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></dt> |
1056 |
|
<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 |
|
|
1059 |
|
</div> |
1060 |
|
<a name="methodis_action_checked" id="is_action_checked"><!-- --></a> |
1061 |
|
<div class="evenrow"> |
1062 |
|
|
1063 |
|
<div class="method-header"> |
1064 |
|
<span class="method-title">is_action_checked</span> (line <span class="line-number">832</span>) |
1065 |
|
</div> |
1066 |
|
|
1067 |
|
<!-- ========== Info from phpDoc block ========= --> |
1068 |
|
<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 class="method-signature"> |
1071 |
|
<span class="method-result">boolean</span> |
1072 |
|
<span class="method-name"> |
1073 |
|
is_action_checked |
1074 |
|
</span> |
1075 |
|
(<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 |
|
</div> |
1077 |
|
|
1078 |
|
<ul class="parameters"> |
1079 |
|
<li> |
1080 |
|
<span class="var-type">string</span> |
1081 |
|
<span class="var-name">$value</span><span class="var-description">: - the item to look for.</span> </li> |
1082 |
|
<li> |
1083 |
|
<span class="var-type">array</span> |
1084 |
|
<span class="var-name">$row_data</span><span class="var-description">: - the row's data.</span> </li> |
1085 |
|
</ul> |
1086 |
|
|
1087 |
|
|
1088 |
|
</div> |
1089 |
|
<a name="methodis_action_enabled" id="is_action_enabled"><!-- --></a> |
1090 |
|
<div class="oddrow"> |
1091 |
|
|
1092 |
|
<div class="method-header"> |
1093 |
|
<span class="method-title">is_action_enabled</span> (line <span class="line-number">845</span>) |
1094 |
|
</div> |
1095 |
|
|
1096 |
|
<!-- ========== Info from phpDoc block ========= --> |
1097 |
|
<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="method-signature"> |
1100 |
|
<span class="method-result">boolean</span> |
1101 |
|
<span class="method-name"> |
1102 |
|
is_action_enabled |
1103 |
|
</span> |
1104 |
|
(<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 |
|
</div> |
1106 |
|
|
1107 |
|
<ul class="parameters"> |
1108 |
|
<li> |
1109 |
|
<span class="var-type">string</span> |
1110 |
|
<span class="var-name">$value</span><span class="var-description">: - the item to look for.</span> </li> |
1111 |
|
<li> |
1112 |
|
<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 |
|
</ul> |
1115 |
|
|
1116 |
|
|
1117 |
|
</div> |
1118 |
|
<a name="methodsave_checked_items" id="save_checked_items"><!-- --></a> |
1119 |
|
<div class="evenrow"> |
1120 |
|
|
1121 |
|
<div class="method-header"> |
1122 |
|
<span class="method-title">save_checked_items</span> (line <span class="line-number">632</span>) |
1123 |
|
</div> |
1124 |
|
|
1125 |
|
<!-- ========== Info from phpDoc block ========= --> |
1126 |
|
<p class="short-description">set the flag to tell the object to save the checked items</p> |
1127 |
|
<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 |
|
|
1129 |
|
<div class="method-signature"> |
1130 |
|
<span class="method-result">void</span> |
1131 |
|
<span class="method-name"> |
1132 |
|
save_checked_items |
1133 |
|
</span> |
1134 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
1135 |
|
</div> |
1136 |
|
|
1137 |
|
<ul class="parameters"> |
1138 |
|
<li> |
1139 |
|
<span class="var-type">boolean</span> |
1140 |
|
<span class="var-name">$flag</span><span class="var-description">: TRUE = enable</span> </li> |
1141 |
|
</ul> |
1142 |
|
|
1143 |
|
|
1144 |
|
</div> |
1145 |
|
<a name="methodset_actionbar" id="set_actionbar"><!-- --></a> |
1146 |
|
<div class="oddrow"> |
1147 |
|
|
1148 |
|
<div class="method-header"> |
1149 |
|
<span class="method-title">set_actionbar</span> (line <span class="line-number">677</span>) |
1150 |
|
</div> |
1151 |
|
|
1152 |
|
<!-- ========== 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 |
|
|
1155 |
|
<div class="method-signature"> |
1156 |
|
<span class="method-result">void</span> |
1157 |
|
<span class="method-name"> |
1158 |
|
set_actionbar |
1159 |
|
</span> |
1160 |
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
1161 |
|
</div> |
1162 |
|
|
1163 |
|
<ul class="parameters"> |
1164 |
|
<li> |
1165 |
|
<span class="var-type">boolean</span> |
1166 |
|
<span class="var-name">$flag</span><span class="var-description">: - TRUE = on FALSE = off</span> </li> |
1167 |
|
</ul> |
1168 |
|
|
1169 |
|
|
1170 |
|
</div> |
1171 |
|
<a name="methodset_align" id="set_align"><!-- --></a> |
1172 |
|
<div class="evenrow"> |
1173 |
|
|
1174 |
|
<div class="method-header"> |
1175 |
|
<span class="method-title">set_align</span> (line <span class="line-number">218</span>) |
1176 |
|
</div> |
1177 |
|
|
1178 |
|
<!-- ========== Info from phpDoc block ========= --> |
1179 |
|
<p class="short-description">this function is used to set the overall alignment of the widget</p> |
1180 |
|
|
1181 |
|
<div class="method-signature"> |
1182 |
|
<span class="method-result">void</span> |
1183 |
|
<span class="method-name"> |
1184 |
|
set_align |
1185 |
|
</span> |
1186 |
|
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
1187 |
|
</div> |
1188 |
|
|
1189 |
|
<ul class="parameters"> |
1190 |
|
<li> |
1191 |
|
<span class="var-type">string</span> |
1192 |
|
<span class="var-name">$align</span><span class="var-description">: - the align value</span> </li> |
1193 |
|
</ul> |
1194 |
|
|
1195 |
|
<hr class="separator" /> |
1196 |
|
<div class="notes">Redefinition of:</div> |
1197 |
|
<dl> |
1198 |
|
<dt><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></dt> |
1199 |
|
<dd>This function sets the align attribute for the outer table.</dd> |
1200 |
|
</dl> |
1201 |
|
|
1202 |
|
</div> |
1203 |
|
<a name="methodset_default_checked_items" id="set_default_checked_items"><!-- --></a> |
1204 |
|
<div class="oddrow"> |
1205 |
|
|
1206 |
|
<div class="method-header"> |
1207 |
|
<span class="method-title">set_default_checked_items</span> (line <span class="line-number">607</span>) |
1208 |
|
</div> |
1209 |
|
|
1210 |
|
<!-- ========== Info from phpDoc block ========= --> |
1211 |
|
<p class="short-description">This function is used to set the default list</p> |
1212 |
|
<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 |
|
|
1214 |
|
<div class="method-signature"> |
1215 |
|
<span class="method-result">void</span> |
1216 |
|
<span class="method-name"> |
1217 |
|
set_default_checked_items |
1218 |
|
</span> |
1219 |
|
(<span class="var-type">array</span> <span class="var-name">$items</span>) |
1220 |
|
</div> |
1221 |
|
|
1222 |
|
<ul class="parameters"> |
1223 |
|
<li> |
1224 |
|
<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 |
|
</ul> |
1227 |
|
|
1228 |
|
|
1229 |
|
</div> |
1230 |
|
<a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a> |
1231 |
|
<div class="evenrow"> |
1232 |
|
|
1233 |
|
<div class="method-header"> |
1234 |
|
<span class="method-title">set_global_prefix</span> (line <span class="line-number">140</span>) |
1235 |
|
</div> |
1236 |
|
|
1237 |
|
<!-- ========== 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 |
|
|
1240 |
|
<div class="method-signature"> |
1241 |
|
<span class="method-result">void</span> |
1242 |
|
<span class="method-name"> |
1243 |
|
set_global_prefix |
1244 |
|
</span> |
1245 |
|
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
1246 |
|
</div> |
1247 |
|
|
1248 |
|
<ul class="parameters"> |
1249 |
|
<li> |
1250 |
|
<span class="var-type">string</span> |
1251 |
|
<span class="var-name">$prefix</span><span class="var-description">: - the prefix for all vars.</span> </li> |
1252 |
|
</ul> |
1253 |
|
|
1254 |
|
<hr class="separator" /> |
1255 |
|
<div class="notes">Redefinition of:</div> |
1256 |
|
<dl> |
1257 |
|
<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> |
1260 |
|
|
1261 |
|
</div> |
1262 |
|
<a name="methodset_search_collapse" id="set_search_collapse"><!-- --></a> |
1263 |
|
<div class="oddrow"> |
1264 |
|
|
1265 |
|
<div class="method-header"> |
1266 |
|
<span class="method-title">set_search_collapse</span> (line <span class="line-number">153</span>) |
1267 |
|
</div> |
1268 |
|
|
1269 |
|
<!-- ========== Info from phpDoc block ========= --> |
1270 |
|
<p class="short-description">This sets the flag to turn on/off the ability to collapse the search box.</p> |
1271 |
|
|
1272 |
|
<div class="method-signature"> |
1273 |
|
<span class="method-result">void</span> |
1274 |
|
<span class="method-name"> |
1275 |
|
set_search_collapse |
1276 |
|
</span> |
1277 |
|
([<span class="var-type">bool</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
1278 |
|
</div> |
1279 |
|
|
1280 |
|
<ul class="parameters"> |
1281 |
|
<li> |
1282 |
|
<span class="var-type">bool</span> |
1283 |
|
<span class="var-name">$flag</span> </li> |
1284 |
|
</ul> |
1285 |
|
|
1286 |
|
|
1287 |
|
</div> |
1288 |
|
<a name="methodshow_actionbar" id="show_actionbar"><!-- --></a> |
1289 |
|
<div class="evenrow"> |
1290 |
|
|
1291 |
|
<div class="method-header"> |
1292 |
|
<span class="method-title">show_actionbar</span> (line <span class="line-number">687</span>) |
1293 |
|
</div> |
1294 |
|
|
1295 |
|
<!-- ========== Info from phpDoc block ========= --> |
1296 |
|
<p class="short-description">This function gets the current value of the show actionbar flag setting.</p> |
1297 |
|
|
1298 |
|
<div class="method-signature"> |
1299 |
|
<span class="method-result">boolean</span> |
1300 |
|
<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> |