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

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

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

revision 1.1 by jonen, Sat Feb 22 21:05:31 2003 UTC revision 1.2 by jonen, Sat Sep 20 00:36:45 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:47 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class FEText</TITLE>                          <title>Docs For Class FEText</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 FEText</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 FEText">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-descendents">Descendents</a>
20        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>                          |                                                                                       <a href="#sec-vars">Vars</a>
21        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22        <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>                                                  
23     </TD>                          </div>
24   </TR>          <div class="info-box-body">
25  </TABLE>                  <!-- ========== Info from phpDoc block ========= -->
26  <BR>  <p class="short-description">This is the Text FormElement which builds a  text input field. It has no validation method.</p>
27  <!-- Start of Class Data -->          <ul class="tags">
28  <H2>                                  <li><span class="field">copyright:</span> <p>LGPL - See LICENCE</p></li>
29          Class FEText                                  <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  </H2> (line <span class="linenumber">29</span>)                                  <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  <pre>                          </ul>
32  <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>                  <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     |     |
39     --FEText</pre>     --FEText</pre>
40  <SPAN class="type">Classes extended from FEText:</SPAN>          
41                  <dl>                          </div>
42          <dt><a href="../../phpHtmlLib/FormProcessing/FEName.html">FEName</a></dt>  </div>
                 <dd>This is the Name FormElement which builds a  text input field, and validates against the  is_name() method.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEEmail.html">FEEmail</a></dt>  
                 <dd>This is the Email FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEEmailMany.html">FEEmailMany</a></dt>  
                 <dd>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.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEDomainName.html">FEDomainName</a></dt>  
                 <dd>This is the DomainName FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEIPAddress.html">FEIPAddress</a></dt>  
                 <dd>This is the Ip Address FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FENumberFloat.html">FENumberFloat</a></dt>  
                 <dd>This is the float FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FENumberPrice.html">FENumberPrice</a></dt>  
                 <dd>This is the Price FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEUrl.html">FEUrl</a></dt>  
                 <dd>This is the URL FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEUrlStrict.html">FEUrlStrict</a></dt>  
                 <dd>This is the URLStrict FormElement which builds a  text input field.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></dt>  
                 <dd>This is the Password FormElement which builds a  input field of type="password".  It validates  the data as is_password().</dd>  
         </dl>  
         </p>  
 <p>  
         <b><i>Located in File: Program_Root/form/form_elements/FEText.inc</i></b><br>  
 </p>  
 <hr>  
 This is the Text FormElement which builds a  text input field. It has no validation method.  
 <br />  
   
 <UL>  
                 <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>  
                 <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>  
                 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
         </UL>  
 <hr>  
 <!-- =========== VAR SUMMARY =========== -->  
 <A NAME='var_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
         </TABLE>  
 <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/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/FEText.html#methodFEText'>void constructor FEText ( $label, [$required = TRUE], [$width = NULL], [$maxlength = NULL] )</A></B></CODE>  
                         <BR>  
                         <blockquote> The constructor </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEText.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>  
43    
44                  <!-- =========== Summary =========== -->          <a name="sec-descendents"></a>
45          <TR BGCOLOR='white' CLASS='TableRowColor'>          <div class="info-box">
46                  <TD>                  <div class="info-box-title">Direct descendents</div>
47                          <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>                  <div class="nav-bar">
48              <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">                          <a href="#sec-description">Description</a> |
49                                  <tr CLASS="tableheadingcolor">                          <span class="disabled">Descendents</span>
50                                          <th>Function</th>                          |                                                                                               <a href="#sec-vars">Vars</a>
51                                          <th>Description</th>                                                                  |                                                                                                                       <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                                  </tr>                                  </tr>
60                                                                  <tr>                                                                  <tr>
61                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumber.html">FENumber</a></td>
62                                          <td CLASS="font10">The constructor</td>                                          <td>
63                                                                  <tr>                                                                                          This is the FormElement which builds a  text input field that validates  It validates as is_number().
64                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>                                                                                  </td>
65                                          <td CLASS="font10">This function creates element name</td>                                  </tr>
                                                                 <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>  
66                                                                  <tr>                                                                  <tr>
67                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberFloat.html">FENumberFloat</a></td>
68                                          <td CLASS="font10">This function return the javaScript code for  an onSubmit event</td>                                          <td>
69                                                                                            This is the float FormElement which builds a  text input field.
70                                                                                    </td>
71                                    </tr>
72                                                                  <tr>                                                                  <tr>
73                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberPrice.html">FENumberPrice</a></td>
74                                          <td CLASS="font10">add a single attribute (name="value")</td>                                          <td>
75                                                                                            This is the Price FormElement which builds a  text input field.
76                                                                                    </td>
77                                    </tr>
78                                                                  <tr>                                                                  <tr>
79                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENumberInRange.html">FENumberInRange</a></td>
80                                          <td CLASS="font10">Sets the disabled element flag</td>                                          <td>
81                                                                                            This is the Number Range FormElement which builds a  text input field.
82                                                                                    </td>
83                                    </tr>
84                                                                  <tr>                                                                  <tr>
85                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEFile.html">FEFile</a></td>
86                                          <td CLASS="font10">Defines error message text and  sets the error flag to true</td>                                          <td>
87                                                                                            This is the FileUpload FormElement which builds a  input field of type=&quot;file&quot;.
88                                                                                    </td>
89                                    </tr>
90                                                                  <tr>                                                                  <tr>
91                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEName.html">FEName</a></td>
92                                          <td CLASS="font10">This function will set the  label for the element</td>                                          <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                                                                  <tr>                                                                  <tr>
97                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEEmail.html">FEEmail</a></td>
98                                          <td CLASS="font10">This function set the elements  required state</td>                                          <td>
99                                                                                            This is the Email FormElement which builds a  text input field.
100                                                                                    </td>
101                                    </tr>
102                                                                  <tr>                                                                  <tr>
103                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEEmailMany.html">FEEmailMany</a></td>
104                                          <td CLASS="font10">Sets elements css attribute</td>                                          <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                                                                  <tr>                                                                  <tr>
109                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDomainName.html">FEDomainName</a></td>
110                                          <td CLASS="font10">Sets elements title text</td>                                          <td>
111                                                                                            This is the DomainName FormElement which builds a  text input field.
112                                                                                    </td>
113                                    </tr>
114                                                                  <tr>                                                                  <tr>
115                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html">FEHostNameWithPort</a></td>
116                                          <td CLASS="font10">This function will set the  initial value for the element</td>                                          <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                                                                  <tr>                                                                  <tr>
121                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEIPAddress.html">FEIPAddress</a></td>
122                                          <td CLASS="font10">This function performs the actual validation  It is called only if the validation is required by  this element</td>                                          <td>
123                                                                                            This is the Ip Address FormElement which builds a  text input field.
124                                                                                    </td>
125                                    </tr>
126                                                                  <tr>                                                                  <tr>
127                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEUrl.html">FEUrl</a></td>
128                                          <td CLASS="font10">This function builds the element form attributes</td>                                          <td>
129                                                                                            This is the URL FormElement which builds a  text input field.
130                                                                                    </td>
131                                    </tr>
132                                                                  <tr>                                                                  <tr>
133                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEUrlStrict.html">FEUrlStrict</a></td>
134                                          <td CLASS="font10">This function builds the complete javaScript events code  for the element</td>                                          <td>
135                                                                                            This is the URLStrict FormElement which builds a  text input field.
136                                                                                    </td>
137                                    </tr>
138                                                                  <tr>                                                                  <tr>
139                                          <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>                                          <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEPassword.html">FEPassword</a></td>
140                                          <td CLASS="font10">This function checks if the validation</td>                                          <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                                                          </table>                                                          </table>
145              <br>                                          </div>
146                  </TD>          </div>
         </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='methodFEText'><!-- --></A>  
 <SPAN CLASS="font12bold">Constructor FEText</SPAN> (line <span class="linenumber">39</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">FEText(  
 label  
 $label, [bool  
 $required = TRUE], [int  
 $width = NULL], [int  
 $maxlength = NULL])</SPAN>  
 <BR>  
147    
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 The constructor  
 <br />  
148    
149  <DL>          <a name="sec-method-summary"></a>
150          <DT class="font10bold">Function Parameters:</DT>          <div class="info-box">
151                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">label</SPAN> <span style="color: #0000FF;font-weight:bold">$label</SPAN></SPAN> string - text label for the element</DD>                  <div class="info-box-title">Method Summary</span></div>
152                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">bool</SPAN> <span style="color: #0000FF;font-weight:bold">$required</SPAN></SPAN> required - is this a required element</DD>                  <div class="nav-bar">
153                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> required - element width in characters, pixels (px), percentage (%) or elements (em)</DD>                          <a href="#sec-description">Description</a> |
154                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$maxlength</SPAN></SPAN> required - maximum number of chars allowed to type in</DD>                                                          <a href="#sec-descendents">Descendents</a> |
155                                                                                                                                    <a href="#sec-vars">Vars</a>
156          <DT class="font10bold">Function Info:</DT>                                  
157          </DL>                                  |
158  </DIV>                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
159  <BR>                  </div>
160  <DIV CLASS="function">                  <div class="info-box-body">                    
161  <A NAME='methodget_element'><!-- --></A>                          <div class="method-summary">
162  <SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">60</span>)                                                                  
163  <BR>                                  <div class="method-definition">
164  <SPAN CLASS="font10bold">Usage : </SPAN>                                                                                          <span class="method-result">void</span>
165  <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;                                                                                  <a href="#FEText" title="details" class="method-name">FEText</a>
166  <span class="font10bold" style="color: #0000FF">get_element(                                                                                          (<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  )</SPAN>                                                                          </div>
168  <BR>                                                                  
169          <p>Overridden in child classes as:<br />                                  <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                  <dl>                  <dl>
306          <dt><a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a></dt>                          <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>                                                  <dd>This function builds and returns the  form element object</dd>
308          </dl>                                          </dl>
309          </p>                  
310                            <hr class="separator" />
311  <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a> This function builds and returns the  form element object                  <div class="notes">Redefined in descendants as:</div>
312  <BR>                  <ul class="redefinitions">
313  <SPAN CLASS="font10bold">Description : </SPAN>                                          <li>
314  This function builds and returns the  form element object                                  <a href="../../phpHtmlLib/FormProcessing/FEFile.html#methodget_element">FEFile::get_element()</a>
315  <br />                                                                  : This function builds and returns the  form element object
316                                                            </li>
317  <DL>                                          <li>
318                                    <a href="../../phpHtmlLib/FormProcessing/FEHostNameWithPort.html#methodget_element">FEHostNameWithPort::get_element()</a>
319          <DT class="font10bold">Function Info:</DT>                                                                  : This function builds and returns the  form element object
320          </DL>                                                          </li>
321  </DIV>                                          <li>
322  <BR>                                  <a href="../../phpHtmlLib/FormProcessing/FEPassword.html#methodget_element">FEPassword::get_element()</a>
323          <div id="credit">                                                                  : This function builds and returns the  form element object
324                  <hr>                                                          </li>
325                  Documention generated on Thu, 20 Feb 2003 16:22:47 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>                                  </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>          </div>
372  </body>          
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            </p>
376            </div></body>
377  </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