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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1 by jonen, Sat Feb 22 21:05:35 2003 UTC revision 1.2 by jonen, Sat Sep 20 00:36:46 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!--NewPage-->  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <HTML>    <html xmlns="http://www.w3.org/1999/xhtml">
4  <HEAD>                  <head>
5          <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:48 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class FETextArea</TITLE>                          <title>Docs For Class FETextArea</title>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'>                          <link rel="stylesheet" href="../../media/stylesheet.css" />
8  </HEAD>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">                  </head>
10  <!-- Links -->                  <body>
11  <a NAME="top"></A>                          <div class="page-body">                
12  <table WIDTH="100%" class="links">  <h2 class="class-name">Class FETextArea</h2>
13   <TR>  
14     <TD class="font10">  <a name="sec-description"></a>
15        Links:  <div class="info-box">
16        <A HREF="#children_summary" class="links" title="Classes extended from FETextArea">Child Classes</A>          <div class="info-box-title">Description</div>
17        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>          <div class="nav-bar">
18        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
20        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</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>                          </div>
23     </TD>          <div class="info-box-body">
24   </TR>                  <!-- ========== Info from phpDoc block ========= -->
25  </TABLE>  <p class="short-description">This is the TextArea FormElement which builds a  textarea field. It has no validation method.</p>
26  <BR>          <ul class="tags">
27  <!-- Start of Class Data -->                                  <li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li>
28  <H2>                                  <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          Class FETextArea                                  <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  </H2> (line <span class="linenumber">28</span>)                          </ul>
31  <pre>                  <p class="notes">
32  <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>                          Located in <a class="field" href="_form_form_elements_FETextArea_inc.html">Program_Root/form/form_elements/FETextArea.inc</a> (line <span class="field">28</span>)
33                    </p>
34                    
35                            
36                    <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
37     |     |
38     --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>     --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>
39        |        |
40        --FETextArea</pre>        --FETextArea</pre>
41  <p>          
42          <b><i>Located in File: Program_Root/form/form_elements/FETextArea.inc</i></b><br>                          </div>
43  </p>  </div>
44  <hr>  
45  This is the TextArea FormElement which builds a  textarea field. It has no validation method.  
46  <br />          <a name="sec-var-summary"></a>
47            <div class="info-box">
48  <UL>                  <div class="info-box-title">Variable Summary</span></div>
49                  <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>                  <div class="nav-bar">
50                  <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>                          <a href="#sec-description">Description</a> |
51                  <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>                                                  <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
52          </UL>                                                          |
53  <hr>                                                                          <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54  <!-- =========== VAR SUMMARY =========== -->                                                          
55  <A NAME='var_summary'><!-- --></A>                                          </div>
56  <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">                  <div class="info-box-body">
57          <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>                          <div class="var-summary">
58                  <TD>                                                                  <div class="var-title">
59                          <span CLASS="font12bold">Class Variable Summary</span>                                          <span class="var-type">mixed</span>
60              <A HREF="#top" CLASS="links">^TOP</A>                                          <a href="#$_limit_char_count" title="details" class="var-name">$_limit_char_count</a>
61                  </TD>                                  </div>
62          </TR>                                                          </div>
63                    </div>
64          </TABLE>          </div>
 <hr>  
 <!-- =========== VAR INHERITED SUMMARY =========== -->  
 <A NAME='var_inherited_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span>  
             <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                         <tr CLASS="tableheadingcolor">  
                                 <th>Variable</th>  
                                 <th>Default Value</th>  
                                 <th>Description</th>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the height of the element</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the width of the element</td>  
                         </tr>  
                                                         </table>  
             <BR>  
         </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>  
             <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                         <tr CLASS="tableheadingcolor">  
                                 <th>Variable</th>  
                                 <th>Default Value</th>  
                                 <th>Description</th>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>  
                                 <td CLASS="font10">Holds additional attributes for</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the name of the element</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the error message text</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>  
                                 <td CLASS="font10">Holds the state of the last validation</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>  
                                 <td CLASS="font10">Indicates a disabled element</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>  
                                 <td CLASS="font10">Indicates whether this elements</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the elements label text</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>  
                                 <td CLASS="font10">Holds additional style attributes for</td>  
                         </tr>  
                                                         <tr>  
                                 <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>  
                                 <td CLASS="font10">Holds the elements initial value</td>  
                         </tr>  
                                                         </table>  
             <BR>  
         </TD>  
         </TR>  
         </TABLE>  
   
 <hr>  
 <!-- =========== METHOD SUMMARY =========== -->  
 <A NAME='method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FETextArea.html#methodget_element'>object get_element (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function builds and returns the  form element object </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
                                 </tr>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></td>  
                                         <td CLASS="font10">The constructor</td>  
                                                         </table>  
             <br>                          
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
                                 </tr>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>  
                                         <td CLASS="font10">The constructor</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>  
                                         <td CLASS="font10">This function creates element name</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td>  
                                         <td CLASS="font10">return a single attribute</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td>  
                                         <td CLASS="font10">This function builds and returns the  form element object</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td>  
                                         <td CLASS="font10">Returns the element name  to be used in the form</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td>  
                                         <td CLASS="font10">Returns the current error message  if any</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td>  
                                         <td CLASS="font10">This returns the initial value of  the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td>  
                                         <td CLASS="font10">This function builds and returns a  label object based on the label text  and error conditions</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td>  
                                         <td CLASS="font10">This function will return the  elements label text</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td>  
                                         <td CLASS="font10">This function return the symbol used to  denote a required field</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td>  
                                         <td CLASS="font10">This function will return the  elements value</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td>  
                                         <td CLASS="font10">This provides a method</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td>  
                                         <td CLASS="font10">Returns the current error state</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td>  
                                         <td CLASS="font10">Returns the elements disabled  state</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td>  
                                         <td CLASS="font10">Returns whether this elements  final value cannot be empty</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onBlur event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onClick event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onFocus event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>  
                                         <td CLASS="font10">This function return the javaScript code for  an onSubmit event</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>  
                                         <td CLASS="font10">add a single attribute (name="value")</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>  
                                         <td CLASS="font10">Sets the disabled element flag</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>  
                                         <td CLASS="font10">Defines error message text and  sets the error flag to true</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>  
                                         <td CLASS="font10">This function will set the  label for the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>  
                                         <td CLASS="font10">This function set the elements  required state</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>  
                                         <td CLASS="font10">Sets elements css attribute</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>  
                                         <td CLASS="font10">Sets elements title text</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>  
                                         <td CLASS="font10">This function will set the  initial value for the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>  
                                         <td CLASS="font10">This function performs the actual validation  It is called only if the validation is required by  this element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>  
                                         <td CLASS="font10">This function builds the element form attributes</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>  
                                         <td CLASS="font10">This function builds the complete javaScript events code  for the element</td>  
                                                                 <tr>  
                                         <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>  
                                         <td CLASS="font10">This function checks if the validation</td>  
                                                         </table>  
             <br>                          
                 </TD>  
         </TR>  
         </TABLE>  
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
 <hr>  
 <!-- ============ METHOD DETAIL =========== -->  
   
 <A NAME='method_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodget_element'><!-- --></A>  
 <SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">36</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_element(  
 )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function builds and returns the  form element object  
 <br />  
65    
66  <DL>          <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">void</span>
81                                                                                    <a href="#FETextArea" title="details" class="method-name">FETextArea</a>
82                                                                                            (<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">$rows</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$cols</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">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$limit_char_count</span> = <span class="var-default">-1</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">mixed</span>
93                                                                                    <a href="#get_value" title="details" class="method-name">get_value</a>
94                                                                                    ()
95                                                                            </div>
96                                                                    
97                                    <div class="method-definition">
98                                                                                            <span class="method-result">void</span>
99                                                                                    <a href="#set_cols" title="details" class="method-name">set_cols</a>
100                                                                                            (<span class="var-type">int</span>&nbsp;<span class="var-name">$cols</span>)
101                                                                            </div>
102                                                                    
103                                    <div class="method-definition">
104                                                                                            <span class="method-result">void</span>
105                                                                                    <a href="#set_rows" title="details" class="method-name">set_rows</a>
106                                                                                            (<span class="var-type">int</span>&nbsp;<span class="var-name">$rows</span>)
107                                                                            </div>
108                                                            </div>
109                    </div>
110            </div>          
111    
112            <a name="sec-vars"></a>
113            <div class="info-box">
114                    <div class="info-box-title">Variables</div>
115                    <div class="nav-bar">
116                            <a href="#sec-description">Description</a> |
117                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
118                                                    
119                            
120                                                            |
121                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
122                                                            
123                                            </div>
124                    <div class="info-box-body">
125                            <a name="var$_limit_char_count" id="$_limit_char_count"><!-- --></A>
126    <div class="evenrow">
127    
128            <div class="var-header">
129                    <span class="var-title">
130                            <span class="var-type">mixed</span>
131                            <span class="var-name">$_limit_char_count</span>
132                             = <span class="var-default"> -1</span>                 (line <span class="line-number">55</span>)
133                    </span>
134            </div>
135    
136          <DT class="font10bold">Function Info:</DT>          <!-- ========== Info from phpDoc block ========= -->
137          </DL>  <p class="short-description">This lets you limit the amount of data to</p>
138  </DIV>  <p class="description"><p>accept in the field</p></p>
139  <BR>          
140          <div id="credit">          
141                  <hr>                  
142                  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>                  
143    
144    </div>
145                                                            <h4>Inherited Variables</h4>
146                                    <A NAME='inherited_vars'><!-- --></A>
147                                                                            <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
148                                            <blockquote>
149                                                                                                            <span class="var-title">
150                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br>
151                                                            </span>
152                                                                                                            <span class="var-title">
153                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br>
154                                                            </span>
155                                                                                            </blockquote>
156                                                                            <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
157                                            <blockquote>
158                                                                                                            <span class="var-title">
159                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
160                                                            </span>
161                                                                                                            <span class="var-title">
162                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
163                                                            </span>
164                                                                                                            <span class="var-title">
165                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
166                                                            </span>
167                                                                                                            <span class="var-title">
168                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
169                                                            </span>
170                                                                                                            <span class="var-title">
171                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
172                                                            </span>
173                                                                                                            <span class="var-title">
174                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
175                                                            </span>
176                                                                                                            <span class="var-title">
177                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
178                                                            </span>
179                                                                                                            <span class="var-title">
180                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
181                                                            </span>
182                                                                                                            <span class="var-title">
183                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
184                                                            </span>
185                                                                                                            <span class="var-title">
186                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
187                                                            </span>
188                                                                                                            <span class="var-title">
189                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
190                                                            </span>
191                                                                                                            <span class="var-title">
192                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
193                                                            </span>
194                                                                                            </blockquote>
195                                                                                    
196                    </div>
197            </div>
198            
199            <a name="sec-methods"></a>
200            <div class="info-box">
201                    <div class="info-box-title">Methods</div>
202                    <div class="nav-bar">
203                            <a href="#sec-description">Description</a> |
204                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
205                                                                                                                    <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
206                                                    
207                    </div>
208                    <div class="info-box-body">
209                            <A NAME='method_detail'></A>
210    <a name="methodFETextArea" id="FETextArea"><!-- --></a>
211    <div class="oddrow">
212            
213            <div class="method-header">
214                    <span class="method-title">Constructor FETextArea</span> (line <span class="line-number">42</span>)
215            </div>
216            
217            <!-- ========== Info from phpDoc block ========= -->
218    <p class="short-description">The constructor</p>
219            
220            <div class="method-signature">
221                    <span class="method-result">void</span>
222                    <span class="method-name">
223                            FETextArea
224                    </span>
225                                            (<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">$rows</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$cols</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">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$limit_char_count</span> = <span class="var-default">-1</span>])
226                            </div>
227            
228                            <ul class="parameters">
229                                            <li>
230                                    <span class="var-type">label</span>
231                                    <span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span>                   </li>
232                                            <li>
233                                    <span class="var-type">bool</span>
234                                    <span class="var-name">$required</span><span class="var-description">: <p>required - is this a required element</p></span>                      </li>
235                                            <li>
236                                    <span class="var-type">int</span>
237                                    <span class="var-name">$rows</span><span class="var-description">: <p>required - the rows attribute</p></span>                  </li>
238                                            <li>
239                                    <span class="var-type">int</span>
240                                    <span class="var-name">$cols</span><span class="var-description">: <p>required - the cols attribute</p></span>                  </li>
241                                            <li>
242                                    <span class="var-type">int</span>
243                                    <span class="var-name">$width</span><span class="var-description">: <p>optional - element width in pixels (px), percentage (%) or elements (em)</p></span>                      </li>
244                                            <li>
245                                    <span class="var-type">int</span>
246                                    <span class="var-name">$height</span><span class="var-description">: <p>optional - element height in pixels (px), percentage (%) or elements (em)</p></span>                    </li>
247                                            <li>
248                                    <span class="var-type">int</span>
249                                    <span class="var-name">$limit_char_count</span><span class="var-description">: <p>optional - the number of characters to limit the value to.</p></span>                 </li>
250                                    </ul>
251                    
252                    
253            </div>
254    <a name="methodget_element" id="get_element"><!-- --></a>
255    <div class="evenrow">
256            
257            <div class="method-header">
258                    <span class="method-title">get_element</span> (line <span class="line-number">63</span>)
259            </div>
260            
261            <!-- ========== Info from phpDoc block ========= -->
262    <p class="short-description">This function builds and returns the  form element object</p>
263            
264            <div class="method-signature">
265                    <span class="method-result">object</span>
266                    <span class="method-name">
267                            get_element
268                    </span>
269                                    ()
270                            </div>
271            
272                    
273                            <hr class="separator" />
274                    <div class="notes">Redefinition of:</div>
275                    <dl>
276                            <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
277                                                    <dd>This function builds and returns the  form element object</dd>
278                                            </dl>
279                    
280            </div>
281    <a name="methodget_value" id="get_value"><!-- --></a>
282    <div class="oddrow">
283            
284            <div class="method-header">
285                    <span class="method-title">get_value</span> (line <span class="line-number">82</span>)
286            </div>
287            
288            <!-- ========== Info from phpDoc block ========= -->
289    <p class="short-description">This function will return the  elements value</p>
290            
291            <div class="method-signature">
292                    <span class="method-result">mixed</span>
293                    <span class="method-name">
294                            get_value
295                    </span>
296                                    ()
297                            </div>
298            
299                    
300                            <hr class="separator" />
301                    <div class="notes">Redefinition of:</div>
302                    <dl>
303                            <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></dt>
304                                                    <dd>This function will return the  elements value</dd>
305                                            </dl>
306                    
307            </div>
308    <a name="methodset_cols" id="set_cols"><!-- --></a>
309    <div class="evenrow">
310            
311            <div class="method-header">
312                    <span class="method-title">set_cols</span> (line <span class="line-number">108</span>)
313            </div>
314            
315            <!-- ========== Info from phpDoc block ========= -->
316    <p class="short-description">This method is used as a shortcut  to set the cols attribute</p>
317            
318            <div class="method-signature">
319                    <span class="method-result">void</span>
320                    <span class="method-name">
321                            set_cols
322                    </span>
323                                            (<span class="var-type">int</span>&nbsp;<span class="var-name">$cols</span>)
324                            </div>
325            
326                            <ul class="parameters">
327                                            <li>
328                                    <span class="var-type">int</span>
329                                    <span class="var-name">$cols</span><span class="var-description">: <p>the cols attribute value</p></span>                       </li>
330                                    </ul>
331                    
332                    
333            </div>
334    <a name="methodset_rows" id="set_rows"><!-- --></a>
335    <div class="oddrow">
336            
337            <div class="method-header">
338                    <span class="method-title">set_rows</span> (line <span class="line-number">98</span>)
339            </div>
340            
341            <!-- ========== Info from phpDoc block ========= -->
342    <p class="short-description">This method is used as a shortcut  to set the rows attribute</p>
343            
344            <div class="method-signature">
345                    <span class="method-result">void</span>
346                    <span class="method-name">
347                            set_rows
348                    </span>
349                                            (<span class="var-type">int</span>&nbsp;<span class="var-name">$rows</span>)
350                            </div>
351            
352                            <ul class="parameters">
353                                            <li>
354                                    <span class="var-type">int</span>
355                                    <span class="var-name">$rows</span><span class="var-description">: <p>the rows attribute value</p></span>                       </li>
356                                    </ul>
357                    
358                    
359            </div>
360                                                            <h4>Inherited Methods</h4>
361                                    <a name='inherited_methods'><!-- --></a>        
362                                                                            <!-- =========== Summary =========== -->
363                                            <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
364                                            <blockquote>
365                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br>
366                                                                                            </blockquote>
367                                                                            <!-- =========== Summary =========== -->
368                                            <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
369                                            <blockquote>
370                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
371                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
372                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
373                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
374                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
375                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
376                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
377                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
378                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
379                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
380                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
381                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
382                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
383                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
384                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
385                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
386                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
387                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
388                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
389                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
390                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
391                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
392                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
393                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
394                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
395                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
396                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
397                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
398                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
399                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
400                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
401                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
402                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
403                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
404                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
405                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
406                                                                                            </blockquote>
407                                                                                    
408                    </div>
409          </div>          </div>
410  </body>          
411            <p class="notes" id="credit">
412                    Documention generated on Thu, 31 Jul 2003 18:32:39 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
413            </p>
414            </div></body>
415  </html>  </html>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed