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

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

Parent Directory Parent Directory | Revision Log Revision Log

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