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 FEYesNoListBox</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 FEYesNoListBox</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-vars">Vars</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">Build a Yes/No Select box</p> |
26 |
<ul class="tags"> |
27 |
<li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li> |
28 |
<li><span class="field">author:</span> <p>Suren Markossian <<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>></p></li> |
29 |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
30 |
</ul> |
31 |
<p class="notes"> |
32 |
Located in <a class="field" href="_form_form_elements_FEListBox_inc.html">Program_Root/form/form_elements/FEListBox.inc</a> (line <span class="field">70</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 |
--<a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a> |
43 |
| |
44 |
--FEYesNoListBox</pre> |
45 |
|
46 |
</div> |
47 |
</div> |
48 |
|
49 |
|
50 |
|
51 |
<a name="sec-method-summary"></a> |
52 |
<div class="info-box"> |
53 |
<div class="info-box-title">Method Summary</span></div> |
54 |
<div class="nav-bar"> |
55 |
<a href="#sec-description">Description</a> | |
56 |
<a href="#sec-vars">Vars</a> |
57 |
|
58 |
| |
59 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
60 |
</div> |
61 |
<div class="info-box-body"> |
62 |
<div class="method-summary"> |
63 |
|
64 |
<div class="method-definition"> |
65 |
<span class="method-result">void</span> |
66 |
<a href="#FEYesNoListBox" title="details" class="method-name">FEYesNoListBox</a> |
67 |
(<span class="var-type">label</span> <span class="var-name">$label</span>, [<span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">array</span> <span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$yes_value</span> = <span class="var-default">"yes"</span>], [<span class="var-type">string</span> <span class="var-name">$no_value</span> = <span class="var-default">"no"</span>]) |
68 |
</div> |
69 |
</div> |
70 |
</div> |
71 |
</div> |
72 |
|
73 |
<a name="sec-vars"></a> |
74 |
<div class="info-box"> |
75 |
<div class="info-box-title">Variables</div> |
76 |
<div class="nav-bar"> |
77 |
<a href="#sec-description">Description</a> | |
78 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
79 |
|
80 |
|
81 |
| |
82 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
83 |
|
84 |
</div> |
85 |
<div class="info-box-body"> |
86 |
<h4>Inherited Variables</h4> |
87 |
<A NAME='inherited_vars'><!-- --></A> |
88 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p> |
89 |
<blockquote> |
90 |
<span class="var-title"> |
91 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#var$_data_list">FEDataList::$_data_list</a></span><br> |
92 |
</span> |
93 |
</blockquote> |
94 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
95 |
<blockquote> |
96 |
<span class="var-title"> |
97 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br> |
98 |
</span> |
99 |
<span class="var-title"> |
100 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br> |
101 |
</span> |
102 |
</blockquote> |
103 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
104 |
<blockquote> |
105 |
<span class="var-title"> |
106 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
107 |
</span> |
108 |
<span class="var-title"> |
109 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
110 |
</span> |
111 |
<span class="var-title"> |
112 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
113 |
</span> |
114 |
<span class="var-title"> |
115 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
116 |
</span> |
117 |
<span class="var-title"> |
118 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
119 |
</span> |
120 |
<span class="var-title"> |
121 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
122 |
</span> |
123 |
<span class="var-title"> |
124 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
125 |
</span> |
126 |
<span class="var-title"> |
127 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
128 |
</span> |
129 |
<span class="var-title"> |
130 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
131 |
</span> |
132 |
<span class="var-title"> |
133 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
134 |
</span> |
135 |
<span class="var-title"> |
136 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
137 |
</span> |
138 |
<span class="var-title"> |
139 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
140 |
</span> |
141 |
</blockquote> |
142 |
|
143 |
</div> |
144 |
</div> |
145 |
|
146 |
<a name="sec-methods"></a> |
147 |
<div class="info-box"> |
148 |
<div class="info-box-title">Methods</div> |
149 |
<div class="nav-bar"> |
150 |
<a href="#sec-description">Description</a> | |
151 |
<a href="#sec-vars">Vars</a> |
152 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
153 |
|
154 |
</div> |
155 |
<div class="info-box-body"> |
156 |
<A NAME='method_detail'></A> |
157 |
<a name="methodFEYesNoListBox" id="FEYesNoListBox"><!-- --></a> |
158 |
<div class="oddrow"> |
159 |
|
160 |
<div class="method-header"> |
161 |
<span class="method-title">Constructor FEYesNoListBox</span> (line <span class="line-number">84</span>) |
162 |
</div> |
163 |
|
164 |
<!-- ========== Info from phpDoc block ========= --> |
165 |
<p class="short-description">The Constructor</p> |
166 |
|
167 |
<div class="method-signature"> |
168 |
<span class="method-result">void</span> |
169 |
<span class="method-name"> |
170 |
FEYesNoListBox |
171 |
</span> |
172 |
(<span class="var-type">label</span> <span class="var-name">$label</span>, [<span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">array</span> <span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$yes_value</span> = <span class="var-default">"yes"</span>], [<span class="var-type">string</span> <span class="var-name">$no_value</span> = <span class="var-default">"no"</span>]) |
173 |
</div> |
174 |
|
175 |
<ul class="parameters"> |
176 |
<li> |
177 |
<span class="var-type">label</span> |
178 |
<span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span> </li> |
179 |
<li> |
180 |
<span class="var-type">bool</span> |
181 |
<span class="var-name">$required</span><span class="var-description">: <p>required - is this a required element</p></span> </li> |
182 |
<li> |
183 |
<span class="var-type">array</span> |
184 |
<span class="var-name">$width</span><span class="var-description">: <p>data_list - list of data elements (name=>value)</p></span> </li> |
185 |
<li> |
186 |
<span class="var-type">int</span> |
187 |
<span class="var-name">$height</span><span class="var-description">: <p>required - element width in characters, pixels (px), percentage (%) or elements (em)</p></span> </li> |
188 |
<li> |
189 |
<span class="var-type">string</span> |
190 |
<span class="var-name">$yes_value</span><span class="var-description">: <p>- the value to use for the 'yes' radio NOTE: default is 'yes'</p></span> </li> |
191 |
<li> |
192 |
<span class="var-type">string</span> |
193 |
<span class="var-name">$no_value</span><span class="var-description">: <p>- the value to use for the 'no' radio NOTE: default is 'no'</p></span> </li> |
194 |
</ul> |
195 |
|
196 |
|
197 |
</div> |
198 |
<h4>Inherited Methods</h4> |
199 |
<a name='inherited_methods'><!-- --></a> |
200 |
<!-- =========== Summary =========== --> |
201 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a></span></p> |
202 |
<blockquote> |
203 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html#methodget_element">FEListBox::get_element()</a></span><br> |
204 |
</blockquote> |
205 |
<!-- =========== Summary =========== --> |
206 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></span></p> |
207 |
<blockquote> |
208 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodFEDataList">FEDataList::FEDataList()</a></span><br> |
209 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text">FEDataList::get_value_text()</a></span><br> |
210 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodset_list_data">FEDataList::set_list_data()</a></span><br> |
211 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate">FEDataList::validate()</a></span><br> |
212 |
</blockquote> |
213 |
<!-- =========== Summary =========== --> |
214 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
215 |
<blockquote> |
216 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br> |
217 |
</blockquote> |
218 |
<!-- =========== Summary =========== --> |
219 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
220 |
<blockquote> |
221 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
222 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
223 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
224 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
225 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
226 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
227 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
228 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
229 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
230 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
231 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
232 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
233 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
234 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
235 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
236 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
237 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
238 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
239 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
240 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
241 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
242 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
243 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
244 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
245 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
246 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
247 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
248 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
249 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
250 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
251 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
252 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
253 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
254 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
255 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
256 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
257 |
</blockquote> |
258 |
|
259 |
</div> |
260 |
</div> |
261 |
|
262 |
<p class="notes" id="credit"> |
263 |
Documention generated on Thu, 31 Jul 2003 18:32:32 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
264 |
</p> |
265 |
</div></body> |
266 |
</html> |