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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations)
Sat Feb 22 21:05:12 2003 UTC (21 years, 6 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:42 -0800' -->
6     <TITLE>Docs For Class FECheckBox</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 FECheckBox">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 FECheckBox
30     </H2> (line <span class="linenumber">28</span>)
31     <pre>
32     <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
33     |
34     --FECheckBox</pre>
35     <p>
36     <b><i>Located in File: Program_Root/form/form_elements/FECheckBox.inc</i></b><br>
37     </p>
38     <hr>
39     This is the CheckBox FormElement which builds a input field of type="checkbox". It has no validation method.
40     <br />
41    
42     <UL>
43     <LI><b>copyright</b> - <CODE>LGPL - See LICENCE</CODE></LI>
44     <LI><b>author</b> - <CODE>Suren Markossian &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</CODE></LI>
45     <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
46     </UL>
47     <hr>
48     <!-- =========== VAR SUMMARY =========== -->
49     <A NAME='var_summary'><!-- --></A>
50     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
51     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
52     <TD>
53     <span CLASS="font12bold">Class Variable Summary</span>
54     <A HREF="#top" CLASS="links">^TOP</A>
55     </TD>
56     </TR>
57    
58     <!-- =========== Summary =========== -->
59     <TR BGCOLOR='white' CLASS='TableRowColor'>
60     <TD>
61     <CODE><B><A HREF="../../phpHtmlLib/FormProcessing/FECheckBox.html#var$_text">$_text</A></B></CODE>
62     <BR>
63     <blockquote> Holds the checkbox text </blockquote>
64     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
65     </TD>
66     </TR>
67     </TABLE>
68     <hr>
69     <!-- =========== VAR INHERITED SUMMARY =========== -->
70     <A NAME='var_inherited_summary'><!-- --></A>
71     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
72     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
73     <TD>
74     <span CLASS="font12bold">Inherited Class Variable Summary</span>
75     <A HREF="#top" CLASS="links">^TOP</A>
76     </TD>
77     </TR>
78    
79     <!-- =========== Summary =========== -->
80     <TR BGCOLOR='white'>
81     <TD>
82     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
83     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
84     <tr CLASS="tableheadingcolor">
85     <th>Variable</th>
86     <th>Default Value</th>
87     <th>Description</th>
88     </tr>
89     <tr>
90     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></td>
91     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
92     <td CLASS="font10">Holds additional attributes for</td>
93     </tr>
94     <tr>
95     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></td>
96     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
97     <td CLASS="font10">Holds the name of the element</td>
98     </tr>
99     <tr>
100     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></td>
101     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
102     <td CLASS="font10">Holds the error message text</td>
103     </tr>
104     <tr>
105     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></td>
106     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
107     <td CLASS="font10">Holds the state of the last validation</td>
108     </tr>
109     <tr>
110     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></td>
111     <td CLASS="font10" STYLE="white-space: nowrap">-> FALSE<-</td>
112     <td CLASS="font10">Indicates a disabled element</td>
113     </tr>
114     <tr>
115     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></td>
116     <td CLASS="font10" STYLE="white-space: nowrap">-> TRUE<-</td>
117     <td CLASS="font10">Indicates whether this elements</td>
118     </tr>
119     <tr>
120     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></td>
121     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
122     <td CLASS="font10">Holds the elements label text</td>
123     </tr>
124     <tr>
125     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></td>
126     <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
127     <td CLASS="font10">Holds additional style attributes for</td>
128     </tr>
129     <tr>
130     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></td>
131     <td CLASS="font10" STYLE="white-space: nowrap">-> NULL<-</td>
132     <td CLASS="font10">Holds the elements initial value</td>
133     </tr>
134     </table>
135     <BR>
136     </TD>
137     </TR>
138     </TABLE>
139    
140     <hr>
141     <!-- =========== METHOD SUMMARY =========== -->
142     <A NAME='method_summary'><!-- --></A>
143     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
144     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
145     <TD>
146     <span class="font12bold">Method Summary</span>
147     <A HREF="#top" CLASS="links">^TOP</A>
148     </TD>
149     </TR>
150    
151     <!-- =========== Summary =========== -->
152     <TR BGCOLOR='white' CLASS='TableRowColor'>
153     <TD>
154     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FECheckBox.html#methodFECheckBox'>void constructor FECheckBox ( $label, $text )</A></B></CODE>
155     <BR>
156     <blockquote> The constructor </blockquote>
157     </TD>
158     </TR>
159     <!-- =========== Summary =========== -->
160     <TR BGCOLOR='white' CLASS='TableRowColor'>
161     <TD>
162     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_element'>object get_element ( )</A></B></CODE>
163     <BR>
164     <blockquote> This function builds and returns the form element object </blockquote>
165     </TD>
166     </TR>
167     <!-- =========== Summary =========== -->
168     <TR BGCOLOR='white' CLASS='TableRowColor'>
169     <TD>
170     <CODE><B><A HREF='../../phpHtmlLib/FormProcessing/FECheckBox.html#methodget_value_text'>string get_value_text ( $value )</A></B></CODE>
171     <BR>
172     <blockquote> This provides a method </blockquote>
173     </TD>
174     </TR>
175     </TABLE>
176     <!-- =========== INHERITED METHOD SUMMARY =========== -->
177     <A NAME='functions_inherited'><!-- --></A>
178     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
179     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
180     <TD>
181     <span CLASS="font12bold">Inherited Method Summary</span>
182     <A HREF="#top" CLASS="links">^TOP</A>
183     </TD>
184     </TR>
185    
186     <!-- =========== Summary =========== -->
187     <TR BGCOLOR='white' CLASS='TableRowColor'>
188     <TD>
189     <span CLASS="font10bold">Inherited From Class <a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span>
190     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
191     <tr CLASS="tableheadingcolor">
192     <th>Function</th>
193     <th>Description</th>
194     </tr>
195     <tr>
196     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></td>
197     <td CLASS="font10">The constructor</td>
198     <tr>
199     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></td>
200     <td CLASS="font10">This function creates element name</td>
201     <tr>
202     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></td>
203     <td CLASS="font10">return a single attribute</td>
204     <tr>
205     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></td>
206     <td CLASS="font10">This function builds and returns the form element object</td>
207     <tr>
208     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></td>
209     <td CLASS="font10">Returns the element name to be used in the form</td>
210     <tr>
211     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></td>
212     <td CLASS="font10">Returns the current error message if any</td>
213     <tr>
214     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></td>
215     <td CLASS="font10">This returns the initial value of the element</td>
216     <tr>
217     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></td>
218     <td CLASS="font10">This function builds and returns a label object based on the label text and error conditions</td>
219     <tr>
220     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></td>
221     <td CLASS="font10">This function will return the elements label text</td>
222     <tr>
223     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></td>
224     <td CLASS="font10">This function return the symbol used to denote a required field</td>
225     <tr>
226     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></td>
227     <td CLASS="font10">This function will return the elements value</td>
228     <tr>
229     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></td>
230     <td CLASS="font10">This provides a method</td>
231     <tr>
232     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></td>
233     <td CLASS="font10">Returns the current error state</td>
234     <tr>
235     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></td>
236     <td CLASS="font10">Returns the elements disabled state</td>
237     <tr>
238     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></td>
239     <td CLASS="font10">Returns whether this elements final value cannot be empty</td>
240     <tr>
241     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></td>
242     <td CLASS="font10">This function return the javaScript code for an onBlur event</td>
243     <tr>
244     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></td>
245     <td CLASS="font10">This function return the javaScript code for an onClick event</td>
246     <tr>
247     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></td>
248     <td CLASS="font10">This function return the javaScript code for an onFocus event</td>
249     <tr>
250     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></td>
251     <td CLASS="font10">This function return the javaScript code for an onSubmit event</td>
252     <tr>
253     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></td>
254     <td CLASS="font10">add a single attribute (name="value")</td>
255     <tr>
256     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></td>
257     <td CLASS="font10">Sets the disabled element flag</td>
258     <tr>
259     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></td>
260     <td CLASS="font10">Defines error message text and sets the error flag to true</td>
261     <tr>
262     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></td>
263     <td CLASS="font10">This function will set the label for the element</td>
264     <tr>
265     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></td>
266     <td CLASS="font10">This function set the elements required state</td>
267     <tr>
268     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></td>
269     <td CLASS="font10">Sets elements css attribute</td>
270     <tr>
271     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></td>
272     <td CLASS="font10">Sets elements title text</td>
273     <tr>
274     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></td>
275     <td CLASS="font10">This function will set the initial value for the element</td>
276     <tr>
277     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></td>
278     <td CLASS="font10">This function performs the actual validation It is called only if the validation is required by this element</td>
279     <tr>
280     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></td>
281     <td CLASS="font10">This function builds the element form attributes</td>
282     <tr>
283     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></td>
284     <td CLASS="font10">This function builds the complete javaScript events code for the element</td>
285     <tr>
286     <td CLASS="font10bold"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></td>
287     <td CLASS="font10">This function checks if the validation</td>
288     </table>
289     <br>
290     </TD>
291     </TR>
292     </TABLE>
293     <hr>
294     <!-- ============ VARIABLE DETAIL =========== -->
295    
296     <A NAME='variable_detail'></A>
297     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
298     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
299     <TD>
300     <span CLASS="font12bold">Variable Detail</span>
301     <A HREF="#top" CLASS="links">^TOP</A>
302     </TD>
303     </TR>
304     </TABLE>
305    
306     <A NAME='var$_text'><!-- --></A><H3>$_text</H3> (line <span class="linenumber">34</span>)<br />
307     <b>Data type:</b> mixed<br>Holds the checkbox text
308     <br />
309    
310     <UL>
311     </UL>
312     <HR>
313     <hr>
314     <!-- ============ METHOD DETAIL =========== -->
315    
316     <A NAME='method_detail'></A>
317     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
318     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
319     <TD>
320     <span class="font12bold">Method Detail</span>
321     <A HREF="#top" CLASS="links">^TOP</A>
322     </TD>
323     </TR>
324     </TABLE>
325     <BR>
326     <DIV CLASS="function">
327     <A NAME='methodFECheckBox'><!-- --></A>
328     <SPAN CLASS="font12bold">Constructor FECheckBox</SPAN> (line <span class="linenumber">42</span>)
329     <BR>
330     <SPAN CLASS="font10bold">Usage : </SPAN>
331     <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
332     <span class="font10bold" style="color: #0000FF">FECheckBox(
333     label
334     $label, string
335     $text)</SPAN>
336     <BR>
337    
338     <BR>
339     <SPAN CLASS="font10bold">Description : </SPAN>
340     The constructor
341     <br />
342    
343     <DL>
344     <DT class="font10bold">Function Parameters:</DT>
345     <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>
346     <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">$text</SPAN></SPAN> text - checkbox text to be displayed</DD>
347    
348     <DT class="font10bold">Function Info:</DT>
349     </DL>
350     </DIV>
351     <BR>
352     <DIV CLASS="function">
353     <A NAME='methodget_element'><!-- --></A>
354     <SPAN CLASS="font12bold">get_element</SPAN> (line <span class="linenumber">70</span>)
355     <BR>
356     <SPAN CLASS="font10bold">Usage : </SPAN>
357     <span class="font10bold" style="color: #FF0000">object</SPAN>&nbsp;
358     <span class="font10bold" style="color: #0000FF">get_element(
359     )</SPAN>
360     <BR>
361    
362     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a> This function builds and returns the form element object
363     <BR>
364     <SPAN CLASS="font10bold">Description : </SPAN>
365     This function builds and returns the form element object
366     <br />
367    
368     <DL>
369    
370     <DT class="font10bold">Function Info:</DT>
371     </DL>
372     </DIV>
373     <BR>
374     <DIV CLASS="function">
375     <A NAME='methodget_value_text'><!-- --></A>
376     <SPAN CLASS="font12bold">get_value_text</SPAN> (line <span class="linenumber">60</span>)
377     <BR>
378     <SPAN CLASS="font10bold">Usage : </SPAN>
379     <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
380     <span class="font10bold" style="color: #0000FF">get_value_text(
381     mixed
382     $value)</SPAN>
383     <BR>
384    
385     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a> This provides a method
386     <BR>
387     <SPAN CLASS="font10bold">Description : </SPAN>
388     This provides a method
389     <br />
390     <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>
391     <DL>
392     <DT class="font10bold">Function Parameters:</DT>
393     <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>
394    
395     <DT class="font10bold">Function Info:</DT>
396     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the text associated</DD>
397     </DL>
398     </DIV>
399     <BR>
400     <div id="credit">
401     <hr>
402     Documention generated on Thu, 20 Feb 2003 16:22:42 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
403     </div>
404     </body>
405     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed