1 |
jonen |
1.1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
|
|
<!--NewPage--> |
3 |
|
|
<HTML> |
4 |
|
|
<HEAD> |
5 |
|
|
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:41 -0800' --> |
6 |
|
|
<TITLE>Docs For Class FEButton</TITLE> |
7 |
|
|
<LINK REL ='stylesheet' TYPE='text/css' HREF='../../media/stylesheet.css' TITLE='Style'> |
8 |
|
|
</HEAD> |
9 |
|
|
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
|
<!-- Links --> |
11 |
|
|
<a NAME="top"></A> |
12 |
|
|
<table WIDTH="100%" class="links"> |
13 |
|
|
<TR> |
14 |
|
|
<TD class="font10"> |
15 |
|
|
Links: |
16 |
|
|
<A HREF="#children_summary" class="links" title="Classes extended from FEButton">Child Classes</A> |
17 |
|
|
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
|
|
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
|
|
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
|
|
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
|
|
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
|
|
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
|
|
</TD> |
24 |
|
|
</TR> |
25 |
|
|
</TABLE> |
26 |
|
|
<BR> |
27 |
|
|
<!-- Start of Class Data --> |
28 |
|
|
<H2> |
29 |
|
|
Class FEButton |
30 |
|
|
</H2> (line <span class="linenumber">28</span>) |
31 |
|
|
<pre> |
32 |
|
|
<a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
33 |
|
|
| |
34 |
|
|
--<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a> |
35 |
|
|
| |
36 |
|
|
--FEButton</pre> |
37 |
|
|
<SPAN class="type">Classes extended from FEButton:</SPAN> |
38 |
|
|
<dl> |
39 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html">FESubmitButton</a></dt> |
40 |
|
|
<dd>This is the SubmitButton FormElement which builds a input field of type="submit". It has no validation method.</dd> |
41 |
|
|
</dl> |
42 |
|
|
</p> |
43 |
|
|
<p> |
44 |
|
|
<b><i>Located in File: Program_Root/form/form_elements/FEButton.inc</i></b><br> |
45 |
|
|
</p> |
46 |
|
|
<hr> |
47 |
|
|
This is the button FormElement which builds a input field of type="button". It has no validation method. |
48 |
|
|
<br /> |
49 |
|
|
|
50 |
|
|
<UL> |
51 |
|
|
<LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI> |
52 |
|
|
<LI><b>author</b> - <CODE>Suren Markossian <<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>></CODE></LI> |
53 |
|
|
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
54 |
|
|
</UL> |
55 |
|
|
<hr> |
56 |
|
|
<!-- =========== VAR SUMMARY =========== --> |
57 |
|
|
<A NAME='var_summary'><!-- --></A> |
58 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
59 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
60 |
|
|
<TD> |
61 |
|
|
<span CLASS="font12bold">Class Variable Summary</span> |
62 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
63 |
|
|
</TD> |
64 |
|
|
</TR> |
65 |
|
|
|
66 |
|
|
<!-- =========== Summary =========== --> |
67 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
68 |
|
|
<TD> |
69 |
|
|
<CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FEButton.html#var$_action">$_action</A></B></CODE> |
70 |
|
|
<BR> |
71 |
|
|
<blockquote> Holds the button action </blockquote> |
72 |
|
|
<blockquote> Default Value: <CODE>-> NULL<-</CODE> </blockquote> |
73 |
|
|
</TD> |
74 |
|
|
</TR> |
75 |
|
|
</TABLE> |
76 |
|
|
<hr> |
77 |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
78 |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
79 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
80 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
81 |
|
|
<TD> |
82 |
|
|
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
83 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
84 |
|
|
</TD> |
85 |
|
|
</TR> |
86 |
|
|
|
87 |
|
|
<!-- =========== Summary =========== --> |
88 |
|
|
<TR BGCOLOR='white'> |
89 |
|
|
<TD> |
90 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span> |
91 |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
92 |
|
|
<tr CLASS="tableheadingcolor"> |
93 |
|
|
<th>Variable</th> |
94 |
|
|
<th>Default Value</th> |
95 |
|
|
<th>Description</th> |
96 |
|
|
</tr> |
97 |
|
|
<tr> |
98 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></td> |
99 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
100 |
|
|
<td CLASS="font10">Holds the height of the element</td> |
101 |
|
|
</tr> |
102 |
|
|
<tr> |
103 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></td> |
104 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
105 |
|
|
<td CLASS="font10">Holds the width of the element</td> |
106 |
|
|
</tr> |
107 |
|
|
</table> |
108 |
|
|
<BR> |
109 |
|
|
</TD> |
110 |
|
|
</TR> |
111 |
|
|
<!-- =========== Summary =========== --> |
112 |
|
|
<TR BGCOLOR='white'> |
113 |
|
|
<TD> |
114 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span> |
115 |
|
|
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
116 |
|
|
<tr CLASS="tableheadingcolor"> |
117 |
|
|
<th>Variable</th> |
118 |
|
|
<th>Default Value</th> |
119 |
|
|
<th>Description</th> |
120 |
|
|
</tr> |
121 |
|
|
<tr> |
122 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td> |
123 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
124 |
|
|
<td CLASS="font10">Holds additional attributes for</td> |
125 |
|
|
</tr> |
126 |
|
|
<tr> |
127 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td> |
128 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
129 |
|
|
<td CLASS="font10">Holds the name of the element</td> |
130 |
|
|
</tr> |
131 |
|
|
<tr> |
132 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td> |
133 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
134 |
|
|
<td CLASS="font10">Holds the error message text</td> |
135 |
|
|
</tr> |
136 |
|
|
<tr> |
137 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td> |
138 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
139 |
|
|
<td CLASS="font10">Holds the state of the last validation</td> |
140 |
|
|
</tr> |
141 |
|
|
<tr> |
142 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td> |
143 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td> |
144 |
|
|
<td CLASS="font10">Indicates a disabled element</td> |
145 |
|
|
</tr> |
146 |
|
|
<tr> |
147 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td> |
148 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td> |
149 |
|
|
<td CLASS="font10">Indicates whether this elements</td> |
150 |
|
|
</tr> |
151 |
|
|
<tr> |
152 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td> |
153 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
154 |
|
|
<td CLASS="font10">Holds the elements label text</td> |
155 |
|
|
</tr> |
156 |
|
|
<tr> |
157 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td> |
158 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
159 |
|
|
<td CLASS="font10">Holds additional style attributes for</td> |
160 |
|
|
</tr> |
161 |
|
|
<tr> |
162 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td> |
163 |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td> |
164 |
|
|
<td CLASS="font10">Holds the elements initial value</td> |
165 |
|
|
</tr> |
166 |
|
|
</table> |
167 |
|
|
<BR> |
168 |
|
|
</TD> |
169 |
|
|
</TR> |
170 |
|
|
</TABLE> |
171 |
|
|
|
172 |
|
|
<hr> |
173 |
|
|
<!-- =========== METHOD SUMMARY =========== --> |
174 |
|
|
<A NAME='method_summary'><!-- --></A> |
175 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
176 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
177 |
|
|
<TD> |
178 |
|
|
<span class="font12bold">Method Summary</span> |
179 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
180 |
|
|
</TD> |
181 |
|
|
</TR> |
182 |
|
|
|
183 |
|
|
<!-- =========== Summary =========== --> |
184 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
185 |
|
|
<TD> |
186 |
|
|
<CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEButton.html#methodFEButton'>void constructor FEButton ( $label, $value, [$action = NULL], [$width = NULL], [$height = NULL] )</A></B></CODE> |
187 |
|
|
<BR> |
188 |
|
|
<blockquote> The constructor </blockquote> |
189 |
|
|
</TD> |
190 |
|
|
</TR> |
191 |
|
|
<!-- =========== Summary =========== --> |
192 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
193 |
|
|
<TD> |
194 |
|
|
<CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEButton.html#methodget_element'>object get_element ( )</A></B></CODE> |
195 |
|
|
<BR> |
196 |
|
|
<blockquote> This function builds and returns the form element object </blockquote> |
197 |
|
|
</TD> |
198 |
|
|
</TR> |
199 |
|
|
<!-- =========== Summary =========== --> |
200 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
201 |
|
|
<TD> |
202 |
|
|
<CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FEButton.html#methodonClick'>string onClick ( )</A></B></CODE> |
203 |
|
|
<BR> |
204 |
|
|
<blockquote> This function return the javaScript code for an onClick event </blockquote> |
205 |
|
|
</TD> |
206 |
|
|
</TR> |
207 |
|
|
</TABLE> |
208 |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
209 |
|
|
<A NAME='functions_inherited'><!-- --></A> |
210 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
211 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
212 |
|
|
<TD> |
213 |
|
|
<span CLASS="font12bold">Inherited Method Summary</span> |
214 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
215 |
|
|
</TD> |
216 |
|
|
</TR> |
217 |
|
|
|
218 |
|
|
<!-- =========== Summary =========== --> |
219 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
220 |
|
|
<TD> |
221 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span> |
222 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
223 |
|
|
<tr CLASS="tableheadingcolor"> |
224 |
|
|
<th>Function</th> |
225 |
|
|
<th>Description</th> |
226 |
|
|
</tr> |
227 |
|
|
<tr> |
228 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></td> |
229 |
|
|
<td CLASS="font10">The constructor</td> |
230 |
|
|
</table> |
231 |
|
|
<br> |
232 |
|
|
</TD> |
233 |
|
|
</TR> |
234 |
|
|
<!-- =========== Summary =========== --> |
235 |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
236 |
|
|
<TD> |
237 |
|
|
<span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span> |
238 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
239 |
|
|
<tr CLASS="tableheadingcolor"> |
240 |
|
|
<th>Function</th> |
241 |
|
|
<th>Description</th> |
242 |
|
|
</tr> |
243 |
|
|
<tr> |
244 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td> |
245 |
|
|
<td CLASS="font10">The constructor</td> |
246 |
|
|
<tr> |
247 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td> |
248 |
|
|
<td CLASS="font10">This function creates element name</td> |
249 |
|
|
<tr> |
250 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td> |
251 |
|
|
<td CLASS="font10">return a single attribute</td> |
252 |
|
|
<tr> |
253 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td> |
254 |
|
|
<td CLASS="font10">This function builds and returns the form element object</td> |
255 |
|
|
<tr> |
256 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td> |
257 |
|
|
<td CLASS="font10">Returns the element name to be used in the form</td> |
258 |
|
|
<tr> |
259 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td> |
260 |
|
|
<td CLASS="font10">Returns the current error message if any</td> |
261 |
|
|
<tr> |
262 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td> |
263 |
|
|
<td CLASS="font10">This returns the initial value of the element</td> |
264 |
|
|
<tr> |
265 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td> |
266 |
|
|
<td CLASS="font10">This function builds and returns a label object based on the label text and error conditions</td> |
267 |
|
|
<tr> |
268 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td> |
269 |
|
|
<td CLASS="font10">This function will return the elements label text</td> |
270 |
|
|
<tr> |
271 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td> |
272 |
|
|
<td CLASS="font10">This function return the symbol used to denote a required field</td> |
273 |
|
|
<tr> |
274 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td> |
275 |
|
|
<td CLASS="font10">This function will return the elements value</td> |
276 |
|
|
<tr> |
277 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td> |
278 |
|
|
<td CLASS="font10">This provides a method</td> |
279 |
|
|
<tr> |
280 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td> |
281 |
|
|
<td CLASS="font10">Returns the current error state</td> |
282 |
|
|
<tr> |
283 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td> |
284 |
|
|
<td CLASS="font10">Returns the elements disabled state</td> |
285 |
|
|
<tr> |
286 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td> |
287 |
|
|
<td CLASS="font10">Returns whether this elements final value cannot be empty</td> |
288 |
|
|
<tr> |
289 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td> |
290 |
|
|
<td CLASS="font10">This function return the javaScript code for an onBlur event</td> |
291 |
|
|
<tr> |
292 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td> |
293 |
|
|
<td CLASS="font10">This function return the javaScript code for an onClick event</td> |
294 |
|
|
<tr> |
295 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td> |
296 |
|
|
<td CLASS="font10">This function return the javaScript code for an onFocus event</td> |
297 |
|
|
<tr> |
298 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td> |
299 |
|
|
<td CLASS="font10">This function return the javaScript code for an onSubmit event</td> |
300 |
|
|
<tr> |
301 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td> |
302 |
|
|
<td CLASS="font10">add a single attribute (name="value")</td> |
303 |
|
|
<tr> |
304 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td> |
305 |
|
|
<td CLASS="font10">Sets the disabled element flag</td> |
306 |
|
|
<tr> |
307 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td> |
308 |
|
|
<td CLASS="font10">Defines error message text and sets the error flag to true</td> |
309 |
|
|
<tr> |
310 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td> |
311 |
|
|
<td CLASS="font10">This function will set the label for the element</td> |
312 |
|
|
<tr> |
313 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td> |
314 |
|
|
<td CLASS="font10">This function set the elements required state</td> |
315 |
|
|
<tr> |
316 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td> |
317 |
|
|
<td CLASS="font10">Sets elements css attribute</td> |
318 |
|
|
<tr> |
319 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td> |
320 |
|
|
<td CLASS="font10">Sets elements title text</td> |
321 |
|
|
<tr> |
322 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td> |
323 |
|
|
<td CLASS="font10">This function will set the initial value for the element</td> |
324 |
|
|
<tr> |
325 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td> |
326 |
|
|
<td CLASS="font10">This function performs the actual validation It is called only if the validation is required by this element</td> |
327 |
|
|
<tr> |
328 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td> |
329 |
|
|
<td CLASS="font10">This function builds the element form attributes</td> |
330 |
|
|
<tr> |
331 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td> |
332 |
|
|
<td CLASS="font10">This function builds the complete javaScript events code for the element</td> |
333 |
|
|
<tr> |
334 |
|
|
<td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td> |
335 |
|
|
<td CLASS="font10">This function checks if the validation</td> |
336 |
|
|
</table> |
337 |
|
|
<br> |
338 |
|
|
</TD> |
339 |
|
|
</TR> |
340 |
|
|
</TABLE> |
341 |
|
|
<hr> |
342 |
|
|
<!-- ============ VARIABLE DETAIL =========== --> |
343 |
|
|
|
344 |
|
|
<A NAME='variable_detail'></A> |
345 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
346 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
347 |
|
|
<TD> |
348 |
|
|
<span CLASS="font12bold">Variable Detail</span> |
349 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
350 |
|
|
</TD> |
351 |
|
|
</TR> |
352 |
|
|
</TABLE> |
353 |
|
|
|
354 |
|
|
<A NAME='var$_action'><!-- --></A><H3>$_action</H3> (line <span class="linenumber">35</span>)<br /> |
355 |
|
|
<b>Data type:</b> mixed<br>Holds the button action |
356 |
|
|
<br /> |
357 |
|
|
|
358 |
|
|
<UL> |
359 |
|
|
</UL> |
360 |
|
|
<HR> |
361 |
|
|
<hr> |
362 |
|
|
<!-- ============ METHOD DETAIL =========== --> |
363 |
|
|
|
364 |
|
|
<A NAME='method_detail'></A> |
365 |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
366 |
|
|
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
367 |
|
|
<TD> |
368 |
|
|
<span class="font12bold">Method Detail</span> |
369 |
|
|
<A HREF="#top" CLASS="links">^TOP</A> |
370 |
|
|
</TD> |
371 |
|
|
</TR> |
372 |
|
|
</TABLE> |
373 |
|
|
<BR> |
374 |
|
|
<DIV CLASS="function"> |
375 |
|
|
<A NAME='methodFEButton'><!-- --></A> |
376 |
|
|
<SPAN CLASS="font12bold">Constructor FEButton</SPAN> (line <span class="linenumber">46</span>) |
377 |
|
|
<BR> |
378 |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
379 |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
380 |
|
|
<span class="font10bold" style="color: #0000FF">FEButton( |
381 |
|
|
label |
382 |
|
|
$label, string |
383 |
|
|
$value, [string |
384 |
|
|
$action = NULL], [int |
385 |
|
|
$width = NULL], [int |
386 |
|
|
$height = NULL])</SPAN> |
387 |
|
|
<BR> |
388 |
|
|
|
389 |
|
|
<BR> |
390 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
391 |
|
|
The constructor |
392 |
|
|
<br /> |
393 |
|
|
|
394 |
|
|
<DL> |
395 |
|
|
<DT class="font10bold">Function Parameters:</DT> |
396 |
|
|
<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> |
397 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> value - button text</DD> |
398 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$action</SPAN></SPAN> action - action to perform</DD> |
399 |
|
|
<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> |
400 |
|
|
<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> |
401 |
|
|
|
402 |
|
|
<DT class="font10bold">Function Info:</DT> |
403 |
|
|
</DL> |
404 |
|
|
</DIV> |
405 |
|
|
<BR> |
406 |
|
|
<DIV CLASS="function"> |
407 |
|
|
<A NAME='methodget_element'><!-- --></A> |
408 |
|
|
<SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">75</span>) |
409 |
|
|
<BR> |
410 |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
411 |
|
|
<span class="font10bold" style="color: #FF0000">object</SPAN> |
412 |
|
|
<span class="font10bold" style="color: #0000FF">get_element( |
413 |
|
|
)</SPAN> |
414 |
|
|
<BR> |
415 |
|
|
<p>Overridden in child classes as:<br /> |
416 |
|
|
<dl> |
417 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodget_element">FESubmitButton::get_element()</a></dt> |
418 |
|
|
<dd>This function builds and returns the form element object</dd> |
419 |
|
|
</dl> |
420 |
|
|
</p> |
421 |
|
|
|
422 |
|
|
<BR> |
423 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
424 |
|
|
This function builds and returns the form element object |
425 |
|
|
<br /> |
426 |
|
|
|
427 |
|
|
<DL> |
428 |
|
|
|
429 |
|
|
<DT class="font10bold">Function Info:</DT> |
430 |
|
|
</DL> |
431 |
|
|
</DIV> |
432 |
|
|
<BR> |
433 |
|
|
<DIV CLASS="function"> |
434 |
|
|
<A NAME='methodonClick'><!-- --></A> |
435 |
|
|
<SPAN CLASS="font12bold">onClick</SPAN> (line <span class="linenumber">60</span>) |
436 |
|
|
<BR> |
437 |
|
|
<SPAN CLASS="font10bold">Usage : </SPAN> |
438 |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
439 |
|
|
<span class="font10bold" style="color: #0000FF">onClick( |
440 |
|
|
)</SPAN> |
441 |
|
|
<BR> |
442 |
|
|
<p>Overridden in child classes as:<br /> |
443 |
|
|
<dl> |
444 |
|
|
<dt><a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodonClick">FESubmitButton::onClick()</a></dt> |
445 |
|
|
<dd>This function return the javaScript code for an onSubmit event</dd> |
446 |
|
|
</dl> |
447 |
|
|
</p> |
448 |
|
|
|
449 |
|
|
<BR> |
450 |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
451 |
|
|
This function return the javaScript code for an onClick event |
452 |
|
|
<br /> |
453 |
|
|
|
454 |
|
|
<DL> |
455 |
|
|
|
456 |
|
|
<DT class="font10bold">Function Info:</DT> |
457 |
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - javascript code</DD> |
458 |
|
|
</DL> |
459 |
|
|
</DIV> |
460 |
|
|
<BR> |
461 |
|
|
<div id="credit"> |
462 |
|
|
<hr> |
463 |
|
|
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> |
464 |
|
|
</div> |
465 |
|
|
</body> |
466 |
|
|
</html> |