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

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

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

revision 1.1 by jonen, Sat Feb 22 21:04:59 2003 UTC revision 1.3 by jonen, Thu May 6 16:25:56 2004 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:41 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class FEBoxElement</TITLE>                          <title>Docs For Class FEBoxElement</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 FEBoxElement</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 FEBoxElement">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-var-summary">Vars</a> (<a href="#sec-vars">details</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 Box FormElement which builds a  DIV with a width and a height.  It is a base  class for more complicated FormElements.</p>
27  <!-- Start of Class Data -->          <ul class="tags">
28  <H2>                                  <li><span class="field">copyright:</span> LGPL - See LICENCE</li>
29          Class FEBoxElement                                  <li><span class="field">author:</span> Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</li>
30  </H2> (line <span class="linenumber">29</span>)                                  <li><span class="field">author:</span> Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>&gt;</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_FEBoxElement_inc.html">/form/form_elements/FEBoxElement.inc</a> (line <span class="field">29</span>)
34                    </p>
35                    
36                                    
37                    <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
38     |     |
    --FEBoxElement</pre>  
 <SPAN class="type">Classes extended from FEBoxElement:</SPAN>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FETextArea.html">FETextArea</a></dt>  
                 <dd>This is the TextArea FormElement which builds a  textarea field. It has no validation method.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></dt>  
                 <dd>This is the DataList FormElement which builds a  a complex FEBoxElement. It has no validation method.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../../phpHtmlLib/FormProcessing/FEButton.html">FEButton</a></dt>  
                 <dd>This is the button FormElement which builds a  input field of type="button". It has no validation method.</dd>  
         </dl>  
         </p>  
 <p>  
         <b><i>Located in File: Program_Root/form/form_elements/FEBoxElement.inc</i></b><br>  
 </p>  
 <hr>  
 This is the Box FormElement which builds a  DIV with a width and a height.  It is a base  class for more complicated FormElements.  
 <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>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">$_height</A></B></CODE>  
                         <BR>  
                         <blockquote> Holds the height of the element </blockquote>  
                         <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">$_width</A></B></CODE>  
                         <BR>  
                         <blockquote> Holds the width of the element </blockquote>  
                         <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>  
                 </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/FEBoxElement.html#methodFEBoxElement'>void constructor FEBoxElement ( $label, [$required = TRUE], [$width = NULL], [$height = NULL] )</A></B></CODE>  
                         <BR>  
                         <blockquote> The constructor </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/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>  
   
 <A NAME='var$_height'><!-- --></A><H3>$_height</H3> (line <span class="linenumber">41</span>)<br />  
 <b>Data type:</b> mixed<br>Holds the height of the element  
 <br />  
   
 <UL>  
         </UL>  
 <HR>  
 <A NAME='var$_width'><!-- --></A><H3>$_width</H3> (line <span class="linenumber">35</span>)<br />  
 <b>Data type:</b> mixed<br>Holds the width of the element  
 <br />  
   
 <UL>  
         </UL>  
 <HR>  
 <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='methodFEBoxElement'><!-- --></A>  
 <SPAN CLASS="font12bold">Constructor FEBoxElement</SPAN> (line <span class="linenumber">51</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">FEBoxElement(  
 label  
 $label, [bool  
 $required = TRUE], [int  
 $width = NULL], [int  
 $height = NULL])</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 The constructor  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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>  
                 <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>  
                 <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 pixels (px), percentage (%) or elements (em)</DD>  
                 <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">$height</SPAN></SPAN> required - element height in pixels (px), percentage (%) or elements (em)</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
         <div id="credit">  
                 <hr>  
                 Documention generated on Thu, 20 Feb 2003 16:22:41 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>  
         </div>  
 </body>  
 </html>  
39       --FEBoxElement</pre>
40            
41                            </div>
42    </div>
43    
44            <a name="sec-descendents"></a>
45            <div class="info-box">
46                    <div class="info-box-title">Direct descendents</div>
47                    <div class="nav-bar">
48                            <a href="#sec-description">Description</a> |
49                            <span class="disabled">Descendents</span>
50                            |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
51                                                                    |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
52                                                            
53                                                                    </div>
54                    <div class="info-box-body">
55                            <table cellpadding="2" cellspacing="0" class="class-table">
56                                    <tr>
57                                            <th class="class-table-header">Class</th>
58                                            <th class="class-table-header">Description</th>
59                                    </tr>
60                                                                    <tr>
61                                            <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEButton.html">FEButton</a></td>
62                                            <td>
63                                                                                            This is the button FormElement which builds a  input field of type=&quot;button&quot;. It has no validation method.
64                                                                                    </td>
65                                    </tr>
66                                                                    <tr>
67                                            <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></td>
68                                            <td>
69                                                                                            This is the DataList FormElement which builds a  a complex FEBoxElement. It has no validation method.
70                                                                                    </td>
71                                    </tr>
72                                                                    <tr>
73                                            <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDate.html">FEDate</a></td>
74                                            <td>
75                                                                                            This class builds a FEDataList that shows a group of select boxes  (FEYears, FEMonths, FEDays) representing a date.
76                                                                                    </td>
77                                    </tr>
78                                                                    <tr>
79                                            <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FETextArea.html">FETextArea</a></td>
80                                            <td>
81                                                                                            This is the TextArea FormElement which builds a  textarea field. It has no validation method.
82                                                                                    </td>
83                                    </tr>
84                                                            </table>
85                    </div>
86            </div>
87    
88    
89            <a name="sec-var-summary"></a>
90            <div class="info-box">
91                    <div class="info-box-title">Variable Summary</span></div>
92                    <div class="nav-bar">
93                            <a href="#sec-description">Description</a> |
94                                                            <a href="#sec-descendents">Descendents</a> |
95                                                    <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
96                                                            |
97                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
98                                                            
99                                                                    </div>
100                    <div class="info-box-body">
101                            <div class="var-summary">
102                                                                    <div class="var-title">
103                                            <span class="var-type">mixed</span>
104                                            <a href="#$_height" title="details" class="var-name">$_height</a>
105                                    </div>
106                                                                    <div class="var-title">
107                                            <span class="var-type">mixed</span>
108                                            <a href="#$_width" title="details" class="var-name">$_width</a>
109                                    </div>
110                                                            </div>
111                    </div>
112            </div>
113    
114            <a name="sec-method-summary"></a>
115            <div class="info-box">
116                    <div class="info-box-title">Method Summary</span></div>
117                    <div class="nav-bar">
118                            <a href="#sec-description">Description</a> |
119                                                            <a href="#sec-descendents">Descendents</a> |
120                                                                                                                                                    <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
121                                    
122                                    |
123                                                    <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
124                    </div>
125                    <div class="info-box-body">                    
126                            <div class="method-summary">
127                                                                    
128                                    <div class="method-definition">
129                                                                                            <span class="method-result">FEBoxElement</span>
130                                                                                    <a href="#FEBoxElement" title="details" class="method-name">FEBoxElement</a>
131                                                                                            (<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">$height</span> = <span class="var-default">NULL</span>])
132                                                                            </div>
133                                                            </div>
134                    </div>
135            </div>          
136    
137            <a name="sec-vars"></a>
138            <div class="info-box">
139                    <div class="info-box-title">Variables</div>
140                    <div class="nav-bar">
141                            <a href="#sec-description">Description</a> |
142                                                            <a href="#sec-descendents">Descendents</a> |
143                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
144                                                    
145                            
146                                                                                    |
147                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
148                                                            
149                                            </div>
150                    <div class="info-box-body">
151                            <a name="var$_height" id="$_height"><!-- --></A>
152    <div class="oddrow">
153    
154            <div class="var-header">
155                    <span class="var-title">
156                            <span class="var-type">mixed</span>
157                            <span class="var-name">$_height</span>
158                             = <span class="var-default"> NULL</span>                       (line <span class="line-number">41</span>)
159                    </span>
160            </div>
161    
162            <!-- ========== Info from phpDoc block ========= -->
163    <p class="short-description">Holds the height of the element</p>
164            
165            
166                    
167                    
168    
169    </div>
170    <a name="var$_width" id="$_width"><!-- --></A>
171    <div class="evenrow">
172    
173            <div class="var-header">
174                    <span class="var-title">
175                            <span class="var-type">mixed</span>
176                            <span class="var-name">$_width</span>
177                             = <span class="var-default"> NULL</span>                       (line <span class="line-number">35</span>)
178                    </span>
179            </div>
180    
181            <!-- ========== Info from phpDoc block ========= -->
182    <p class="short-description">Holds the width of the element</p>
183            
184            
185                    
186                    
187    
188    </div>
189                                                            <h4>Inherited Variables</h4>
190                                    <A NAME='inherited_vars'><!-- --></A>
191                                                                            <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
192                                            <blockquote>
193                                                                                                            <span class="var-title">
194                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
195                                                            </span>
196                                                                                                            <span class="var-title">
197                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
198                                                            </span>
199                                                                                                            <span class="var-title">
200                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
201                                                            </span>
202                                                                                                            <span class="var-title">
203                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
204                                                            </span>
205                                                                                                            <span class="var-title">
206                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
207                                                            </span>
208                                                                                                            <span class="var-title">
209                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
210                                                            </span>
211                                                                                                            <span class="var-title">
212                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</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$_required_field_marker">FormElement::$_required_field_marker</a></span><br>
225                                                            </span>
226                                                                                                            <span class="var-title">
227                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br>
228                                                            </span>
229                                                                                                            <span class="var-title">
230                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
231                                                            </span>
232                                                                                                            <span class="var-title">
233                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
234                                                            </span>
235                                                                                                            <span class="var-title">
236                                                                    <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
237                                                            </span>
238                                                                                            </blockquote>
239                                                                                    
240                    </div>
241            </div>
242            
243            <a name="sec-methods"></a>
244            <div class="info-box">
245                    <div class="info-box-title">Methods</div>
246                    <div class="nav-bar">
247                            <a href="#sec-description">Description</a> |
248                                                            <a href="#sec-descendents">Descendents</a> |
249                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
250                                                                                                                                            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
251                                                    
252                    </div>
253                    <div class="info-box-body">
254                            <A NAME='method_detail'></A>
255    <a name="methodFEBoxElement" id="FEBoxElement"><!-- --></a>
256    <div class="oddrow">
257            
258            <div class="method-header">
259                    <span class="method-title">Constructor FEBoxElement</span> (line <span class="line-number">51</span>)
260            </div>
261            
262            <!-- ========== Info from phpDoc block ========= -->
263    <p class="short-description">The constructor</p>
264            
265            <div class="method-signature">
266                    <span class="method-result">FEBoxElement</span>
267                    <span class="method-name">
268                            FEBoxElement
269                    </span>
270                                            (<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">$height</span> = <span class="var-default">NULL</span>])
271                            </div>
272            
273                            <ul class="parameters">
274                                            <li>
275                                    <span class="var-type">label</span>
276                                    <span class="var-name">$label</span><span class="var-description">: string - text label for the element</span>                  </li>
277                                            <li>
278                                    <span class="var-type">bool</span>
279                                    <span class="var-name">$required</span><span class="var-description">: required - is this a required element</span>                     </li>
280                                            <li>
281                                    <span class="var-type">int</span>
282                                    <span class="var-name">$width</span><span class="var-description">: required - element width in pixels (px), percentage (%) or elements (em)</span>                     </li>
283                                            <li>
284                                    <span class="var-type">int</span>
285                                    <span class="var-name">$height</span><span class="var-description">: required - element height in pixels (px), percentage (%) or elements (em)</span>                   </li>
286                                    </ul>
287                    
288                    
289            </div>
290                                                            <h4>Inherited Methods</h4>
291                                    <a name='inherited_methods'><!-- --></a>        
292                                                                            <!-- =========== Summary =========== -->
293                                            <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
294                                            <blockquote>
295                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
296                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
297                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br>
298                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
299                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br>
300                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
301                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
302                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
303                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
304                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
305                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
306                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
307                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
308                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br>
309                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br>
310                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
311                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
312                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
313                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
314                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
315                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
316                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
317                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
318                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
319                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
320                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
321                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
322                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br>
323                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
324                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br>
325                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
326                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
327                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
328                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
329                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br>
330                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br>
331                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br>
332                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
333                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
334                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br>
335                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
336                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
337                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
338                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
339                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
340                                                                                                            <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
341                                                                                            </blockquote>
342                                                                                    
343                    </div>
344            </div>
345    
346    
347            <p class="notes" id="credit">
348                    Documentation generated on Thu,  1 Apr 2004 09:38:17 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
349            </p>
350            </div></body>
351    </html>
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.3
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed