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