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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations)
Thu May 6 16:26:14 2004 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +414 -393 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 FERadioGroup</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 FERadioGroup</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-var-summary">Vars</a> (<a href="#sec-vars">details</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 Radio Button Group FormElement which builds a List of Radio buttons that can be used in any style of layout.</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_FERadioGroup_inc.html">/form/form_elements/FERadioGroup.inc</a> (line <span class="field">31</span>)
36 </p>
37
38
39 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
40 |
41 --FERadioGroup</pre>
42
43 </div>
44 </div>
45
46 <a name="sec-descendents"></a>
47 <div class="info-box">
48 <div class="info-box-title">Direct descendents</div>
49 <div class="nav-bar">
50 <a href="#sec-description">Description</a> |
51 <span class="disabled">Descendents</span>
52 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
53 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54
55 </div>
56 <div class="info-box-body">
57 <table cellpadding="2" cellspacing="0" class="class-table">
58 <tr>
59 <th class="class-table-header">Class</th>
60 <th class="class-table-header">Description</th>
61 </tr>
62 <tr>
63 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEYesNoRadioGroup.html">FEYesNoRadioGroup</a></td>
64 <td>
65 This is the Yes/No Radio Button Group FormElement.
66 </td>
67 </tr>
68 </table>
69 </div>
70 </div>
71
72
73 <a name="sec-var-summary"></a>
74 <div class="info-box">
75 <div class="info-box-title">Variable Summary</span></div>
76 <div class="nav-bar">
77 <a href="#sec-description">Description</a> |
78 <a href="#sec-descendents">Descendents</a> |
79 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
80 |
81 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
82
83 </div>
84 <div class="info-box-body">
85 <div class="var-summary">
86 <div class="var-title">
87 <span class="var-type">mixed</span>
88 <a href="#$_data_list" title="details" class="var-name">$_data_list</a>
89 </div>
90 </div>
91 </div>
92 </div>
93
94 <a name="sec-method-summary"></a>
95 <div class="info-box">
96 <div class="info-box-title">Method Summary</span></div>
97 <div class="nav-bar">
98 <a href="#sec-description">Description</a> |
99 <a href="#sec-descendents">Descendents</a> |
100 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
101
102 |
103 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
104 </div>
105 <div class="info-box-body">
106 <div class="method-summary">
107
108 <div class="method-definition">
109 <span class="method-result">FERadioGroup</span>
110 <a href="#FERadioGroup" title="details" class="method-name">FERadioGroup</a>
111 (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
112 </div>
113
114 <div class="method-definition">
115 <span class="method-result">object</span>
116 <a href="#get_element" title="details" class="method-name">get_element</a>
117 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$index</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$br_flag</span> = <span class="var-default">FALSE</span>])
118 </div>
119
120 <div class="method-definition">
121 <span class="method-result">string</span>
122 <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
123 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">0</span>)
124 </div>
125
126 <div class="method-definition">
127 <span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
128 <a href="#_get_index_element" title="details" class="method-name">_get_index_element</a>
129 (<span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
130 </div>
131 </div>
132 </div>
133 </div>
134
135 <a name="sec-vars"></a>
136 <div class="info-box">
137 <div class="info-box-title">Variables</div>
138 <div class="nav-bar">
139 <a href="#sec-description">Description</a> |
140 <a href="#sec-descendents">Descendents</a> |
141 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
142
143
144 |
145 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
146
147 </div>
148 <div class="info-box-body">
149 <a name="var$_data_list" id="$_data_list"><!-- --></A>
150 <div class="evenrow">
151
152 <div class="var-header">
153 <span class="var-title">
154 <span class="var-type">mixed</span>
155 <span class="var-name">$_data_list</span>
156 = <span class="var-default">array()</span> (line <span class="line-number">38</span>)
157 </span>
158 </div>
159
160 <!-- ========== Info from phpDoc block ========= -->
161 <p class="short-description">Holds the list of available</p>
162 <p class="description"><p>data elements</p></p>
163
164
165
166
167
168 </div>
169
170 <h4>Inherited Variables</h4>
171 <A NAME='inherited_vars'><!-- --></A>
172 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
173 <blockquote>
174 <span class="var-title">
175 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
176 </span>
177 <span class="var-title">
178 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
179 </span>
180 <span class="var-title">
181 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
182 </span>
183 <span class="var-title">
184 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
185 </span>
186 <span class="var-title">
187 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
188 </span>
189 <span class="var-title">
190 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
191 </span>
192 <span class="var-title">
193 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
194 </span>
195 <span class="var-title">
196 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
197 </span>
198 <span class="var-title">
199 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
200 </span>
201 <span class="var-title">
202 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
203 </span>
204 <span class="var-title">
205 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
206 </span>
207 <span class="var-title">
208 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
209 </span>
210 <span class="var-title">
211 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
212 </span>
213 <span class="var-title">
214 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
215 </span>
216 <span class="var-title">
217 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
218 </span>
219 </blockquote>
220
221 </div>
222 </div>
223
224 <a name="sec-methods"></a>
225 <div class="info-box">
226 <div class="info-box-title">Methods</div>
227 <div class="nav-bar">
228 <a href="#sec-description">Description</a> |
229 <a href="#sec-descendents">Descendents</a> |
230 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
231 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
232
233 </div>
234 <div class="info-box-body">
235 <A NAME='method_detail'></A>
236 <a name="methodFERadioGroup" id="FERadioGroup"><!-- --></a>
237 <div class="oddrow">
238
239 <div class="method-header">
240 <span class="method-title">Constructor FERadioGroup</span> (line <span class="line-number">47</span>)
241 </div>
242
243 <!-- ========== Info from phpDoc block ========= -->
244 <p class="short-description">The constructor</p>
245
246 <div class="method-signature">
247 <span class="method-result">FERadioGroup</span>
248 <span class="method-name">
249 FERadioGroup
250 </span>
251 (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
252 </div>
253
254 <ul class="parameters">
255 <li>
256 <span class="var-type">label</span>
257 <span class="var-name">$label</span><span class="var-description">: string - text label for the element</span> </li>
258 <li>
259 <span class="var-type">array</span>
260 <span class="var-name">$data_list</span><span class="var-description">: - the name =&gt; value pairs of the radio buttons text =&gt; value</span> </li>
261 </ul>
262
263
264 </div>
265 <a name="methodget_element" id="get_element"><!-- --></a>
266 <div class="evenrow">
267
268 <div class="method-header">
269 <span class="method-title">get_element</span> (line <span class="line-number">85</span>)
270 </div>
271
272 <!-- ========== Info from phpDoc block ========= -->
273 <p class="short-description">This function builds and returns the form element object</p>
274
275 <div class="method-signature">
276 <span class="method-result">object</span>
277 <span class="method-name">
278 get_element
279 </span>
280 ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$index</span> = <span class="var-default">NULL</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$br_flag</span> = <span class="var-default">FALSE</span>])
281 </div>
282
283
284 <hr class="separator" />
285 <div class="notes">Redefinition of:</div>
286 <dl>
287 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
288 <dd>This function builds and returns the form element object</dd>
289 </dl>
290
291 </div>
292 <a name="methodget_value_text" id="get_value_text"><!-- --></a>
293 <div class="oddrow">
294
295 <div class="method-header">
296 <span class="method-title">get_value_text</span> (line <span class="line-number">67</span>)
297 </div>
298
299 <!-- ========== Info from phpDoc block ========= -->
300 <p class="short-description">This provides a method</p>
301 <p class="description"><p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p></p>
302 <ul class="tags">
303 <li><span class="field">return:</span> - the text associated</li>
304 </ul>
305
306 <div class="method-signature">
307 <span class="method-result">string</span>
308 <span class="method-name">
309 get_value_text
310 </span>
311 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">0</span>)
312 </div>
313
314 <ul class="parameters">
315 <li>
316 <span class="var-type">mixed</span>
317 <span class="var-name">0</span><span class="var-description">: - the value to look up</span> </li>
318 </ul>
319
320 <hr class="separator" />
321 <div class="notes">Redefinition of:</div>
322 <dl>
323 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt>
324 <dd>This provides a method</dd>
325 </dl>
326
327 </div>
328 <a name="method_get_index_element" id="_get_index_element"><!-- --></a>
329 <div class="evenrow">
330
331 <div class="method-header">
332 <span class="method-title">_get_index_element</span> (line <span class="line-number">114</span>)
333 </div>
334
335 <!-- ========== Info from phpDoc block ========= -->
336 <p class="short-description">This method builds an individual Radio button with its associated text</p>
337 <ul class="tags">
338 <li><span class="field">return:</span> of type radio</li>
339 </ul>
340
341 <div class="method-signature">
342 <span class="method-result"><a href="../../phpHtmlLib/INPUTtag.html">INPUTtag</a></span>
343 <span class="method-name">
344 _get_index_element
345 </span>
346 (<span class="var-type">int</span>&nbsp;<span class="var-name">$index</span>)
347 </div>
348
349 <ul class="parameters">
350 <li>
351 <span class="var-type">int</span>
352 <span class="var-name">$index</span><span class="var-description">: - the index</span> </li>
353 </ul>
354
355
356 </div>
357 <h4>Inherited Methods</h4>
358 <a name='inherited_methods'><!-- --></a>
359 <!-- =========== Summary =========== -->
360 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
361 <blockquote>
362 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
363 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
364 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
365 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
366 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
367 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
368 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
369 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
370 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
371 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
372 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
373 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
374 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
375 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
376 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
377 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
378 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
379 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
380 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
381 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
382 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
383 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
384 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
385 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
386 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
387 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
388 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
389 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
390 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
391 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
392 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
393 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
394 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
395 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
396 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
397 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
398 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
399 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
400 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
401 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
402 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
403 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
404 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
405 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
406 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
407 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
408 </blockquote>
409
410 </div>
411 </div>
412
413
414 <p class="notes" id="credit">
415 Documentation generated on Thu, 1 Apr 2004 09:38:35 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
416 </p>
417 </div></body>
418 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed