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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu May 6 16:57:07 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
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 FEComboListBox</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 FEComboListBox</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 builds a complex dual select box with buttons to move entries from one select box to another.</p>
27 <p class="description"><p>From Actions To -------- Add &gt;&gt; -------- |------| Add All |------| |------| |------| |------| |------| |------| Remove |------| |------| Remove All |------| |------| |------| -------- --------</p></p>
28 <ul class="tags">
29 <li><span class="field">copyright:</span> LGPL - See LICENCE</li>
30 <li><span class="field">author:</span> Walter A. Boring IV</li>
31 </ul>
32 <p class="notes">
33 Located in <a class="field" href="_form_form_elements_FEListBox_inc.html">/form/form_elements/FEListBox.inc</a> (line <span class="field">483</span>)
34 </p>
35
36
37 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
38 |
39 --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>
40 |
41 --<a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a>
42 |
43 --FEComboListBox</pre>
44
45 </div>
46 </div>
47
48
49
50 <a name="sec-var-summary"></a>
51 <div class="info-box">
52 <div class="info-box-title">Variable Summary</span></div>
53 <div class="nav-bar">
54 <a href="#sec-description">Description</a> |
55 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
56 |
57 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
58
59 </div>
60 <div class="info-box-body">
61 <div class="var-summary">
62 <div class="var-title">
63 <span class="var-type">mixed</span>
64 <a href="#$_data_list_to" title="details" class="var-name">$_data_list_to</a>
65 </div>
66 <div class="var-title">
67 <span class="var-type">string</span>
68 <a href="#$_from_label" title="details" class="var-name">$_from_label</a>
69 </div>
70 <div class="var-title">
71 <span class="var-type">string</span>
72 <a href="#$_has_form_on_submit" title="details" class="var-name">$_has_form_on_submit</a>
73 </div>
74 <div class="var-title">
75 <span class="var-type">string</span>
76 <a href="#$_to_label" title="details" class="var-name">$_to_label</a>
77 </div>
78 </div>
79 </div>
80 </div>
81
82 <a name="sec-method-summary"></a>
83 <div class="info-box">
84 <div class="info-box-title">Method Summary</span></div>
85 <div class="nav-bar">
86 <a href="#sec-description">Description</a> |
87 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
88
89 |
90 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
91 </div>
92 <div class="info-box-body">
93 <div class="method-summary">
94
95 <div class="method-definition">
96 <span class="method-result">FEComboListBox</span>
97 <a href="#FEComboListBox" title="details" class="method-name">FEComboListBox</a>
98 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"200px"</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">"100px"</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$from_data_list</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$to_data_list</span> = <span class="var-default">array()</span>])
99 </div>
100
101 <div class="method-definition">
102 <span class="method-result">string</span>
103 <a href="#form_tag_onsubmit" title="details" class="method-name">form_tag_onsubmit</a>
104 ()
105 </div>
106
107 <div class="method-definition">
108 <span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
109 <a href="#get_confirm_element" title="details" class="method-name">get_confirm_element</a>
110 ()
111 </div>
112
113 <div class="method-definition">
114 <span class="method-result">object</span>
115 <a href="#get_element" title="details" class="method-name">get_element</a>
116 ()
117 </div>
118
119 <div class="method-definition">
120 <span class="method-result">mixed</span>
121 <a href="#get_value" title="details" class="method-name">get_value</a>
122 ()
123 </div>
124
125 <div class="method-definition">
126 <span class="method-result">string</span>
127 <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
128 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">0</span>)
129 </div>
130
131 <div class="method-definition">
132 <span class="method-result">string</span>
133 <a href="#javascript" title="details" class="method-name">javascript</a>
134 ()
135 </div>
136
137 <div class="method-definition">
138 <span class="method-result">none</span>
139 <a href="#set_from_label" title="details" class="method-name">set_from_label</a>
140 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
141 </div>
142
143 <div class="method-definition">
144 <span class="method-result">none</span>
145 <a href="#set_to_label" title="details" class="method-name">set_to_label</a>
146 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
147 </div>
148
149 <div class="method-definition">
150 <span class="method-result">void</span>
151 <a href="#set_to_list_data" title="details" class="method-name">set_to_list_data</a>
152 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
153 </div>
154
155 <div class="method-definition">
156 <span class="method-result">void</span>
157 <a href="#set_value" title="details" class="method-name">set_value</a>
158 (<span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
159 </div>
160
161 <div class="method-definition">
162 <span class="method-result">void</span>
163 <a href="#validate" title="details" class="method-name">validate</a>
164 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
165 </div>
166 </div>
167 </div>
168 </div>
169
170 <a name="sec-vars"></a>
171 <div class="info-box">
172 <div class="info-box-title">Variables</div>
173 <div class="nav-bar">
174 <a href="#sec-description">Description</a> |
175 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
176
177
178 |
179 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
180
181 </div>
182 <div class="info-box-body">
183 <a name="var$_data_list_to" id="$_data_list_to"><!-- --></A>
184 <div class="evenrow">
185
186 <div class="var-header">
187 <span class="var-title">
188 <span class="var-type">mixed</span>
189 <span class="var-name">$_data_list_to</span>
190 = <span class="var-default">array()</span> (line <span class="line-number">492</span>)
191 </span>
192 </div>
193
194 <!-- ========== Info from phpDoc block ========= -->
195 <p class="short-description">Holds the list of available data elements for the 'to' box.</p>
196
197
198
199
200
201 </div>
202 <a name="var$_from_label" id="$_from_label"><!-- --></A>
203 <div class="oddrow">
204
205 <div class="var-header">
206 <span class="var-title">
207 <span class="var-type">string</span>
208 <span class="var-name">$_from_label</span>
209 = <span class="var-default"> 'Available'</span> (line <span class="line-number">499</span>)
210 </span>
211 </div>
212
213 <!-- ========== Info from phpDoc block ========= -->
214 <p class="short-description">The from field's label</p>
215
216
217
218
219
220 </div>
221 <a name="var$_has_form_on_submit" id="$_has_form_on_submit"><!-- --></A>
222 <div class="evenrow">
223
224 <div class="var-header">
225 <span class="var-title">
226 <span class="var-type">string</span>
227 <span class="var-name">$_has_form_on_submit</span>
228 = <span class="var-default"> true</span> (line <span class="line-number">515</span>)
229 </span>
230 </div>
231
232 <!-- ========== Info from phpDoc block ========= -->
233 <p class="short-description">This Form Element needs to propogate some js to the Form tag's onsubmit attribute</p>
234
235
236 <hr class="separator" />
237 <div class="notes">Redefinition of:</div>
238 <dl>
239 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></dt>
240 <dd>This Form Element needs to propogate some js to the Form tag's onsubmit attribute</dd>
241 </dl>
242
243
244
245 </div>
246 <a name="var$_to_label" id="$_to_label"><!-- --></A>
247 <div class="oddrow">
248
249 <div class="var-header">
250 <span class="var-title">
251 <span class="var-type">string</span>
252 <span class="var-name">$_to_label</span>
253 = <span class="var-default"> 'Selected'</span> (line <span class="line-number">506</span>)
254 </span>
255 </div>
256
257 <!-- ========== Info from phpDoc block ========= -->
258 <p class="short-description">The to field's label</p>
259
260
261
262
263
264 </div>
265
266 <h4>Inherited Variables</h4>
267 <A NAME='inherited_vars'><!-- --></A>
268 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p>
269 <blockquote>
270 <span class="var-title">
271 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_data_list">FEDataList::$_data_list</a></span><br>
272 </span>
273 <span class="var-title">
274 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_disabled_items">FEDataList::$_disabled_items</a></span><br>
275 </span>
276 </blockquote>
277 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
278 <blockquote>
279 <span class="var-title">
280 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br>
281 </span>
282 <span class="var-title">
283 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br>
284 </span>
285 </blockquote>
286 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
287 <blockquote>
288 <span class="var-title">
289 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
290 </span>
291 <span class="var-title">
292 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
293 </span>
294 <span class="var-title">
295 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
296 </span>
297 <span class="var-title">
298 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
299 </span>
300 <span class="var-title">
301 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
302 </span>
303 <span class="var-title">
304 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
305 </span>
306 <span class="var-title">
307 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
308 </span>
309 <span class="var-title">
310 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
311 </span>
312 <span class="var-title">
313 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
314 </span>
315 <span class="var-title">
316 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
317 </span>
318 <span class="var-title">
319 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
320 </span>
321 <span class="var-title">
322 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
323 </span>
324 <span class="var-title">
325 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
326 </span>
327 <span class="var-title">
328 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
329 </span>
330 </blockquote>
331
332 </div>
333 </div>
334
335 <a name="sec-methods"></a>
336 <div class="info-box">
337 <div class="info-box-title">Methods</div>
338 <div class="nav-bar">
339 <a href="#sec-description">Description</a> |
340 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
341 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
342
343 </div>
344 <div class="info-box-body">
345 <A NAME='method_detail'></A>
346 <a name="methodFEComboListBox" id="FEComboListBox"><!-- --></a>
347 <div class="evenrow">
348
349 <div class="method-header">
350 <span class="method-title">Constructor FEComboListBox</span> (line <span class="line-number">528</span>)
351 </div>
352
353 <!-- ========== Info from phpDoc block ========= -->
354 <p class="short-description">The constructor</p>
355
356 <div class="method-signature">
357 <span class="method-result">FEComboListBox</span>
358 <span class="method-name">
359 FEComboListBox
360 </span>
361 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"200px"</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">"100px"</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$from_data_list</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$to_data_list</span> = <span class="var-default">array()</span>])
362 </div>
363
364 <ul class="parameters">
365 <li>
366 <span class="var-type">string</span>
367 <span class="var-name">$label</span><span class="var-description">: text label for the element</span> </li>
368 <li>
369 <span class="var-type">boolean</span>
370 <span class="var-name">$required</span><span class="var-description">: is this a required element?</span> </li>
371 <li>
372 <span class="var-type">int</span>
373 <span class="var-name">$width</span><span class="var-description">: element width in characters, pixels (px), percentage (%) or elements (em)</span> </li>
374 <li>
375 <span class="var-type">int</span>
376 <span class="var-name">$height</span><span class="var-description">: element height in px</span> </li>
377 <li>
378 <span class="var-type">array</span>
379 <span class="var-name">$from_data_list</span><span class="var-description">: list of 'from' field data elements (name=&gt;value)</span> </li>
380 <li>
381 <span class="var-type">array</span>
382 <span class="var-name">$to_data_list</span><span class="var-description">: list of 'to' field data elements (name=&gt;value)</span> </li>
383 </ul>
384
385
386 </div>
387 <a name="methodform_tag_onsubmit" id="form_tag_onsubmit"><!-- --></a>
388 <div class="oddrow">
389
390 <div class="method-header">
391 <span class="method-title">form_tag_onsubmit</span> (line <span class="line-number">724</span>)
392 </div>
393
394 <!-- ========== Info from phpDoc block ========= -->
395 <p class="short-description">This is a method for getting the JS needed for the form tag's onsubmit attribute.</p>
396
397 <div class="method-signature">
398 <span class="method-result">string</span>
399 <span class="method-name">
400 form_tag_onsubmit
401 </span>
402 ()
403 </div>
404
405
406 <hr class="separator" />
407 <div class="notes">Redefinition of:</div>
408 <dl>
409 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></dt>
410 <dd>This is a method for getting the JS needed for the form tag's onsubmit attribute.</dd>
411 </dl>
412
413 </div>
414 <a name="methodget_confirm_element" id="get_confirm_element"><!-- --></a>
415 <div class="evenrow">
416
417 <div class="method-header">
418 <span class="method-title">get_confirm_element</span> (line <span class="line-number">765</span>)
419 </div>
420
421 <!-- ========== Info from phpDoc block ========= -->
422 <p class="short-description">This method returns the hidden version of this element for a confirmation page.</p>
423 <p class="description"><p>NOTE: This is called by the FormProcessor only. It shouldn't be called manually.</p></p>
424 <ul class="tags">
425 <li><span class="field">return:</span> of type hidden</li>
426 </ul>
427
428 <div class="method-signature">
429 <span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
430 <span class="method-name">
431 get_confirm_element
432 </span>
433 ()
434 </div>
435
436
437 <hr class="separator" />
438 <div class="notes">Redefinition of:</div>
439 <dl>
440 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></dt>
441 <dd>This method returns the hidden version of this element for a confirmation page.</dd>
442 </dl>
443
444 </div>
445 <a name="methodget_element" id="get_element"><!-- --></a>
446 <div class="oddrow">
447
448 <div class="method-header">
449 <span class="method-title">get_element</span> (line <span class="line-number">617</span>)
450 </div>
451
452 <!-- ========== Info from phpDoc block ========= -->
453 <p class="short-description">This function builds and returns the form element object</p>
454
455 <div class="method-signature">
456 <span class="method-result">object</span>
457 <span class="method-name">
458 get_element
459 </span>
460 ()
461 </div>
462
463
464 <hr class="separator" />
465 <div class="notes">Redefinition of:</div>
466 <dl>
467 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
468 <dd>This function builds and returns the form element object</dd>
469 </dl>
470
471 </div>
472 <a name="methodget_value" id="get_value"><!-- --></a>
473 <div class="evenrow">
474
475 <div class="method-header">
476 <span class="method-title">get_value</span> (line <span class="line-number">751</span>)
477 </div>
478
479 <!-- ========== Info from phpDoc block ========= -->
480 <p class="short-description">This function will return the elements value</p>
481
482 <div class="method-signature">
483 <span class="method-result">mixed</span>
484 <span class="method-name">
485 get_value
486 </span>
487 ()
488 </div>
489
490
491 <hr class="separator" />
492 <div class="notes">Redefinition of:</div>
493 <dl>
494 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></dt>
495 <dd>This function will return the elements value</dd>
496 </dl>
497
498 </div>
499 <a name="methodget_value_text" id="get_value_text"><!-- --></a>
500 <div class="oddrow">
501
502 <div class="method-header">
503 <span class="method-title">get_value_text</span> (line <span class="line-number">714</span>)
504 </div>
505
506 <!-- ========== Info from phpDoc block ========= -->
507 <p class="short-description">This provides a method</p>
508 <p class="description"><p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p></p>
509 <ul class="tags">
510 <li><span class="field">return:</span> - the text associated</li>
511 </ul>
512
513 <div class="method-signature">
514 <span class="method-result">string</span>
515 <span class="method-name">
516 get_value_text
517 </span>
518 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">0</span>)
519 </div>
520
521 <ul class="parameters">
522 <li>
523 <span class="var-type">mixed</span>
524 <span class="var-name">0</span><span class="var-description">: - the value to look up</span> </li>
525 </ul>
526
527 <hr class="separator" />
528 <div class="notes">Redefinition of:</div>
529 <dl>
530 <dt><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></dt>
531 <dd>This provides a method</dd>
532 </dl>
533
534 </div>
535 <a name="methodjavascript" id="javascript"><!-- --></a>
536 <div class="evenrow">
537
538 <div class="method-header">
539 <span class="method-title">javascript</span> (line <span class="line-number">735</span>)
540 </div>
541
542 <!-- ========== Info from phpDoc block ========= -->
543 <p class="short-description">This method builds the Javascript needed for this element.</p>
544 <ul class="tags">
545 <li><span class="field">return:</span> The javascript.</li>
546 </ul>
547
548 <div class="method-signature">
549 <span class="method-result">string</span>
550 <span class="method-name">
551 javascript
552 </span>
553 ()
554 </div>
555
556
557 <hr class="separator" />
558 <div class="notes">Redefinition of:</div>
559 <dl>
560 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></dt>
561 <dd>This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor</dd>
562 </dl>
563
564 </div>
565 <a name="methodset_from_label" id="set_from_label"><!-- --></a>
566 <div class="oddrow">
567
568 <div class="method-header">
569 <span class="method-title">set_from_label</span> (line <span class="line-number">551</span>)
570 </div>
571
572 <!-- ========== Info from phpDoc block ========= -->
573 <p class="short-description">Use this method to set the label for the 'from' field</p>
574
575 <div class="method-signature">
576 <span class="method-result">none</span>
577 <span class="method-name">
578 set_from_label
579 </span>
580 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
581 </div>
582
583 <ul class="parameters">
584 <li>
585 <span class="var-type">string</span>
586 <span class="var-name">$label</span> </li>
587 </ul>
588
589
590 </div>
591 <a name="methodset_to_label" id="set_to_label"><!-- --></a>
592 <div class="evenrow">
593
594 <div class="method-header">
595 <span class="method-title">set_to_label</span> (line <span class="line-number">562</span>)
596 </div>
597
598 <!-- ========== Info from phpDoc block ========= -->
599 <p class="short-description">Use this method to set the label for the 'to' field</p>
600
601 <div class="method-signature">
602 <span class="method-result">none</span>
603 <span class="method-name">
604 set_to_label
605 </span>
606 (<span class="var-type">string</span>&nbsp;<span class="var-name">$label</span>)
607 </div>
608
609 <ul class="parameters">
610 <li>
611 <span class="var-type">string</span>
612 <span class="var-name">$label</span> </li>
613 </ul>
614
615
616 </div>
617 <a name="methodset_to_list_data" id="set_to_list_data"><!-- --></a>
618 <div class="oddrow">
619
620 <div class="method-header">
621 <span class="method-title">set_to_list_data</span> (line <span class="line-number">540</span>)
622 </div>
623
624 <!-- ========== Info from phpDoc block ========= -->
625 <p class="short-description">This function sets the array of data to be used in the data list</p>
626
627 <div class="method-signature">
628 <span class="method-result">void</span>
629 <span class="method-name">
630 set_to_list_data
631 </span>
632 ([<span class="var-type">array</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
633 </div>
634
635 <ul class="parameters">
636 <li>
637 <span class="var-type">array</span>
638 <span class="var-name">$data_list</span><span class="var-description">: data_list - list of data elements (name=&gt;value)</span> </li>
639 </ul>
640
641
642 </div>
643 <a name="methodset_value" id="set_value"><!-- --></a>
644 <div class="evenrow">
645
646 <div class="method-header">
647 <span class="method-title">set_value</span> (line <span class="line-number">573</span>)
648 </div>
649
650 <!-- ========== Info from phpDoc block ========= -->
651 <p class="short-description">This function will set the initial value for the element</p>
652
653 <div class="method-signature">
654 <span class="method-result">void</span>
655 <span class="method-name">
656 set_value
657 </span>
658 (<span class="var-type">value</span>&nbsp;<span class="var-name">$value</span>)
659 </div>
660
661 <ul class="parameters">
662 <li>
663 <span class="var-type">value</span>
664 <span class="var-name">$value</span><span class="var-description">: mixed</span> </li>
665 </ul>
666
667 <hr class="separator" />
668 <div class="notes">Redefinition of:</div>
669 <dl>
670 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></dt>
671 <dd>This function will set the initial value for the element</dd>
672 </dl>
673
674 </div>
675 <a name="methodvalidate" id="validate"><!-- --></a>
676 <div class="oddrow">
677
678 <div class="method-header">
679 <span class="method-title">validate</span> (line <span class="line-number">673</span>)
680 </div>
681
682 <!-- ========== Info from phpDoc block ========= -->
683 <p class="short-description">This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p>
684 <p class="description"><p>NOTE: This makes sure that the data submitted for both fields is in the original list.</p></p>
685
686 <div class="method-signature">
687 <span class="method-result">void</span>
688 <span class="method-name">
689 validate
690 </span>
691 (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
692 </div>
693
694 <ul class="parameters">
695 <li>
696 <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
697 <span class="var-name">&$_FormValidation</span><span class="var-description">: object</span> </li>
698 </ul>
699
700 <hr class="separator" />
701 <div class="notes">Redefinition of:</div>
702 <dl>
703 <dt><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a></dt>
704 <dd>This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</dd>
705 </dl>
706
707 </div>
708 <h4>Inherited Methods</h4>
709 <a name='inherited_methods'><!-- --></a>
710 <!-- =========== Summary =========== -->
711 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p>
712 <blockquote>
713 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodFEDataList">FEDataList::FEDataList()</a></span><br>
714 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methoddisable_item">FEDataList::disable_item()</a></span><br>
715 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></span><br>
716 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodset_list_data">FEDataList::set_list_data()</a></span><br>
717 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a></span><br>
718 </blockquote>
719 <!-- =========== Summary =========== -->
720 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
721 <blockquote>
722 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br>
723 </blockquote>
724 <!-- =========== Summary =========== -->
725 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
726 <blockquote>
727 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
728 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
729 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
730 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
731 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
732 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
733 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
734 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
735 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
736 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
737 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
738 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
739 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
740 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
741 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
742 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
743 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
744 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
745 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
746 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
747 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
748 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
749 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
750 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
751 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
752 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
753 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
754 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
755 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
756 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
757 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
758 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
759 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
760 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
761 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
762 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
763 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
764 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
765 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
766 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
767 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
768 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
769 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
770 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
771 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
772 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
773 </blockquote>
774
775 </div>
776 </div>
777
778
779 <p class="notes" id="credit">
780 Documentation generated on Thu, 1 Apr 2004 09:38:23 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
781 </p>
782 </div></body>
783 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed