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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (hide annotations)
Thu May 6 16:26:08 2004 UTC (20 years, 4 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +374 -316 lines
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
1 jonen 1.3 <?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 FEMultiListBox</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 FEMultiListBox</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-descendents">Descendents</a>
20     | <a href="#sec-vars">Vars</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 is the MultiListBox FormElement which builds a select field with all of its options. It enables the ability to have multiple selections.</p>
27     <p class="description"><p>It has no validation method.</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 &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
31     <li><span class="field">author:</span> Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>&gt;</li>
32     </ul>
33     <p class="notes">
34     Located in <a class="field" href="_form_form_elements_FEListBox_inc.html">/form/form_elements/FEListBox.inc</a> (line <span class="field">307</span>)
35     </p>
36    
37    
38 jonen 1.2 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
39 jonen 1.1 |
40     --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>
41     |
42     --<a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a>
43     |
44     --<a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a>
45     |
46 jonen 1.3 --FEMultiListBox</pre>
47    
48     </div>
49     </div>
50    
51     <a name="sec-descendents"></a>
52     <div class="info-box">
53     <div class="info-box-title">Direct descendents</div>
54     <div class="nav-bar">
55     <a href="#sec-description">Description</a> |
56     <span class="disabled">Descendents</span>
57     | <a href="#sec-vars">Vars</a>
58     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
59    
60     </div>
61     <div class="info-box-body">
62     <table cellpadding="2" cellspacing="0" class="class-table">
63     <tr>
64     <th class="class-table-header">Class</th>
65     <th class="class-table-header">Description</th>
66     </tr>
67     <tr>
68     <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FECheckBoxList.html">FECheckBoxList</a></td>
69     <td>
70     This is the CheckBoxList FormElement which builds a list of checkboxes inside a scrollable DIV.
71     </td>
72     </tr>
73     </table>
74     </div>
75     </div>
76    
77    
78    
79     <a name="sec-method-summary"></a>
80     <div class="info-box">
81     <div class="info-box-title">Method Summary</span></div>
82     <div class="nav-bar">
83     <a href="#sec-description">Description</a> |
84     <a href="#sec-descendents">Descendents</a> |
85     <a href="#sec-vars">Vars</a>
86    
87     |
88     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
89     </div>
90     <div class="info-box-body">
91     <div class="method-summary">
92    
93     <div class="method-definition">
94     <span class="method-result">void</span>
95     <a href="#create_element_name" title="details" class="method-name">create_element_name</a>
96     ()
97     </div>
98    
99     <div class="method-definition">
100     <span class="method-result">object</span>
101     <a href="#get_element" title="details" class="method-name">get_element</a>
102     ()
103     </div>
104    
105     <div class="method-definition">
106     <span class="method-result">string</span>
107     <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
108     ()
109     </div>
110     </div>
111     </div>
112     </div>
113    
114     <a name="sec-vars"></a>
115     <div class="info-box">
116     <div class="info-box-title">Variables</div>
117     <div class="nav-bar">
118     <a href="#sec-description">Description</a> |
119     <a href="#sec-descendents">Descendents</a> |
120     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
121    
122    
123     |
124     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
125    
126     </div>
127     <div class="info-box-body">
128     <h4>Inherited Variables</h4>
129     <A NAME='inherited_vars'><!-- --></A>
130     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p>
131     <blockquote>
132     <span class="var-title">
133     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_data_list">FEDataList::$_data_list</a></span><br>
134     </span>
135     <span class="var-title">
136     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_disabled_items">FEDataList::$_disabled_items</a></span><br>
137     </span>
138     </blockquote>
139     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
140     <blockquote>
141     <span class="var-title">
142     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br>
143     </span>
144     <span class="var-title">
145     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br>
146     </span>
147     </blockquote>
148     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
149     <blockquote>
150     <span class="var-title">
151     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
152     </span>
153     <span class="var-title">
154     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
155     </span>
156     <span class="var-title">
157     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
158     </span>
159     <span class="var-title">
160     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
161     </span>
162     <span class="var-title">
163     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
164     </span>
165     <span class="var-title">
166     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
167     </span>
168     <span class="var-title">
169     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
170     </span>
171     <span class="var-title">
172     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
173     </span>
174     <span class="var-title">
175     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
176     </span>
177     <span class="var-title">
178     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
179     </span>
180     <span class="var-title">
181     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
182     </span>
183     <span class="var-title">
184     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
185     </span>
186     <span class="var-title">
187     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
188     </span>
189     <span class="var-title">
190     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
191     </span>
192     <span class="var-title">
193     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
194     </span>
195     </blockquote>
196    
197     </div>
198     </div>
199    
200     <a name="sec-methods"></a>
201     <div class="info-box">
202     <div class="info-box-title">Methods</div>
203     <div class="nav-bar">
204     <a href="#sec-description">Description</a> |
205     <a href="#sec-descendents">Descendents</a> |
206     <a href="#sec-vars">Vars</a>
207     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
208    
209     </div>
210     <div class="info-box-body">
211     <A NAME='method_detail'></A>
212     <a name="methodcreate_element_name" id="create_element_name"><!-- --></a>
213     <div class="oddrow">
214    
215     <div class="method-header">
216     <span class="method-title">create_element_name</span> (line <span class="line-number">318</span>)
217     </div>
218    
219     <!-- ========== Info from phpDoc block ========= -->
220     <p class="short-description">This function creates element name used in the form based on the text label or any other parameters</p>
221     <p class="description"><p>Overriding things function to make sure an array is created instead of a single variable</p></p>
222    
223     <div class="method-signature">
224     <span class="method-result">void</span>
225     <span class="method-name">
226     create_element_name
227     </span>
228     ()
229     </div>
230    
231    
232     <hr class="separator" />
233     <div class="notes">Redefinition of:</div>
234     <dl>
235     <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></dt>
236     <dd>This function creates element name</dd>
237     </dl>
238    
239     </div>
240     <a name="methodget_element" id="get_element"><!-- --></a>
241     <div class="evenrow">
242    
243     <div class="method-header">
244     <span class="method-title">get_element</span> (line <span class="line-number">349</span>)
245     </div>
246    
247     <!-- ========== Info from phpDoc block ========= -->
248     <p class="short-description">This function builds and returns the form element object</p>
249    
250     <div class="method-signature">
251     <span class="method-result">object</span>
252     <span class="method-name">
253     get_element
254     </span>
255     ()
256     </div>
257    
258    
259     <hr class="separator" />
260     <div class="notes">Redefinition of:</div>
261     <dl>
262     <dt><a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a></dt>
263     <dd>This function builds and returns the form element object</dd>
264     </dl>
265    
266     <hr class="separator" />
267     <div class="notes">Redefined in descendants as:</div>
268     <ul class="redefinitions">
269     <li>
270     <a href="../../phpHtmlLib/FormProcessing/FECheckBoxList.html#methodget_element">FECheckBoxList::get_element()</a>
271     : This function builds and returns the form element object
272     </li>
273     </ul>
274     </div>
275     <a name="methodget_value_text" id="get_value_text"><!-- --></a>
276     <div class="oddrow">
277    
278     <div class="method-header">
279     <span class="method-title">get_value_text</span> (line <span class="line-number">330</span>)
280     </div>
281    
282     <!-- ========== Info from phpDoc block ========= -->
283     <p class="short-description">build the string for the confirmation page</p>
284    
285     <div class="method-signature">
286     <span class="method-result">string</span>
287     <span class="method-name">
288     get_value_text
289     </span>
290     ()
291     </div>
292    
293    
294     <hr class="separator" />
295     <div class="notes">Redefinition of:</div>
296     <dl>
297     <dt><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></dt>
298     <dd>This provides a method</dd>
299     </dl>
300    
301     </div>
302     <h4>Inherited Methods</h4>
303     <a name='inherited_methods'><!-- --></a>
304     <!-- =========== Summary =========== -->
305     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a></span></p>
306     <blockquote>
307     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a></span><br>
308     </blockquote>
309     <!-- =========== Summary =========== -->
310     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p>
311     <blockquote>
312     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodFEDataList">FEDataList::FEDataList()</a></span><br>
313     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methoddisable_item">FEDataList::disable_item()</a></span><br>
314     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></span><br>
315     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodset_list_data">FEDataList::set_list_data()</a></span><br>
316     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a></span><br>
317     </blockquote>
318     <!-- =========== Summary =========== -->
319     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
320     <blockquote>
321     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br>
322     </blockquote>
323     <!-- =========== Summary =========== -->
324     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
325     <blockquote>
326     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
327     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
328     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
329     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
330     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
331     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
332     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
333     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
334     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
335     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
336     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
337     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
338     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
339     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
340     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
341     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
342     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
343     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
344     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
345     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
346     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
347     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
348     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
349     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
350     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
351     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
352     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
353     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
354     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
355     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
356     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
357     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
358     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
359     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
360     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
361     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
362     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
363     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
364     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
365     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
366     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
367     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
368     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
369     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
370     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
371     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
372     </blockquote>
373    
374     </div>
375     </div>
376    
377    
378     <p class="notes" id="credit">
379     Documentation generated on Thu, 1 Apr 2004 09:38:28 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
380     </p>
381     </div></body>
382     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed