1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
4 |
<head> |
5 |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<title>Docs For Class FEBoxElement</title> |
7 |
<link rel="stylesheet" href="../../media/stylesheet.css" /> |
8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
9 |
</head> |
10 |
<body> |
11 |
<div class="page-body"> |
12 |
|
13 |
<h2 class="class-name">Class FEBoxElement</h2> |
14 |
|
15 |
<a name="sec-description"></a> |
16 |
<div class="info-box"> |
17 |
<div class="info-box-title">Description</div> |
18 |
<div class="nav-bar"> |
19 |
<span class="disabled">Description</span> | |
20 |
<a href="#sec-descendents">Descendents</a> |
21 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
22 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
23 |
|
24 |
</div> |
25 |
<div class="info-box-body"> |
26 |
<!-- ========== Info from phpDoc block ========= --> |
27 |
<p class="short-description">This is the Box FormElement which builds a DIV with a width and a height. It is a base class for more complicated FormElements.</p> |
28 |
<ul class="tags"> |
29 |
<li><span class="field">copyright:</span> LGPL - See LICENCE</li> |
30 |
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> |
31 |
<li><span class="field">author:</span> Suren Markossian <<a href="mailto:suren@bcsweb.com">suren@bcsweb.com</a>></li> |
32 |
</ul> |
33 |
<p class="notes"> |
34 |
Located in <a class="field" href="_form_form_elements_FEBoxElement_inc.html">/form/form_elements/FEBoxElement.inc</a> (line <span class="field">29</span>) |
35 |
</p> |
36 |
|
37 |
|
38 |
<pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a> |
39 |
| |
40 |
--FEBoxElement</pre> |
41 |
|
42 |
</div> |
43 |
</div> |
44 |
|
45 |
<a name="sec-descendents"></a> |
46 |
<div class="info-box"> |
47 |
<div class="info-box-title">Direct descendents</div> |
48 |
<div class="nav-bar"> |
49 |
<a href="#sec-description">Description</a> | |
50 |
<span class="disabled">Descendents</span> |
51 |
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
52 |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
53 |
|
54 |
</div> |
55 |
<div class="info-box-body"> |
56 |
<table cellpadding="2" cellspacing="0" class="class-table"> |
57 |
<tr> |
58 |
<th class="class-table-header">Class</th> |
59 |
<th class="class-table-header">Description</th> |
60 |
</tr> |
61 |
<tr> |
62 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEButton.html">FEButton</a></td> |
63 |
<td> |
64 |
This is the button FormElement which builds a input field of type="button". It has no validation method. |
65 |
</td> |
66 |
</tr> |
67 |
<tr> |
68 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDataList.html">FEDataList</a></td> |
69 |
<td> |
70 |
This is the DataList FormElement which builds a a complex FEBoxElement. It has no validation method. |
71 |
</td> |
72 |
</tr> |
73 |
<tr> |
74 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEDate.html">FEDate</a></td> |
75 |
<td> |
76 |
This class builds a FEDataList that shows a group of select boxes (FEYears, FEMonths, FEDays) representing a date. |
77 |
</td> |
78 |
</tr> |
79 |
<tr> |
80 |
<td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FETextArea.html">FETextArea</a></td> |
81 |
<td> |
82 |
This is the TextArea FormElement which builds a textarea field. It has no validation method. |
83 |
</td> |
84 |
</tr> |
85 |
</table> |
86 |
</div> |
87 |
</div> |
88 |
|
89 |
|
90 |
<a name="sec-var-summary"></a> |
91 |
<div class="info-box"> |
92 |
<div class="info-box-title">Variable Summary</span></div> |
93 |
<div class="nav-bar"> |
94 |
<a href="#sec-description">Description</a> | |
95 |
<a href="#sec-descendents">Descendents</a> | |
96 |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
97 |
| |
98 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
99 |
|
100 |
</div> |
101 |
<div class="info-box-body"> |
102 |
<div class="var-summary"> |
103 |
<div class="var-title"> |
104 |
<span class="var-type">mixed</span> |
105 |
<a href="#$_height" title="details" class="var-name">$_height</a> |
106 |
</div> |
107 |
<div class="var-title"> |
108 |
<span class="var-type">mixed</span> |
109 |
<a href="#$_width" title="details" class="var-name">$_width</a> |
110 |
</div> |
111 |
</div> |
112 |
</div> |
113 |
</div> |
114 |
|
115 |
<a name="sec-method-summary"></a> |
116 |
<div class="info-box"> |
117 |
<div class="info-box-title">Method Summary</span></div> |
118 |
<div class="nav-bar"> |
119 |
<a href="#sec-description">Description</a> | |
120 |
<a href="#sec-descendents">Descendents</a> | |
121 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
122 |
|
123 |
| |
124 |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
125 |
</div> |
126 |
<div class="info-box-body"> |
127 |
<div class="method-summary"> |
128 |
|
129 |
<div class="method-definition"> |
130 |
<span class="method-result">FEBoxElement</span> |
131 |
<a href="#FEBoxElement" title="details" class="method-name">FEBoxElement</a> |
132 |
(<span class="var-type">label</span> <span class="var-name">$label</span>, [<span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">NULL</span>]) |
133 |
</div> |
134 |
</div> |
135 |
</div> |
136 |
</div> |
137 |
|
138 |
<a name="sec-vars"></a> |
139 |
<div class="info-box"> |
140 |
<div class="info-box-title">Variables</div> |
141 |
<div class="nav-bar"> |
142 |
<a href="#sec-description">Description</a> | |
143 |
<a href="#sec-descendents">Descendents</a> | |
144 |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
145 |
|
146 |
|
147 |
| |
148 |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
149 |
|
150 |
</div> |
151 |
<div class="info-box-body"> |
152 |
<a name="var$_height" id="$_height"><!-- --></A> |
153 |
<div class="oddrow"> |
154 |
|
155 |
<div class="var-header"> |
156 |
<span class="var-title"> |
157 |
<span class="var-type">mixed</span> |
158 |
<span class="var-name">$_height</span> |
159 |
= <span class="var-default"> NULL</span> (line <span class="line-number">41</span>) |
160 |
</span> |
161 |
</div> |
162 |
|
163 |
<!-- ========== Info from phpDoc block ========= --> |
164 |
<p class="short-description">Holds the height of the element</p> |
165 |
|
166 |
|
167 |
|
168 |
|
169 |
|
170 |
</div> |
171 |
<a name="var$_width" id="$_width"><!-- --></A> |
172 |
<div class="evenrow"> |
173 |
|
174 |
<div class="var-header"> |
175 |
<span class="var-title"> |
176 |
<span class="var-type">mixed</span> |
177 |
<span class="var-name">$_width</span> |
178 |
= <span class="var-default"> NULL</span> (line <span class="line-number">35</span>) |
179 |
</span> |
180 |
</div> |
181 |
|
182 |
<!-- ========== Info from phpDoc block ========= --> |
183 |
<p class="short-description">Holds the width of the element</p> |
184 |
|
185 |
|
186 |
|
187 |
|
188 |
|
189 |
</div> |
190 |
|
191 |
<h4>Inherited Variables</h4> |
192 |
<A NAME='inherited_vars'><!-- --></A> |
193 |
<p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
194 |
<blockquote> |
195 |
<span class="var-title"> |
196 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br> |
197 |
</span> |
198 |
<span class="var-title"> |
199 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br> |
200 |
</span> |
201 |
<span class="var-title"> |
202 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br> |
203 |
</span> |
204 |
<span class="var-title"> |
205 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br> |
206 |
</span> |
207 |
<span class="var-title"> |
208 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br> |
209 |
</span> |
210 |
<span class="var-title"> |
211 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br> |
212 |
</span> |
213 |
<span class="var-title"> |
214 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_form_on_submit">FormElement::$_has_form_on_submit</a></span><br> |
215 |
</span> |
216 |
<span class="var-title"> |
217 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br> |
218 |
</span> |
219 |
<span class="var-title"> |
220 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br> |
221 |
</span> |
222 |
<span class="var-title"> |
223 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br> |
224 |
</span> |
225 |
<span class="var-title"> |
226 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_required_field_marker">FormElement::$_required_field_marker</a></span><br> |
227 |
</span> |
228 |
<span class="var-title"> |
229 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_slave_elements">FormElement::$_slave_elements</a></span><br> |
230 |
</span> |
231 |
<span class="var-title"> |
232 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br> |
233 |
</span> |
234 |
<span class="var-title"> |
235 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br> |
236 |
</span> |
237 |
<span class="var-title"> |
238 |
<span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br> |
239 |
</span> |
240 |
</blockquote> |
241 |
|
242 |
</div> |
243 |
</div> |
244 |
|
245 |
<a name="sec-methods"></a> |
246 |
<div class="info-box"> |
247 |
<div class="info-box-title">Methods</div> |
248 |
<div class="nav-bar"> |
249 |
<a href="#sec-description">Description</a> | |
250 |
<a href="#sec-descendents">Descendents</a> | |
251 |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
252 |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
253 |
|
254 |
</div> |
255 |
<div class="info-box-body"> |
256 |
<A NAME='method_detail'></A> |
257 |
<a name="methodFEBoxElement" id="FEBoxElement"><!-- --></a> |
258 |
<div class="oddrow"> |
259 |
|
260 |
<div class="method-header"> |
261 |
<span class="method-title">Constructor FEBoxElement</span> (line <span class="line-number">51</span>) |
262 |
</div> |
263 |
|
264 |
<!-- ========== Info from phpDoc block ========= --> |
265 |
<p class="short-description">The constructor</p> |
266 |
|
267 |
<div class="method-signature"> |
268 |
<span class="method-result">FEBoxElement</span> |
269 |
<span class="method-name"> |
270 |
FEBoxElement |
271 |
</span> |
272 |
(<span class="var-type">label</span> <span class="var-name">$label</span>, [<span class="var-type">bool</span> <span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$height</span> = <span class="var-default">NULL</span>]) |
273 |
</div> |
274 |
|
275 |
<ul class="parameters"> |
276 |
<li> |
277 |
<span class="var-type">label</span> |
278 |
<span class="var-name">$label</span><span class="var-description">: string - text label for the element</span> </li> |
279 |
<li> |
280 |
<span class="var-type">bool</span> |
281 |
<span class="var-name">$required</span><span class="var-description">: required - is this a required element</span> </li> |
282 |
<li> |
283 |
<span class="var-type">int</span> |
284 |
<span class="var-name">$width</span><span class="var-description">: required - element width in pixels (px), percentage (%) or elements (em)</span> </li> |
285 |
<li> |
286 |
<span class="var-type">int</span> |
287 |
<span class="var-name">$height</span><span class="var-description">: required - element height in pixels (px), percentage (%) or elements (em)</span> </li> |
288 |
</ul> |
289 |
|
290 |
|
291 |
</div> |
292 |
<h4>Inherited Methods</h4> |
293 |
<a name='inherited_methods'><!-- --></a> |
294 |
<!-- =========== Summary =========== --> |
295 |
<p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p> |
296 |
<blockquote> |
297 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br> |
298 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br> |
299 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodform_tag_onsubmit">FormElement::form_tag_onsubmit()</a></span><br> |
300 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br> |
301 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_confirm_element">FormElement::get_confirm_element()</a></span><br> |
302 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br> |
303 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br> |
304 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br> |
305 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br> |
306 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br> |
307 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br> |
308 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br> |
309 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br> |
310 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_slave_elements">FormElement::get_slave_elements()</a></span><br> |
311 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_tabindex">FormElement::get_tabindex()</a></span><br> |
312 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br> |
313 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br> |
314 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br> |
315 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br> |
316 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br> |
317 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br> |
318 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br> |
319 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br> |
320 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br> |
321 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br> |
322 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br> |
323 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br> |
324 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_data_all_slaves">FormElement::set_data_all_slaves()</a></span><br> |
325 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br> |
326 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_element_name">FormElement::set_element_name()</a></span><br> |
327 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br> |
328 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br> |
329 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br> |
330 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br> |
331 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required_symbol">FormElement::set_required_symbol()</a></span><br> |
332 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_data">FormElement::set_slave_data()</a></span><br> |
333 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_slave_elements">FormElement::set_slave_elements()</a></span><br> |
334 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br> |
335 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br> |
336 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_tabindex">FormElement::set_tabindex()</a></span><br> |
337 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br> |
338 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br> |
339 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br> |
340 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br> |
341 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br> |
342 |
<span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br> |
343 |
</blockquote> |
344 |
|
345 |
</div> |
346 |
</div> |
347 |
|
348 |
|
349 |
<p class="notes" id="credit"> |
350 |
Documentation generated on Thu, 1 Apr 2004 09:38:17 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
351 |
</p> |
352 |
</div></body> |
353 |
</html> |