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

Annotation of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FormElement.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 21:05:35 2003 UTC (21 years, 10 months ago) by jonen
Branch: MAIN
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
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:52 -0800' -->
6     <TITLE>Docs For Class FormElement</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 FormElement">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 FormElement
30     </H2> (line <span class="linenumber">39</span>)
31     <pre>
32     </pre>
33     <SPAN class="type">Classes extended from FormElement:</SPAN>
34     <dl>
35     <dt><a href="../../phpHtmlLib/FormProcessing/FEHidden.html">FEHidden</a></dt>
36     <dd>This is the Hidden FormElement which builds a input field of type="hidden". It has no validation method.</dd>
37     </dl>
38     <dl>
39     <dt><a href="../../phpHtmlLib/FormProcessing/FEError.html">FEError</a></dt>
40     <dd>This is a way of providing an Error to the FormProcessor.</dd>
41     </dl>
42     <dl>
43     <dt><a href="../../phpHtmlLib/FormProcessing/FEText.html">FEText</a></dt>
44     <dd>This is the Text FormElement which builds a text input field. It has no validation method.</dd>
45     </dl>
46     <dl>
47     <dt><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></dt>
48     <dd>This is the Box FormElement which builds a DIV with a width and a height. It is a base class for more complicated FormElements.</dd>
49     </dl>
50     <dl>
51     <dt><a href="../../phpHtmlLib/FormProcessing/FECheckBox.html">FECheckBox</a></dt>
52     <dd>This is the CheckBox FormElement which builds a input field of type="checkbox". It has no validation method.</dd>
53     </dl>
54     <dl>
55     <dt><a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html">FERadioGroup</a></dt>
56     <dd>This is the Radio Button Group FormElement which builds a List of Radio buttons that can be used in any style of layout.</dd>
57     </dl>
58     </p>
59     <p>
60     <b><i>Located in File: Program_Root/form/FormElement.inc</i></b><br>
61     </p>
62     <hr>
63     This is the base FormElement object. It can be single form field such as a text input field, or a complex object.
64     <br />
65     <p>Usefull Functions</p><p>get_value() - This gets the current 'value' of the FormElement. NOTE: This can be a 'complex' FormElement in which it may return an array of values.</p><p>set_value() - Set the current value for this FormElement.</p><p>get_label() - returns the label for this FormElement.</p>
66     <UL>
67     </UL>
68     <hr>
69     <!-- =========== VAR SUMMARY =========== -->
70     <A NAME='var_summary'><!-- --></A>
71     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
72     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
73     <TD>
74     <span CLASS="font12bold">Class Variable Summary</span>
75     <A HREF="#top" CLASS="links">^TOP</A>
76     </TD>
77     </TR>
78    
79     <!-- =========== Summary =========== -->
80     <TR BGCOLOR='white' CLASS='TableRowColor'>
81     <TD>
82     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">$_attributes</A></B></CODE>
83     <BR>
84     <blockquote> Holds additional attributes for </blockquote>
85     <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
86     </TD>
87     </TR>
88     <!-- =========== Summary =========== -->
89     <TR BGCOLOR='white' CLASS='TableRowColor'>
90     <TD>
91     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">$_element_name</A></B></CODE>
92     <BR>
93     <blockquote> Holds the name of the element </blockquote>
94     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
95     </TD>
96     </TR>
97     <!-- =========== Summary =========== -->
98     <TR BGCOLOR='white' CLASS='TableRowColor'>
99     <TD>
100     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">$_error_message</A></B></CODE>
101     <BR>
102     <blockquote> Holds the error message text </blockquote>
103     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
104     </TD>
105     </TR>
106     <!-- =========== Summary =========== -->
107     <TR BGCOLOR='white' CLASS='TableRowColor'>
108     <TD>
109     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">$_has_error</A></B></CODE>
110     <BR>
111     <blockquote> Holds the state of the last validation </blockquote>
112     <blockquote> Default Value: <CODE>->&nbsp;FALSE<-</CODE> </blockquote>
113     </TD>
114     </TR>
115     <!-- =========== Summary =========== -->
116     <TR BGCOLOR='white' CLASS='TableRowColor'>
117     <TD>
118     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">$_is_disabled</A></B></CODE>
119     <BR>
120     <blockquote> Indicates a disabled element </blockquote>
121     <blockquote> Default Value: <CODE>->&nbsp;FALSE<-</CODE> </blockquote>
122     </TD>
123     </TR>
124     <!-- =========== Summary =========== -->
125     <TR BGCOLOR='white' CLASS='TableRowColor'>
126     <TD>
127     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">$_is_required</A></B></CODE>
128     <BR>
129     <blockquote> Indicates whether this elements </blockquote>
130     <blockquote> Default Value: <CODE>->&nbsp;TRUE<-</CODE> </blockquote>
131     </TD>
132     </TR>
133     <!-- =========== Summary =========== -->
134     <TR BGCOLOR='white' CLASS='TableRowColor'>
135     <TD>
136     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">$_label_text</A></B></CODE>
137     <BR>
138     <blockquote> Holds the elements label text </blockquote>
139     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
140     </TD>
141     </TR>
142     <!-- =========== Summary =========== -->
143     <TR BGCOLOR='white' CLASS='TableRowColor'>
144     <TD>
145     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">$_style_attributes</A></B></CODE>
146     <BR>
147     <blockquote> Holds additional style attributes for </blockquote>
148     <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
149     </TD>
150     </TR>
151     <!-- =========== Summary =========== -->
152     <TR BGCOLOR='white' CLASS='TableRowColor'>
153     <TD>
154     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">$_value</A></B></CODE>
155     <BR>
156     <blockquote> Holds the elements initial value </blockquote>
157     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
158     </TD>
159     </TR>
160     </TABLE>
161     <hr>
162     <!-- =========== VAR INHERITED SUMMARY =========== -->
163     <A NAME='var_inherited_summary'><!-- --></A>
164     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
165     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
166     <TD>
167     <span CLASS="font12bold">Inherited Class Variable Summary</span>
168     <A HREF="#top" CLASS="links">^TOP</A>
169     </TD>
170     </TR>
171    
172     </TABLE>
173    
174     <hr>
175     <!-- =========== METHOD SUMMARY =========== -->
176     <A NAME='method_summary'><!-- --></A>
177     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
178     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
179     <TD>
180     <span class="font12bold">Method Summary</span>
181     <A HREF="#top" CLASS="links">^TOP</A>
182     </TD>
183     </TR>
184    
185     <!-- =========== Summary =========== -->
186     <TR BGCOLOR='white' CLASS='TableRowColor'>
187     <TD>
188     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement'>void constructor FormElement ( $label, [$required = TRUE] )</A></B></CODE>
189     <BR>
190     <blockquote> The constructor </blockquote>
191     </TD>
192     </TR>
193     <!-- =========== Summary =========== -->
194     <TR BGCOLOR='white' CLASS='TableRowColor'>
195     <TD>
196     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name'>void create_element_name ( )</A></B></CODE>
197     <BR>
198     <blockquote> This function creates element name </blockquote>
199     </TD>
200     </TR>
201     <!-- =========== Summary =========== -->
202     <TR BGCOLOR='white' CLASS='TableRowColor'>
203     <TD>
204     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute'>mixed get_attribute ( $name )</A></B></CODE>
205     <BR>
206     <blockquote> return a single attribute </blockquote>
207     </TD>
208     </TR>
209     <!-- =========== Summary =========== -->
210     <TR BGCOLOR='white' CLASS='TableRowColor'>
211     <TD>
212     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element'>object get_element ( )</A></B></CODE>
213     <BR>
214     <blockquote> This function builds and returns the form element object </blockquote>
215     </TD>
216     </TR>
217     <!-- =========== Summary =========== -->
218     <TR BGCOLOR='white' CLASS='TableRowColor'>
219     <TD>
220     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name'>string get_element_name ( )</A></B></CODE>
221     <BR>
222     <blockquote> Returns the element name to be used in the form </blockquote>
223     </TD>
224     </TR>
225     <!-- =========== Summary =========== -->
226     <TR BGCOLOR='white' CLASS='TableRowColor'>
227     <TD>
228     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message'>mesage get_error_message ( )</A></B></CODE>
229     <BR>
230     <blockquote> Returns the current error message if any </blockquote>
231     </TD>
232     </TR>
233     <!-- =========== Summary =========== -->
234     <TR BGCOLOR='white' CLASS='TableRowColor'>
235     <TD>
236     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value'>mixed get_init_value ( )</A></B></CODE>
237     <BR>
238     <blockquote> This returns the initial value of the element </blockquote>
239     </TD>
240     </TR>
241     <!-- =========== Summary =========== -->
242     <TR BGCOLOR='white' CLASS='TableRowColor'>
243     <TD>
244     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label'>object get_label ( )</A></B></CODE>
245     <BR>
246     <blockquote> This function builds and returns a label object based on the label text and error conditions </blockquote>
247     </TD>
248     </TR>
249     <!-- =========== Summary =========== -->
250     <TR BGCOLOR='white' CLASS='TableRowColor'>
251     <TD>
252     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text'>string get_label_text ( )</A></B></CODE>
253     <BR>
254     <blockquote> This function will return the elements label text </blockquote>
255     </TD>
256     </TR>
257     <!-- =========== Summary =========== -->
258     <TR BGCOLOR='white' CLASS='TableRowColor'>
259     <TD>
260     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol'>string get_required_symbol ( )</A></B></CODE>
261     <BR>
262     <blockquote> This function return the symbol used to denote a required field </blockquote>
263     </TD>
264     </TR>
265     <!-- =========== Summary =========== -->
266     <TR BGCOLOR='white' CLASS='TableRowColor'>
267     <TD>
268     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value'>mixed get_value ( )</A></B></CODE>
269     <BR>
270     <blockquote> This function will return the elements value </blockquote>
271     </TD>
272     </TR>
273     <!-- =========== Summary =========== -->
274     <TR BGCOLOR='white' CLASS='TableRowColor'>
275     <TD>
276     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text'>string get_value_text ( $value )</A></B></CODE>
277     <BR>
278     <blockquote> This provides a method </blockquote>
279     </TD>
280     </TR>
281     <!-- =========== Summary =========== -->
282     <TR BGCOLOR='white' CLASS='TableRowColor'>
283     <TD>
284     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error'>bool has_error ( )</A></B></CODE>
285     <BR>
286     <blockquote> Returns the current error state </blockquote>
287     </TD>
288     </TR>
289     <!-- =========== Summary =========== -->
290     <TR BGCOLOR='white' CLASS='TableRowColor'>
291     <TD>
292     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled'>bool is_disabled ( )</A></B></CODE>
293     <BR>
294     <blockquote> Returns the elements disabled state </blockquote>
295     </TD>
296     </TR>
297     <!-- =========== Summary =========== -->
298     <TR BGCOLOR='white' CLASS='TableRowColor'>
299     <TD>
300     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required'>bool is_required ( )</A></B></CODE>
301     <BR>
302     <blockquote> Returns whether this elements final value cannot be empty </blockquote>
303     </TD>
304     </TR>
305     <!-- =========== Summary =========== -->
306     <TR BGCOLOR='white' CLASS='TableRowColor'>
307     <TD>
308     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur'>string onBlur ( )</A></B></CODE>
309     <BR>
310     <blockquote> This function return the javaScript code for an onBlur event </blockquote>
311     </TD>
312     </TR>
313     <!-- =========== Summary =========== -->
314     <TR BGCOLOR='white' CLASS='TableRowColor'>
315     <TD>
316     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick'>string onClick ( )</A></B></CODE>
317     <BR>
318     <blockquote> This function return the javaScript code for an onClick event </blockquote>
319     </TD>
320     </TR>
321     <!-- =========== Summary =========== -->
322     <TR BGCOLOR='white' CLASS='TableRowColor'>
323     <TD>
324     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus'>string onFocus ( )</A></B></CODE>
325     <BR>
326     <blockquote> This function return the javaScript code for an onFocus event </blockquote>
327     </TD>
328     </TR>
329     <!-- =========== Summary =========== -->
330     <TR BGCOLOR='white' CLASS='TableRowColor'>
331     <TD>
332     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit'>string onSubmit ( )</A></B></CODE>
333     <BR>
334     <blockquote> This function return the javaScript code for an onSubmit event </blockquote>
335     </TD>
336     </TR>
337     <!-- =========== Summary =========== -->
338     <TR BGCOLOR='white' CLASS='TableRowColor'>
339     <TD>
340     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute'>void set_attribute ( $name, [$value = NULL] )</A></B></CODE>
341     <BR>
342     <blockquote> add a single attribute (name="value") </blockquote>
343     </TD>
344     </TR>
345     <!-- =========== Summary =========== -->
346     <TR BGCOLOR='white' CLASS='TableRowColor'>
347     <TD>
348     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled'>void set_disabled ( $flag )</A></B></CODE>
349     <BR>
350     <blockquote> Sets the disabled element flag </blockquote>
351     </TD>
352     </TR>
353     <!-- =========== Summary =========== -->
354     <TR BGCOLOR='white' CLASS='TableRowColor'>
355     <TD>
356     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message'>void set_error_message ( $message )</A></B></CODE>
357     <BR>
358     <blockquote> Defines error message text and sets the error flag to true </blockquote>
359     </TD>
360     </TR>
361     <!-- =========== Summary =========== -->
362     <TR BGCOLOR='white' CLASS='TableRowColor'>
363     <TD>
364     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text'>void set_label_text ( $label )</A></B></CODE>
365     <BR>
366     <blockquote> This function will set the label for the element </blockquote>
367     </TD>
368     </TR>
369     <!-- =========== Summary =========== -->
370     <TR BGCOLOR='white' CLASS='TableRowColor'>
371     <TD>
372     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required'>void set_required ( $required )</A></B></CODE>
373     <BR>
374     <blockquote> This function set the elements required state </blockquote>
375     </TD>
376     </TR>
377     <!-- =========== Summary =========== -->
378     <TR BGCOLOR='white' CLASS='TableRowColor'>
379     <TD>
380     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute'>void set_style_attribute ( $name, $value )</A></B></CODE>
381     <BR>
382     <blockquote> Sets elements css attribute </blockquote>
383     </TD>
384     </TR>
385     <!-- =========== Summary =========== -->
386     <TR BGCOLOR='white' CLASS='TableRowColor'>
387     <TD>
388     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title'>void set_title ( $title )</A></B></CODE>
389     <BR>
390     <blockquote> Sets elements title text </blockquote>
391     </TD>
392     </TR>
393     <!-- =========== Summary =========== -->
394     <TR BGCOLOR='white' CLASS='TableRowColor'>
395     <TD>
396     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value'>void set_value ( $value )</A></B></CODE>
397     <BR>
398     <blockquote> This function will set the initial value for the element </blockquote>
399     </TD>
400     </TR>
401     <!-- =========== Summary =========== -->
402     <TR BGCOLOR='white' CLASS='TableRowColor'>
403     <TD>
404     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate'>void validate ( )</A></B></CODE>
405     <BR>
406     <blockquote> This function performs the actual validation It is called only if the validation is required by this element </blockquote>
407     </TD>
408     </TR>
409     <!-- =========== Summary =========== -->
410     <TR BGCOLOR='white' CLASS='TableRowColor'>
411     <TD>
412     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes'>array _build_element_attributes ( )</A></B></CODE>
413     <BR>
414     <blockquote> This function builds the element form attributes </blockquote>
415     </TD>
416     </TR>
417     <!-- =========== Summary =========== -->
418     <TR BGCOLOR='white' CLASS='TableRowColor'>
419     <TD>
420     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript'>array _build_javascript ( )</A></B></CODE>
421     <BR>
422     <blockquote> This function builds the complete javaScript events code for the element </blockquote>
423     </TD>
424     </TR>
425     <!-- =========== Summary =========== -->
426     <TR BGCOLOR='white' CLASS='TableRowColor'>
427     <TD>
428     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation'>void _do_validation ( )</A></B></CODE>
429     <BR>
430     <blockquote> This function checks if the validation </blockquote>
431     </TD>
432     </TR>
433     </TABLE>
434     <!-- =========== INHERITED METHOD SUMMARY =========== -->
435     <A NAME='functions_inherited'><!-- --></A>
436     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
437     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
438     <TD>
439     <span CLASS="font12bold">Inherited Method Summary</span>
440     <A HREF="#top" CLASS="links">^TOP</A>
441     </TD>
442     </TR>
443    
444     </TABLE>
445     <hr>
446     <!-- ============ VARIABLE DETAIL =========== -->
447    
448     <A NAME='variable_detail'></A>
449     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
450     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
451     <TD>
452     <span CLASS="font12bold">Variable Detail</span>
453     <A HREF="#top" CLASS="links">^TOP</A>
454     </TD>
455     </TR>
456     </TABLE>
457    
458     <A NAME='var$_attributes'><!-- --></A><H3>$_attributes</H3> (line <span class="linenumber">86</span>)<br />
459     <b>Data type:</b> mixed<br>Holds additional attributes for
460     <br />
461     <p>the elements html tag</p>
462     <UL>
463     </UL>
464     <HR>
465     <A NAME='var$_element_name'><!-- --></A><H3>$_element_name</H3> (line <span class="linenumber">79</span>)<br />
466     <b>Data type:</b> mixed<br>Holds the name of the element
467     <br />
468     <p>as it appears in the form html tag</p>
469     <UL>
470     </UL>
471     <HR>
472     <A NAME='var$_error_message'><!-- --></A><H3>$_error_message</H3> (line <span class="linenumber">65</span>)<br />
473     <b>Data type:</b> mixed<br>Holds the error message text
474     <br />
475     <p>for validation errors, if any</p>
476     <UL>
477     </UL>
478     <HR>
479     <A NAME='var$_has_error'><!-- --></A><H3>$_has_error</H3> (line <span class="linenumber">72</span>)<br />
480     <b>Data type:</b> mixed<br>Holds the state of the last validation
481     <br />
482     <p>Sets to true in case of a validation error</p>
483     <UL>
484     </UL>
485     <HR>
486     <A NAME='var$_is_disabled'><!-- --></A><H3>$_is_disabled</H3> (line <span class="linenumber">99</span>)<br />
487     <b>Data type:</b> mixed<br>Indicates a disabled element
488     <br />
489    
490     <UL>
491     </UL>
492     <HR>
493     <A NAME='var$_is_required'><!-- --></A><H3>$_is_required</H3> (line <span class="linenumber">58</span>)<br />
494     <b>Data type:</b> mixed<br>Indicates whether this elements
495     <br />
496     <p>final value is required and cannot be empty</p>
497     <UL>
498     </UL>
499     <HR>
500     <A NAME='var$_label_text'><!-- --></A><H3>$_label_text</H3> (line <span class="linenumber">45</span>)<br />
501     <b>Data type:</b> mixed<br>Holds the elements label text
502     <br />
503    
504     <UL>
505     </UL>
506     <HR>
507     <A NAME='var$_style_attributes'><!-- --></A><H3>$_style_attributes</H3> (line <span class="linenumber">93</span>)<br />
508     <b>Data type:</b> mixed<br>Holds additional style attributes for
509     <br />
510     <p>the elements html tag</p>
511     <UL>
512     </UL>
513     <HR>
514     <A NAME='var$_value'><!-- --></A><H3>$_value</H3> (line <span class="linenumber">51</span>)<br />
515     <b>Data type:</b> mixed<br>Holds the elements initial value
516     <br />
517    
518     <UL>
519     </UL>
520     <HR>
521     <hr>
522     <!-- ============ METHOD DETAIL =========== -->
523    
524     <A NAME='method_detail'></A>
525     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
526     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
527     <TD>
528     <span class="font12bold">Method Detail</span>
529     <A HREF="#top" CLASS="links">^TOP</A>
530     </TD>
531     </TR>
532     </TABLE>
533     <BR>
534     <DIV CLASS="function">
535     <A NAME='methodFormElement'><!-- --></A>
536     <SPAN CLASS="font12bold">Constructor FormElement</SPAN> (line <span class="linenumber">108</span>)
537     <BR>
538     <SPAN CLASS="font10bold">Usage : </SPAN>
539     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
540     <span class="font10bold" style="color: #0000FF">FormElement(
541     label
542     $label, [bool
543     $required = TRUE])</SPAN>
544     <BR>
545    
546     <BR>
547     <SPAN CLASS="font10bold">Description : </SPAN>
548     The constructor
549     <br />
550    
551     <DL>
552     <DT class="font10bold">Function Parameters:</DT>
553     <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>
554     <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>
555    
556     <DT class="font10bold">Function Info:</DT>
557     </DL>
558     </DIV>
559     <BR>
560     <DIV CLASS="function">
561     <A NAME='methodcreate_element_name'><!-- --></A>
562     <SPAN CLASS="font12bold">create_element_name</SPAN> (line <span class="linenumber">324</span>)
563     <BR>
564     <SPAN CLASS="font10bold">Usage : </SPAN>
565     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
566     <span class="font10bold" style="color: #0000FF">create_element_name(
567     )</SPAN>
568     <BR>
569    
570     <BR>
571     <SPAN CLASS="font10bold">Description : </SPAN>
572     This function creates element name
573     <br />
574     <p>used in the form based on the text label or any other parameters</p>
575     <DL>
576    
577     <DT class="font10bold">Function Info:</DT>
578     </DL>
579     </DIV>
580     <BR>
581     <DIV CLASS="function">
582     <A NAME='methodget_attribute'><!-- --></A>
583     <SPAN CLASS="font12bold">get_attribute</SPAN> (line <span class="linenumber">257</span>)
584     <BR>
585     <SPAN CLASS="font10bold">Usage : </SPAN>
586     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
587     <span class="font10bold" style="color: #0000FF">get_attribute(
588     string
589     $name)</SPAN>
590     <BR>
591    
592     <BR>
593     <SPAN CLASS="font10bold">Description : </SPAN>
594     return a single attribute
595     <br />
596    
597     <DL>
598     <DT class="font10bold">Function Parameters:</DT>
599     <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">$name</SPAN></SPAN> attribute name</DD>
600    
601     <DT class="font10bold">Function Info:</DT>
602     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - $value the value</DD>
603     </DL>
604     </DIV>
605     <BR>
606     <DIV CLASS="function">
607     <A NAME='methodget_element'><!-- --></A>
608     <SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">536</span>)
609     <BR>
610     <SPAN CLASS="font10bold">Usage : </SPAN>
611     <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;
612     <span class="font10bold" style="color: #0000FF">get_element(
613     )</SPAN>
614     <BR>
615     <p>Overridden in child classes as:<br />
616     <dl>
617     <dt><a href="../../phpHtmlLib/FormProcessing/FEHidden.html#methodget_element">FEHidden::get_element()</a></dt>
618     <dd></dd>
619     </dl>
620     <dl>
621     <dt><a href="../../phpHtmlLib/FormProcessing/FEText.html#methodget_element">FEText::get_element()</a></dt>
622     <dd>This function builds and returns the form element object</dd>
623     </dl>
624     <dl>
625     <dt><a href="../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_element">FECheckBox::get_element()</a></dt>
626     <dd>This function builds and returns the form element object</dd>
627     </dl>
628     <dl>
629     <dt><a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html#methodget_element">FERadioGroup::get_element()</a></dt>
630     <dd>This function builds and returns the form element object</dd>
631     </dl>
632     </p>
633    
634     <BR>
635     <SPAN CLASS="font10bold">Description : </SPAN>
636     This function builds and returns the form element object
637     <br />
638    
639     <DL>
640    
641     <DT class="font10bold">Function Info:</DT>
642     </DL>
643     </DIV>
644     <BR>
645     <DIV CLASS="function">
646     <A NAME='methodget_element_name'><!-- --></A>
647     <SPAN CLASS="font12bold">get_element_name</SPAN> (line <span class="linenumber">343</span>)
648     <BR>
649     <SPAN CLASS="font10bold">Usage : </SPAN>
650     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
651     <span class="font10bold" style="color: #0000FF">get_element_name(
652     )</SPAN>
653     <BR>
654    
655     <BR>
656     <SPAN CLASS="font10bold">Description : </SPAN>
657     Returns the element name to be used in the form
658     <br />
659    
660     <DL>
661    
662     <DT class="font10bold">Function Info:</DT>
663     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - form element name</DD>
664     </DL>
665     </DIV>
666     <BR>
667     <DIV CLASS="function">
668     <A NAME='methodget_error_message'><!-- --></A>
669     <SPAN CLASS="font12bold">get_error_message</SPAN> (line <span class="linenumber">301</span>)
670     <BR>
671     <SPAN CLASS="font10bold">Usage : </SPAN>
672     <span class="font10bold" style="color: #FF0000">mesage</SPAN>&nbsp;
673     <span class="font10bold" style="color: #0000FF">get_error_message(
674     )</SPAN>
675     <BR>
676    
677     <BR>
678     <SPAN CLASS="font10bold">Description : </SPAN>
679     Returns the current error message if any
680     <br />
681    
682     <DL>
683    
684     <DT class="font10bold">Function Info:</DT>
685     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - text - error message</DD>
686     </DL>
687     </DIV>
688     <BR>
689     <DIV CLASS="function">
690     <A NAME='methodget_init_value'><!-- --></A>
691     <SPAN CLASS="font12bold">get_init_value</SPAN> (line <span class="linenumber">206</span>)
692     <BR>
693     <SPAN CLASS="font10bold">Usage : </SPAN>
694     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
695     <span class="font10bold" style="color: #0000FF">get_init_value(
696     )</SPAN>
697     <BR>
698    
699     <BR>
700     <SPAN CLASS="font10bold">Description : </SPAN>
701     This returns the initial value of the element
702     <br />
703    
704     <DL>
705    
706     <DT class="font10bold">Function Info:</DT>
707     </DL>
708     </DIV>
709     <BR>
710     <DIV CLASS="function">
711     <A NAME='methodget_label'><!-- --></A>
712     <SPAN CLASS="font12bold">get_label</SPAN> (line <span class="linenumber">514</span>)
713     <BR>
714     <SPAN CLASS="font10bold">Usage : </SPAN>
715     <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;
716     <span class="font10bold" style="color: #0000FF">get_label(
717     )</SPAN>
718     <BR>
719    
720     <BR>
721     <SPAN CLASS="font10bold">Description : </SPAN>
722     This function builds and returns a label object based on the label text and error conditions
723     <br />
724    
725     <DL>
726    
727     <DT class="font10bold">Function Info:</DT>
728     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - SPANtag</DD>
729     </DL>
730     </DIV>
731     <BR>
732     <DIV CLASS="function">
733     <A NAME='methodget_label_text'><!-- --></A>
734     <SPAN CLASS="font12bold">get_label_text</SPAN> (line <span class="linenumber">127</span>)
735     <BR>
736     <SPAN CLASS="font10bold">Usage : </SPAN>
737     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
738     <span class="font10bold" style="color: #0000FF">get_label_text(
739     )</SPAN>
740     <BR>
741    
742     <BR>
743     <SPAN CLASS="font10bold">Description : </SPAN>
744     This function will return the elements label text
745     <br />
746    
747     <DL>
748    
749     <DT class="font10bold">Function Info:</DT>
750     </DL>
751     </DIV>
752     <BR>
753     <DIV CLASS="function">
754     <A NAME='methodget_required_symbol'><!-- --></A>
755     <SPAN CLASS="font12bold">get_required_symbol</SPAN> (line <span class="linenumber">469</span>)
756     <BR>
757     <SPAN CLASS="font10bold">Usage : </SPAN>
758     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
759     <span class="font10bold" style="color: #0000FF">get_required_symbol(
760     )</SPAN>
761     <BR>
762    
763     <BR>
764     <SPAN CLASS="font10bold">Description : </SPAN>
765     This function return the symbol used to denote a required field
766     <br />
767    
768     <DL>
769    
770     <DT class="font10bold">Function Info:</DT>
771     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - required symbol</DD>
772     </DL>
773     </DIV>
774     <BR>
775     <DIV CLASS="function">
776     <A NAME='methodget_value'><!-- --></A>
777     <SPAN CLASS="font12bold">get_value</SPAN> (line <span class="linenumber">147</span>)
778     <BR>
779     <SPAN CLASS="font10bold">Usage : </SPAN>
780     <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
781     <span class="font10bold" style="color: #0000FF">get_value(
782     )</SPAN>
783     <BR>
784    
785     <BR>
786     <SPAN CLASS="font10bold">Description : </SPAN>
787     This function will return the elements value
788     <br />
789    
790     <DL>
791    
792     <DT class="font10bold">Function Info:</DT>
793     </DL>
794     </DIV>
795     <BR>
796     <DIV CLASS="function">
797     <A NAME='methodget_value_text'><!-- --></A>
798     <SPAN CLASS="font12bold">get_value_text</SPAN> (line <span class="linenumber">174</span>)
799     <BR>
800     <SPAN CLASS="font10bold">Usage : </SPAN>
801     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
802     <span class="font10bold" style="color: #0000FF">get_value_text(
803     mixed
804     $value)</SPAN>
805     <BR>
806     <p>Overridden in child classes as:<br />
807     <dl>
808     <dt><a href="../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_value_text">FECheckBox::get_value_text()</a></dt>
809     <dd>This provides a method</dd>
810     </dl>
811     <dl>
812     <dt><a href="../../phpHtmlLib/FormProcessing/FERadioGroup.html#methodget_value_text">FERadioGroup::get_value_text()</a></dt>
813     <dd>This provides a method</dd>
814     </dl>
815     </p>
816    
817     <BR>
818     <SPAN CLASS="font10bold">Description : </SPAN>
819     This provides a method
820     <br />
821     <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>
822     <DL>
823     <DT class="font10bold">Function Parameters:</DT>
824     <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>
825    
826     <DT class="font10bold">Function Info:</DT>
827     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the text associated</DD>
828     </DL>
829     </DIV>
830     <BR>
831     <DIV CLASS="function">
832     <A NAME='methodhas_error'><!-- --></A>
833     <SPAN CLASS="font12bold">has_error</SPAN> (line <span class="linenumber">311</span>)
834     <BR>
835     <SPAN CLASS="font10bold">Usage : </SPAN>
836     <span class="font10bold" style="color: #FF0000">bool</SPAN>&nbsp;
837     <span class="font10bold" style="color: #0000FF">has_error(
838     )</SPAN>
839     <BR>
840    
841     <BR>
842     <SPAN CLASS="font10bold">Description : </SPAN>
843     Returns the current error state
844     <br />
845    
846     <DL>
847    
848     <DT class="font10bold">Function Info:</DT>
849     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - error state</DD>
850     </DL>
851     </DIV>
852     <BR>
853     <DIV CLASS="function">
854     <A NAME='methodis_disabled'><!-- --></A>
855     <SPAN CLASS="font12bold">is_disabled</SPAN> (line <span class="linenumber">226</span>)
856     <BR>
857     <SPAN CLASS="font10bold">Usage : </SPAN>
858     <span class="font10bold" style="color: #FF0000">bool</SPAN>&nbsp;
859     <span class="font10bold" style="color: #0000FF">is_disabled(
860     )</SPAN>
861     <BR>
862    
863     <BR>
864     <SPAN CLASS="font10bold">Description : </SPAN>
865     Returns the elements disabled state
866     <br />
867    
868     <DL>
869    
870     <DT class="font10bold">Function Info:</DT>
871     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - disabled</DD>
872     </DL>
873     </DIV>
874     <BR>
875     <DIV CLASS="function">
876     <A NAME='methodis_required'><!-- --></A>
877     <SPAN CLASS="font12bold">is_required</SPAN> (line <span class="linenumber">195</span>)
878     <BR>
879     <SPAN CLASS="font10bold">Usage : </SPAN>
880     <span class="font10bold" style="color: #FF0000">bool</SPAN>&nbsp;
881     <span class="font10bold" style="color: #0000FF">is_required(
882     )</SPAN>
883     <BR>
884    
885     <BR>
886     <SPAN CLASS="font10bold">Description : </SPAN>
887     Returns whether this elements final value cannot be empty
888     <br />
889    
890     <DL>
891    
892     <DT class="font10bold">Function Info:</DT>
893     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - requried</DD>
894     </DL>
895     </DIV>
896     <BR>
897     <DIV CLASS="function">
898     <A NAME='methodonBlur'><!-- --></A>
899     <SPAN CLASS="font12bold">onBlur</SPAN> (line <span class="linenumber">421</span>)
900     <BR>
901     <SPAN CLASS="font10bold">Usage : </SPAN>
902     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
903     <span class="font10bold" style="color: #0000FF">onBlur(
904     )</SPAN>
905     <BR>
906    
907     <BR>
908     <SPAN CLASS="font10bold">Description : </SPAN>
909     This function return the javaScript code for an onBlur event
910     <br />
911    
912     <DL>
913    
914     <DT class="font10bold">Function Info:</DT>
915     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - javascript code</DD>
916     </DL>
917     </DIV>
918     <BR>
919     <DIV CLASS="function">
920     <A NAME='methodonClick'><!-- --></A>
921     <SPAN CLASS="font12bold">onClick</SPAN> (line <span class="linenumber">391</span>)
922     <BR>
923     <SPAN CLASS="font10bold">Usage : </SPAN>
924     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
925     <span class="font10bold" style="color: #0000FF">onClick(
926     )</SPAN>
927     <BR>
928    
929     <BR>
930     <SPAN CLASS="font10bold">Description : </SPAN>
931     This function return the javaScript code for an onClick event
932     <br />
933    
934     <DL>
935    
936     <DT class="font10bold">Function Info:</DT>
937     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - javascript code</DD>
938     </DL>
939     </DIV>
940     <BR>
941     <DIV CLASS="function">
942     <A NAME='methodonFocus'><!-- --></A>
943     <SPAN CLASS="font12bold">onFocus</SPAN> (line <span class="linenumber">401</span>)
944     <BR>
945     <SPAN CLASS="font10bold">Usage : </SPAN>
946     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
947     <span class="font10bold" style="color: #0000FF">onFocus(
948     )</SPAN>
949     <BR>
950    
951     <BR>
952     <SPAN CLASS="font10bold">Description : </SPAN>
953     This function return the javaScript code for an onFocus event
954     <br />
955    
956     <DL>
957    
958     <DT class="font10bold">Function Info:</DT>
959     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - javascript code</DD>
960     </DL>
961     </DIV>
962     <BR>
963     <DIV CLASS="function">
964     <A NAME='methodonSubmit'><!-- --></A>
965     <SPAN CLASS="font12bold">onSubmit</SPAN> (line <span class="linenumber">411</span>)
966     <BR>
967     <SPAN CLASS="font10bold">Usage : </SPAN>
968     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
969     <span class="font10bold" style="color: #0000FF">onSubmit(
970     )</SPAN>
971     <BR>
972    
973     <BR>
974     <SPAN CLASS="font10bold">Description : </SPAN>
975     This function return the javaScript code for an onSubmit event
976     <br />
977    
978     <DL>
979    
980     <DT class="font10bold">Function Info:</DT>
981     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - javascript code</DD>
982     </DL>
983     </DIV>
984     <BR>
985     <DIV CLASS="function">
986     <A NAME='methodset_attribute'><!-- --></A>
987     <SPAN CLASS="font12bold">set_attribute</SPAN> (line <span class="linenumber">241</span>)
988     <BR>
989     <SPAN CLASS="font10bold">Usage : </SPAN>
990     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
991     <span class="font10bold" style="color: #0000FF">set_attribute(
992     string
993     $name, [mixed
994     $value = NULL])</SPAN>
995     <BR>
996    
997     <BR>
998     <SPAN CLASS="font10bold">Description : </SPAN>
999     add a single attribute (name="value")
1000     <br />
1001    
1002     <DL>
1003     <DT class="font10bold">Function Parameters:</DT>
1004     <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">$name</SPAN></SPAN> attribute name</DD>
1005     <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</DD>
1006    
1007     <DT class="font10bold">Function Info:</DT>
1008     </DL>
1009     </DIV>
1010     <BR>
1011     <DIV CLASS="function">
1012     <A NAME='methodset_disabled'><!-- --></A>
1013     <SPAN CLASS="font12bold">set_disabled</SPAN> (line <span class="linenumber">216</span>)
1014     <BR>
1015     <SPAN CLASS="font10bold">Usage : </SPAN>
1016     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1017     <span class="font10bold" style="color: #0000FF">set_disabled(
1018     bool
1019     $flag)</SPAN>
1020     <BR>
1021    
1022     <BR>
1023     <SPAN CLASS="font10bold">Description : </SPAN>
1024     Sets the disabled element flag
1025     <br />
1026    
1027     <DL>
1028     <DT class="font10bold">Function Parameters:</DT>
1029     <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">$flag</SPAN></SPAN> disabled</DD>
1030    
1031     <DT class="font10bold">Function Info:</DT>
1032     </DL>
1033     </DIV>
1034     <BR>
1035     <DIV CLASS="function">
1036     <A NAME='methodset_error_message'><!-- --></A>
1037     <SPAN CLASS="font12bold">set_error_message</SPAN> (line <span class="linenumber">289</span>)
1038     <BR>
1039     <SPAN CLASS="font10bold">Usage : </SPAN>
1040     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1041     <span class="font10bold" style="color: #0000FF">set_error_message(
1042     mesage
1043     $message)</SPAN>
1044     <BR>
1045    
1046     <BR>
1047     <SPAN CLASS="font10bold">Description : </SPAN>
1048     Defines error message text and sets the error flag to true
1049     <br />
1050    
1051     <DL>
1052     <DT class="font10bold">Function Parameters:</DT>
1053     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mesage</SPAN> <span style="color: #0000FF;font-weight:bold">$message</SPAN></SPAN> text - error message</DD>
1054    
1055     <DT class="font10bold">Function Info:</DT>
1056     </DL>
1057     </DIV>
1058     <BR>
1059     <DIV CLASS="function">
1060     <A NAME='methodset_label_text'><!-- --></A>
1061     <SPAN CLASS="font12bold">set_label_text</SPAN> (line <span class="linenumber">137</span>)
1062     <BR>
1063     <SPAN CLASS="font10bold">Usage : </SPAN>
1064     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1065     <span class="font10bold" style="color: #0000FF">set_label_text(
1066     label
1067     $label)</SPAN>
1068     <BR>
1069    
1070     <BR>
1071     <SPAN CLASS="font10bold">Description : </SPAN>
1072     This function will set the label for the element
1073     <br />
1074    
1075     <DL>
1076     <DT class="font10bold">Function Parameters:</DT>
1077     <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</DD>
1078    
1079     <DT class="font10bold">Function Info:</DT>
1080     </DL>
1081     </DIV>
1082     <BR>
1083     <DIV CLASS="function">
1084     <A NAME='methodset_required'><!-- --></A>
1085     <SPAN CLASS="font12bold">set_required</SPAN> (line <span class="linenumber">185</span>)
1086     <BR>
1087     <SPAN CLASS="font10bold">Usage : </SPAN>
1088     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1089     <span class="font10bold" style="color: #0000FF">set_required(
1090     bool
1091     $required)</SPAN>
1092     <BR>
1093    
1094     <BR>
1095     <SPAN CLASS="font10bold">Description : </SPAN>
1096     This function set the elements required state
1097     <br />
1098    
1099     <DL>
1100     <DT class="font10bold">Function Parameters:</DT>
1101     <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</DD>
1102    
1103     <DT class="font10bold">Function Info:</DT>
1104     </DL>
1105     </DIV>
1106     <BR>
1107     <DIV CLASS="function">
1108     <A NAME='methodset_style_attribute'><!-- --></A>
1109     <SPAN CLASS="font12bold">set_style_attribute</SPAN> (line <span class="linenumber">276</span>)
1110     <BR>
1111     <SPAN CLASS="font10bold">Usage : </SPAN>
1112     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1113     <span class="font10bold" style="color: #0000FF">set_style_attribute(
1114     string
1115     $name, mixed
1116     $value)</SPAN>
1117     <BR>
1118    
1119     <BR>
1120     <SPAN CLASS="font10bold">Description : </SPAN>
1121     Sets elements css attribute
1122     <br />
1123    
1124     <DL>
1125     <DT class="font10bold">Function Parameters:</DT>
1126     <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">$name</SPAN></SPAN> attribute name</DD>
1127     <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</DD>
1128    
1129     <DT class="font10bold">Function Info:</DT>
1130     </DL>
1131     </DIV>
1132     <BR>
1133     <DIV CLASS="function">
1134     <A NAME='methodset_title'><!-- --></A>
1135     <SPAN CLASS="font12bold">set_title</SPAN> (line <span class="linenumber">266</span>)
1136     <BR>
1137     <SPAN CLASS="font10bold">Usage : </SPAN>
1138     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1139     <span class="font10bold" style="color: #0000FF">set_title(
1140     string
1141     $title)</SPAN>
1142     <BR>
1143    
1144     <BR>
1145     <SPAN CLASS="font10bold">Description : </SPAN>
1146     Sets elements title text
1147     <br />
1148    
1149     <DL>
1150     <DT class="font10bold">Function Parameters:</DT>
1151     <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">$title</SPAN></SPAN> title</DD>
1152    
1153     <DT class="font10bold">Function Info:</DT>
1154     </DL>
1155     </DIV>
1156     <BR>
1157     <DIV CLASS="function">
1158     <A NAME='methodset_value'><!-- --></A>
1159     <SPAN CLASS="font12bold">set_value</SPAN> (line <span class="linenumber">157</span>)
1160     <BR>
1161     <SPAN CLASS="font10bold">Usage : </SPAN>
1162     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1163     <span class="font10bold" style="color: #0000FF">set_value(
1164     value
1165     $value)</SPAN>
1166     <BR>
1167    
1168     <BR>
1169     <SPAN CLASS="font10bold">Description : </SPAN>
1170     This function will set the initial value for the element
1171     <br />
1172    
1173     <DL>
1174     <DT class="font10bold">Function Parameters:</DT>
1175     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">value</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> mixed</DD>
1176    
1177     <DT class="font10bold">Function Info:</DT>
1178     </DL>
1179     </DIV>
1180     <BR>
1181     <DIV CLASS="function">
1182     <A NAME='methodvalidate'><!-- --></A>
1183     <SPAN CLASS="font12bold">validate</SPAN> (line <span class="linenumber">361</span>)
1184     <BR>
1185     <SPAN CLASS="font10bold">Usage : </SPAN>
1186     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1187     <span class="font10bold" style="color: #0000FF">validate(
1188     )</SPAN>
1189     <BR>
1190    
1191     <BR>
1192     <SPAN CLASS="font10bold">Description : </SPAN>
1193     This function performs the actual validation It is called only if the validation is required by this element
1194     <br />
1195     <p>This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p>
1196     <DL>
1197    
1198     <DT class="font10bold">Function Info:</DT>
1199     </DL>
1200     </DIV>
1201     <BR>
1202     <DIV CLASS="function">
1203     <A NAME='method_build_element_attributes'><!-- --></A>
1204     <SPAN CLASS="font12bold">_build_element_attributes</SPAN> (line <span class="linenumber">478</span>)
1205     <BR>
1206     <SPAN CLASS="font10bold">Usage : </SPAN>
1207     <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
1208     <span class="font10bold" style="color: #0000FF">_build_element_attributes(
1209     )</SPAN>
1210     <BR>
1211    
1212     <BR>
1213     <SPAN CLASS="font10bold">Description : </SPAN>
1214     This function builds the element form attributes
1215     <br />
1216    
1217     <DL>
1218    
1219     <DT class="font10bold">Function Info:</DT>
1220     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - attributes</DD>
1221     </DL>
1222     </DIV>
1223     <BR>
1224     <DIV CLASS="function">
1225     <A NAME='method_build_javascript'><!-- --></A>
1226     <SPAN CLASS="font12bold">_build_javascript</SPAN> (line <span class="linenumber">431</span>)
1227     <BR>
1228     <SPAN CLASS="font10bold">Usage : </SPAN>
1229     <span class="font10bold" style="color: #FF0000">array</SPAN>&nbsp;
1230     <span class="font10bold" style="color: #0000FF">_build_javascript(
1231     )</SPAN>
1232     <BR>
1233    
1234     <BR>
1235     <SPAN CLASS="font10bold">Description : </SPAN>
1236     This function builds the complete javaScript events code for the element
1237     <br />
1238    
1239     <DL>
1240    
1241     <DT class="font10bold">Function Info:</DT>
1242     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - attributes</DD>
1243     </DL>
1244     </DIV>
1245     <BR>
1246     <DIV CLASS="function">
1247     <A NAME='method_do_validation'><!-- --></A>
1248     <SPAN CLASS="font12bold">_do_validation</SPAN> (line <span class="linenumber">371</span>)
1249     <BR>
1250     <SPAN CLASS="font10bold">Usage : </SPAN>
1251     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
1252     <span class="font10bold" style="color: #0000FF">_do_validation(
1253     )</SPAN>
1254     <BR>
1255    
1256     <BR>
1257     <SPAN CLASS="font10bold">Description : </SPAN>
1258     This function checks if the validation
1259     <br />
1260     <p>is nesseccary and calls the validate method</p>
1261     <DL>
1262    
1263     <DT class="font10bold">Function Info:</DT>
1264     </DL>
1265     </DIV>
1266     <BR>
1267     <div id="credit">
1268     <hr>
1269     Documention generated on Thu, 20 Feb 2003 16:22:52 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
1270     </div>
1271     </body>
1272     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed