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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (show annotations)
Thu May 6 16:26:15 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +408 -375 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 FEText</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 FEText</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-descendents">Descendents</a>
21 | <a href="#sec-vars">Vars</a>
22 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
23
24 </div>
25 <div class="info-box-body">
26 <!-- ========== Info from phpDoc block ========= -->
27 <p class="short-description">This is the Text FormElement which builds a text input field. It has no validation method.</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_FEText_inc.html">/form/form_elements/FEText.inc</a> (line <span class="field">29</span>)
35 </p>
36
37
38 <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
39 |
40 --FEText</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-vars">Vars</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/FEFile.html">FEFile</a></td>
63 <td>
64 This is the FileUpload FormElement which builds a input field of type=&quot;file&quot;. This automagically handles the case of a confirmation page.
65 </td>
66 </tr>
67 <tr>
68 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumber.html">FENumber</a></td>
69 <td>
70 This is the FormElement which builds a text input field that validates It validates as is_number().
71 </td>
72 </tr>
73 <tr>
74 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberFloat.html">FENumberFloat</a></td>
75 <td>
76 This is the float FormElement which builds a text input field.
77 </td>
78 </tr>
79 <tr>
80 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberPrice.html">FENumberPrice</a></td>
81 <td>
82 This is the Price FormElement which builds a text input field.
83 </td>
84 </tr>
85 <tr>
86 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html">FENumberInRange</a></td>
87 <td>
88 This is the Number Range FormElement which builds a text input field.
89 </td>
90 </tr>
91 <tr>
92 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></td>
93 <td>
94 This is the Password FormElement which builds a input field of type=&quot;password&quot;. It validates the data as is_password().
95 </td>
96 </tr>
97 <tr>
98 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEName.html">FEName</a></td>
99 <td>
100 This is the Name FormElement which builds a text input field, and validates against the is_name() method.
101 </td>
102 </tr>
103 <tr>
104 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEEmail.html">FEEmail</a></td>
105 <td>
106 This is the Email FormElement which builds a text input field.
107 </td>
108 </tr>
109 <tr>
110 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEEmailMany.html">FEEmailMany</a></td>
111 <td>
112 This is the EmailMany FormElement which builds a text input field. This allows for multiple email addresses in 1 text input field seperated by commas.
113 </td>
114 </tr>
115 <tr>
116 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDomainName.html">FEDomainName</a></td>
117 <td>
118 This is the DomainName FormElement which builds a text input field.
119 </td>
120 </tr>
121 <tr>
122 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html">FEHostNameWithPort</a></td>
123 <td>
124 This is the DomainName FormElement which builds a text input field. It also includes a port # It validates as is_domainname().
125 </td>
126 </tr>
127 <tr>
128 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEIPAddress.html">FEIPAddress</a></td>
129 <td>
130 This is the Ip Address FormElement which builds a text input field.
131 </td>
132 </tr>
133 <tr>
134 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEUrl.html">FEUrl</a></td>
135 <td>
136 This is the URL FormElement which builds a text input field.
137 </td>
138 </tr>
139 <tr>
140 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEUrlStrict.html">FEUrlStrict</a></td>
141 <td>
142 This is the URLStrict FormElement which builds a text input field.
143 </td>
144 </tr>
145 <tr>
146 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEZipcode.html">FEZipcode</a></td>
147 <td>
148 This is the FEZipcode class.
149 </td>
150 </tr>
151 <tr>
152 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FERegEx.html">FERegEx</a></td>
153 <td>
154 This is the RegEx FormElement which builds a text input field, and validates against the is_regex() method.
155 </td>
156 </tr>
157 </table>
158 </div>
159 </div>
160
161
162
163 <a name="sec-method-summary"></a>
164 <div class="info-box">
165 <div class="info-box-title">Method Summary</span></div>
166 <div class="nav-bar">
167 <a href="#sec-description">Description</a> |
168 <a href="#sec-descendents">Descendents</a> |
169 <a href="#sec-vars">Vars</a>
170
171 |
172 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
173 </div>
174 <div class="info-box-body">
175 <div class="method-summary">
176
177 <div class="method-definition">
178 <span class="method-result">FEText</span>
179 <a href="#FEText" title="details" class="method-name">FEText</a>
180 (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">FALSE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">NULL</span>])
181 </div>
182
183 <div class="method-definition">
184 <span class="method-result">object</span>
185 <a href="#get_element" title="details" class="method-name">get_element</a>
186 ()
187 </div>
188 </div>
189 </div>
190 </div>
191
192 <a name="sec-vars"></a>
193 <div class="info-box">
194 <div class="info-box-title">Variables</div>
195 <div class="nav-bar">
196 <a href="#sec-description">Description</a> |
197 <a href="#sec-descendents">Descendents</a> |
198 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
199
200
201 |
202 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
203
204 </div>
205 <div class="info-box-body">
206
207 <h4>Inherited Variables</h4>
208 <A NAME='inherited_vars'><!-- --></A>
209 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
210 <blockquote>
211 <span class="var-title">
212 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
213 </span>
214 <span class="var-title">
215 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
216 </span>
217 <span class="var-title">
218 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
219 </span>
220 <span class="var-title">
221 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
222 </span>
223 <span class="var-title">
224 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
225 </span>
226 <span class="var-title">
227 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
228 </span>
229 <span class="var-title">
230 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br>
231 </span>
232 <span class="var-title">
233 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
234 </span>
235 <span class="var-title">
236 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
237 </span>
238 <span class="var-title">
239 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
240 </span>
241 <span class="var-title">
242 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
243 </span>
244 <span class="var-title">
245 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
246 </span>
247 <span class="var-title">
248 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
249 </span>
250 <span class="var-title">
251 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
252 </span>
253 <span class="var-title">
254 <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
255 </span>
256 </blockquote>
257
258 </div>
259 </div>
260
261 <a name="sec-methods"></a>
262 <div class="info-box">
263 <div class="info-box-title">Methods</div>
264 <div class="nav-bar">
265 <a href="#sec-description">Description</a> |
266 <a href="#sec-descendents">Descendents</a> |
267 <a href="#sec-vars">Vars</a>
268 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
269
270 </div>
271 <div class="info-box-body">
272 <A NAME='method_detail'></A>
273 <a name="methodFEText" id="FEText"><!-- --></a>
274 <div class="oddrow">
275
276 <div class="method-header">
277 <span class="method-title">Constructor FEText</span> (line <span class="line-number">39</span>)
278 </div>
279
280 <!-- ========== Info from phpDoc block ========= -->
281 <p class="short-description">The constructor</p>
282
283 <div class="method-signature">
284 <span class="method-result">FEText</span>
285 <span class="method-name">
286 FEText
287 </span>
288 (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">FALSE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$maxlength</span> = <span class="var-default">NULL</span>])
289 </div>
290
291 <ul class="parameters">
292 <li>
293 <span class="var-type">label</span>
294 <span class="var-name">$label</span><span class="var-description">: string - text label for the element</span> </li>
295 <li>
296 <span class="var-type">bool</span>
297 <span class="var-name">$required</span><span class="var-description">: required - is this a required element</span> </li>
298 <li>
299 <span class="var-type">int</span>
300 <span class="var-name">$width</span><span class="var-description">: required - element width in characters, pixels (px), percentage (%) or elements (em)</span> </li>
301 <li>
302 <span class="var-type">int</span>
303 <span class="var-name">$maxlength</span><span class="var-description">: required - maximum number of chars allowed to type in</span> </li>
304 </ul>
305
306
307 </div>
308 <a name="methodget_element" id="get_element"><!-- --></a>
309 <div class="evenrow">
310
311 <div class="method-header">
312 <span class="method-title">get_element</span> (line <span class="line-number">60</span>)
313 </div>
314
315 <!-- ========== Info from phpDoc block ========= -->
316 <p class="short-description">This function builds and returns the form element object</p>
317
318 <div class="method-signature">
319 <span class="method-result">object</span>
320 <span class="method-name">
321 get_element
322 </span>
323 ()
324 </div>
325
326
327 <hr class="separator" />
328 <div class="notes">Redefinition of:</div>
329 <dl>
330 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
331 <dd>This function builds and returns the form element object</dd>
332 </dl>
333
334 <hr class="separator" />
335 <div class="notes">Redefined in descendants as:</div>
336 <ul class="redefinitions">
337 <li>
338 <a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_element">FEFile::get_element()</a>
339 : This function builds and returns the form element object
340 </li>
341 <li>
342 <a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a>
343 : This function builds and returns the form element object
344 </li>
345 <li>
346 <a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodget_element">FEHostNameWithPort::get_element()</a>
347 : This function builds and returns the form element object
348 </li>
349 </ul>
350 </div>
351 <h4>Inherited Methods</h4>
352 <a name='inherited_methods'><!-- --></a>
353 <!-- =========== Summary =========== -->
354 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
355 <blockquote>
356 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
357 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
358 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
359 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
360 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
361 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
362 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
363 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
364 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
365 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
366 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
367 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
368 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
369 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
370 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
371 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
372 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
373 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
374 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
375 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
376 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
377 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
378 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
379 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
380 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
381 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
382 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
383 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
384 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
385 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
386 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
387 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
388 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
389 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
390 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
391 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
392 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
393 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
394 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
395 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
396 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
397 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
398 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
399 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
400 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
401 <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
402 </blockquote>
403
404 </div>
405 </div>
406
407
408 <p class="notes" id="credit">
409 Documentation generated on Thu, 1 Apr 2004 09:38:40 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
410 </p>
411 </div></body>
412 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed