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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Sep 20 00:36:45 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.1: +353 -383 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 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     <h2 class="class-name">Class FEText</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-vars">Vars</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 Text FormElement which builds a text input field. It has no validation method.</p>
27     <ul class="tags">
28     <li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li>
29     <li><span class="field">author:</span> <p>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</p></li>
30     <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>
31     </ul>
32     <p class="notes">
33     Located in <a class="field" href="_form_form_elements_FEText_inc.html">Program_Root/form/form_elements/FEText.inc</a> (line <span class="field">29</span>)
34     </p>
35    
36    
37     <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
38 jonen 1.1 |
39     --FEText</pre>
40 jonen 1.2
41     </div>
42     </div>
43 jonen 1.1
44 jonen 1.2 <a name="sec-descendents"></a>
45     <div class="info-box">
46     <div class="info-box-title">Direct descendents</div>
47     <div class="nav-bar">
48     <a href="#sec-description">Description</a> |
49     <span class="disabled">Descendents</span>
50     | <a href="#sec-vars">Vars</a>
51     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
52    
53     </div>
54     <div class="info-box-body">
55     <table cellpadding="2" cellspacing="0" class="class-table">
56     <tr>
57     <th class="class-table-header">Class</th>
58     <th class="class-table-header">Description</th>
59 jonen 1.1 </tr>
60     <tr>
61 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumber.html">FENumber</a></td>
62     <td>
63     This is the FormElement which builds a text input field that validates It validates as is_number().
64     </td>
65     </tr>
66 jonen 1.1 <tr>
67 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberFloat.html">FENumberFloat</a></td>
68     <td>
69     This is the float FormElement which builds a text input field.
70     </td>
71     </tr>
72 jonen 1.1 <tr>
73 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberPrice.html">FENumberPrice</a></td>
74     <td>
75     This is the Price FormElement which builds a text input field.
76     </td>
77     </tr>
78 jonen 1.1 <tr>
79 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html">FENumberInRange</a></td>
80     <td>
81     This is the Number Range FormElement which builds a text input field.
82     </td>
83     </tr>
84 jonen 1.1 <tr>
85 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEFile.html">FEFile</a></td>
86     <td>
87     This is the FileUpload FormElement which builds a input field of type=&quot;file&quot;.
88     </td>
89     </tr>
90 jonen 1.1 <tr>
91 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEName.html">FEName</a></td>
92     <td>
93     This is the Name FormElement which builds a text input field, and validates against the is_name() method.
94     </td>
95     </tr>
96 jonen 1.1 <tr>
97 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEEmail.html">FEEmail</a></td>
98     <td>
99     This is the Email FormElement which builds a text input field.
100     </td>
101     </tr>
102 jonen 1.1 <tr>
103 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEEmailMany.html">FEEmailMany</a></td>
104     <td>
105     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.
106     </td>
107     </tr>
108 jonen 1.1 <tr>
109 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDomainName.html">FEDomainName</a></td>
110     <td>
111     This is the DomainName FormElement which builds a text input field.
112     </td>
113     </tr>
114 jonen 1.1 <tr>
115 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html">FEHostNameWithPort</a></td>
116     <td>
117     This is the DomainName FormElement which builds a text input field. It also includes a port # It validates as is_domainname().
118     </td>
119     </tr>
120 jonen 1.1 <tr>
121 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEIPAddress.html">FEIPAddress</a></td>
122     <td>
123     This is the Ip Address FormElement which builds a text input field.
124     </td>
125     </tr>
126 jonen 1.1 <tr>
127 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEUrl.html">FEUrl</a></td>
128     <td>
129     This is the URL FormElement which builds a text input field.
130     </td>
131     </tr>
132 jonen 1.1 <tr>
133 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEUrlStrict.html">FEUrlStrict</a></td>
134     <td>
135     This is the URLStrict FormElement which builds a text input field.
136     </td>
137     </tr>
138 jonen 1.1 <tr>
139 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></td>
140     <td>
141     This is the Password FormElement which builds a input field of type=&quot;password&quot;. It validates the data as is_password().
142     </td>
143     </tr>
144 jonen 1.1 </table>
145 jonen 1.2 </div>
146     </div>
147 jonen 1.1
148    
149 jonen 1.2 <a name="sec-method-summary"></a>
150     <div class="info-box">
151     <div class="info-box-title">Method Summary</span></div>
152     <div class="nav-bar">
153     <a href="#sec-description">Description</a> |
154     <a href="#sec-descendents">Descendents</a> |
155     <a href="#sec-vars">Vars</a>
156    
157     |
158     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
159     </div>
160     <div class="info-box-body">
161     <div class="method-summary">
162    
163     <div class="method-definition">
164     <span class="method-result">void</span>
165     <a href="#FEText" title="details" class="method-name">FEText</a>
166     (<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">TRUE</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>])
167     </div>
168    
169     <div class="method-definition">
170     <span class="method-result">object</span>
171     <a href="#get_element" title="details" class="method-name">get_element</a>
172     ()
173     </div>
174     </div>
175     </div>
176     </div>
177    
178     <a name="sec-vars"></a>
179     <div class="info-box">
180     <div class="info-box-title">Variables</div>
181     <div class="nav-bar">
182     <a href="#sec-description">Description</a> |
183     <a href="#sec-descendents">Descendents</a> |
184     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
185    
186    
187     |
188     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
189    
190     </div>
191     <div class="info-box-body">
192     <h4>Inherited Variables</h4>
193     <A NAME='inherited_vars'><!-- --></A>
194     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
195     <blockquote>
196     <span class="var-title">
197     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
198     </span>
199     <span class="var-title">
200     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
201     </span>
202     <span class="var-title">
203     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
204     </span>
205     <span class="var-title">
206     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
207     </span>
208     <span class="var-title">
209     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
210     </span>
211     <span class="var-title">
212     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
213     </span>
214     <span class="var-title">
215     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
216     </span>
217     <span class="var-title">
218     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
219     </span>
220     <span class="var-title">
221     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
222     </span>
223     <span class="var-title">
224     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
225     </span>
226     <span class="var-title">
227     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
228     </span>
229     <span class="var-title">
230     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
231     </span>
232     </blockquote>
233    
234     </div>
235     </div>
236    
237     <a name="sec-methods"></a>
238     <div class="info-box">
239     <div class="info-box-title">Methods</div>
240     <div class="nav-bar">
241     <a href="#sec-description">Description</a> |
242     <a href="#sec-descendents">Descendents</a> |
243     <a href="#sec-vars">Vars</a>
244     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
245    
246     </div>
247     <div class="info-box-body">
248     <A NAME='method_detail'></A>
249     <a name="methodFEText" id="FEText"><!-- --></a>
250     <div class="evenrow">
251    
252     <div class="method-header">
253     <span class="method-title">Constructor FEText</span> (line <span class="line-number">39</span>)
254     </div>
255    
256     <!-- ========== Info from phpDoc block ========= -->
257     <p class="short-description">The constructor</p>
258    
259     <div class="method-signature">
260     <span class="method-result">void</span>
261     <span class="method-name">
262     FEText
263     </span>
264     (<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">TRUE</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>])
265     </div>
266    
267     <ul class="parameters">
268     <li>
269     <span class="var-type">label</span>
270     <span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span> </li>
271     <li>
272     <span class="var-type">bool</span>
273     <span class="var-name">$required</span><span class="var-description">: <p>required - is this a required element</p></span> </li>
274     <li>
275     <span class="var-type">int</span>
276     <span class="var-name">$width</span><span class="var-description">: <p>required - element width in characters, pixels (px), percentage (%) or elements (em)</p></span> </li>
277     <li>
278     <span class="var-type">int</span>
279     <span class="var-name">$maxlength</span><span class="var-description">: <p>required - maximum number of chars allowed to type in</p></span> </li>
280     </ul>
281    
282    
283     </div>
284     <a name="methodget_element" id="get_element"><!-- --></a>
285     <div class="oddrow">
286    
287     <div class="method-header">
288     <span class="method-title">get_element</span> (line <span class="line-number">60</span>)
289     </div>
290    
291     <!-- ========== Info from phpDoc block ========= -->
292     <p class="short-description">This function builds and returns the form element object</p>
293    
294     <div class="method-signature">
295     <span class="method-result">object</span>
296     <span class="method-name">
297     get_element
298     </span>
299     ()
300     </div>
301    
302    
303     <hr class="separator" />
304     <div class="notes">Redefinition of:</div>
305 jonen 1.1 <dl>
306 jonen 1.2 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
307     <dd>This function builds and returns the form element object</dd>
308     </dl>
309    
310     <hr class="separator" />
311     <div class="notes">Redefined in descendants as:</div>
312     <ul class="redefinitions">
313     <li>
314     <a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_element">FEFile::get_element()</a>
315     : This function builds and returns the form element object
316     </li>
317     <li>
318     <a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodget_element">FEHostNameWithPort::get_element()</a>
319     : This function builds and returns the form element object
320     </li>
321     <li>
322     <a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a>
323     : This function builds and returns the form element object
324     </li>
325     </ul>
326     </div>
327     <h4>Inherited Methods</h4>
328     <a name='inherited_methods'><!-- --></a>
329     <!-- =========== Summary =========== -->
330     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
331     <blockquote>
332     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
333     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
334     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
335     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
336     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
337     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
338     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
339     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
340     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
341     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
342     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
343     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
344     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
345     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
346     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
347     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
348     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
349     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
350     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
351     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
352     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
353     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
354     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
355     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
356     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
357     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
358     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
359     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
360     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
361     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
362     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
363     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
364     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
365     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
366     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
367     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
368     </blockquote>
369    
370     </div>
371     </div>
372    
373     <p class="notes" id="credit">
374     Documention generated on Thu, 31 Jul 2003 18:32:38 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
375 jonen 1.1 </p>
376 jonen 1.2 </div></body>
377 jonen 1.1 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed