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