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

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

Parent Directory Parent Directory | Revision Log Revision Log

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