| 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 FEListBox</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 FEListBox</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 ListBox FormElement which builds a select field with all of its options.</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">29</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 |
--FEListBox</pre> |
| 45 |
|
| 46 |
</div> |
| 47 |
</div> |
| 48 |
|
| 49 |
<a name="sec-descendents"></a> |
| 50 |
<div class="info-box"> |
| 51 |
<div class="info-box-title">Direct descendents</div> |
| 52 |
<div class="nav-bar"> |
| 53 |
<a href="#sec-description">Description</a> | |
| 54 |
<span class="disabled">Descendents</span> |
| 55 |
| <a href="#sec-vars">Vars</a> |
| 56 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 57 |
|
| 58 |
</div> |
| 59 |
<div class="info-box-body"> |
| 60 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
| 61 |
<tr> |
| 62 |
<th class="class-table-header">Class</th> |
| 63 |
<th class="class-table-header">Description</th> |
| 64 |
</tr> |
| 65 |
<tr> |
| 66 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEYesNoListBox.html">FEYesNoListBox</a></td> |
| 67 |
<td> |
| 68 |
Build a Yes/No Select box |
| 69 |
</td> |
| 70 |
</tr> |
| 71 |
<tr> |
| 72 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html">FEMultiListBox</a></td> |
| 73 |
<td> |
| 74 |
This is the MultiListBox FormElement which builds a select field with all of its options. It enables the ability to have multiple selections. |
| 75 |
</td> |
| 76 |
</tr> |
| 77 |
</table> |
| 78 |
</div> |
| 79 |
</div> |
| 80 |
|
| 81 |
|
| 82 |
<a name="sec-method-summary"></a> |
| 83 |
<div class="info-box"> |
| 84 |
<div class="info-box-title">Method Summary</span></div> |
| 85 |
<div class="nav-bar"> |
| 86 |
<a href="#sec-description">Description</a> | |
| 87 |
<a href="#sec-descendents">Descendents</a> | |
| 88 |
<a href="#sec-vars">Vars</a> |
| 89 |
|
| 90 |
| |
| 91 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 92 |
</div> |
| 93 |
<div class="info-box-body"> |
| 94 |
<div class="method-summary"> |
| 95 |
|
| 96 |
<div class="method-definition"> |
| 97 |
<span class="method-result">object</span> |
| 98 |
<a href="#get_element" title="details" class="method-name">get_element</a> |
| 99 |
() |
| 100 |
</div> |
| 101 |
</div> |
| 102 |
</div> |
| 103 |
</div> |
| 104 |
|
| 105 |
<a name="sec-vars"></a> |
| 106 |
<div class="info-box"> |
| 107 |
<div class="info-box-title">Variables</div> |
| 108 |
<div class="nav-bar"> |
| 109 |
<a href="#sec-description">Description</a> | |
| 110 |
<a href="#sec-descendents">Descendents</a> | |
| 111 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 112 |
|
| 113 |
|
| 114 |
| |
| 115 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 116 |
|
| 117 |
</div> |
| 118 |
<div class="info-box-body"> |
| 119 |
<h4>Inherited Variables</h4> |
| 120 |
<A NAME='inherited_vars'><!-- --></A> |
| 121 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p> |
| 122 |
<blockquote> |
| 123 |
<span class="var-title"> |
| 124 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_data_list">FEDataList::$_data_list</a></span><br> |
| 125 |
</span> |
| 126 |
</blockquote> |
| 127 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
| 128 |
<blockquote> |
| 129 |
<span class="var-title"> |
| 130 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br> |
| 131 |
</span> |
| 132 |
<span class="var-title"> |
| 133 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br> |
| 134 |
</span> |
| 135 |
</blockquote> |
| 136 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
| 137 |
<blockquote> |
| 138 |
<span class="var-title"> |
| 139 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
| 140 |
</span> |
| 141 |
<span class="var-title"> |
| 142 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
| 143 |
</span> |
| 144 |
<span class="var-title"> |
| 145 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
| 146 |
</span> |
| 147 |
<span class="var-title"> |
| 148 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
| 149 |
</span> |
| 150 |
<span class="var-title"> |
| 151 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
| 152 |
</span> |
| 153 |
<span class="var-title"> |
| 154 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
| 155 |
</span> |
| 156 |
<span class="var-title"> |
| 157 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
| 158 |
</span> |
| 159 |
<span class="var-title"> |
| 160 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
| 161 |
</span> |
| 162 |
<span class="var-title"> |
| 163 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
| 164 |
</span> |
| 165 |
<span class="var-title"> |
| 166 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
| 167 |
</span> |
| 168 |
<span class="var-title"> |
| 169 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
| 170 |
</span> |
| 171 |
<span class="var-title"> |
| 172 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
| 173 |
</span> |
| 174 |
</blockquote> |
| 175 |
|
| 176 |
</div> |
| 177 |
</div> |
| 178 |
|
| 179 |
<a name="sec-methods"></a> |
| 180 |
<div class="info-box"> |
| 181 |
<div class="info-box-title">Methods</div> |
| 182 |
<div class="nav-bar"> |
| 183 |
<a href="#sec-description">Description</a> | |
| 184 |
<a href="#sec-descendents">Descendents</a> | |
| 185 |
<a href="#sec-vars">Vars</a> |
| 186 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 187 |
|
| 188 |
</div> |
| 189 |
<div class="info-box-body"> |
| 190 |
<A NAME='method_detail'></A> |
| 191 |
<a name="methodget_element" id="get_element"><!-- --></a> |
| 192 |
<div class="evenrow"> |
| 193 |
|
| 194 |
<div class="method-header"> |
| 195 |
<span class="method-title">get_element</span> (line <span class="line-number">37</span>) |
| 196 |
</div> |
| 197 |
|
| 198 |
<!-- ========== Info from phpDoc block ========= --> |
| 199 |
<p class="short-description">This function builds and returns the form element object</p> |
| 200 |
|
| 201 |
<div class="method-signature"> |
| 202 |
<span class="method-result">object</span> |
| 203 |
<span class="method-name"> |
| 204 |
get_element |
| 205 |
</span> |
| 206 |
() |
| 207 |
</div> |
| 208 |
|
| 209 |
|
| 210 |
<hr class="separator" /> |
| 211 |
<div class="notes">Redefinition of:</div> |
| 212 |
<dl> |
| 213 |
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt> |
| 214 |
<dd>This function builds and returns the form element object</dd> |
| 215 |
</dl> |
| 216 |
|
| 217 |
<hr class="separator" /> |
| 218 |
<div class="notes">Redefined in descendants as:</div> |
| 219 |
<ul class="redefinitions"> |
| 220 |
<li> |
| 221 |
<a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodget_element">FEMultiListBox::get_element()</a> |
| 222 |
: This function builds and returns the form element object |
| 223 |
</li> |
| 224 |
<li> |
| 225 |
<a href="../../phpHtmlLib/FormProcessing/FECheckBoxList.html#methodget_element">FECheckBoxList::get_element()</a> |
| 226 |
: This function builds and returns the form element object |
| 227 |
</li> |
| 228 |
</ul> |
| 229 |
</div> |
| 230 |
<h4>Inherited Methods</h4> |
| 231 |
<a name='inherited_methods'><!-- --></a> |
| 232 |
<!-- =========== Summary =========== --> |
| 233 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p> |
| 234 |
<blockquote> |
| 235 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodFEDataList">FEDataList::FEDataList()</a></span><br> |
| 236 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></span><br> |
| 237 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodset_list_data">FEDataList::set_list_data()</a></span><br> |
| 238 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a></span><br> |
| 239 |
</blockquote> |
| 240 |
<!-- =========== Summary =========== --> |
| 241 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
| 242 |
<blockquote> |
| 243 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br> |
| 244 |
</blockquote> |
| 245 |
<!-- =========== Summary =========== --> |
| 246 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
| 247 |
<blockquote> |
| 248 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
| 249 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
| 250 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
| 251 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
| 252 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
| 253 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
| 254 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
| 255 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
| 256 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
| 257 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
| 258 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
| 259 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
| 260 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
| 261 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
| 262 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
| 263 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
| 264 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
| 265 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
| 266 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
| 267 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
| 268 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
| 269 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
| 270 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
| 271 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
| 272 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
| 273 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
| 274 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
| 275 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
| 276 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
| 277 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
| 278 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
| 279 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
| 280 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
| 281 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
| 282 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
| 283 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
| 284 |
</blockquote> |
| 285 |
|
| 286 |
</div> |
| 287 |
</div> |
| 288 |
|
| 289 |
<p class="notes" id="credit"> |
| 290 |
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> |
| 291 |
</p> |
| 292 |
</div></body> |
| 293 |
</html> |
Parent Directory
| 
Revision Log
