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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (hide annotations)
Thu May 6 16:25:59 2004 UTC (20 years, 4 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +342 -326 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 FECheckBox</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 FECheckBox</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-var-summary">Vars</a> (<a href="#sec-vars">details</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">This is the CheckBox FormElement which builds a input field of type=&quot;checkbox&quot;. It has no validation method.</p>
26     <ul class="tags">
27     <li><span class="field">copyright:</span> LGPL - See LICENCE</li>
28     <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
29     <li><span class="field">author:</span> Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>&gt;</li>
30     </ul>
31     <p class="notes">
32     Located in <a class="field" href="_form_form_elements_FECheckBox_inc.html">/form/form_elements/FECheckBox.inc</a> (line <span class="field">28</span>)
33     </p>
34    
35    
36 jonen 1.2 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
37 jonen 1.1 |
38 jonen 1.3 --FECheckBox</pre>
39    
40     </div>
41     </div>
42    
43    
44    
45     <a name="sec-var-summary"></a>
46     <div class="info-box">
47     <div class="info-box-title">Variable Summary</span></div>
48     <div class="nav-bar">
49     <a href="#sec-description">Description</a> |
50     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
51     |
52     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
53    
54     </div>
55     <div class="info-box-body">
56     <div class="var-summary">
57     <div class="var-title">
58     <span class="var-type">mixed</span>
59     <a href="#$_text" title="details" class="var-name">$_text</a>
60     </div>
61     </div>
62     </div>
63     </div>
64    
65     <a name="sec-method-summary"></a>
66     <div class="info-box">
67     <div class="info-box-title">Method Summary</span></div>
68     <div class="nav-bar">
69     <a href="#sec-description">Description</a> |
70     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
71    
72     |
73     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
74     </div>
75     <div class="info-box-body">
76     <div class="method-summary">
77    
78     <div class="method-definition">
79     <span class="method-result">FECheckBox</span>
80     <a href="#FECheckBox" title="details" class="method-name">FECheckBox</a>
81     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
82     </div>
83    
84     <div class="method-definition">
85     <span class="method-result">object</span>
86     <a href="#get_element" title="details" class="method-name">get_element</a>
87     ()
88     </div>
89    
90     <div class="method-definition">
91     <span class="method-result">string</span>
92     <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
93     ()
94     </div>
95     </div>
96     </div>
97     </div>
98    
99     <a name="sec-vars"></a>
100     <div class="info-box">
101     <div class="info-box-title">Variables</div>
102     <div class="nav-bar">
103     <a href="#sec-description">Description</a> |
104     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
105    
106    
107     |
108     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
109    
110     </div>
111     <div class="info-box-body">
112     <a name="var$_text" id="$_text"><!-- --></A>
113     <div class="evenrow">
114    
115     <div class="var-header">
116     <span class="var-title">
117     <span class="var-type">mixed</span>
118     <span class="var-name">$_text</span>
119     = <span class="var-default"> NULL</span> (line <span class="line-number">34</span>)
120     </span>
121     </div>
122    
123     <!-- ========== Info from phpDoc block ========= -->
124     <p class="short-description">Holds the checkbox text</p>
125    
126    
127    
128    
129    
130     </div>
131     <h4>Inherited Variables</h4>
132     <A NAME='inherited_vars'><!-- --></A>
133     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
134     <blockquote>
135     <span class="var-title">
136     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
137     </span>
138     <span class="var-title">
139     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
140     </span>
141     <span class="var-title">
142     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
143     </span>
144     <span class="var-title">
145     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
146     </span>
147     <span class="var-title">
148     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
149     </span>
150     <span class="var-title">
151     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
152     </span>
153     <span class="var-title">
154     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</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$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
167     </span>
168     <span class="var-title">
169     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
170     </span>
171     <span class="var-title">
172     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
173     </span>
174     <span class="var-title">
175     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
176     </span>
177     <span class="var-title">
178     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
179     </span>
180     </blockquote>
181    
182     </div>
183     </div>
184    
185     <a name="sec-methods"></a>
186     <div class="info-box">
187     <div class="info-box-title">Methods</div>
188     <div class="nav-bar">
189     <a href="#sec-description">Description</a> |
190     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
191     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
192    
193     </div>
194     <div class="info-box-body">
195     <A NAME='method_detail'></A>
196     <a name="methodFECheckBox" id="FECheckBox"><!-- --></a>
197     <div class="oddrow">
198    
199     <div class="method-header">
200     <span class="method-title">Constructor FECheckBox</span> (line <span class="line-number">42</span>)
201     </div>
202    
203     <!-- ========== Info from phpDoc block ========= -->
204     <p class="short-description">The constructor</p>
205    
206     <div class="method-signature">
207     <span class="method-result">FECheckBox</span>
208     <span class="method-name">
209     FECheckBox
210     </span>
211     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
212     </div>
213    
214     <ul class="parameters">
215     <li>
216     <span class="var-type">label</span>
217     <span class="var-name">$label</span><span class="var-description">: string - text label for the element</span> </li>
218     <li>
219     <span class="var-type">string</span>
220     <span class="var-name">$text</span><span class="var-description">: text - checkbox text to be displayed</span> </li>
221     </ul>
222    
223    
224     </div>
225     <a name="methodget_element" id="get_element"><!-- --></a>
226     <div class="evenrow">
227    
228     <div class="method-header">
229     <span class="method-title">get_element</span> (line <span class="line-number">74</span>)
230     </div>
231    
232     <!-- ========== Info from phpDoc block ========= -->
233     <p class="short-description">This function builds and returns the form element object</p>
234    
235     <div class="method-signature">
236     <span class="method-result">object</span>
237     <span class="method-name">
238     get_element
239     </span>
240     ()
241     </div>
242    
243    
244     <hr class="separator" />
245     <div class="notes">Redefinition of:</div>
246     <dl>
247     <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
248     <dd>This function builds and returns the form element object</dd>
249     </dl>
250    
251     </div>
252     <a name="methodget_value_text" id="get_value_text"><!-- --></a>
253     <div class="oddrow">
254    
255     <div class="method-header">
256     <span class="method-title">get_value_text</span> (line <span class="line-number">59</span>)
257     </div>
258    
259     <!-- ========== Info from phpDoc block ========= -->
260     <p class="short-description">This provides a method</p>
261     <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>
262     <ul class="tags">
263     <li><span class="field">return:</span> - the text associated</li>
264     </ul>
265    
266     <div class="method-signature">
267     <span class="method-result">string</span>
268     <span class="method-name">
269     get_value_text
270     </span>
271     ()
272     </div>
273    
274    
275     <hr class="separator" />
276     <div class="notes">Redefinition of:</div>
277     <dl>
278     <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt>
279     <dd>This provides a method</dd>
280     </dl>
281    
282     </div>
283     <h4>Inherited Methods</h4>
284     <a name='inherited_methods'><!-- --></a>
285     <!-- =========== Summary =========== -->
286     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
287     <blockquote>
288     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
289     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
290     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
291     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
292     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
293     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
294     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
295     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
296     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
297     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
298     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
299     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
300     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
301     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
302     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
303     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
304     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
305     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
306     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
307     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
308     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
309     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
310     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
311     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
312     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
313     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
314     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
315     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
316     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
317     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
318     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
319     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
320     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
321     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
322     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
323     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
324     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
325     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
326     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
327     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
328     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
329     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
330     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
331     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
332     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
333     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
334     </blockquote>
335    
336     </div>
337     </div>
338    
339    
340     <p class="notes" id="credit">
341     Documentation generated on Thu, 1 Apr 2004 09:38:21 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
342     </p>
343     </div></body>
344     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed