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