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