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