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

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

Parent Directory Parent Directory | Revision Log Revision Log

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