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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations)
Thu May 6 16:24:21 2004 UTC (20 years, 2 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +965 -963 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
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 ListAction</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 ListAction</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">A class for showing a list of items to preform an action on</p>
27 <ul class="tags">
28 <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
29 </ul>
30 <p class="notes">
31 Located in <a class="field" href="_widgets_data_list_ListAction_inc.html">/widgets/data_list/ListAction.inc</a> (line <span class="field">18</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 --ListAction</pre>
42
43 </div>
44 </div>
45
46
47
48 <a name="sec-var-summary"></a>
49 <div class="info-box">
50 <div class="info-box-title">Variable Summary</span></div>
51 <div class="nav-bar">
52 <a href="#sec-description">Description</a> |
53 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
54 |
55 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
56
57 </div>
58 <div class="info-box-body">
59 <div class="var-summary">
60 <div class="var-title">
61 <span class="var-type">mixed</span>
62 <a href="#$_action_name" title="details" class="var-name">$_action_name</a>
63 </div>
64 <div class="var-title">
65 <span class="var-type">mixed</span>
66 <a href="#$_align" title="details" class="var-name">$_align</a>
67 </div>
68 <div class="var-title">
69 <span class="var-type">mixed</span>
70 <a href="#$_cancel_url" title="details" class="var-name">$_cancel_url</a>
71 </div>
72 <div class="var-title">
73 <span class="var-type">mixed</span>
74 <a href="#$_data_post_name" title="details" class="var-name">$_data_post_name</a>
75 </div>
76 <div class="var-title">
77 <span class="var-type">mixed</span>
78 <a href="#$_item_name" title="details" class="var-name">$_item_name</a>
79 </div>
80 <div class="var-title">
81 <span class="var-type">mixed</span>
82 <a href="#$_save_all_vars" title="details" class="var-name">$_save_all_vars</a>
83 </div>
84 </div>
85 </div>
86 </div>
87
88 <a name="sec-method-summary"></a>
89 <div class="info-box">
90 <div class="info-box-title">Method Summary</span></div>
91 <div class="nav-bar">
92 <a href="#sec-description">Description</a> |
93 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
94
95 |
96 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
97 </div>
98 <div class="info-box-body">
99 <div class="method-summary">
100
101 <div class="method-definition">
102 <span class="method-result">mixed</span>
103 <a href="#build_column_header" title="details" class="method-name">build_column_header</a>
104 (<span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$col_data</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$col_num</span>)
105 </div>
106
107 <div class="method-definition">
108 <span class="method-result">string</span>
109 <a href="#build_in_clause" title="details" class="method-name">build_in_clause</a>
110 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
111 </div>
112
113 <div class="method-definition">
114 <span class="method-result">void</span>
115 <a href="#build_options" title="details" class="method-name">build_options</a>
116 ()
117 </div>
118
119 <div class="method-definition">
120 <span class="method-result">void</span>
121 <a href="#child_add_row_cell" title="details" class="method-name">child_add_row_cell</a>
122 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$last_in_row_flag</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$row_data</span>)
123 </div>
124
125 <div class="method-definition">
126 <span class="method-result">void</span>
127 <a href="#child_build_column_header" title="details" class="method-name">child_build_column_header</a>
128 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$col</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$cnt</span>)
129 </div>
130
131 <div class="method-definition">
132 <span class="method-result">void</span>
133 <a href="#child_get_gui" title="details" class="method-name">child_get_gui</a>
134 ()
135 </div>
136
137 <div class="method-definition">
138 <span class="method-result">string</span>
139 <a href="#get_cancel_url" title="details" class="method-name">get_cancel_url</a>
140 ()
141 </div>
142
143 <div class="method-definition">
144 <span class="method-result">void</span>
145 <a href="#gui_init" title="details" class="method-name">gui_init</a>
146 ()
147 </div>
148
149 <div class="method-definition">
150 <span class="method-result">void</span>
151 <a href="#set_action_name" title="details" class="method-name">set_action_name</a>
152 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
153 </div>
154
155 <div class="method-definition">
156 <span class="method-result">void</span>
157 <a href="#set_align" title="details" class="method-name">set_align</a>
158 (<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span>)
159 </div>
160
161 <div class="method-definition">
162 <span class="method-result">void</span>
163 <a href="#set_cancel_url" title="details" class="method-name">set_cancel_url</a>
164 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
165 </div>
166
167 <div class="method-definition">
168 <span class="method-result">void</span>
169 <a href="#set_item_name" title="details" class="method-name">set_item_name</a>
170 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
171 </div>
172
173 <div class="method-definition">
174 <span class="method-result">void</span>
175 <a href="#set_save_vars_Flag" title="details" class="method-name">set_save_vars_Flag</a>
176 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
177 </div>
178
179 <div class="method-definition">
180 <span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span>
181 <a href="#wrap_column_item" title="details" class="method-name">wrap_column_item</a>
182 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">2</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">3</span>)
183 </div>
184
185 <div class="method-definition">
186 <span class="method-result">void</span>
187 <a href="#_build_delete_confirm" title="details" class="method-name">_build_delete_confirm</a>
188 ()
189 </div>
190
191 <div class="method-definition">
192 <span class="method-result">Container</span>
193 <a href="#_build_hidden_vars" title="details" class="method-name">_build_hidden_vars</a>
194 ()
195 </div>
196 </div>
197 </div>
198 </div>
199
200 <a name="sec-vars"></a>
201 <div class="info-box">
202 <div class="info-box-title">Variables</div>
203 <div class="nav-bar">
204 <a href="#sec-description">Description</a> |
205 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
206
207
208 |
209 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
210
211 </div>
212 <div class="info-box-body">
213 <a name="var$_action_name" id="$_action_name"><!-- --></A>
214 <div class="evenrow">
215
216 <div class="var-header">
217 <span class="var-title">
218 <span class="var-type">mixed</span>
219 <span class="var-name">$_action_name</span>
220 = <span class="var-default"> 'delete'</span> (line <span class="line-number">25</span>)
221 </span>
222 </div>
223
224 <!-- ========== Info from phpDoc block ========= -->
225 <p class="short-description">The string that describes</p>
226 <p class="description"><p>the action ie. 'delete'</p></p>
227
228
229
230
231
232 </div>
233 <a name="var$_align" id="$_align"><!-- --></A>
234 <div class="oddrow">
235
236 <div class="var-header">
237 <span class="var-title">
238 <span class="var-type">mixed</span>
239 <span class="var-name">$_align</span>
240 = <span class="var-default"> &quot;center&quot;</span> (line <span class="line-number">40</span>)
241 </span>
242 </div>
243
244 <!-- ========== Info from phpDoc block ========= -->
245 <p class="short-description">The overall alignment</p>
246 <p class="description"><p>DEFAULT: &quot;center&quot;</p></p>
247
248
249
250
251
252 </div>
253 <a name="var$_cancel_url" id="$_cancel_url"><!-- --></A>
254 <div class="evenrow">
255
256 <div class="var-header">
257 <span class="var-title">
258 <span class="var-type">mixed</span>
259 <span class="var-name">$_cancel_url</span>
260 = <span class="var-default"> &quot;index.php&quot;</span> (line <span class="line-number">53</span>)
261 </span>
262 </div>
263
264 <!-- ========== Info from phpDoc block ========= -->
265 <p class="short-description">This sets the url for the</p>
266 <p class="description"><p>cancel action to post to</p></p>
267
268
269
270
271
272 </div>
273 <a name="var$_data_post_name" id="$_data_post_name"><!-- --></A>
274 <div class="oddrow">
275
276 <div class="var-header">
277 <span class="var-title">
278 <span class="var-type">mixed</span>
279 <span class="var-name">$_data_post_name</span>
280 = <span class="var-default"> &quot;checkbox&quot;</span> (line <span class="line-number">61</span>)
281 </span>
282 </div>
283
284 <!-- ========== Info from phpDoc block ========= -->
285 <p class="short-description">The name of the array variable</p>
286 <p class="description"><p>that the data was posted to us</p></p>
287
288
289
290
291
292 </div>
293 <a name="var$_item_name" id="$_item_name"><!-- --></A>
294 <div class="evenrow">
295
296 <div class="var-header">
297 <span class="var-title">
298 <span class="var-type">mixed</span>
299 <span class="var-name">$_item_name</span>
300 = <span class="var-default"> ''</span> (line <span class="line-number">33</span>)
301 </span>
302 </div>
303
304 <!-- ========== Info from phpDoc block ========= -->
305 <p class="short-description">name/description of the type of</p>
306 <p class="description"><p>data we are working on ie 'users', 'files'</p></p>
307
308
309
310
311
312 </div>
313 <a name="var$_save_all_vars" id="$_save_all_vars"><!-- --></A>
314 <div class="oddrow">
315
316 <div class="var-header">
317 <span class="var-title">
318 <span class="var-type">mixed</span>
319 <span class="var-name">$_save_all_vars</span>
320 = <span class="var-default"> TRUE</span> (line <span class="line-number">47</span>)
321 </span>
322 </div>
323
324 <!-- ========== Info from phpDoc block ========= -->
325 <p class="short-description">A flag to tell us to save all</p>
326 <p class="description"><p>vars passed</p></p>
327
328
329
330
331
332 </div>
333
334 <h4>Inherited Variables</h4>
335 <A NAME='inherited_vars'><!-- --></A>
336 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p>
337 <blockquote>
338 <span class="var-title">
339 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$alternating_row_colors">DataList::$alternating_row_colors</a></span><br>
340 </span>
341 <span class="var-title">
342 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_advanced_search_flag">DataList::$_advanced_search_flag</a></span><br>
343 </span>
344 <span class="var-title">
345 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_columns">DataList::$_columns</a></span><br>
346 </span>
347 <span class="var-title">
348 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_datasource">DataList::$_datasource</a></span><br>
349 </span>
350 <span class="var-title">
351 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_orderby">DataList::$_default_orderby</a></span><br>
352 </span>
353 <span class="var-title">
354 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_reverseorder">DataList::$_default_reverseorder</a></span><br>
355 </span>
356 <span class="var-title">
357 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_default_rows_per_page">DataList::$_default_rows_per_page</a></span><br>
358 </span>
359 <span class="var-title">
360 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_attributes">DataList::$_form_attributes</a></span><br>
361 </span>
362 <span class="var-title">
363 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_form_render_flag">DataList::$_form_render_flag</a></span><br>
364 </span>
365 <span class="var-title">
366 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_global_prefix">DataList::$_global_prefix</a></span><br>
367 </span>
368 <span class="var-title">
369 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_image_path">DataList::$_image_path</a></span><br>
370 </span>
371 <span class="var-title">
372 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_max_rows">DataList::$_max_rows</a></span><br>
373 </span>
374 <span class="var-title">
375 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_columns">DataList::$_num_columns</a></span><br>
376 </span>
377 <span class="var-title">
378 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_num_pages">DataList::$_num_pages</a></span><br>
379 </span>
380 <span class="var-title">
381 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_save_vars">DataList::$_save_vars</a></span><br>
382 </span>
383 <span class="var-title">
384 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_flag">DataList::$_search_flag</a></span><br>
385 </span>
386 <span class="var-title">
387 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_search_table">DataList::$_search_table</a></span><br>
388 </span>
389 <span class="var-title">
390 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_all_rows">DataList::$_show_all_rows</a></span><br>
391 </span>
392 <span class="var-title">
393 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_show_results_flag">DataList::$_show_results_flag</a></span><br>
394 </span>
395 <span class="var-title">
396 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_simple_search_modifier">DataList::$_simple_search_modifier</a></span><br>
397 </span>
398 <span class="var-title">
399 <span class="var-name"><a href="../phpHtmlLib/DataList.html#var$_vars">DataList::$_vars</a></span><br>
400 </span>
401 </blockquote>
402 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
403 <blockquote>
404 <span class="var-title">
405 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
406 </span>
407 <span class="var-title">
408 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
409 </span>
410 </blockquote>
411
412 </div>
413 </div>
414
415 <a name="sec-methods"></a>
416 <div class="info-box">
417 <div class="info-box-title">Methods</div>
418 <div class="nav-bar">
419 <a href="#sec-description">Description</a> |
420 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
421 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
422
423 </div>
424 <div class="info-box-body">
425 <A NAME='method_detail'></A>
426 <a name="methodbuild_column_header" id="build_column_header"><!-- --></a>
427 <div class="evenrow">
428
429 <div class="method-header">
430 <span class="method-title">build_column_header</span> (line <span class="line-number">159</span>)
431 </div>
432
433 <!-- ========== Info from phpDoc block ========= -->
434 <p class="short-description">This function builds the object/text</p>
435 <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>
436 <ul class="tags">
437 <li><span class="field">return:</span> - either an Atag object or raw text.</li>
438 </ul>
439
440 <div class="method-signature">
441 <span class="method-result">mixed</span>
442 <span class="method-name">
443 build_column_header
444 </span>
445 (<span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$col_data</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$col_num</span>)
446 </div>
447
448 <ul class="parameters">
449 <li>
450 <span class="var-type">string</span>
451 <span class="var-name">$col_name</span><span class="var-description">: - the column name to build from the headers.</span> </li>
452 <li>
453 <span class="var-type">array</span>
454 <span class="var-name">$col_data</span><span class="var-description">: - the column's data.</span> </li>
455 <li>
456 <span class="var-type">int</span>
457 <span class="var-name">$col_num</span><span class="var-description">: the column # we are working on.</span> </li>
458 </ul>
459
460
461 </div>
462 <a name="methodbuild_in_clause" id="build_in_clause"><!-- --></a>
463 <div class="oddrow">
464
465 <div class="method-header">
466 <span class="method-title">build_in_clause</span> (line <span class="line-number">281</span>)
467 </div>
468
469 <!-- ========== Info from phpDoc block ========= -->
470 <p class="short-description">This method is used to build the portion</p>
471 <p class="description"><p>of the DB query that limits the list of items to show based on what was submitted from the original DataList action</p></p>
472
473 <div class="method-signature">
474 <span class="method-result">string</span>
475 <span class="method-name">
476 build_in_clause
477 </span>
478 (<span class="var-type">string</span>&nbsp;<span class="var-name">$field</span>)
479 </div>
480
481 <ul class="parameters">
482 <li>
483 <span class="var-type">string</span>
484 <span class="var-name">$field</span><span class="var-description">: - the field</span> </li>
485 </ul>
486
487
488 </div>
489 <a name="methodbuild_options" id="build_options"><!-- --></a>
490 <div class="evenrow">
491
492 <div class="method-header">
493 <span class="method-title">build_options</span> (line <span class="line-number">267</span>)
494 </div>
495
496 <!-- ========== Info from phpDoc block ========= -->
497 <p class="short-description">Build any additional custom options such as checkboxes, radiobuttons for special options for the action.</p>
498
499 <div class="method-signature">
500 <span class="method-result">void</span>
501 <span class="method-name">
502 build_options
503 </span>
504 ()
505 </div>
506
507
508
509 </div>
510 <a name="methodchild_add_row_cell" id="child_add_row_cell"><!-- --></a>
511 <div class="oddrow">
512
513 <div class="method-header">
514 <span class="method-title">child_add_row_cell</span> (line <span class="line-number">112</span>)
515 </div>
516
517 <!-- ========== Info from phpDoc block ========= -->
518
519 <div class="method-signature">
520 <span class="method-result">void</span>
521 <span class="method-name">
522 child_add_row_cell
523 </span>
524 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$last_in_row_flag</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$row_data</span>)
525 </div>
526
527
528 <hr class="separator" />
529 <div class="notes">Redefinition of:</div>
530 <dl>
531 <dt><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></dt>
532 <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>
533 </dl>
534
535 </div>
536 <a name="methodchild_build_column_header" id="child_build_column_header"><!-- --></a>
537 <div class="evenrow">
538
539 <div class="method-header">
540 <span class="method-title">child_build_column_header</span> (line <span class="line-number">106</span>)
541 </div>
542
543 <!-- ========== Info from phpDoc block ========= -->
544
545 <div class="method-signature">
546 <span class="method-result">void</span>
547 <span class="method-name">
548 child_build_column_header
549 </span>
550 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$col</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$cnt</span>)
551 </div>
552
553
554 <hr class="separator" />
555 <div class="notes">Redefinition of:</div>
556 <dl>
557 <dt><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></dt>
558 <dd>This method is supposed to be written by the child class to build and add the column title to the UI</dd>
559 </dl>
560
561 </div>
562 <a name="methodchild_get_gui" id="child_get_gui"><!-- --></a>
563 <div class="oddrow">
564
565 <div class="method-header">
566 <span class="method-title">child_get_gui</span> (line <span class="line-number">98</span>)
567 </div>
568
569 <!-- ========== Info from phpDoc block ========= -->
570
571 <div class="method-signature">
572 <span class="method-result">void</span>
573 <span class="method-name">
574 child_get_gui
575 </span>
576 ()
577 </div>
578
579
580 <hr class="separator" />
581 <div class="notes">Redefinition of:</div>
582 <dl>
583 <dt><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></dt>
584 <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>
585 </dl>
586
587 </div>
588 <a name="methodget_cancel_url" id="get_cancel_url"><!-- --></a>
589 <div class="evenrow">
590
591 <div class="method-header">
592 <span class="method-title">get_cancel_url</span> (line <span class="line-number">427</span>)
593 </div>
594
595 <!-- ========== Info from phpDoc block ========= -->
596 <p class="short-description">this returns the current cancel url</p>
597 <ul class="tags">
598 <li><span class="field">return:</span> - the url</li>
599 </ul>
600
601 <div class="method-signature">
602 <span class="method-result">string</span>
603 <span class="method-name">
604 get_cancel_url
605 </span>
606 ()
607 </div>
608
609
610
611 </div>
612 <a name="methodgui_init" id="gui_init"><!-- --></a>
613 <div class="oddrow">
614
615 <div class="method-header">
616 <span class="method-title">gui_init</span> (line <span class="line-number">72</span>)
617 </div>
618
619 <!-- ========== Info from phpDoc block ========= -->
620 <p class="short-description">Initialize the gui layout</p>
621
622 <div class="method-signature">
623 <span class="method-result">void</span>
624 <span class="method-name">
625 gui_init
626 </span>
627 ()
628 </div>
629
630
631 <hr class="separator" />
632 <div class="notes">Redefinition of:</div>
633 <dl>
634 <dt><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></dt>
635 <dd>A subclass can override this function to setup the class variables after the constructor. The constructor automatically calls this function.</dd>
636 </dl>
637
638 </div>
639 <a name="methodset_action_name" id="set_action_name"><!-- --></a>
640 <div class="evenrow">
641
642 <div class="method-header">
643 <span class="method-title">set_action_name</span> (line <span class="line-number">397</span>)
644 </div>
645
646 <!-- ========== Info from phpDoc block ========= -->
647 <p class="short-description">Set the name of the action</p>
648 <p class="description"><p>used for display purposes only</p></p>
649
650 <div class="method-signature">
651 <span class="method-result">void</span>
652 <span class="method-name">
653 set_action_name
654 </span>
655 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
656 </div>
657
658
659
660 </div>
661 <a name="methodset_align" id="set_align"><!-- --></a>
662 <div class="oddrow">
663
664 <div class="method-header">
665 <span class="method-title">set_align</span> (line <span class="line-number">380</span>)
666 </div>
667
668 <!-- ========== Info from phpDoc block ========= -->
669 <p class="short-description">this function is used to set the overall alignment of the widget</p>
670
671 <div class="method-signature">
672 <span class="method-result">void</span>
673 <span class="method-name">
674 set_align
675 </span>
676 (<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span>)
677 </div>
678
679 <ul class="parameters">
680 <li>
681 <span class="var-type">string</span>
682 <span class="var-name">$align</span><span class="var-description">: - the align value</span> </li>
683 </ul>
684
685 <hr class="separator" />
686 <div class="notes">Redefinition of:</div>
687 <dl>
688 <dt><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></dt>
689 <dd>This function sets the align attribute for the outer table.</dd>
690 </dl>
691
692 </div>
693 <a name="methodset_cancel_url" id="set_cancel_url"><!-- --></a>
694 <div class="evenrow">
695
696 <div class="method-header">
697 <span class="method-title">set_cancel_url</span> (line <span class="line-number">418</span>)
698 </div>
699
700 <!-- ========== Info from phpDoc block ========= -->
701 <p class="short-description">This sets the url to post to when a cancel/no action is clicked</p>
702
703 <div class="method-signature">
704 <span class="method-result">void</span>
705 <span class="method-name">
706 set_cancel_url
707 </span>
708 (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
709 </div>
710
711 <ul class="parameters">
712 <li>
713 <span class="var-type">string</span>
714 <span class="var-name">$url</span><span class="var-description">: - the url</span> </li>
715 </ul>
716
717
718 </div>
719 <a name="methodset_item_name" id="set_item_name"><!-- --></a>
720 <div class="oddrow">
721
722 <div class="method-header">
723 <span class="method-title">set_item_name</span> (line <span class="line-number">389</span>)
724 </div>
725
726 <!-- ========== Info from phpDoc block ========= -->
727 <p class="short-description">Set the name of the deleted items</p>
728 <p class="description"><p>used for display purposes only</p></p>
729
730 <div class="method-signature">
731 <span class="method-result">void</span>
732 <span class="method-name">
733 set_item_name
734 </span>
735 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$item</span>)
736 </div>
737
738
739
740 </div>
741 <a name="methodset_save_vars_Flag" id="set_save_vars_Flag"><!-- --></a>
742 <div class="evenrow">
743
744 <div class="method-header">
745 <span class="method-title">set_save_vars_Flag</span> (line <span class="line-number">408</span>)
746 </div>
747
748 <!-- ========== Info from phpDoc block ========= -->
749 <p class="short-description">This method sets the flag that tells us to automatically add hidden form fields for all the GET/POST vars passed in to us.</p>
750
751 <div class="method-signature">
752 <span class="method-result">void</span>
753 <span class="method-name">
754 set_save_vars_Flag
755 </span>
756 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
757 </div>
758
759
760
761 </div>
762 <a name="methodwrap_column_item" id="wrap_column_item"><!-- --></a>
763 <div class="oddrow">
764
765 <div class="method-header">
766 <span class="method-title">wrap_column_item</span> (line <span class="line-number">222</span>)
767 </div>
768
769 <!-- ========== Info from phpDoc block ========= -->
770 <p class="short-description">This function ensures that the data we place in a column is aligned according to what the user wants.</p>
771 <ul class="tags">
772 <li><span class="field">return:</span> object</li>
773 </ul>
774
775 <div class="method-signature">
776 <span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span>
777 <span class="method-name">
778 wrap_column_item
779 </span>
780 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$obj</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$col_name</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">2</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">3</span>)
781 </div>
782
783 <ul class="parameters">
784 <li>
785 <span class="var-type">int</span>
786 <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>
787 <li>
788 <span class="var-type">int</span>
789 <span class="var-name">3</span><span class="var-description">: - the column # we are working on.</span> </li>
790 <li>
791 <span class="var-type">mixed</span>
792 <span class="var-name">$obj</span><span class="var-description">: - $obj - the data for the td.</span> </li>
793 <li>
794 <span class="var-type">string</span>
795 <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>
796 </ul>
797
798
799 </div>
800 <a name="method_build_delete_confirm" id="_build_delete_confirm"><!-- --></a>
801 <div class="evenrow">
802
803 <div class="method-header">
804 <span class="method-title">_build_delete_confirm</span> (line <span class="line-number">301</span>)
805 </div>
806
807 <!-- ========== Info from phpDoc block ========= -->
808 <p class="short-description">This function builds the actual form</p>
809
810 <div class="method-signature">
811 <span class="method-result">void</span>
812 <span class="method-name">
813 _build_delete_confirm
814 </span>
815 ()
816 </div>
817
818
819
820 </div>
821 <a name="method_build_hidden_vars" id="_build_hidden_vars"><!-- --></a>
822 <div class="oddrow">
823
824 <div class="method-header">
825 <span class="method-title">_build_hidden_vars</span> (line <span class="line-number">131</span>)
826 </div>
827
828 <!-- ========== Info from phpDoc block ========= -->
829 <p class="short-description">This builds the hidden form fields of the data that was originally sent to us</p>
830
831 <div class="method-signature">
832 <span class="method-result">Container</span>
833 <span class="method-name">
834 _build_hidden_vars
835 </span>
836 ()
837 </div>
838
839
840
841 </div>
842 <h4>Inherited Methods</h4>
843 <a name='inherited_methods'><!-- --></a>
844 <!-- =========== Summary =========== -->
845 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/DataList.html">DataList</a></span></p>
846 <blockquote>
847 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodDataList">DataList::DataList()</a></span><br>
848 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadd_header_item">DataList::add_header_item()</a></span><br>
849 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_disable">DataList::advanced_search_disable()</a></span><br>
850 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodadvanced_search_enable">DataList::advanced_search_enable()</a></span><br>
851 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_base_url">DataList::build_base_url()</a></span><br>
852 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_item">DataList::build_column_item()</a></span><br>
853 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_column_url">DataList::build_column_url()</a></span><br>
854 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_gui">DataList::build_gui()</a></span><br>
855 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_orderby_querystring">DataList::build_orderby_querystring()</a></span><br>
856 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_reverseorder_querystring">DataList::build_reverseorder_querystring()</a></span><br>
857 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchfield_querystring">DataList::build_searchfield_querystring()</a></span><br>
858 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_searchvalue_querystring">DataList::build_searchvalue_querystring()</a></span><br>
859 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_state_vars_query_string">DataList::build_state_vars_query_string()</a></span><br>
860 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodbuild_tool_link">DataList::build_tool_link()</a></span><br>
861 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_add_row_cell">DataList::child_add_row_cell()</a></span><br>
862 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_column_header">DataList::child_build_column_header()</a></span><br>
863 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_build_search_table">DataList::child_build_search_table()</a></span><br>
864 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodchild_get_gui">DataList::child_get_gui()</a></span><br>
865 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddata_prefetch">DataList::data_prefetch()</a></span><br>
866 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methoddo_action">DataList::do_action()</a></span><br>
867 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodexpandrows">DataList::expandrows()</a></span><br>
868 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodfilter_column_string">DataList::filter_column_string()</a></span><br>
869 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_current_page">DataList::get_current_page()</a></span><br>
870 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_data_source">DataList::get_data_source()</a></span><br>
871 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_default_num_rows">DataList::get_default_num_rows()</a></span><br>
872 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_action">DataList::get_form_action()</a></span><br>
873 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_method">DataList::get_form_method()</a></span><br>
874 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_name">DataList::get_form_name()</a></span><br>
875 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_render">DataList::get_form_render()</a></span><br>
876 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_form_target">DataList::get_form_target()</a></span><br>
877 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_global_prefix">DataList::get_global_prefix()</a></span><br>
878 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_image_path">DataList::get_image_path()</a></span><br>
879 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_last_page">DataList::get_last_page()</a></span><br>
880 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_max_rows">DataList::get_max_rows()</a></span><br>
881 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_num_pages">DataList::get_num_pages()</a></span><br>
882 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_page_info">DataList::get_page_info()</a></span><br>
883 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_showall">DataList::get_showall()</a></span><br>
884 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodget_simple_search_modifier">DataList::get_simple_search_modifier()</a></span><br>
885 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodgui_init">DataList::gui_init()</a></span><br>
886 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_advanced_search_enabled">DataList::is_advanced_search_enabled()</a></span><br>
887 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodis_search_enabled">DataList::is_search_enabled()</a></span><br>
888 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodnumrows">DataList::numrows()</a></span><br>
889 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodoffset">DataList::offset()</a></span><br>
890 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodorderby">DataList::orderby()</a></span><br>
891 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a></span><br>
892 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodreverseorder">DataList::reverseorder()</a></span><br>
893 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_disable">DataList::search_disable()</a></span><br>
894 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_enable">DataList::search_enable()</a></span><br>
895 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_field">DataList::search_field()</a></span><br>
896 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_type">DataList::search_type()</a></span><br>
897 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value">DataList::search_value()</a></span><br>
898 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsearch_value_filter">DataList::search_value_filter()</a></span><br>
899 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsetup_columns">DataList::setup_columns()</a></span><br>
900 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_data_source">DataList::set_data_source()</a></span><br>
901 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_default_num_rows">DataList::set_default_num_rows()</a></span><br>
902 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_expandrows">DataList::set_expandrows()</a></span><br>
903 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_action">DataList::set_form_action()</a></span><br>
904 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_method">DataList::set_form_method()</a></span><br>
905 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_name">DataList::set_form_name()</a></span><br>
906 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_render">DataList::set_form_render()</a></span><br>
907 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_form_target">DataList::set_form_target()</a></span><br>
908 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_global_prefix">DataList::set_global_prefix()</a></span><br>
909 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_image_path">DataList::set_image_path()</a></span><br>
910 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_max_rows">DataList::set_max_rows()</a></span><br>
911 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_not_found_message">DataList::set_not_found_message()</a></span><br>
912 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_numrows">DataList::set_numrows()</a></span><br>
913 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_offset">DataList::set_offset()</a></span><br>
914 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_reverseorder">DataList::set_reverseorder()</a></span><br>
915 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_save_vars">DataList::set_save_vars()</a></span><br>
916 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_search_type">DataList::set_search_type()</a></span><br>
917 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_showall">DataList::set_showall()</a></span><br>
918 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_show_results">DataList::set_show_results()</a></span><br>
919 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodset_simple_search_modifier">DataList::set_simple_search_modifier()</a></span><br>
920 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methodsimple_search_modifier_value">DataList::simple_search_modifier_value()</a></span><br>
921 <span class="method-name"><a href="../phpHtmlLib/DataList.html#methoduser_setup">DataList::user_setup()</a></span><br>
922 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_default_vars">DataList::_build_default_vars()</a></span><br>
923 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_save_vars">DataList::_build_save_vars()</a></span><br>
924 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_simple_search_modifier">DataList::_build_simple_search_modifier()</a></span><br>
925 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_build_tool_url">DataList::_build_tool_url()</a></span><br>
926 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_check_datasource">DataList::_check_datasource()</a></span><br>
927 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_clean_string">DataList::_clean_string()</a></span><br>
928 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_filter_column_string">DataList::_filter_column_string()</a></span><br>
929 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get">DataList::_get()</a></span><br>
930 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_get_searchable_fields">DataList::_get_searchable_fields()</a></span><br>
931 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_javascript">DataList::_javascript()</a></span><br>
932 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_save_mozilla_nav_link">DataList::_save_mozilla_nav_link()</a></span><br>
933 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_set">DataList::_set()</a></span><br>
934 <span class="method-name"><a href="../phpHtmlLib/DataList.html#method_show_results">DataList::_show_results()</a></span><br>
935 </blockquote>
936 <!-- =========== Summary =========== -->
937 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
938 <blockquote>
939 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
940 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
941 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
942 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
943 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
944 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
945 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
946 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
947 </blockquote>
948 <!-- =========== Summary =========== -->
949 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
950 <blockquote>
951 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
952 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
953 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
954 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
955 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
956 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
957 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
958 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
959 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
960 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
961 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
962 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
963 </blockquote>
964
965 </div>
966 </div>
967
968
969 <p class="notes" id="credit">
970 Documentation generated on Thu, 1 Apr 2004 09:39:02 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
971 </p>
972 </div></body>
973 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed