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

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

Parent Directory Parent Directory | Revision Log Revision Log

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