| 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"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<head> |
| 5 |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<title>Docs For Class DefaultGUIDatalist</title> |
| 7 |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
</head> |
| 10 |
<body> |
| 11 |
<div class="page-body"> |
| 12 |
<h2 class="class-name">Class DefaultGUIDatalist</h2> |
| 13 |
|
| 14 |
<a name="sec-description"></a> |
| 15 |
<div class="info-box"> |
| 16 |
<div class="info-box-title">Description</div> |
| 17 |
<div class="nav-bar"> |
| 18 |
<span class="disabled">Description</span> | |
| 19 |
<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>) |
| 21 |
|
| 22 |
</div> |
| 23 |
<div class="info-box-body"> |
| 24 |
<!-- ========== 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> |
| 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> |
| 27 |
<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> |
| 29 |
</ul> |
| 30 |
<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>) |
| 32 |
</p> |
| 33 |
|
| 34 |
|
| 35 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
| 36 |
| |
| 37 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
| 38 |
| |
| 39 |
--<a href="../phpHtmlLib/DataList.html">DataList</a> |
| 40 |
| |
| 41 |
--DefaultGUIDatalist</pre> |
| 42 |
|
| 43 |
</div> |
| 44 |
</div> |
| 45 |
|
| 46 |
|
| 47 |
<a name="sec-var-summary"></a> |
| 48 |
<div class="info-box"> |
| 49 |
<div class="info-box-title">Variable Summary</span></div> |
| 50 |
<div class="nav-bar"> |
| 51 |
<a href="#sec-description">Description</a> | |
| 52 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 53 |
| |
| 54 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 55 |
|
| 56 |
</div> |
| 57 |
<div class="info-box-body"> |
| 58 |
<div class="var-summary"> |
| 59 |
<div class="var-title"> |
| 60 |
<span class="var-type">mixed</span> |
| 61 |
<a href="#$_action_column" title="details" class="var-name">$_action_column</a> |
| 62 |
</div> |
| 63 |
<div class="var-title"> |
| 64 |
<span class="var-type">mixed</span> |
| 65 |
<a href="#$_action_count" title="details" class="var-name">$_action_count</a> |
| 66 |
</div> |
| 67 |
<div class="var-title"> |
| 68 |
<span class="var-type">mixed</span> |
| 69 |
<a href="#$_align" title="details" class="var-name">$_align</a> |
| 70 |
</div> |
| 71 |
<div class="var-title"> |
| 72 |
<span class="var-type">mixed</span> |
| 73 |
<a href="#$_allow_select_all" title="details" class="var-name">$_allow_select_all</a> |
| 74 |
</div> |
| 75 |
<div class="var-title"> |
| 76 |
<span class="var-type">mixed</span> |
| 77 |
<a href="#$_cur_col_cntr" title="details" class="var-name">$_cur_col_cntr</a> |
| 78 |
</div> |
| 79 |
<div class="var-title"> |
| 80 |
<span class="var-type">mixed</span> |
| 81 |
<a href="#$_default_checked_items" title="details" class="var-name">$_default_checked_items</a> |
| 82 |
</div> |
| 83 |
<div class="var-title"> |
| 84 |
<span class="var-type">mixed</span> |
| 85 |
<a href="#$_hidden_checkbox_items" title="details" class="var-name">$_hidden_checkbox_items</a> |
| 86 |
</div> |
| 87 |
<div class="var-title"> |
| 88 |
<span class="var-type">mixed</span> |
| 89 |
<a href="#$_search_text" title="details" class="var-name">$_search_text</a> |
| 90 |
</div> |
| 91 |
<div class="var-title"> |
| 92 |
<span class="var-type">mixed</span> |
| 93 |
<a href="#$_show_actionbar" title="details" class="var-name">$_show_actionbar</a> |
| 94 |
</div> |
| 95 |
<div class="var-title"> |
| 96 |
<span class="var-type">mixed</span> |
| 97 |
<a href="#$_visible_checkbox_items" title="details" class="var-name">$_visible_checkbox_items</a> |
| 98 |
</div> |
| 99 |
<div class="var-title"> |
| 100 |
<span class="var-type">mixed</span> |
| 101 |
<a href="#$__page_info" title="details" class="var-name">$__page_info</a> |
| 102 |
</div> |
| 103 |
</div> |
| 104 |
</div> |
| 105 |
</div> |
| 106 |
|
| 107 |
<a name="sec-method-summary"></a> |
| 108 |
<div class="info-box"> |
| 109 |
<div class="info-box-title">Method Summary</span></div> |
| 110 |
<div class="nav-bar"> |
| 111 |
<a href="#sec-description">Description</a> | |
| 112 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 113 |
|
| 114 |
| |
| 115 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 116 |
</div> |
| 117 |
<div class="info-box-body"> |
| 118 |
<div class="method-summary"> |
| 119 |
|
| 120 |
<div class="method-definition"> |
| 121 |
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
| 122 |
<a href="#actionbar_cell" title="details" class="method-name">actionbar_cell</a> |
| 123 |
() |
| 124 |
</div> |
| 125 |
|
| 126 |
<div class="method-definition"> |
| 127 |
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
| 128 |
<a href="#action_button" title="details" class="method-name">action_button</a> |
| 129 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$action</span>) |
| 130 |
</div> |
| 131 |
|
| 132 |
<div class="method-definition"> |
| 133 |
<span class="method-result">void</span> |
| 134 |
<a href="#add_action_column" title="details" class="method-name">add_action_column</a> |
| 135 |
(<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>]) |
| 136 |
</div> |
| 137 |
|
| 138 |
<div class="method-definition"> |
| 139 |
<span class="method-result">void</span> |
| 140 |
<a href="#allow_select_all" title="details" class="method-name">allow_select_all</a> |
| 141 |
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
| 142 |
</div> |
| 143 |
|
| 144 |
<div class="method-definition"> |
| 145 |
<span class="method-result">mixed</span> |
| 146 |
<a href="#build_column_header" title="details" class="method-name">build_column_header</a> |
| 147 |
(<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>) |
| 148 |
</div> |
| 149 |
|
| 150 |
<div class="method-definition"> |
| 151 |
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
| 152 |
<a href="#build_gui" title="details" class="method-name">build_gui</a> |
| 153 |
() |
| 154 |
</div> |
| 155 |
|
| 156 |
<div class="method-definition"> |
| 157 |
<span class="method-result">void</span> |
| 158 |
<a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a> |
| 159 |
(<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>) |
| 160 |
</div> |
| 161 |
|
| 162 |
<div class="method-definition"> |
| 163 |
<span class="method-result">void</span> |
| 164 |
<a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a> |
| 165 |
(<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>) |
| 166 |
</div> |
| 167 |
|
| 168 |
<div class="method-definition"> |
| 169 |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 170 |
<a href="#child_build_search_table" title="details" class="method-name">child_build_search_table</a> |
| 171 |
() |
| 172 |
</div> |
| 173 |
|
| 174 |
<div class="method-definition"> |
| 175 |
<span class="method-result">void</span> |
| 176 |
<a href="#child_get_gui" title="details" class="method-name">child_get_gui</a> |
| 177 |
() |
| 178 |
</div> |
| 179 |
|
| 180 |
<div class="method-definition"> |
| 181 |
<span class="method-result">array</span> |
| 182 |
<a href="#get_default_checked_items" title="details" class="method-name">get_default_checked_items</a> |
| 183 |
() |
| 184 |
</div> |
| 185 |
|
| 186 |
<div class="method-definition"> |
| 187 |
<span class="method-result">void</span> |
| 188 |
<a href="#gui_init" title="details" class="method-name">gui_init</a> |
| 189 |
() |
| 190 |
</div> |
| 191 |
|
| 192 |
<div class="method-definition"> |
| 193 |
<span class="method-result">boolean</span> |
| 194 |
<a href="#is_action_checked" title="details" class="method-name">is_action_checked</a> |
| 195 |
(<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>) |
| 196 |
</div> |
| 197 |
|
| 198 |
<div class="method-definition"> |
| 199 |
<span class="method-result">boolean</span> |
| 200 |
<a href="#is_action_enabled" title="details" class="method-name">is_action_enabled</a> |
| 201 |
(<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>) |
| 202 |
</div> |
| 203 |
|
| 204 |
<div class="method-definition"> |
| 205 |
<span class="method-result">void</span> |
| 206 |
<a href="#save_checked_items" title="details" class="method-name">save_checked_items</a> |
| 207 |
() |
| 208 |
</div> |
| 209 |
|
| 210 |
<div class="method-definition"> |
| 211 |
<span class="method-result">void</span> |
| 212 |
<a href="#set_actionbar" title="details" class="method-name">set_actionbar</a> |
| 213 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 214 |
</div> |
| 215 |
|
| 216 |
<div class="method-definition"> |
| 217 |
<span class="method-result">void</span> |
| 218 |
<a href="#set_align" title="details" class="method-name">set_align</a> |
| 219 |
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
| 220 |
</div> |
| 221 |
|
| 222 |
<div class="method-definition"> |
| 223 |
<span class="method-result">void</span> |
| 224 |
<a href="#set_default_checked_items" title="details" class="method-name">set_default_checked_items</a> |
| 225 |
(<span class="var-type">array</span> <span class="var-name">$items</span>) |
| 226 |
</div> |
| 227 |
|
| 228 |
<div class="method-definition"> |
| 229 |
<span class="method-result">void</span> |
| 230 |
<a href="#set_global_prefix" title="details" class="method-name">set_global_prefix</a> |
| 231 |
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
| 232 |
</div> |
| 233 |
|
| 234 |
<div class="method-definition"> |
| 235 |
<span class="method-result">boolean</span> |
| 236 |
<a href="#show_actionbar" title="details" class="method-name">show_actionbar</a> |
| 237 |
() |
| 238 |
</div> |
| 239 |
|
| 240 |
<div class="method-definition"> |
| 241 |
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 242 |
<a href="#wrap_column_item" title="details" class="method-name">wrap_column_item</a> |
| 243 |
(<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>) |
| 244 |
</div> |
| 245 |
|
| 246 |
<div class="method-definition"> |
| 247 |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 248 |
<a href="#_build_actionbar" title="details" class="method-name">_build_actionbar</a> |
| 249 |
() |
| 250 |
</div> |
| 251 |
|
| 252 |
<div class="method-definition"> |
| 253 |
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 254 |
<a href="#_build_actionbar_arrow_cell" title="details" class="method-name">_build_actionbar_arrow_cell</a> |
| 255 |
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
| 256 |
</div> |
| 257 |
|
| 258 |
<div class="method-definition"> |
| 259 |
<span class="method-result">TDtag;</span> |
| 260 |
<a href="#_build_actionbar_data_cell" title="details" class="method-name">_build_actionbar_data_cell</a> |
| 261 |
() |
| 262 |
</div> |
| 263 |
|
| 264 |
<div class="method-definition"> |
| 265 |
<span class="method-result">HTMLTag</span> |
| 266 |
<a href="#_build_action_column" title="details" class="method-name">_build_action_column</a> |
| 267 |
(<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>]) |
| 268 |
</div> |
| 269 |
|
| 270 |
<div class="method-definition"> |
| 271 |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 272 |
<a href="#_build_search_title" title="details" class="method-name">_build_search_title</a> |
| 273 |
() |
| 274 |
</div> |
| 275 |
|
| 276 |
<div class="method-definition"> |
| 277 |
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
| 278 |
<a href="#_build_simple_search_form" title="details" class="method-name">_build_simple_search_form</a> |
| 279 |
() |
| 280 |
</div> |
| 281 |
|
| 282 |
<div class="method-definition"> |
| 283 |
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
| 284 |
<a href="#_checkbox_javascript" title="details" class="method-name">_checkbox_javascript</a> |
| 285 |
() |
| 286 |
</div> |
| 287 |
|
| 288 |
<div class="method-definition"> |
| 289 |
<span class="method-result">boolean</span> |
| 290 |
<a href="#_has_action_column" title="details" class="method-name">_has_action_column</a> |
| 291 |
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
| 292 |
</div> |
| 293 |
|
| 294 |
<div class="method-definition"> |
| 295 |
<span class="method-result">boolean.</span> |
| 296 |
<a href="#_is_col_checked" title="details" class="method-name">_is_col_checked</a> |
| 297 |
(<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>) |
| 298 |
</div> |
| 299 |
|
| 300 |
<div class="method-definition"> |
| 301 |
<span class="method-result">mixed</span> |
| 302 |
<a href="#_javascript" title="details" class="method-name">_javascript</a> |
| 303 |
() |
| 304 |
</div> |
| 305 |
|
| 306 |
<div class="method-definition"> |
| 307 |
<span class="method-result">boolean</span> |
| 308 |
<a href="#_save_checked_items_enabled" title="details" class="method-name">_save_checked_items_enabled</a> |
| 309 |
() |
| 310 |
</div> |
| 311 |
</div> |
| 312 |
</div> |
| 313 |
</div> |
| 314 |
|
| 315 |
<a name="sec-vars"></a> |
| 316 |
<div class="info-box"> |
| 317 |
<div class="info-box-title">Variables</div> |
| 318 |
<div class="nav-bar"> |
| 319 |
<a href="#sec-description">Description</a> | |
| 320 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 321 |
|
| 322 |
|
| 323 |
| |
| 324 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 325 |
|
| 326 |
</div> |
| 327 |
<div class="info-box-body"> |
| 328 |
<a name="var$_action_column" id="$_action_column"><!-- --></A> |
| 329 |
<div class="evenrow"> |
| 330 |
|
| 331 |
<div class="var-header"> |
| 332 |
<span class="var-title"> |
| 333 |
<span class="var-type">mixed</span> |
| 334 |
<span class="var-name">$_action_column</span> |
| 335 |
= <span class="var-default">array()</span> (line <span class="line-number">42</span>) |
| 336 |
</span> |
| 337 |
</div> |
| 338 |
|
| 339 |
<!-- ========== Info from phpDoc block ========= --> |
| 340 |
<p class="short-description">This holds the action column settings if any.</p> |
| 341 |
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 |
|
| 346 |
</div> |
| 347 |
<a name="var$_action_count" id="$_action_count"><!-- --></A> |
| 348 |
<div class="oddrow"> |
| 349 |
|
| 350 |
<div class="var-header"> |
| 351 |
<span class="var-title"> |
| 352 |
<span class="var-type">mixed</span> |
| 353 |
<span class="var-name">$_action_count</span> |
| 354 |
= <span class="var-default"> 0</span> (line <span class="line-number">48</span>) |
| 355 |
</span> |
| 356 |
</div> |
| 357 |
|
| 358 |
<!-- ========== Info from phpDoc block ========= --> |
| 359 |
<p class="short-description">holds the cntr for the action</p> |
| 360 |
<p class="description"><p>checkbox name</p></p> |
| 361 |
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
</div> |
| 367 |
<a name="var$_align" id="$_align"><!-- --></A> |
| 368 |
<div class="evenrow"> |
| 369 |
|
| 370 |
<div class="var-header"> |
| 371 |
<span class="var-title"> |
| 372 |
<span class="var-type">mixed</span> |
| 373 |
<span class="var-name">$_align</span> |
| 374 |
= <span class="var-default"> "center"</span> (line <span class="line-number">36</span>) |
| 375 |
</span> |
| 376 |
</div> |
| 377 |
|
| 378 |
<!-- ========== Info from phpDoc block ========= --> |
| 379 |
<p class="short-description">The overall alignment</p> |
| 380 |
<p class="description"><p>DEFAULT: "center"</p></p> |
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
</div> |
| 387 |
<a name="var$_allow_select_all" id="$_allow_select_all"><!-- --></A> |
| 388 |
<div class="oddrow"> |
| 389 |
|
| 390 |
<div class="var-header"> |
| 391 |
<span class="var-title"> |
| 392 |
<span class="var-type">mixed</span> |
| 393 |
<span class="var-name">$_allow_select_all</span> |
| 394 |
= <span class="var-default"> TRUE</span> (line <span class="line-number">86</span>) |
| 395 |
</span> |
| 396 |
</div> |
| 397 |
|
| 398 |
<!-- ========== Info from phpDoc block ========= --> |
| 399 |
<p class="short-description">This variable tells us whether to display</p> |
| 400 |
<p class="description"><p>select all checkbox</p></p> |
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
|
| 406 |
</div> |
| 407 |
<a name="var$_cur_col_cntr" id="$_cur_col_cntr"><!-- --></A> |
| 408 |
<div class="evenrow"> |
| 409 |
|
| 410 |
<div class="var-header"> |
| 411 |
<span class="var-title"> |
| 412 |
<span class="var-type">mixed</span> |
| 413 |
<span class="var-name">$_cur_col_cntr</span> |
| 414 |
= <span class="var-default"> 0</span> (line <span class="line-number">107</span>) |
| 415 |
</span> |
| 416 |
</div> |
| 417 |
|
| 418 |
<!-- ========== Info from phpDoc block ========= --> |
| 419 |
|
| 420 |
|
| 421 |
|
| 422 |
|
| 423 |
|
| 424 |
</div> |
| 425 |
<a name="var$_default_checked_items" id="$_default_checked_items"><!-- --></A> |
| 426 |
<div class="oddrow"> |
| 427 |
|
| 428 |
<div class="var-header"> |
| 429 |
<span class="var-title"> |
| 430 |
<span class="var-type">mixed</span> |
| 431 |
<span class="var-name">$_default_checked_items</span> |
| 432 |
= <span class="var-default">array()</span> (line <span class="line-number">74</span>) |
| 433 |
</span> |
| 434 |
</div> |
| 435 |
|
| 436 |
<!-- ========== Info from phpDoc block ========= --> |
| 437 |
<p class="short-description">This variable holds the array of default</p> |
| 438 |
<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> |
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
</div> |
| 445 |
<a name="var$_hidden_checkbox_items" id="$_hidden_checkbox_items"><!-- --></A> |
| 446 |
<div class="evenrow"> |
| 447 |
|
| 448 |
<div class="var-header"> |
| 449 |
<span class="var-title"> |
| 450 |
<span class="var-type">mixed</span> |
| 451 |
<span class="var-name">$_hidden_checkbox_items</span> |
| 452 |
= <span class="var-default">array()</span> (line <span class="line-number">55</span>) |
| 453 |
</span> |
| 454 |
</div> |
| 455 |
|
| 456 |
<!-- ========== Info from phpDoc block ========= --> |
| 457 |
<p class="short-description">This array holds the list of hidden checkbox[] items.</p> |
| 458 |
|
| 459 |
|
| 460 |
|
| 461 |
|
| 462 |
|
| 463 |
</div> |
| 464 |
<a name="var$_search_text" id="$_search_text"><!-- --></A> |
| 465 |
<div class="oddrow"> |
| 466 |
|
| 467 |
<div class="var-header"> |
| 468 |
<span class="var-title"> |
| 469 |
<span class="var-type">mixed</span> |
| 470 |
<span class="var-name">$_search_text</span> |
| 471 |
= <span class="var-default">array("title" => "Search",<br /> "find" => "Find",<br /> "button" => "Search")</span> (line <span class="line-number">96</span>) |
| 472 |
</span> |
| 473 |
</div> |
| 474 |
|
| 475 |
<!-- ========== Info from phpDoc block ========= --> |
| 476 |
<p class="short-description">this array holds some strings for the search functionality. This enables some level of localization for other languages.</p> |
| 477 |
|
| 478 |
|
| 479 |
|
| 480 |
|
| 481 |
|
| 482 |
</div> |
| 483 |
<a name="var$_show_actionbar" id="$_show_actionbar"><!-- --></A> |
| 484 |
<div class="evenrow"> |
| 485 |
|
| 486 |
<div class="var-header"> |
| 487 |
<span class="var-title"> |
| 488 |
<span class="var-type">mixed</span> |
| 489 |
<span class="var-name">$_show_actionbar</span> |
| 490 |
= <span class="var-default"> TRUE</span> (line <span class="line-number">80</span>) |
| 491 |
</span> |
| 492 |
</div> |
| 493 |
|
| 494 |
<!-- ========== Info from phpDoc block ========= --> |
| 495 |
<p class="short-description">Do we show action bar row?</p> |
| 496 |
|
| 497 |
|
| 498 |
|
| 499 |
|
| 500 |
|
| 501 |
</div> |
| 502 |
<a name="var$_visible_checkbox_items" id="$_visible_checkbox_items"><!-- --></A> |
| 503 |
<div class="oddrow"> |
| 504 |
|
| 505 |
<div class="var-header"> |
| 506 |
<span class="var-title"> |
| 507 |
<span class="var-type">mixed</span> |
| 508 |
<span class="var-name">$_visible_checkbox_items</span> |
| 509 |
= <span class="var-default">array()</span> (line <span class="line-number">63</span>) |
| 510 |
</span> |
| 511 |
</div> |
| 512 |
|
| 513 |
<!-- ========== Info from phpDoc block ========= --> |
| 514 |
<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> |
| 515 |
|
| 516 |
|
| 517 |
|
| 518 |
|
| 519 |
|
| 520 |
</div> |
| 521 |
<a name="var$__page_info" id="$__page_info"><!-- --></A> |
| 522 |
<div class="evenrow"> |
| 523 |
|
| 524 |
<div class="var-header"> |
| 525 |
<span class="var-title"> |
| 526 |
<span class="var-type">mixed</span> |
| 527 |
<span class="var-name">$__page_info</span> |
| 528 |
= <span class="var-default"> ""</span> (line <span class="line-number">104</span>) |
| 529 |
</span> |
| 530 |
</div> |
| 531 |
|
| 532 |
<!-- ========== Info from phpDoc block ========= --> |
| 533 |
<p class="short-description">for a reference so the row_filter affects the paging information.</p> |
| 534 |
|
| 535 |
|
| 536 |
|
| 537 |
|
| 538 |
|
| 539 |
</div> |
| 540 |
<h4>Inherited Variables</h4> |
| 541 |
<A NAME='inherited_vars'><!-- --></A> |
| 542 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
| 543 |
<blockquote> |
| 544 |
<span class="var-title"> |
| 545 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></span><br> |
| 546 |
</span> |
| 547 |
<span class="var-title"> |
| 548 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></span><br> |
| 549 |
</span> |
| 550 |
<span class="var-title"> |
| 551 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></span><br> |
| 552 |
</span> |
| 553 |
<span class="var-title"> |
| 554 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></span><br> |
| 555 |
</span> |
| 556 |
<span class="var-title"> |
| 557 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></span><br> |
| 558 |
</span> |
| 559 |
<span class="var-title"> |
| 560 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></span><br> |
| 561 |
</span> |
| 562 |
<span class="var-title"> |
| 563 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></span><br> |
| 564 |
</span> |
| 565 |
<span class="var-title"> |
| 566 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></span><br> |
| 567 |
</span> |
| 568 |
<span class="var-title"> |
| 569 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></span><br> |
| 570 |
</span> |
| 571 |
<span class="var-title"> |
| 572 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></span><br> |
| 573 |
</span> |
| 574 |
<span class="var-title"> |
| 575 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></span><br> |
| 576 |
</span> |
| 577 |
<span class="var-title"> |
| 578 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></span><br> |
| 579 |
</span> |
| 580 |
<span class="var-title"> |
| 581 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></span><br> |
| 582 |
</span> |
| 583 |
<span class="var-title"> |
| 584 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></span><br> |
| 585 |
</span> |
| 586 |
<span class="var-title"> |
| 587 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></span><br> |
| 588 |
</span> |
| 589 |
<span class="var-title"> |
| 590 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></span><br> |
| 591 |
</span> |
| 592 |
<span class="var-title"> |
| 593 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></span><br> |
| 594 |
</span> |
| 595 |
<span class="var-title"> |
| 596 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></span><br> |
| 597 |
</span> |
| 598 |
<span class="var-title"> |
| 599 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></span><br> |
| 600 |
</span> |
| 601 |
<span class="var-title"> |
| 602 |
<span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></span><br> |
| 603 |
</span> |
| 604 |
</blockquote> |
| 605 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 606 |
<blockquote> |
| 607 |
<span class="var-title"> |
| 608 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
| 609 |
</span> |
| 610 |
<span class="var-title"> |
| 611 |
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
| 612 |
</span> |
| 613 |
</blockquote> |
| 614 |
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
| 615 |
<blockquote> |
| 616 |
<span class="var-title"> |
| 617 |
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
| 618 |
</span> |
| 619 |
</blockquote> |
| 620 |
|
| 621 |
</div> |
| 622 |
</div> |
| 623 |
|
| 624 |
<a name="sec-methods"></a> |
| 625 |
<div class="info-box"> |
| 626 |
<div class="info-box-title">Methods</div> |
| 627 |
<div class="nav-bar"> |
| 628 |
<a href="#sec-description">Description</a> | |
| 629 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 630 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 631 |
|
| 632 |
</div> |
| 633 |
<div class="info-box-body"> |
| 634 |
<A NAME='method_detail'></A> |
| 635 |
<a name="methodactionbar_cell" id="actionbar_cell"><!-- --></a> |
| 636 |
<div class="oddrow"> |
| 637 |
|
| 638 |
<div class="method-header"> |
| 639 |
<span class="method-title">actionbar_cell</span> (line <span class="line-number">863</span>) |
| 640 |
</div> |
| 641 |
|
| 642 |
<!-- ========== Info from phpDoc block ========= --> |
| 643 |
<p class="short-description">this is the method that builds the contents for the middle actionbar td cell.</p> |
| 644 |
<p class="description"><p>NOTE this function is meant to be overriden by the child class.</p></p> |
| 645 |
<ul class="tags"> |
| 646 |
<li><span class="field">return:</span> <p>object</p></li> |
| 647 |
</ul> |
| 648 |
|
| 649 |
<div class="method-signature"> |
| 650 |
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
| 651 |
<span class="method-name"> |
| 652 |
actionbar_cell |
| 653 |
</span> |
| 654 |
() |
| 655 |
</div> |
| 656 |
|
| 657 |
|
| 658 |
|
| 659 |
</div> |
| 660 |
<a name="methodaction_button" id="action_button"><!-- --></a> |
| 661 |
<div class="evenrow"> |
| 662 |
|
| 663 |
<div class="method-header"> |
| 664 |
<span class="method-title">action_button</span> (line <span class="line-number">876</span>) |
| 665 |
</div> |
| 666 |
|
| 667 |
<!-- ========== Info from phpDoc block ========= --> |
| 668 |
<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> |
| 669 |
<ul class="tags"> |
| 670 |
<li><span class="field">return:</span> <p>object</p></li> |
| 671 |
</ul> |
| 672 |
|
| 673 |
<div class="method-signature"> |
| 674 |
<span class="method-result"><a href="../phpHtmlLib/INPUTtag.html">INPUTtag</a></span> |
| 675 |
<span class="method-name"> |
| 676 |
action_button |
| 677 |
</span> |
| 678 |
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type">string</span> <span class="var-name">$action</span>) |
| 679 |
</div> |
| 680 |
|
| 681 |
<ul class="parameters"> |
| 682 |
<li> |
| 683 |
<span class="var-type">string</span> |
| 684 |
<span class="var-name">$name</span><span class="var-description">: <p>- the button name</p></span> </li> |
| 685 |
<li> |
| 686 |
<span class="var-type">string</span> |
| 687 |
<span class="var-name">$action</span><span class="var-description">: <p>- the script that gets called.</p></span> </li> |
| 688 |
</ul> |
| 689 |
|
| 690 |
|
| 691 |
</div> |
| 692 |
<a name="methodadd_action_column" id="add_action_column"><!-- --></a> |
| 693 |
<div class="oddrow"> |
| 694 |
|
| 695 |
<div class="method-header"> |
| 696 |
<span class="method-title">add_action_column</span> (line <span class="line-number">503</span>) |
| 697 |
</div> |
| 698 |
|
| 699 |
<!-- ========== Info from phpDoc block ========= --> |
| 700 |
<p class="short-description">This function adds an action column. This adds a column of either checkboxes or radio buttons.</p> |
| 701 |
|
| 702 |
<div class="method-signature"> |
| 703 |
<span class="method-result">void</span> |
| 704 |
<span class="method-name"> |
| 705 |
add_action_column |
| 706 |
</span> |
| 707 |
(<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>]) |
| 708 |
</div> |
| 709 |
|
| 710 |
<ul class="parameters"> |
| 711 |
<li> |
| 712 |
<span class="var-type">string</span> |
| 713 |
<span class="var-name">$type</span><span class="var-description">: <p>- type of column 'checkbox' or 'radio'</p></span> </li> |
| 714 |
<li> |
| 715 |
<span class="var-type">string</span> |
| 716 |
<span class="var-name">$col</span><span class="var-description">: <p>- which column it lives in 'FIRST' or 'LAST'</p></span> </li> |
| 717 |
<li> |
| 718 |
<span class="var-type">string</span> |
| 719 |
<span class="var-name">$db_field</span><span class="var-description">: <p>- which db field is associated with this.</p></span> </li> |
| 720 |
<li> |
| 721 |
<span class="var-type">string</span> |
| 722 |
<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> |
| 723 |
</ul> |
| 724 |
|
| 725 |
|
| 726 |
</div> |
| 727 |
<a name="methodallow_select_all" id="allow_select_all"><!-- --></a> |
| 728 |
<div class="evenrow"> |
| 729 |
|
| 730 |
<div class="method-header"> |
| 731 |
<span class="method-title">allow_select_all</span> (line <span class="line-number">597</span>) |
| 732 |
</div> |
| 733 |
|
| 734 |
<!-- ========== Info from phpDoc block ========= --> |
| 735 |
<p class="short-description">Sets the flag for rendering the select all checkbox</p> |
| 736 |
|
| 737 |
<div class="method-signature"> |
| 738 |
<span class="method-result">void</span> |
| 739 |
<span class="method-name"> |
| 740 |
allow_select_all |
| 741 |
</span> |
| 742 |
(<span class="var-type">bool</span> <span class="var-name">$flag</span>) |
| 743 |
</div> |
| 744 |
|
| 745 |
<ul class="parameters"> |
| 746 |
<li> |
| 747 |
<span class="var-type">bool</span> |
| 748 |
<span class="var-name">$flag</span><span class="var-description">: <p>flag</p></span> </li> |
| 749 |
</ul> |
| 750 |
|
| 751 |
|
| 752 |
</div> |
| 753 |
<a name="methodbuild_column_header" id="build_column_header"><!-- --></a> |
| 754 |
<div class="oddrow"> |
| 755 |
|
| 756 |
<div class="method-header"> |
| 757 |
<span class="method-title">build_column_header</span> (line <span class="line-number">291</span>) |
| 758 |
</div> |
| 759 |
|
| 760 |
<!-- ========== Info from phpDoc block ========= --> |
| 761 |
<p class="short-description">This function builds the object/text</p> |
| 762 |
<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> |
| 763 |
<ul class="tags"> |
| 764 |
<li><span class="field">return:</span> <p>- either an Atag object or raw text.</p></li> |
| 765 |
</ul> |
| 766 |
|
| 767 |
<div class="method-signature"> |
| 768 |
<span class="method-result">mixed</span> |
| 769 |
<span class="method-name"> |
| 770 |
build_column_header |
| 771 |
</span> |
| 772 |
(<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>) |
| 773 |
</div> |
| 774 |
|
| 775 |
<ul class="parameters"> |
| 776 |
<li> |
| 777 |
<span class="var-type">string</span> |
| 778 |
<span class="var-name">$col_name</span><span class="var-description">: <p>- the column name to build from the headers.</p></span> </li> |
| 779 |
<li> |
| 780 |
<span class="var-type">array</span> |
| 781 |
<span class="var-name">$col_data</span><span class="var-description">: <p>- the column's data.</p></span> </li> |
| 782 |
<li> |
| 783 |
<span class="var-type">int</span> |
| 784 |
<span class="var-name">$col_num</span><span class="var-description">: <p>the column # we are working on.</p></span> </li> |
| 785 |
</ul> |
| 786 |
|
| 787 |
|
| 788 |
</div> |
| 789 |
<a name="methodbuild_gui" id="build_gui"><!-- --></a> |
| 790 |
<div class="evenrow"> |
| 791 |
|
| 792 |
<div class="method-header"> |
| 793 |
<span class="method-title">build_gui</span> (line <span class="line-number">264</span>) |
| 794 |
</div> |
| 795 |
|
| 796 |
<!-- ========== Info from phpDoc block ========= --> |
| 797 |
<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> |
| 798 |
<ul class="tags"> |
| 799 |
<li><span class="field">return:</span> <p>object</p></li> |
| 800 |
</ul> |
| 801 |
|
| 802 |
<div class="method-signature"> |
| 803 |
<span class="method-result"><a href="../phpHtmlLib/DIVtag.html">DIVtag</a></span> |
| 804 |
<span class="method-name"> |
| 805 |
build_gui |
| 806 |
</span> |
| 807 |
() |
| 808 |
</div> |
| 809 |
|
| 810 |
|
| 811 |
<hr class="separator" /> |
| 812 |
<div class="notes">Redefinition of:</div> |
| 813 |
<dl> |
| 814 |
<dt><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></dt> |
| 815 |
<dd>This function is responsible for calling the child class's methods for building the GUI container.</dd> |
| 816 |
</dl> |
| 817 |
|
| 818 |
</div> |
| 819 |
<a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a> |
| 820 |
<div class="oddrow"> |
| 821 |
|
| 822 |
<div class="method-header"> |
| 823 |
<span class="method-title">child_add_row_cell</span> (line <span class="line-number">219</span>) |
| 824 |
</div> |
| 825 |
|
| 826 |
<!-- ========== Info from phpDoc block ========= --> |
| 827 |
|
| 828 |
<div class="method-signature"> |
| 829 |
<span class="method-result">void</span> |
| 830 |
<span class="method-name"> |
| 831 |
child_add_row_cell |
| 832 |
</span> |
| 833 |
(<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>) |
| 834 |
</div> |
| 835 |
|
| 836 |
|
| 837 |
<hr class="separator" /> |
| 838 |
<div class="notes">Redefinition of:</div> |
| 839 |
<dl> |
| 840 |
<dt><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></dt> |
| 841 |
<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> |
| 842 |
</dl> |
| 843 |
|
| 844 |
</div> |
| 845 |
<a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a> |
| 846 |
<div class="evenrow"> |
| 847 |
|
| 848 |
<div class="method-header"> |
| 849 |
<span class="method-title">child_build_column_header</span> (line <span class="line-number">186</span>) |
| 850 |
</div> |
| 851 |
|
| 852 |
<!-- ========== Info from phpDoc block ========= --> |
| 853 |
|
| 854 |
<div class="method-signature"> |
| 855 |
<span class="method-result">void</span> |
| 856 |
<span class="method-name"> |
| 857 |
child_build_column_header |
| 858 |
</span> |
| 859 |
(<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>) |
| 860 |
</div> |
| 861 |
|
| 862 |
|
| 863 |
<hr class="separator" /> |
| 864 |
<div class="notes">Redefinition of:</div> |
| 865 |
<dl> |
| 866 |
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></dt> |
| 867 |
<dd>This method is supposed to be written by the child class to build and add the column title to the UI</dd> |
| 868 |
</dl> |
| 869 |
|
| 870 |
</div> |
| 871 |
<a name="methodchild_build_search_table" id="child_build_search_table"><!-- --></a> |
| 872 |
<div class="oddrow"> |
| 873 |
|
| 874 |
<div class="method-header"> |
| 875 |
<span class="method-title">child_build_search_table</span> (line <span class="line-number">391</span>) |
| 876 |
</div> |
| 877 |
|
| 878 |
<!-- ========== Info from phpDoc block ========= --> |
| 879 |
<p class="short-description">This builds the table that holds the search capability.</p> |
| 880 |
<ul class="tags"> |
| 881 |
<li><span class="field">return:</span> <p>object.</p></li> |
| 882 |
</ul> |
| 883 |
|
| 884 |
<div class="method-signature"> |
| 885 |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 886 |
<span class="method-name"> |
| 887 |
child_build_search_table |
| 888 |
</span> |
| 889 |
() |
| 890 |
</div> |
| 891 |
|
| 892 |
|
| 893 |
<hr class="separator" /> |
| 894 |
<div class="notes">Redefinition of:</div> |
| 895 |
<dl> |
| 896 |
<dt><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></dt> |
| 897 |
<dd>This function builds the search block that lives above the results</dd> |
| 898 |
</dl> |
| 899 |
|
| 900 |
</div> |
| 901 |
<a name="methodchild_get_gui" id="child_get_gui"><!-- --></a> |
| 902 |
<div class="evenrow"> |
| 903 |
|
| 904 |
<div class="method-header"> |
| 905 |
<span class="method-title">child_get_gui</span> (line <span class="line-number">270</span>) |
| 906 |
</div> |
| 907 |
|
| 908 |
<!-- ========== Info from phpDoc block ========= --> |
| 909 |
|
| 910 |
<div class="method-signature"> |
| 911 |
<span class="method-result">void</span> |
| 912 |
<span class="method-name"> |
| 913 |
child_get_gui |
| 914 |
</span> |
| 915 |
() |
| 916 |
</div> |
| 917 |
|
| 918 |
|
| 919 |
<hr class="separator" /> |
| 920 |
<div class="notes">Redefinition of:</div> |
| 921 |
<dl> |
| 922 |
<dt><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></dt> |
| 923 |
<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> |
| 924 |
</dl> |
| 925 |
|
| 926 |
</div> |
| 927 |
<a name="methodget_default_checked_items" id="get_default_checked_items"><!-- --></a> |
| 928 |
<div class="oddrow"> |
| 929 |
|
| 930 |
<div class="method-header"> |
| 931 |
<span class="method-title">get_default_checked_items</span> (line <span class="line-number">529</span>) |
| 932 |
</div> |
| 933 |
|
| 934 |
<!-- ========== Info from phpDoc block ========= --> |
| 935 |
<p class="short-description">This function returns the array of default checked items to be marked as checked in the checkbox action column</p> |
| 936 |
|
| 937 |
<div class="method-signature"> |
| 938 |
<span class="method-result">array</span> |
| 939 |
<span class="method-name"> |
| 940 |
get_default_checked_items |
| 941 |
</span> |
| 942 |
() |
| 943 |
</div> |
| 944 |
|
| 945 |
|
| 946 |
|
| 947 |
</div> |
| 948 |
<a name="methodgui_init" id="gui_init"><!-- --></a> |
| 949 |
<div class="evenrow"> |
| 950 |
|
| 951 |
<div class="method-header"> |
| 952 |
<span class="method-title">gui_init</span> (line <span class="line-number">125</span>) |
| 953 |
</div> |
| 954 |
|
| 955 |
<!-- ========== Info from phpDoc block ========= --> |
| 956 |
|
| 957 |
<div class="method-signature"> |
| 958 |
<span class="method-result">void</span> |
| 959 |
<span class="method-name"> |
| 960 |
gui_init |
| 961 |
</span> |
| 962 |
() |
| 963 |
</div> |
| 964 |
|
| 965 |
|
| 966 |
<hr class="separator" /> |
| 967 |
<div class="notes">Redefinition of:</div> |
| 968 |
<dl> |
| 969 |
<dt><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></dt> |
| 970 |
<dd>A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</dd> |
| 971 |
</dl> |
| 972 |
|
| 973 |
</div> |
| 974 |
<a name="methodis_action_checked" id="is_action_checked"><!-- --></a> |
| 975 |
<div class="oddrow"> |
| 976 |
|
| 977 |
<div class="method-header"> |
| 978 |
<span class="method-title">is_action_checked</span> (line <span class="line-number">734</span>) |
| 979 |
</div> |
| 980 |
|
| 981 |
<!-- ========== Info from phpDoc block ========= --> |
| 982 |
<p class="short-description">This function is provided to give the child class the ability to precheck/select a particular column.</p> |
| 983 |
|
| 984 |
<div class="method-signature"> |
| 985 |
<span class="method-result">boolean</span> |
| 986 |
<span class="method-name"> |
| 987 |
is_action_checked |
| 988 |
</span> |
| 989 |
(<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>) |
| 990 |
</div> |
| 991 |
|
| 992 |
<ul class="parameters"> |
| 993 |
<li> |
| 994 |
<span class="var-type">string</span> |
| 995 |
<span class="var-name">$value</span><span class="var-description">: <p>- the item to look for.</p></span> </li> |
| 996 |
<li> |
| 997 |
<span class="var-type">array</span> |
| 998 |
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
| 999 |
</ul> |
| 1000 |
|
| 1001 |
|
| 1002 |
</div> |
| 1003 |
<a name="methodis_action_enabled" id="is_action_enabled"><!-- --></a> |
| 1004 |
<div class="evenrow"> |
| 1005 |
|
| 1006 |
<div class="method-header"> |
| 1007 |
<span class="method-title">is_action_enabled</span> (line <span class="line-number">747</span>) |
| 1008 |
</div> |
| 1009 |
|
| 1010 |
<!-- ========== Info from phpDoc block ========= --> |
| 1011 |
<p class="short-description">This function is provided to give the child class the ability to enable/disable a particular checkbox.</p> |
| 1012 |
|
| 1013 |
<div class="method-signature"> |
| 1014 |
<span class="method-result">boolean</span> |
| 1015 |
<span class="method-name"> |
| 1016 |
is_action_enabled |
| 1017 |
</span> |
| 1018 |
(<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>) |
| 1019 |
</div> |
| 1020 |
|
| 1021 |
<ul class="parameters"> |
| 1022 |
<li> |
| 1023 |
<span class="var-type">string</span> |
| 1024 |
<span class="var-name">$value</span><span class="var-description">: <p>- the item to look for.</p></span> </li> |
| 1025 |
<li> |
| 1026 |
<span class="var-type">array</span> |
| 1027 |
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
| 1028 |
</ul> |
| 1029 |
|
| 1030 |
|
| 1031 |
</div> |
| 1032 |
<a name="methodsave_checked_items" id="save_checked_items"><!-- --></a> |
| 1033 |
<div class="oddrow"> |
| 1034 |
|
| 1035 |
<div class="method-header"> |
| 1036 |
<span class="method-title">save_checked_items</span> (line <span class="line-number">538</span>) |
| 1037 |
</div> |
| 1038 |
|
| 1039 |
<!-- ========== Info from phpDoc block ========= --> |
| 1040 |
<p class="short-description">set the flag to tell the object to</p> |
| 1041 |
<p class="description"><p>save the checked items</p></p> |
| 1042 |
|
| 1043 |
<div class="method-signature"> |
| 1044 |
<span class="method-result">void</span> |
| 1045 |
<span class="method-name"> |
| 1046 |
save_checked_items |
| 1047 |
</span> |
| 1048 |
() |
| 1049 |
</div> |
| 1050 |
|
| 1051 |
|
| 1052 |
|
| 1053 |
</div> |
| 1054 |
<a name="methodset_actionbar" id="set_actionbar"><!-- --></a> |
| 1055 |
<div class="evenrow"> |
| 1056 |
|
| 1057 |
<div class="method-header"> |
| 1058 |
<span class="method-title">set_actionbar</span> (line <span class="line-number">578</span>) |
| 1059 |
</div> |
| 1060 |
|
| 1061 |
<!-- ========== Info from phpDoc block ========= --> |
| 1062 |
<p class="short-description">This allows the caller to turn on/off the rendering of the bottom action bar row</p> |
| 1063 |
|
| 1064 |
<div class="method-signature"> |
| 1065 |
<span class="method-result">void</span> |
| 1066 |
<span class="method-name"> |
| 1067 |
set_actionbar |
| 1068 |
</span> |
| 1069 |
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 1070 |
</div> |
| 1071 |
|
| 1072 |
<ul class="parameters"> |
| 1073 |
<li> |
| 1074 |
<span class="var-type">boolean</span> |
| 1075 |
<span class="var-name">$flag</span><span class="var-description">: <p>- TRUE = on FALSE = off</p></span> </li> |
| 1076 |
</ul> |
| 1077 |
|
| 1078 |
|
| 1079 |
</div> |
| 1080 |
<a name="methodset_align" id="set_align"><!-- --></a> |
| 1081 |
<div class="oddrow"> |
| 1082 |
|
| 1083 |
<div class="method-header"> |
| 1084 |
<span class="method-title">set_align</span> (line <span class="line-number">182</span>) |
| 1085 |
</div> |
| 1086 |
|
| 1087 |
<!-- ========== Info from phpDoc block ========= --> |
| 1088 |
<p class="short-description">this function is used to set the overall alignment of the widget</p> |
| 1089 |
|
| 1090 |
<div class="method-signature"> |
| 1091 |
<span class="method-result">void</span> |
| 1092 |
<span class="method-name"> |
| 1093 |
set_align |
| 1094 |
</span> |
| 1095 |
(<span class="var-type">string</span> <span class="var-name">$align</span>) |
| 1096 |
</div> |
| 1097 |
|
| 1098 |
<ul class="parameters"> |
| 1099 |
<li> |
| 1100 |
<span class="var-type">string</span> |
| 1101 |
<span class="var-name">$align</span><span class="var-description">: <p>- the align value</p></span> </li> |
| 1102 |
</ul> |
| 1103 |
|
| 1104 |
<hr class="separator" /> |
| 1105 |
<div class="notes">Redefinition of:</div> |
| 1106 |
<dl> |
| 1107 |
<dt><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></dt> |
| 1108 |
<dd>This function sets the align attribute for the outer table.</dd> |
| 1109 |
</dl> |
| 1110 |
|
| 1111 |
</div> |
| 1112 |
<a name="methodset_default_checked_items" id="set_default_checked_items"><!-- --></a> |
| 1113 |
<div class="evenrow"> |
| 1114 |
|
| 1115 |
<div class="method-header"> |
| 1116 |
<span class="method-title">set_default_checked_items</span> (line <span class="line-number">518</span>) |
| 1117 |
</div> |
| 1118 |
|
| 1119 |
<!-- ========== Info from phpDoc block ========= --> |
| 1120 |
<p class="short-description">This function is used to set the default list</p> |
| 1121 |
<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> |
| 1122 |
|
| 1123 |
<div class="method-signature"> |
| 1124 |
<span class="method-result">void</span> |
| 1125 |
<span class="method-name"> |
| 1126 |
set_default_checked_items |
| 1127 |
</span> |
| 1128 |
(<span class="var-type">array</span> <span class="var-name">$items</span>) |
| 1129 |
</div> |
| 1130 |
|
| 1131 |
<ul class="parameters"> |
| 1132 |
<li> |
| 1133 |
<span class="var-type">array</span> |
| 1134 |
<span class="var-name">$items</span><span class="var-description">: <p>- the array of checked items</p></span> </li> |
| 1135 |
</ul> |
| 1136 |
|
| 1137 |
|
| 1138 |
</div> |
| 1139 |
<a name="methodset_global_prefix" id="set_global_prefix"><!-- --></a> |
| 1140 |
<div class="oddrow"> |
| 1141 |
|
| 1142 |
<div class="method-header"> |
| 1143 |
<span class="method-title">set_global_prefix</span> (line <span class="line-number">118</span>) |
| 1144 |
</div> |
| 1145 |
|
| 1146 |
<!-- ========== Info from phpDoc block ========= --> |
| 1147 |
<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> |
| 1148 |
|
| 1149 |
<div class="method-signature"> |
| 1150 |
<span class="method-result">void</span> |
| 1151 |
<span class="method-name"> |
| 1152 |
set_global_prefix |
| 1153 |
</span> |
| 1154 |
(<span class="var-type">string</span> <span class="var-name">$prefix</span>) |
| 1155 |
</div> |
| 1156 |
|
| 1157 |
<ul class="parameters"> |
| 1158 |
<li> |
| 1159 |
<span class="var-type">string</span> |
| 1160 |
<span class="var-name">$prefix</span><span class="var-description">: <p>- the prefix for all vars.</p></span> </li> |
| 1161 |
</ul> |
| 1162 |
|
| 1163 |
<hr class="separator" /> |
| 1164 |
<div class="notes">Redefinition of:</div> |
| 1165 |
<dl> |
| 1166 |
<dt><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></dt> |
| 1167 |
<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> |
| 1168 |
</dl> |
| 1169 |
|
| 1170 |
</div> |
| 1171 |
<a name="methodshow_actionbar" id="show_actionbar"><!-- --></a> |
| 1172 |
<div class="evenrow"> |
| 1173 |
|
| 1174 |
<div class="method-header"> |
| 1175 |
<span class="method-title">show_actionbar</span> (line <span class="line-number">588</span>) |
| 1176 |
</div> |
| 1177 |
|
| 1178 |
<!-- ========== Info from phpDoc block ========= --> |
| 1179 |
<p class="short-description">This function gets the current value of the show actionbar flag setting.</p> |
| 1180 |
|
| 1181 |
<div class="method-signature"> |
| 1182 |
<span class="method-result">boolean</span> |
| 1183 |
<span class="method-name"> |
| 1184 |
show_actionbar |
| 1185 |
</span> |
| 1186 |
() |
| 1187 |
</div> |
| 1188 |
|
| 1189 |
|
| 1190 |
|
| 1191 |
</div> |
| 1192 |
<a name="methodwrap_column_item" id="wrap_column_item"><!-- --></a> |
| 1193 |
<div class="oddrow"> |
| 1194 |
|
| 1195 |
<div class="method-header"> |
| 1196 |
<span class="method-title">wrap_column_item</span> (line <span class="line-number">354</span>) |
| 1197 |
</div> |
| 1198 |
|
| 1199 |
<!-- ========== Info from phpDoc block ========= --> |
| 1200 |
<p class="short-description">This function ensures that the data we place in a column is aligned according to what the user wants.</p> |
| 1201 |
<ul class="tags"> |
| 1202 |
<li><span class="field">return:</span> <p>object</p></li> |
| 1203 |
</ul> |
| 1204 |
|
| 1205 |
<div class="method-signature"> |
| 1206 |
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 1207 |
<span class="method-name"> |
| 1208 |
wrap_column_item |
| 1209 |
</span> |
| 1210 |
(<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>) |
| 1211 |
</div> |
| 1212 |
|
| 1213 |
<ul class="parameters"> |
| 1214 |
<li> |
| 1215 |
<span class="var-type">int</span> |
| 1216 |
<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> |
| 1217 |
<li> |
| 1218 |
<span class="var-type">int</span> |
| 1219 |
<span class="var-name">3</span><span class="var-description">: <p>- the column # we are working on.</p></span> </li> |
| 1220 |
<li> |
| 1221 |
<span class="var-type">mixed</span> |
| 1222 |
<span class="var-name">$obj</span><span class="var-description">: <p>- $obj - the data for the td.</p></span> </li> |
| 1223 |
<li> |
| 1224 |
<span class="var-type">string</span> |
| 1225 |
<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> |
| 1226 |
</ul> |
| 1227 |
|
| 1228 |
|
| 1229 |
</div> |
| 1230 |
<a name="method_build_actionbar" id="_build_actionbar"><!-- --></a> |
| 1231 |
<div class="evenrow"> |
| 1232 |
|
| 1233 |
<div class="method-header"> |
| 1234 |
<span class="method-title">_build_actionbar</span> (line <span class="line-number">757</span>) |
| 1235 |
</div> |
| 1236 |
|
| 1237 |
<!-- ========== Info from phpDoc block ========= --> |
| 1238 |
<p class="short-description">This function renders the action bar at the bottom of the data list.</p> |
| 1239 |
<ul class="tags"> |
| 1240 |
<li><span class="field">return:</span> <p>object</p></li> |
| 1241 |
</ul> |
| 1242 |
|
| 1243 |
<div class="method-signature"> |
| 1244 |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 1245 |
<span class="method-name"> |
| 1246 |
_build_actionbar |
| 1247 |
</span> |
| 1248 |
() |
| 1249 |
</div> |
| 1250 |
|
| 1251 |
|
| 1252 |
|
| 1253 |
</div> |
| 1254 |
<a name="method_build_actionbar_arrow_cell" id="_build_actionbar_arrow_cell"><!-- --></a> |
| 1255 |
<div class="oddrow"> |
| 1256 |
|
| 1257 |
<div class="method-header"> |
| 1258 |
<span class="method-title">_build_actionbar_arrow_cell</span> (line <span class="line-number">793</span>) |
| 1259 |
</div> |
| 1260 |
|
| 1261 |
<!-- ========== Info from phpDoc block ========= --> |
| 1262 |
<p class="short-description">This function builds a TD with the appropriate action arrow.</p> |
| 1263 |
|
| 1264 |
<div class="method-signature"> |
| 1265 |
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 1266 |
<span class="method-name"> |
| 1267 |
_build_actionbar_arrow_cell |
| 1268 |
</span> |
| 1269 |
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
| 1270 |
</div> |
| 1271 |
|
| 1272 |
<ul class="parameters"> |
| 1273 |
<li> |
| 1274 |
<span class="var-type">string</span> |
| 1275 |
<span class="var-name">$col</span><span class="var-description">: <p>- FIRST or LAST</p></span> </li> |
| 1276 |
</ul> |
| 1277 |
|
| 1278 |
|
| 1279 |
</div> |
| 1280 |
<a name="method_build_actionbar_data_cell" id="_build_actionbar_data_cell"><!-- --></a> |
| 1281 |
<div class="evenrow"> |
| 1282 |
|
| 1283 |
<div class="method-header"> |
| 1284 |
<span class="method-title">_build_actionbar_data_cell</span> (line <span class="line-number">828</span>) |
| 1285 |
</div> |
| 1286 |
|
| 1287 |
<!-- ========== Info from phpDoc block ========= --> |
| 1288 |
<p class="short-description">This function builds the user's data cell</p> |
| 1289 |
|
| 1290 |
<div class="method-signature"> |
| 1291 |
<span class="method-result">TDtag;</span> |
| 1292 |
<span class="method-name"> |
| 1293 |
_build_actionbar_data_cell |
| 1294 |
</span> |
| 1295 |
() |
| 1296 |
</div> |
| 1297 |
|
| 1298 |
|
| 1299 |
|
| 1300 |
</div> |
| 1301 |
<a name="method_build_action_column" id="_build_action_column"><!-- --></a> |
| 1302 |
<div class="oddrow"> |
| 1303 |
|
| 1304 |
<div class="method-header"> |
| 1305 |
<span class="method-title">_build_action_column</span> (line <span class="line-number">612</span>) |
| 1306 |
</div> |
| 1307 |
|
| 1308 |
<!-- ========== Info from phpDoc block ========= --> |
| 1309 |
<p class="short-description">This builds an action column cell</p> |
| 1310 |
<ul class="tags"> |
| 1311 |
<li><span class="field">return:</span> <p>object</p></li> |
| 1312 |
</ul> |
| 1313 |
|
| 1314 |
<div class="method-signature"> |
| 1315 |
<span class="method-result">HTMLTag</span> |
| 1316 |
<span class="method-name"> |
| 1317 |
_build_action_column |
| 1318 |
</span> |
| 1319 |
(<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>]) |
| 1320 |
</div> |
| 1321 |
|
| 1322 |
<ul class="parameters"> |
| 1323 |
<li> |
| 1324 |
<span class="var-type">string</span> |
| 1325 |
<span class="var-name">$col</span><span class="var-description">: <p>- the column to test for FIRST or LAST</p></span> </li> |
| 1326 |
<li> |
| 1327 |
<span class="var-type">boolean</span> |
| 1328 |
<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> |
| 1329 |
<li> |
| 1330 |
<span class="var-type">array</span> |
| 1331 |
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
| 1332 |
</ul> |
| 1333 |
|
| 1334 |
|
| 1335 |
</div> |
| 1336 |
<a name="method_build_search_title" id="_build_search_title"><!-- --></a> |
| 1337 |
<div class="evenrow"> |
| 1338 |
|
| 1339 |
<div class="method-header"> |
| 1340 |
<span class="method-title">_build_search_title</span> (line <span class="line-number">423</span>) |
| 1341 |
</div> |
| 1342 |
|
| 1343 |
<!-- ========== Info from phpDoc block ========= --> |
| 1344 |
<p class="short-description">This function builds the search title table</p> |
| 1345 |
<ul class="tags"> |
| 1346 |
<li><span class="field">return:</span> <p>object</p></li> |
| 1347 |
</ul> |
| 1348 |
|
| 1349 |
<div class="method-signature"> |
| 1350 |
<span class="method-result"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
| 1351 |
<span class="method-name"> |
| 1352 |
_build_search_title |
| 1353 |
</span> |
| 1354 |
() |
| 1355 |
</div> |
| 1356 |
|
| 1357 |
|
| 1358 |
|
| 1359 |
</div> |
| 1360 |
<a name="method_build_simple_search_form" id="_build_simple_search_form"><!-- --></a> |
| 1361 |
<div class="oddrow"> |
| 1362 |
|
| 1363 |
<div class="method-header"> |
| 1364 |
<span class="method-title">_build_simple_search_form</span> (line <span class="line-number">441</span>) |
| 1365 |
</div> |
| 1366 |
|
| 1367 |
<!-- ========== Info from phpDoc block ========= --> |
| 1368 |
<p class="short-description">This function builds the simple search TD</p> |
| 1369 |
|
| 1370 |
<div class="method-signature"> |
| 1371 |
<span class="method-result"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></span> |
| 1372 |
<span class="method-name"> |
| 1373 |
_build_simple_search_form |
| 1374 |
</span> |
| 1375 |
() |
| 1376 |
</div> |
| 1377 |
|
| 1378 |
|
| 1379 |
|
| 1380 |
</div> |
| 1381 |
<a name="method_checkbox_javascript" id="_checkbox_javascript"><!-- --></a> |
| 1382 |
<div class="evenrow"> |
| 1383 |
|
| 1384 |
<div class="method-header"> |
| 1385 |
<span class="method-title">_checkbox_javascript</span> (line <span class="line-number">916</span>) |
| 1386 |
</div> |
| 1387 |
|
| 1388 |
<!-- ========== Info from phpDoc block ========= --> |
| 1389 |
<p class="short-description">This function builds the JS needed for the checkbox action column</p> |
| 1390 |
|
| 1391 |
<div class="method-signature"> |
| 1392 |
<span class="method-result"><a href="../phpHtmlLib/SCRIPTtag.html">SCRIPTtag</a></span> |
| 1393 |
<span class="method-name"> |
| 1394 |
_checkbox_javascript |
| 1395 |
</span> |
| 1396 |
() |
| 1397 |
</div> |
| 1398 |
|
| 1399 |
|
| 1400 |
|
| 1401 |
</div> |
| 1402 |
<a name="method_has_action_column" id="_has_action_column"><!-- --></a> |
| 1403 |
<div class="oddrow"> |
| 1404 |
|
| 1405 |
<div class="method-header"> |
| 1406 |
<span class="method-title">_has_action_column</span> (line <span class="line-number">562</span>) |
| 1407 |
</div> |
| 1408 |
|
| 1409 |
<!-- ========== Info from phpDoc block ========= --> |
| 1410 |
<p class="short-description">This function tests to see if the child wants to render an action column</p> |
| 1411 |
|
| 1412 |
<div class="method-signature"> |
| 1413 |
<span class="method-result">boolean</span> |
| 1414 |
<span class="method-name"> |
| 1415 |
_has_action_column |
| 1416 |
</span> |
| 1417 |
(<span class="var-type">string</span> <span class="var-name">$col</span>) |
| 1418 |
</div> |
| 1419 |
|
| 1420 |
<ul class="parameters"> |
| 1421 |
<li> |
| 1422 |
<span class="var-type">string</span> |
| 1423 |
<span class="var-name">$col</span><span class="var-description">: <p>- the column to test for FIRST or LAST</p></span> </li> |
| 1424 |
</ul> |
| 1425 |
|
| 1426 |
|
| 1427 |
</div> |
| 1428 |
<a name="method_is_col_checked" id="_is_col_checked"><!-- --></a> |
| 1429 |
<div class="evenrow"> |
| 1430 |
|
| 1431 |
<div class="method-header"> |
| 1432 |
<span class="method-title">_is_col_checked</span> (line <span class="line-number">703</span>) |
| 1433 |
</div> |
| 1434 |
|
| 1435 |
<!-- ========== Info from phpDoc block ========= --> |
| 1436 |
<p class="short-description">This method checks to see if a particular row has been checked in the action column</p> |
| 1437 |
|
| 1438 |
<div class="method-signature"> |
| 1439 |
<span class="method-result">boolean.</span> |
| 1440 |
<span class="method-name"> |
| 1441 |
_is_col_checked |
| 1442 |
</span> |
| 1443 |
(<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>) |
| 1444 |
</div> |
| 1445 |
|
| 1446 |
<ul class="parameters"> |
| 1447 |
<li> |
| 1448 |
<span class="var-type">string</span> |
| 1449 |
<span class="var-name">$value</span><span class="var-description">: <p>- the item to look for</p></span> </li> |
| 1450 |
<li> |
| 1451 |
<span class="var-type">array</span> |
| 1452 |
<span class="var-name">$row_data</span><span class="var-description">: <p>- the row's data.</p></span> </li> |
| 1453 |
</ul> |
| 1454 |
|
| 1455 |
|
| 1456 |
</div> |
| 1457 |
<a name="method_javascript" id="_javascript"><!-- --></a> |
| 1458 |
<div class="oddrow"> |
| 1459 |
|
| 1460 |
<div class="method-header"> |
| 1461 |
<span class="method-title">_javascript</span> (line <span class="line-number">897</span>) |
| 1462 |
</div> |
| 1463 |
|
| 1464 |
<!-- ========== Info from phpDoc block ========= --> |
| 1465 |
<p class="short-description">This function returns any Javascript required for this widget</p> |
| 1466 |
|
| 1467 |
<div class="method-signature"> |
| 1468 |
<span class="method-result">mixed</span> |
| 1469 |
<span class="method-name"> |
| 1470 |
_javascript |
| 1471 |
</span> |
| 1472 |
() |
| 1473 |
</div> |
| 1474 |
|
| 1475 |
|
| 1476 |
<hr class="separator" /> |
| 1477 |
<div class="notes">Redefinition of:</div> |
| 1478 |
<dl> |
| 1479 |
<dt><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></dt> |
| 1480 |
<dd>This function provides a way to automatically add javascript to this object.</dd> |
| 1481 |
</dl> |
| 1482 |
|
| 1483 |
</div> |
| 1484 |
<a name="method_save_checked_items_enabled" id="_save_checked_items_enabled"><!-- --></a> |
| 1485 |
<div class="evenrow"> |
| 1486 |
|
| 1487 |
<div class="method-header"> |
| 1488 |
<span class="method-title">_save_checked_items_enabled</span> (line <span class="line-number">550</span>) |
| 1489 |
</div> |
| 1490 |
|
| 1491 |
<!-- ========== Info from phpDoc block ========= --> |
| 1492 |
<p class="short-description">This tests the object flag to</p> |
| 1493 |
<p class="description"><p>see if the child class wants to automatically save the checked items</p></p> |
| 1494 |
|
| 1495 |
<div class="method-signature"> |
| 1496 |
<span class="method-result">boolean</span> |
| 1497 |
<span class="method-name"> |
| 1498 |
_save_checked_items_enabled |
| 1499 |
</span> |
| 1500 |
() |
| 1501 |
</div> |
| 1502 |
|
| 1503 |
|
| 1504 |
|
| 1505 |
</div> |
| 1506 |
<h4>Inherited Methods</h4> |
| 1507 |
<a name='inherited_methods'><!-- --></a> |
| 1508 |
<!-- =========== Summary =========== --> |
| 1509 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p> |
| 1510 |
<blockquote> |
| 1511 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></span><br> |
| 1512 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></span><br> |
| 1513 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></span><br> |
| 1514 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></span><br> |
| 1515 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></span><br> |
| 1516 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></span><br> |
| 1517 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></span><br> |
| 1518 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></span><br> |
| 1519 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></span><br> |
| 1520 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></span><br> |
| 1521 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></span><br> |
| 1522 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></span><br> |
| 1523 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></span><br> |
| 1524 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></span><br> |
| 1525 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></span><br> |
| 1526 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></span><br> |
| 1527 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></span><br> |
| 1528 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></span><br> |
| 1529 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></span><br> |
| 1530 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddo_action">DataList::do_action()</a></span><br> |
| 1531 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></span><br> |
| 1532 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></span><br> |
| 1533 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></span><br> |
| 1534 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></span><br> |
| 1535 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></span><br> |
| 1536 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></span><br> |
| 1537 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></span><br> |
| 1538 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></span><br> |
| 1539 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></span><br> |
| 1540 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></span><br> |
| 1541 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></span><br> |
| 1542 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></span><br> |
| 1543 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></span><br> |
| 1544 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></span><br> |
| 1545 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></span><br> |
| 1546 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></span><br> |
| 1547 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></span><br> |
| 1548 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></span><br> |
| 1549 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></span><br> |
| 1550 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></span><br> |
| 1551 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></span><br> |
| 1552 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></span><br> |
| 1553 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></span><br> |
| 1554 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></span><br> |
| 1555 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></span><br> |
| 1556 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></span><br> |
| 1557 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></span><br> |
| 1558 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></span><br> |
| 1559 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></span><br> |
| 1560 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></span><br> |
| 1561 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></span><br> |
| 1562 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></span><br> |
| 1563 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></span><br> |
| 1564 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></span><br> |
| 1565 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></span><br> |
| 1566 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></span><br> |
| 1567 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></span><br> |
| 1568 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></span><br> |
| 1569 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></span><br> |
| 1570 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></span><br> |
| 1571 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></span><br> |
| 1572 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></span><br> |
| 1573 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></span><br> |
| 1574 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></span><br> |
| 1575 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></span><br> |
| 1576 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></span><br> |
| 1577 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></span><br> |
| 1578 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></span><br> |
| 1579 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></span><br> |
| 1580 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodshowall">DataList::showall()</a></span><br> |
| 1581 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></span><br> |
| 1582 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></span><br> |
| 1583 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></span><br> |
| 1584 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></span><br> |
| 1585 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></span><br> |
| 1586 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></span><br> |
| 1587 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></span><br> |
| 1588 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></span><br> |
| 1589 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></span><br> |
| 1590 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></span><br> |
| 1591 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></span><br> |
| 1592 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></span><br> |
| 1593 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></span><br> |
| 1594 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></span><br> |
| 1595 |
<span class="method-name"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></span><br> |
| 1596 |
</blockquote> |
| 1597 |
<!-- =========== Summary =========== --> |
| 1598 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 1599 |
<blockquote> |
| 1600 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
| 1601 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
| 1602 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
| 1603 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
| 1604 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
| 1605 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
| 1606 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
| 1607 |
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
| 1608 |
</blockquote> |
| 1609 |
<!-- =========== Summary =========== --> |
| 1610 |
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
| 1611 |
<blockquote> |
| 1612 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
| 1613 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
| 1614 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
| 1615 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
| 1616 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
| 1617 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
| 1618 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
| 1619 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
| 1620 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
| 1621 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
| 1622 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
| 1623 |
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
| 1624 |
</blockquote> |
| 1625 |
|
| 1626 |
</div> |
| 1627 |
</div> |
| 1628 |
|
| 1629 |
<p class="notes" id="credit"> |
| 1630 |
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> |
| 1631 |
</p> |
| 1632 |
</div></body> |
| 1633 |
</html> |
Parent Directory
| 
Revision Log
