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 |
<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> <p>LGPL - See LICENCE</p></li> |
30 |
<li><span class="field">author:</span> <p>Suren Markossian <<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>></p></li> |
31 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
32 |
</ul> |
33 |
<p class="notes"> |
34 |
Located in <a class="field" href="_form_form_elements_FEListBox_inc.html">Program_Root/form/form_elements/FEListBox.inc</a> (line <span class="field">106</span>) |
35 |
</p> |
36 |
|
37 |
|
38 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
39 |
| |
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 |
--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 |
<a name="sec-method-summary"></a> |
79 |
<div class="info-box"> |
80 |
<div class="info-box-title">Method Summary</span></div> |
81 |
<div class="nav-bar"> |
82 |
<a href="#sec-description">Description</a> | |
83 |
<a href="#sec-descendents">Descendents</a> | |
84 |
<a href="#sec-vars">Vars</a> |
85 |
|
86 |
| |
87 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
88 |
</div> |
89 |
<div class="info-box-body"> |
90 |
<div class="method-summary"> |
91 |
|
92 |
<div class="method-definition"> |
93 |
<span class="method-result">void</span> |
94 |
<a href="#create_element_name" title="details" class="method-name">create_element_name</a> |
95 |
() |
96 |
</div> |
97 |
|
98 |
<div class="method-definition"> |
99 |
<span class="method-result">object</span> |
100 |
<a href="#get_element" title="details" class="method-name">get_element</a> |
101 |
() |
102 |
</div> |
103 |
</div> |
104 |
</div> |
105 |
</div> |
106 |
|
107 |
<a name="sec-vars"></a> |
108 |
<div class="info-box"> |
109 |
<div class="info-box-title">Variables</div> |
110 |
<div class="nav-bar"> |
111 |
<a href="#sec-description">Description</a> | |
112 |
<a href="#sec-descendents">Descendents</a> | |
113 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
114 |
|
115 |
|
116 |
| |
117 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
118 |
|
119 |
</div> |
120 |
<div class="info-box-body"> |
121 |
<h4>Inherited Variables</h4> |
122 |
<A NAME='inherited_vars'><!-- --></A> |
123 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p> |
124 |
<blockquote> |
125 |
<span class="var-title"> |
126 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_data_list">FEDataList::$_data_list</a></span><br> |
127 |
</span> |
128 |
</blockquote> |
129 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
130 |
<blockquote> |
131 |
<span class="var-title"> |
132 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br> |
133 |
</span> |
134 |
<span class="var-title"> |
135 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br> |
136 |
</span> |
137 |
</blockquote> |
138 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
139 |
<blockquote> |
140 |
<span class="var-title"> |
141 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
142 |
</span> |
143 |
<span class="var-title"> |
144 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
145 |
</span> |
146 |
<span class="var-title"> |
147 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
148 |
</span> |
149 |
<span class="var-title"> |
150 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
151 |
</span> |
152 |
<span class="var-title"> |
153 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
154 |
</span> |
155 |
<span class="var-title"> |
156 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
157 |
</span> |
158 |
<span class="var-title"> |
159 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
160 |
</span> |
161 |
<span class="var-title"> |
162 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
163 |
</span> |
164 |
<span class="var-title"> |
165 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
166 |
</span> |
167 |
<span class="var-title"> |
168 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
169 |
</span> |
170 |
<span class="var-title"> |
171 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
172 |
</span> |
173 |
<span class="var-title"> |
174 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
175 |
</span> |
176 |
</blockquote> |
177 |
|
178 |
</div> |
179 |
</div> |
180 |
|
181 |
<a name="sec-methods"></a> |
182 |
<div class="info-box"> |
183 |
<div class="info-box-title">Methods</div> |
184 |
<div class="nav-bar"> |
185 |
<a href="#sec-description">Description</a> | |
186 |
<a href="#sec-descendents">Descendents</a> | |
187 |
<a href="#sec-vars">Vars</a> |
188 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
189 |
|
190 |
</div> |
191 |
<div class="info-box-body"> |
192 |
<A NAME='method_detail'></A> |
193 |
<a name="methodcreate_element_name" id="create_element_name"><!-- --></a> |
194 |
<div class="oddrow"> |
195 |
|
196 |
<div class="method-header"> |
197 |
<span class="method-title">create_element_name</span> (line <span class="line-number">117</span>) |
198 |
</div> |
199 |
|
200 |
<!-- ========== Info from phpDoc block ========= --> |
201 |
<p class="short-description">This function creates element name used in the form based on the text label or any other parameters</p> |
202 |
<p class="description"><p>Overriding things function to make sure an array is created instead of a single variable</p></p> |
203 |
|
204 |
<div class="method-signature"> |
205 |
<span class="method-result">void</span> |
206 |
<span class="method-name"> |
207 |
create_element_name |
208 |
</span> |
209 |
() |
210 |
</div> |
211 |
|
212 |
|
213 |
<hr class="separator" /> |
214 |
<div class="notes">Redefinition of:</div> |
215 |
<dl> |
216 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></dt> |
217 |
<dd>This function creates element name</dd> |
218 |
</dl> |
219 |
|
220 |
</div> |
221 |
<a name="methodget_element" id="get_element"><!-- --></a> |
222 |
<div class="evenrow"> |
223 |
|
224 |
<div class="method-header"> |
225 |
<span class="method-title">get_element</span> (line <span class="line-number">130</span>) |
226 |
</div> |
227 |
|
228 |
<!-- ========== Info from phpDoc block ========= --> |
229 |
<p class="short-description">This function builds and returns the form element object</p> |
230 |
|
231 |
<div class="method-signature"> |
232 |
<span class="method-result">object</span> |
233 |
<span class="method-name"> |
234 |
get_element |
235 |
</span> |
236 |
() |
237 |
</div> |
238 |
|
239 |
|
240 |
<hr class="separator" /> |
241 |
<div class="notes">Redefinition of:</div> |
242 |
<dl> |
243 |
<dt><a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a></dt> |
244 |
<dd>This function builds and returns the form element object</dd> |
245 |
</dl> |
246 |
|
247 |
<hr class="separator" /> |
248 |
<div class="notes">Redefined in descendants as:</div> |
249 |
<ul class="redefinitions"> |
250 |
<li> |
251 |
<a href="../../phpHtmlLib/FormProcessing/FECheckBoxList.html#methodget_element">FECheckBoxList::get_element()</a> |
252 |
: This function builds and returns the form element object |
253 |
</li> |
254 |
</ul> |
255 |
</div> |
256 |
<h4>Inherited Methods</h4> |
257 |
<a name='inherited_methods'><!-- --></a> |
258 |
<!-- =========== Summary =========== --> |
259 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a></span></p> |
260 |
<blockquote> |
261 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a></span><br> |
262 |
</blockquote> |
263 |
<!-- =========== Summary =========== --> |
264 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p> |
265 |
<blockquote> |
266 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodFEDataList">FEDataList::FEDataList()</a></span><br> |
267 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></span><br> |
268 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodset_list_data">FEDataList::set_list_data()</a></span><br> |
269 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a></span><br> |
270 |
</blockquote> |
271 |
<!-- =========== Summary =========== --> |
272 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
273 |
<blockquote> |
274 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br> |
275 |
</blockquote> |
276 |
<!-- =========== Summary =========== --> |
277 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
278 |
<blockquote> |
279 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
280 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
281 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
282 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
283 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
284 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
285 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
286 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
287 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
288 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
289 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
290 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
291 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
292 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
293 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
294 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
295 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
296 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
297 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
298 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
299 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
300 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
301 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
302 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
303 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
304 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
305 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
306 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
307 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
308 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
309 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
310 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
311 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
312 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
313 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
314 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
315 |
</blockquote> |
316 |
|
317 |
</div> |
318 |
</div> |
319 |
|
320 |
<p class="notes" id="credit"> |
321 |
Documention generated on Thu, 31 Jul 2003 18:32:31 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
322 |
</p> |
323 |
</div></body> |
324 |
</html> |