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

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/FormProcessing/FEBoxElement.html

Parent Directory Parent Directory | Revision Log Revision Log

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