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:43 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class FEDataList</TITLE> |
<title>Docs For Class FEDataList</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 FEDataList</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 FEDataList">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 DataList FormElement which builds a a complex FEBoxElement. It has no validation method.</p> |
27 |
<!-- Start of Class Data --> |
<ul class="tags"> |
28 |
<H2> |
<li><span class="field">copyright:</span> LGPL - See LICENCE</li> |
29 |
Class FEDataList |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
30 |
</H2> (line <span class="linenumber">28</span>) |
<li><span class="field">author:</span> Suren Markossian <<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>></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_FEDataList_inc.html">/form/form_elements/FEDataList.inc</a> (line <span class="field">28</span>) |
34 |
|
</p> |
35 |
|
|
36 |
|
|
37 |
|
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
38 |
| |
| |
39 |
--<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a> |
--<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a> |
40 |
| |
| |
|
--FEDataList</pre> |
|
|
<SPAN class="type">Classes extended from FEDataList:</SPAN> |
|
|
<dl> |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a></dt> |
|
|
<dd>This is the ListBox FormElement which builds a select field with all of its options.</dd> |
|
|
</dl> |
|
|
</p> |
|
|
<p> |
|
|
<b><i>Located in File: Program_Root/form/form_elements/FEDataList.inc</i></b><br> |
|
|
</p> |
|
|
<hr> |
|
|
This is the DataList FormElement which builds a a complex FEBoxElement. It has no validation method. |
|
|
<br /> |
|
|
|
|
|
<UL> |
|
|
<LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI> |
|
|
<LI><b>author</b> - <CODE>Suren Markossian <<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>></CODE></LI> |
|
|
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></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/FEDataList.html#var$_data_list">$_data_list</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds the list of available </blockquote> |
|
|
<blockquote> Default Value: <CODE>->array()<-</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/FEBoxElement.html">FEBoxElement</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the height of the element</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the width of the element</td> |
|
|
</tr> |
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span> |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Variable</th> |
|
|
<th>Default Value</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
|
|
<td CLASS="font10">Holds additional attributes for</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the name of the element</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the error message text</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
|
|
<td CLASS="font10">Holds the state of the last validation</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
|
|
<td CLASS="font10">Indicates a disabled element</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td> |
|
|
<td CLASS="font10">Indicates whether this elements</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the elements label text</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
|
|
<td CLASS="font10">Holds additional style attributes for</td> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
|
|
<td CLASS="font10">Holds the elements initial value</td> |
|
|
</tr> |
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- =========== METHOD SUMMARY =========== --> |
|
|
<A NAME='method_summary'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span class="font12bold">Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEDataList.html#methodFEDataList'>void constructor FEDataList ( $label, [$required = TRUE], [$width = NULL], [$height = NULL], [$data_list = array()] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> The constructor </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEDataList.html#methodget_value_text'>string get_value_text ( $value )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This provides a method </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEDataList.html#methodvalidate'>void validate ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is responsible for performing complete </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
|
|
<A NAME='functions_inherited'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></td> |
|
|
<td CLASS="font10">The constructor</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
|
|
<tr CLASS="tableheadingcolor"> |
|
|
<th>Function</th> |
|
|
<th>Description</th> |
|
|
</tr> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td> |
|
|
<td CLASS="font10">The constructor</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td> |
|
|
<td CLASS="font10">This function creates element name</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td> |
|
|
<td CLASS="font10">return a single attribute</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td> |
|
|
<td CLASS="font10">This function builds and returns the form element object</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td> |
|
|
<td CLASS="font10">Returns the element name to be used in the form</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td> |
|
|
<td CLASS="font10">Returns the current error message if any</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td> |
|
|
<td CLASS="font10">This returns the initial value of the element</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td> |
|
|
<td CLASS="font10">This function builds and returns a label object based on the label text and error conditions</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td> |
|
|
<td CLASS="font10">This function will return the elements label text</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td> |
|
|
<td CLASS="font10">This function return the symbol used to denote a required field</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td> |
|
|
<td CLASS="font10">This function will return the elements value</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td> |
|
|
<td CLASS="font10">This provides a method</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td> |
|
|
<td CLASS="font10">Returns the current error state</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td> |
|
|
<td CLASS="font10">Returns the elements disabled state</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td> |
|
|
<td CLASS="font10">Returns whether this elements final value cannot be empty</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td> |
|
|
<td CLASS="font10">This function return the javaScript code for an onBlur event</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td> |
|
|
<td CLASS="font10">This function return the javaScript code for an onClick event</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td> |
|
|
<td CLASS="font10">This function return the javaScript code for an onFocus event</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td> |
|
|
<td CLASS="font10">This function return the javaScript code for an onSubmit event</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td> |
|
|
<td CLASS="font10">add a single attribute (name="value")</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td> |
|
|
<td CLASS="font10">Sets the disabled element flag</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td> |
|
|
<td CLASS="font10">Defines error message text and sets the error flag to true</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td> |
|
|
<td CLASS="font10">This function will set the label for the element</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td> |
|
|
<td CLASS="font10">This function set the elements required state</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td> |
|
|
<td CLASS="font10">Sets elements css attribute</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td> |
|
|
<td CLASS="font10">Sets elements title text</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td> |
|
|
<td CLASS="font10">This function will set the initial value for the element</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td> |
|
|
<td CLASS="font10">This function performs the actual validation It is called only if the validation is required by this element</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td> |
|
|
<td CLASS="font10">This function builds the element form attributes</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td> |
|
|
<td CLASS="font10">This function builds the complete javaScript events code for the element</td> |
|
|
<tr> |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td> |
|
|
<td CLASS="font10">This function checks if the validation</td> |
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
<hr> |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
|
|
|
|
|
<A NAME='variable_detail'></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
|
|
<TD> |
|
|
<span CLASS="font12bold">Variable Detail</span> |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
|
|
</TD> |
|
|
</TR> |
|
|
</TABLE> |
|
|
|
|
|
<A NAME='var$_data_list'><!-- --></A><H3>$_data_list</H3> (line <span class="linenumber">35</span>)<br /> |
|
|
<b>Data type:</b> mixed<br>Holds the list of available |
|
|
<br /> |
|
|
<p>data elements</p> |
|
|
<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='methodFEDataList'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">Constructor FEDataList</SPAN> (line <span class="linenumber">45</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">FEDataList( |
|
|
label |
|
|
$label, [bool |
|
|
$required = TRUE], [array |
|
|
$width = NULL], [int |
|
|
$height = NULL], [mixed |
|
|
$data_list = array()])</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;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> data_list - list of data elements (name=>value)</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 width in characters, pixels (px), percentage (%) or elements (em)</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodget_value_text'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_value_text</SPAN> (line <span class="linenumber">64</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_value_text( |
|
|
mixed |
|
|
$value)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This provides a method |
|
|
<br /> |
|
|
<p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p> |
|
|
<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;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> - the value to look up</DD> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the text associated</DD> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<DIV CLASS="function"> |
|
|
<A NAME='methodvalidate'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">validate</SPAN> (line <span class="linenumber">76</span>) |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">validate( |
|
|
)</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
This function is responsible for performing complete |
|
|
<br /> |
|
|
<p>validation and setting the appropriate error message in case of a failed validation</p> |
|
|
<DL> |
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
</DL> |
|
|
</DIV> |
|
|
<BR> |
|
|
<div id="credit"> |
|
|
<hr> |
|
|
Documention generated on Thu, 20 Feb 2003 16:22:43 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
|
|
</div> |
|
|
</body> |
|
|
</html> |
|
41 |
|
--FEDataList</pre> |
42 |
|
|
43 |
|
</div> |
44 |
|
</div> |
45 |
|
|
46 |
|
<a name="sec-descendents"></a> |
47 |
|
<div class="info-box"> |
48 |
|
<div class="info-box-title">Direct descendents</div> |
49 |
|
<div class="nav-bar"> |
50 |
|
<a href="#sec-description">Description</a> | |
51 |
|
<span class="disabled">Descendents</span> |
52 |
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
53 |
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
54 |
|
|
55 |
|
</div> |
56 |
|
<div class="info-box-body"> |
57 |
|
<table cellpadding="2" cellspacing="0" class="class-table"> |
58 |
|
<tr> |
59 |
|
<th class="class-table-header">Class</th> |
60 |
|
<th class="class-table-header">Description</th> |
61 |
|
</tr> |
62 |
|
<tr> |
63 |
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEListBox.html">FEListBox</a></td> |
64 |
|
<td> |
65 |
|
This is the ListBox FormElement which builds a select field with all of its options. |
66 |
|
</td> |
67 |
|
</tr> |
68 |
|
<tr> |
69 |
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FENestedListBox.html">FENestedListBox</a></td> |
70 |
|
<td> |
71 |
|
This class builds a nested select box that is used to select an entry from nested levels. |
72 |
|
</td> |
73 |
|
</tr> |
74 |
|
<tr> |
75 |
|
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html">FEComboListBox</a></td> |
76 |
|
<td> |
77 |
|
This builds a complex dual select box with buttons to move entries from one select box to another. |
78 |
|
</td> |
79 |
|
</tr> |
80 |
|
</table> |
81 |
|
</div> |
82 |
|
</div> |
83 |
|
|
84 |
|
|
85 |
|
<a name="sec-var-summary"></a> |
86 |
|
<div class="info-box"> |
87 |
|
<div class="info-box-title">Variable Summary</span></div> |
88 |
|
<div class="nav-bar"> |
89 |
|
<a href="#sec-description">Description</a> | |
90 |
|
<a href="#sec-descendents">Descendents</a> | |
91 |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
92 |
|
| |
93 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
94 |
|
|
95 |
|
</div> |
96 |
|
<div class="info-box-body"> |
97 |
|
<div class="var-summary"> |
98 |
|
<div class="var-title"> |
99 |
|
<span class="var-type">mixed</span> |
100 |
|
<a href="#$_data_list" title="details" class="var-name">$_data_list</a> |
101 |
|
</div> |
102 |
|
<div class="var-title"> |
103 |
|
<span class="var-type">mixed</span> |
104 |
|
<a href="#$_disabled_items" title="details" class="var-name">$_disabled_items</a> |
105 |
|
</div> |
106 |
|
</div> |
107 |
|
</div> |
108 |
|
</div> |
109 |
|
|
110 |
|
<a name="sec-method-summary"></a> |
111 |
|
<div class="info-box"> |
112 |
|
<div class="info-box-title">Method Summary</span></div> |
113 |
|
<div class="nav-bar"> |
114 |
|
<a href="#sec-description">Description</a> | |
115 |
|
<a href="#sec-descendents">Descendents</a> | |
116 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
117 |
|
|
118 |
|
| |
119 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
120 |
|
</div> |
121 |
|
<div class="info-box-body"> |
122 |
|
<div class="method-summary"> |
123 |
|
|
124 |
|
<div class="method-definition"> |
125 |
|
<span class="method-result">FEDataList</span> |
126 |
|
<a href="#FEDataList" title="details" class="method-name">FEDataList</a> |
127 |
|
(<span class="var-type">string</span> <span class="var-name">$label</span>, [<span class="var-type">boolean</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$data_list</span> = <span class="var-default">array()</span>]) |
128 |
|
</div> |
129 |
|
|
130 |
|
<div class="method-definition"> |
131 |
|
<span class="method-result">none</span> |
132 |
|
<a href="#disable_item" title="details" class="method-name">disable_item</a> |
133 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
134 |
|
</div> |
135 |
|
|
136 |
|
<div class="method-definition"> |
137 |
|
<span class="method-result">string</span> |
138 |
|
<a href="#get_value_text" title="details" class="method-name">get_value_text</a> |
139 |
|
() |
140 |
|
</div> |
141 |
|
|
142 |
|
<div class="method-definition"> |
143 |
|
<span class="method-result">void</span> |
144 |
|
<a href="#set_list_data" title="details" class="method-name">set_list_data</a> |
145 |
|
([<span class="var-type">array</span> <span class="var-name">$data_list</span> = <span class="var-default">array()</span>]) |
146 |
|
</div> |
147 |
|
|
148 |
|
<div class="method-definition"> |
149 |
|
<span class="method-result">void</span> |
150 |
|
<a href="#validate" title="details" class="method-name">validate</a> |
151 |
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
152 |
|
</div> |
153 |
|
</div> |
154 |
|
</div> |
155 |
|
</div> |
156 |
|
|
157 |
|
<a name="sec-vars"></a> |
158 |
|
<div class="info-box"> |
159 |
|
<div class="info-box-title">Variables</div> |
160 |
|
<div class="nav-bar"> |
161 |
|
<a href="#sec-description">Description</a> | |
162 |
|
<a href="#sec-descendents">Descendents</a> | |
163 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
164 |
|
|
165 |
|
|
166 |
|
| |
167 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
168 |
|
|
169 |
|
</div> |
170 |
|
<div class="info-box-body"> |
171 |
|
<a name="var$_data_list" id="$_data_list"><!-- --></A> |
172 |
|
<div class="oddrow"> |
173 |
|
|
174 |
|
<div class="var-header"> |
175 |
|
<span class="var-title"> |
176 |
|
<span class="var-type">mixed</span> |
177 |
|
<span class="var-name">$_data_list</span> |
178 |
|
= <span class="var-default">array()</span> (line <span class="line-number">35</span>) |
179 |
|
</span> |
180 |
|
</div> |
181 |
|
|
182 |
|
<!-- ========== Info from phpDoc block ========= --> |
183 |
|
<p class="short-description">Holds the list of available</p> |
184 |
|
<p class="description"><p>data elements</p></p> |
185 |
|
|
186 |
|
|
187 |
|
|
188 |
|
|
189 |
|
|
190 |
|
</div> |
191 |
|
<a name="var$_disabled_items" id="$_disabled_items"><!-- --></A> |
192 |
|
<div class="evenrow"> |
193 |
|
|
194 |
|
<div class="var-header"> |
195 |
|
<span class="var-title"> |
196 |
|
<span class="var-type">mixed</span> |
197 |
|
<span class="var-name">$_disabled_items</span> |
198 |
|
= <span class="var-default">array()</span> (line <span class="line-number">41</span>) |
199 |
|
</span> |
200 |
|
</div> |
201 |
|
|
202 |
|
<!-- ========== Info from phpDoc block ========= --> |
203 |
|
<p class="short-description">The list of disabled items</p> |
204 |
|
<p class="description"><p>(if any)</p></p> |
205 |
|
|
206 |
|
|
207 |
|
|
208 |
|
|
209 |
|
|
210 |
|
</div> |
211 |
|
<h4>Inherited Variables</h4> |
212 |
|
<A NAME='inherited_vars'><!-- --></A> |
213 |
|
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
214 |
|
<blockquote> |
215 |
|
<span class="var-title"> |
216 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br> |
217 |
|
</span> |
218 |
|
<span class="var-title"> |
219 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br> |
220 |
|
</span> |
221 |
|
</blockquote> |
222 |
|
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
223 |
|
<blockquote> |
224 |
|
<span class="var-title"> |
225 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
226 |
|
</span> |
227 |
|
<span class="var-title"> |
228 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
229 |
|
</span> |
230 |
|
<span class="var-title"> |
231 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
232 |
|
</span> |
233 |
|
<span class="var-title"> |
234 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
235 |
|
</span> |
236 |
|
<span class="var-title"> |
237 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
238 |
|
</span> |
239 |
|
<span class="var-title"> |
240 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
241 |
|
</span> |
242 |
|
<span class="var-title"> |
243 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br> |
244 |
|
</span> |
245 |
|
<span class="var-title"> |
246 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
247 |
|
</span> |
248 |
|
<span class="var-title"> |
249 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
250 |
|
</span> |
251 |
|
<span class="var-title"> |
252 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
253 |
|
</span> |
254 |
|
<span class="var-title"> |
255 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br> |
256 |
|
</span> |
257 |
|
<span class="var-title"> |
258 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br> |
259 |
|
</span> |
260 |
|
<span class="var-title"> |
261 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
262 |
|
</span> |
263 |
|
<span class="var-title"> |
264 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
265 |
|
</span> |
266 |
|
<span class="var-title"> |
267 |
|
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
268 |
|
</span> |
269 |
|
</blockquote> |
270 |
|
|
271 |
|
</div> |
272 |
|
</div> |
273 |
|
|
274 |
|
<a name="sec-methods"></a> |
275 |
|
<div class="info-box"> |
276 |
|
<div class="info-box-title">Methods</div> |
277 |
|
<div class="nav-bar"> |
278 |
|
<a href="#sec-description">Description</a> | |
279 |
|
<a href="#sec-descendents">Descendents</a> | |
280 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
281 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
282 |
|
|
283 |
|
</div> |
284 |
|
<div class="info-box-body"> |
285 |
|
<A NAME='method_detail'></A> |
286 |
|
<a name="methodFEDataList" id="FEDataList"><!-- --></a> |
287 |
|
<div class="oddrow"> |
288 |
|
|
289 |
|
<div class="method-header"> |
290 |
|
<span class="method-title">Constructor FEDataList</span> (line <span class="line-number">52</span>) |
291 |
|
</div> |
292 |
|
|
293 |
|
<!-- ========== Info from phpDoc block ========= --> |
294 |
|
<p class="short-description">The constructor</p> |
295 |
|
|
296 |
|
<div class="method-signature"> |
297 |
|
<span class="method-result">FEDataList</span> |
298 |
|
<span class="method-name"> |
299 |
|
FEDataList |
300 |
|
</span> |
301 |
|
(<span class="var-type">string</span> <span class="var-name">$label</span>, [<span class="var-type">boolean</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">NULL</span>], [<span class="var-type">array</span> <span class="var-name">$data_list</span> = <span class="var-default">array()</span>]) |
302 |
|
</div> |
303 |
|
|
304 |
|
<ul class="parameters"> |
305 |
|
<li> |
306 |
|
<span class="var-type">string</span> |
307 |
|
<span class="var-name">$label</span><span class="var-description">: text label for the element</span> </li> |
308 |
|
<li> |
309 |
|
<span class="var-type">boolean</span> |
310 |
|
<span class="var-name">$required</span><span class="var-description">: is this a required element?</span> </li> |
311 |
|
<li> |
312 |
|
<span class="var-type">int</span> |
313 |
|
<span class="var-name">$width</span><span class="var-description">: element width in characters, pixels (px), percentage (%) or elements (em)</span> </li> |
314 |
|
<li> |
315 |
|
<span class="var-type">int</span> |
316 |
|
<span class="var-name">$height</span><span class="var-description">: element height in px</span> </li> |
317 |
|
<li> |
318 |
|
<span class="var-type">array</span> |
319 |
|
<span class="var-name">$data_list</span><span class="var-description">: data_list - list of data elements (name=>value)</span> </li> |
320 |
|
</ul> |
321 |
|
|
322 |
|
|
323 |
|
</div> |
324 |
|
<a name="methoddisable_item" id="disable_item"><!-- --></a> |
325 |
|
<div class="evenrow"> |
326 |
|
|
327 |
|
<div class="method-header"> |
328 |
|
<span class="method-title">disable_item</span> (line <span class="line-number">124</span>) |
329 |
|
</div> |
330 |
|
|
331 |
|
<!-- ========== Info from phpDoc block ========= --> |
332 |
|
<p class="short-description">This method allows you to disable one of the items in the list of checkboxes.</p> |
333 |
|
|
334 |
|
<div class="method-signature"> |
335 |
|
<span class="method-result">none</span> |
336 |
|
<span class="method-name"> |
337 |
|
disable_item |
338 |
|
</span> |
339 |
|
(<span class="var-type">string</span> <span class="var-name">$name</span>) |
340 |
|
</div> |
341 |
|
|
342 |
|
<ul class="parameters"> |
343 |
|
<li> |
344 |
|
<span class="var-type">string</span> |
345 |
|
<span class="var-name">$name</span><span class="var-description">: the name of the checkbox to disable</span> </li> |
346 |
|
</ul> |
347 |
|
|
348 |
|
|
349 |
|
</div> |
350 |
|
<a name="methodget_value_text" id="get_value_text"><!-- --></a> |
351 |
|
<div class="oddrow"> |
352 |
|
|
353 |
|
<div class="method-header"> |
354 |
|
<span class="method-title">get_value_text</span> (line <span class="line-number">80</span>) |
355 |
|
</div> |
356 |
|
|
357 |
|
<!-- ========== Info from phpDoc block ========= --> |
358 |
|
<p class="short-description">This provides a method</p> |
359 |
|
<p class="description"><p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p></p> |
360 |
|
<ul class="tags"> |
361 |
|
<li><span class="field">return:</span> - the text associated</li> |
362 |
|
</ul> |
363 |
|
|
364 |
|
<div class="method-signature"> |
365 |
|
<span class="method-result">string</span> |
366 |
|
<span class="method-name"> |
367 |
|
get_value_text |
368 |
|
</span> |
369 |
|
() |
370 |
|
</div> |
371 |
|
|
372 |
|
|
373 |
|
<hr class="separator" /> |
374 |
|
<div class="notes">Redefinition of:</div> |
375 |
|
<dl> |
376 |
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt> |
377 |
|
<dd>This provides a method</dd> |
378 |
|
</dl> |
379 |
|
|
380 |
|
<hr class="separator" /> |
381 |
|
<div class="notes">Redefined in descendants as:</div> |
382 |
|
<ul class="redefinitions"> |
383 |
|
<li> |
384 |
|
<a href="../../phpHtmlLib/FormProcessing/FEMultiListBox.html#methodget_value_text">FEMultiListBox::get_value_text()</a> |
385 |
|
: build the string for the confirmation page |
386 |
|
</li> |
387 |
|
<li> |
388 |
|
<a href="../../phpHtmlLib/FormProcessing/FENestedListBox.html#methodget_value_text">FENestedListBox::get_value_text()</a> |
389 |
|
: This provides a method |
390 |
|
</li> |
391 |
|
<li> |
392 |
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodget_value_text">FEComboListBox::get_value_text()</a> |
393 |
|
: This provides a method |
394 |
|
</li> |
395 |
|
</ul> |
396 |
|
</div> |
397 |
|
<a name="methodset_list_data" id="set_list_data"><!-- --></a> |
398 |
|
<div class="evenrow"> |
399 |
|
|
400 |
|
<div class="method-header"> |
401 |
|
<span class="method-title">set_list_data</span> (line <span class="line-number">63</span>) |
402 |
|
</div> |
403 |
|
|
404 |
|
<!-- ========== Info from phpDoc block ========= --> |
405 |
|
<p class="short-description">This function sets the array of data to be used in the data list</p> |
406 |
|
|
407 |
|
<div class="method-signature"> |
408 |
|
<span class="method-result">void</span> |
409 |
|
<span class="method-name"> |
410 |
|
set_list_data |
411 |
|
</span> |
412 |
|
([<span class="var-type">array</span> <span class="var-name">$data_list</span> = <span class="var-default">array()</span>]) |
413 |
|
</div> |
414 |
|
|
415 |
|
<ul class="parameters"> |
416 |
|
<li> |
417 |
|
<span class="var-type">array</span> |
418 |
|
<span class="var-name">$data_list</span><span class="var-description">: data_list - list of data elements (name=>value)</span> </li> |
419 |
|
</ul> |
420 |
|
|
421 |
|
|
422 |
|
<hr class="separator" /> |
423 |
|
<div class="notes">Redefined in descendants as:</div> |
424 |
|
<ul class="redefinitions"> |
425 |
|
<li> |
426 |
|
<a href="../../phpHtmlLib/FormProcessing/FEListBoxMaster.html#methodset_list_data">FEListBoxMaster::set_list_data()</a> |
427 |
|
: This function sets the array of data to be used in the data list |
428 |
|
</li> |
429 |
|
</ul> |
430 |
|
</div> |
431 |
|
<a name="methodvalidate" id="validate"><!-- --></a> |
432 |
|
<div class="oddrow"> |
433 |
|
|
434 |
|
<div class="method-header"> |
435 |
|
<span class="method-title">validate</span> (line <span class="line-number">98</span>) |
436 |
|
</div> |
437 |
|
|
438 |
|
<!-- ========== Info from phpDoc block ========= --> |
439 |
|
<p class="short-description">This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p> |
440 |
|
|
441 |
|
<div class="method-signature"> |
442 |
|
<span class="method-result">void</span> |
443 |
|
<span class="method-name"> |
444 |
|
validate |
445 |
|
</span> |
446 |
|
(<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> <span class="var-name">&$_FormValidation</span>) |
447 |
|
</div> |
448 |
|
|
449 |
|
<ul class="parameters"> |
450 |
|
<li> |
451 |
|
<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span> |
452 |
|
<span class="var-name">&$_FormValidation</span><span class="var-description">: object</span> </li> |
453 |
|
</ul> |
454 |
|
|
455 |
|
<hr class="separator" /> |
456 |
|
<div class="notes">Redefinition of:</div> |
457 |
|
<dl> |
458 |
|
<dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt> |
459 |
|
<dd>This function performs the actual validation It is called only if the validation is required by this element</dd> |
460 |
|
</dl> |
461 |
|
|
462 |
|
<hr class="separator" /> |
463 |
|
<div class="notes">Redefined in descendants as:</div> |
464 |
|
<ul class="redefinitions"> |
465 |
|
<li> |
466 |
|
<a href="../../phpHtmlLib/FormProcessing/FENestedListBox.html#methodvalidate">FENestedListBox::validate()</a> |
467 |
|
: This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation |
468 |
|
</li> |
469 |
|
<li> |
470 |
|
<a href="../../phpHtmlLib/FormProcessing/FEComboListBox.html#methodvalidate">FEComboListBox::validate()</a> |
471 |
|
: This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation |
472 |
|
</li> |
473 |
|
</ul> |
474 |
|
</div> |
475 |
|
<h4>Inherited Methods</h4> |
476 |
|
<a name='inherited_methods'><!-- --></a> |
477 |
|
<!-- =========== Summary =========== --> |
478 |
|
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p> |
479 |
|
<blockquote> |
480 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br> |
481 |
|
</blockquote> |
482 |
|
<!-- =========== Summary =========== --> |
483 |
|
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
484 |
|
<blockquote> |
485 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
486 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
487 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br> |
488 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
489 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br> |
490 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
491 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
492 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
493 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
494 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
495 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
496 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
497 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
498 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br> |
499 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br> |
500 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
501 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
502 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
503 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
504 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
505 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
506 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
507 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
508 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
509 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
510 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
511 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
512 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br> |
513 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
514 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br> |
515 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
516 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
517 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
518 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
519 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br> |
520 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br> |
521 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br> |
522 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
523 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
524 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br> |
525 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
526 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
527 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
528 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
529 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
530 |
|
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
531 |
|
</blockquote> |
532 |
|
|
533 |
|
</div> |
534 |
|
</div> |
535 |
|
|
536 |
|
|
537 |
|
<p class="notes" id="credit"> |
538 |
|
Documentation generated on Thu, 1 Apr 2004 09:38:22 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
539 |
|
</p> |
540 |
|
</div></body> |
541 |
|
</html> |