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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 21:05:35 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2     <!--NewPage-->
3     <HTML>
4     <HEAD>
5     <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:48 -0800' -->
6     <TITLE>Docs For Class FETextArea</TITLE>
7     <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>
8     </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10     <!-- Links -->
11     <a NAME="top"></A>
12     <table WIDTH="100%" class="links">
13     <TR>
14     <TD class="font10">
15     Links:
16     <A HREF="#children_summary" class="links" title="Classes extended from FETextArea">Child Classes</A>
17     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19     <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20     <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21     <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22     <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23     </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class FETextArea
30     </H2> (line <span class="linenumber">28</span>)
31     <pre>
32     <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
33     |
34     --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>
35     |
36     --FETextArea</pre>
37     <p>
38     <b><i>Located in File: Program_Root/form/form_elements/FETextArea.inc</i></b><br>
39     </p>
40     <hr>
41     This is the TextArea FormElement which builds a textarea field. It has no validation method.
42     <br />
43    
44     <UL>
45     <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>
46     <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>
47     <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
48     </UL>
49     <hr>
50     <!-- =========== VAR SUMMARY =========== -->
51     <A NAME='var_summary'><!-- --></A>
52     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
53     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
54     <TD>
55     <span CLASS="font12bold">Class Variable Summary</span>
56     <A HREF="#top" CLASS="links">^TOP</A>
57     </TD>
58     </TR>
59    
60     </TABLE>
61     <hr>
62     <!-- =========== VAR INHERITED SUMMARY =========== -->
63     <A NAME='var_inherited_summary'><!-- --></A>
64     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
65     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
66     <TD>
67     <span CLASS="font12bold">Inherited Class Variable Summary</span>
68     <A HREF="#top" CLASS="links">^TOP</A>
69     </TD>
70     </TR>
71    
72     <!-- =========== Summary =========== -->
73     <TR BGCOLOR='white'>
74     <TD>
75     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span>
76     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
77     <tr CLASS="tableheadingcolor">
78     <th>Variable</th>
79     <th>Default Value</th>
80     <th>Description</th>
81     </tr>
82     <tr>
83     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></td>
84     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
85     <td CLASS="font10">Holds the height of the element</td>
86     </tr>
87     <tr>
88     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></td>
89     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
90     <td CLASS="font10">Holds the width of the element</td>
91     </tr>
92     </table>
93     <BR>
94     </TD>
95     </TR>
96     <!-- =========== Summary =========== -->
97     <TR BGCOLOR='white'>
98     <TD>
99     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
100     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
101     <tr CLASS="tableheadingcolor">
102     <th>Variable</th>
103     <th>Default Value</th>
104     <th>Description</th>
105     </tr>
106     <tr>
107     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td>
108     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
109     <td CLASS="font10">Holds additional attributes for</td>
110     </tr>
111     <tr>
112     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td>
113     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
114     <td CLASS="font10">Holds the name of the element</td>
115     </tr>
116     <tr>
117     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td>
118     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
119     <td CLASS="font10">Holds the error message text</td>
120     </tr>
121     <tr>
122     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td>
123     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
124     <td CLASS="font10">Holds the state of the last validation</td>
125     </tr>
126     <tr>
127     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td>
128     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
129     <td CLASS="font10">Indicates a disabled element</td>
130     </tr>
131     <tr>
132     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td>
133     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
134     <td CLASS="font10">Indicates whether this elements</td>
135     </tr>
136     <tr>
137     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td>
138     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
139     <td CLASS="font10">Holds the elements label text</td>
140     </tr>
141     <tr>
142     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td>
143     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
144     <td CLASS="font10">Holds additional style attributes for</td>
145     </tr>
146     <tr>
147     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td>
148     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
149     <td CLASS="font10">Holds the elements initial value</td>
150     </tr>
151     </table>
152     <BR>
153     </TD>
154     </TR>
155     </TABLE>
156    
157     <hr>
158     <!-- =========== METHOD SUMMARY =========== -->
159     <A NAME='method_summary'><!-- --></A>
160     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
161     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
162     <TD>
163     <span class="font12bold">Method Summary</span>
164     <A HREF="#top" CLASS="links">^TOP</A>
165     </TD>
166     </TR>
167    
168     <!-- =========== Summary =========== -->
169     <TR BGCOLOR='white' CLASS='TableRowColor'>
170     <TD>
171     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FETextArea.html#methodget_element'>object get_element ( )</A></B></CODE>
172     <BR>
173     <blockquote> This function builds and returns the form element object </blockquote>
174     </TD>
175     </TR>
176     </TABLE>
177     <!-- =========== INHERITED METHOD SUMMARY =========== -->
178     <A NAME='functions_inherited'><!-- --></A>
179     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
180     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
181     <TD>
182     <span CLASS="font12bold">Inherited Method Summary</span>
183     <A HREF="#top" CLASS="links">^TOP</A>
184     </TD>
185     </TR>
186    
187     <!-- =========== Summary =========== -->
188     <TR BGCOLOR='white' CLASS='TableRowColor'>
189     <TD>
190     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span>
191     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
192     <tr CLASS="tableheadingcolor">
193     <th>Function</th>
194     <th>Description</th>
195     </tr>
196     <tr>
197     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></td>
198     <td CLASS="font10">The constructor</td>
199     </table>
200     <br>
201     </TD>
202     </TR>
203     <!-- =========== Summary =========== -->
204     <TR BGCOLOR='white' CLASS='TableRowColor'>
205     <TD>
206     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
207     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
208     <tr CLASS="tableheadingcolor">
209     <th>Function</th>
210     <th>Description</th>
211     </tr>
212     <tr>
213     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>
214     <td CLASS="font10">The constructor</td>
215     <tr>
216     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>
217     <td CLASS="font10">This function creates element name</td>
218     <tr>
219     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td>
220     <td CLASS="font10">return a single attribute</td>
221     <tr>
222     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td>
223     <td CLASS="font10">This function builds and returns the form element object</td>
224     <tr>
225     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td>
226     <td CLASS="font10">Returns the element name to be used in the form</td>
227     <tr>
228     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td>
229     <td CLASS="font10">Returns the current error message if any</td>
230     <tr>
231     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td>
232     <td CLASS="font10">This returns the initial value of the element</td>
233     <tr>
234     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td>
235     <td CLASS="font10">This function builds and returns a label object based on the label text and error conditions</td>
236     <tr>
237     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td>
238     <td CLASS="font10">This function will return the elements label text</td>
239     <tr>
240     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td>
241     <td CLASS="font10">This function return the symbol used to denote a required field</td>
242     <tr>
243     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td>
244     <td CLASS="font10">This function will return the elements value</td>
245     <tr>
246     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td>
247     <td CLASS="font10">This provides a method</td>
248     <tr>
249     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td>
250     <td CLASS="font10">Returns the current error state</td>
251     <tr>
252     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td>
253     <td CLASS="font10">Returns the elements disabled state</td>
254     <tr>
255     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td>
256     <td CLASS="font10">Returns whether this elements final value cannot be empty</td>
257     <tr>
258     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td>
259     <td CLASS="font10">This function return the javaScript code for an onBlur event</td>
260     <tr>
261     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td>
262     <td CLASS="font10">This function return the javaScript code for an onClick event</td>
263     <tr>
264     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td>
265     <td CLASS="font10">This function return the javaScript code for an onFocus event</td>
266     <tr>
267     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>
268     <td CLASS="font10">This function return the javaScript code for an onSubmit event</td>
269     <tr>
270     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>
271     <td CLASS="font10">add a single attribute (name="value")</td>
272     <tr>
273     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>
274     <td CLASS="font10">Sets the disabled element flag</td>
275     <tr>
276     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>
277     <td CLASS="font10">Defines error message text and sets the error flag to true</td>
278     <tr>
279     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>
280     <td CLASS="font10">This function will set the label for the element</td>
281     <tr>
282     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>
283     <td CLASS="font10">This function set the elements required state</td>
284     <tr>
285     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>
286     <td CLASS="font10">Sets elements css attribute</td>
287     <tr>
288     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>
289     <td CLASS="font10">Sets elements title text</td>
290     <tr>
291     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>
292     <td CLASS="font10">This function will set the initial value for the element</td>
293     <tr>
294     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>
295     <td CLASS="font10">This function performs the actual validation It is called only if the validation is required by this element</td>
296     <tr>
297     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>
298     <td CLASS="font10">This function builds the element form attributes</td>
299     <tr>
300     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>
301     <td CLASS="font10">This function builds the complete javaScript events code for the element</td>
302     <tr>
303     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>
304     <td CLASS="font10">This function checks if the validation</td>
305     </table>
306     <br>
307     </TD>
308     </TR>
309     </TABLE>
310     <hr>
311     <!-- ============ VARIABLE DETAIL =========== -->
312    
313     <A NAME='variable_detail'></A>
314     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
315     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
316     <TD>
317     <span CLASS="font12bold">Variable Detail</span>
318     <A HREF="#top" CLASS="links">^TOP</A>
319     </TD>
320     </TR>
321     </TABLE>
322    
323     <hr>
324     <!-- ============ METHOD DETAIL =========== -->
325    
326     <A NAME='method_detail'></A>
327     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
328     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
329     <TD>
330     <span class="font12bold">Method Detail</span>
331     <A HREF="#top" CLASS="links">^TOP</A>
332     </TD>
333     </TR>
334     </TABLE>
335     <BR>
336     <DIV CLASS="function">
337     <A NAME='methodget_element'><!-- --></A>
338     <SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">36</span>)
339     <BR>
340     <SPAN CLASS="font10bold">Usage : </SPAN>
341     <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;
342     <span class="font10bold" style="color: #0000FF">get_element(
343     )</SPAN>
344     <BR>
345    
346     <BR>
347     <SPAN CLASS="font10bold">Description : </SPAN>
348     This function builds and returns the form element object
349     <br />
350    
351     <DL>
352    
353     <DT class="font10bold">Function Info:</DT>
354     </DL>
355     </DIV>
356     <BR>
357     <div id="credit">
358     <hr>
359     Documention generated on Thu, 20 Feb 2003 16:22:48 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
360     </div>
361     </body>
362     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed