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

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

Parent Directory Parent Directory | Revision Log Revision Log

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