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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Sep 20 00:36:26 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.1: +381 -448 lines
File MIME type: text/html 
+ updated whole phphtmllib to v2.3.0
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 FEButton</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 FEButton</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 button FormElement which builds a input field of type=&quot;button&quot;. It has no validation method.</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 &lt;<a href="mailto:suren@bcsweb.com">mailto:suren@bcsweb.com</a>&gt;</p></li>
30     <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
31     </ul>
32     <p class="notes">
33     Located in <a class="field" href="_form_form_elements_FEButton_inc.html">Program_Root/form/form_elements/FEButton.inc</a> (line <span class="field">28</span>)
34     </p>
35    
36    
37     <pre><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a>
38 jonen 1.1 |
39     --<a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a>
40     |
41     --FEButton</pre>
42 jonen 1.2
43     </div>
44     </div>
45 jonen 1.1
46 jonen 1.2 <a name="sec-descendents"></a>
47     <div class="info-box">
48     <div class="info-box-title">Direct descendents</div>
49     <div class="nav-bar">
50     <a href="#sec-description">Description</a> |
51     <span class="disabled">Descendents</span>
52     | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
53     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
54    
55     </div>
56     <div class="info-box-body">
57     <table cellpadding="2" cellspacing="0" class="class-table">
58     <tr>
59     <th class="class-table-header">Class</th>
60     <th class="class-table-header">Description</th>
61 jonen 1.1 </tr>
62     <tr>
63 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html">FESubmitButton</a></td>
64     <td>
65     This is the SubmitButton FormElement which builds a input field of type=&quot;submit&quot;. It has no validation method.
66     </td>
67 jonen 1.1 </tr>
68     <tr>
69 jonen 1.2 <td style="padding-right: 2em"><a href="../../phpHtmlLib/FormProcessing/FEConfirmActionButton.html">FEConfirmActionButton</a></td>
70     <td>
71     This builds a button that will do a JS popup question, asking for yes/no. if yes, it submits the form.
72     </td>
73     </tr>
74 jonen 1.1 </table>
75 jonen 1.2 </div>
76     </div>
77 jonen 1.1
78 jonen 1.2 <a name="sec-var-summary"></a>
79     <div class="info-box">
80     <div class="info-box-title">Variable Summary</span></div>
81     <div class="nav-bar">
82     <a href="#sec-description">Description</a> |
83     <a href="#sec-descendents">Descendents</a> |
84     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
85     |
86     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
87    
88     </div>
89     <div class="info-box-body">
90     <div class="var-summary">
91     <div class="var-title">
92     <span class="var-type">mixed</span>
93     <a href="#$_action" title="details" class="var-name">$_action</a>
94     </div>
95     </div>
96     </div>
97     </div>
98 jonen 1.1
99 jonen 1.2 <a name="sec-method-summary"></a>
100     <div class="info-box">
101     <div class="info-box-title">Method Summary</span></div>
102     <div class="nav-bar">
103     <a href="#sec-description">Description</a> |
104     <a href="#sec-descendents">Descendents</a> |
105     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
106    
107     |
108     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
109     </div>
110     <div class="info-box-body">
111     <div class="method-summary">
112    
113     <div class="method-definition">
114     <span class="method-result">void</span>
115     <a href="#FEButton" title="details" class="method-name">FEButton</a>
116     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">NULL</span>])
117     </div>
118    
119     <div class="method-definition">
120     <span class="method-result">object</span>
121     <a href="#get_element" title="details" class="method-name">get_element</a>
122     ()
123     </div>
124    
125     <div class="method-definition">
126     <span class="method-result">string</span>
127     <a href="#onClick" title="details" class="method-name">onClick</a>
128     ()
129     </div>
130     </div>
131     </div>
132     </div>
133    
134     <a name="sec-vars"></a>
135     <div class="info-box">
136     <div class="info-box-title">Variables</div>
137     <div class="nav-bar">
138     <a href="#sec-description">Description</a> |
139     <a href="#sec-descendents">Descendents</a> |
140     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
141    
142    
143     |
144     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
145    
146     </div>
147     <div class="info-box-body">
148     <a name="var$_action" id="$_action"><!-- --></A>
149     <div class="evenrow">
150    
151     <div class="var-header">
152     <span class="var-title">
153     <span class="var-type">mixed</span>
154     <span class="var-name">$_action</span>
155     = <span class="var-default"> NULL</span> (line <span class="line-number">35</span>)
156     </span>
157     </div>
158 jonen 1.1
159 jonen 1.2 <!-- ========== Info from phpDoc block ========= -->
160     <p class="short-description">Holds the button action</p>
161    
162    
163    
164    
165 jonen 1.1
166 jonen 1.2 </div>
167     <h4>Inherited Variables</h4>
168     <A NAME='inherited_vars'><!-- --></A>
169     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
170     <blockquote>
171     <span class="var-title">
172     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br>
173     </span>
174     <span class="var-title">
175     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br>
176     </span>
177     </blockquote>
178     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
179     <blockquote>
180     <span class="var-title">
181     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
182     </span>
183     <span class="var-title">
184     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
185     </span>
186     <span class="var-title">
187     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
188     </span>
189     <span class="var-title">
190     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
191     </span>
192     <span class="var-title">
193     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
194     </span>
195     <span class="var-title">
196     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
197     </span>
198     <span class="var-title">
199     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
200     </span>
201     <span class="var-title">
202     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
203     </span>
204     <span class="var-title">
205     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
206     </span>
207     <span class="var-title">
208     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
209     </span>
210     <span class="var-title">
211     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
212     </span>
213     <span class="var-title">
214     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
215     </span>
216     </blockquote>
217    
218     </div>
219     </div>
220    
221     <a name="sec-methods"></a>
222     <div class="info-box">
223     <div class="info-box-title">Methods</div>
224     <div class="nav-bar">
225     <a href="#sec-description">Description</a> |
226     <a href="#sec-descendents">Descendents</a> |
227     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
228     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
229    
230     </div>
231     <div class="info-box-body">
232     <A NAME='method_detail'></A>
233     <a name="methodFEButton" id="FEButton"><!-- --></a>
234     <div class="oddrow">
235    
236     <div class="method-header">
237     <span class="method-title">Constructor FEButton</span> (line <span class="line-number">46</span>)
238     </div>
239    
240     <!-- ========== Info from phpDoc block ========= -->
241     <p class="short-description">The constructor</p>
242    
243     <div class="method-signature">
244     <span class="method-result">void</span>
245     <span class="method-name">
246     FEButton
247     </span>
248     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$action</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">NULL</span>])
249     </div>
250    
251     <ul class="parameters">
252     <li>
253     <span class="var-type">label</span>
254     <span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span> </li>
255     <li>
256     <span class="var-type">string</span>
257     <span class="var-name">$value</span><span class="var-description">: <p>value - button text</p></span> </li>
258     <li>
259     <span class="var-type">string</span>
260     <span class="var-name">$action</span><span class="var-description">: <p>action - action to perform</p></span> </li>
261     <li>
262     <span class="var-type">int</span>
263     <span class="var-name">$width</span><span class="var-description">: <p>required - element width in pixels (px), percentage (%) or elements (em)</p></span> </li>
264     <li>
265     <span class="var-type">int</span>
266     <span class="var-name">$height</span><span class="var-description">: <p>required - element height in pixels (px), percentage (%) or elements (em)</p></span> </li>
267     </ul>
268    
269    
270     </div>
271     <a name="methodget_element" id="get_element"><!-- --></a>
272     <div class="evenrow">
273    
274     <div class="method-header">
275     <span class="method-title">get_element</span> (line <span class="line-number">75</span>)
276     </div>
277    
278     <!-- ========== Info from phpDoc block ========= -->
279     <p class="short-description">This function builds and returns the form element object</p>
280    
281     <div class="method-signature">
282     <span class="method-result">object</span>
283     <span class="method-name">
284     get_element
285     </span>
286     ()
287     </div>
288    
289    
290     <hr class="separator" />
291     <div class="notes">Redefinition of:</div>
292 jonen 1.1 <dl>
293 jonen 1.2 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></dt>
294     <dd>This function builds and returns the form element object</dd>
295     </dl>
296    
297     <hr class="separator" />
298     <div class="notes">Redefined in descendants as:</div>
299     <ul class="redefinitions">
300     <li>
301     <a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodget_element">FESubmitButton::get_element()</a>
302     : This function builds and returns the form element object
303     </li>
304     </ul>
305     </div>
306     <a name="methodonClick" id="onClick"><!-- --></a>
307     <div class="oddrow">
308    
309     <div class="method-header">
310     <span class="method-title">onClick</span> (line <span class="line-number">60</span>)
311     </div>
312    
313     <!-- ========== Info from phpDoc block ========= -->
314     <p class="short-description">This function return the javaScript code for an onClick event</p>
315     <ul class="tags">
316     <li><span class="field">return:</span> <p>- javascript code</p></li>
317     </ul>
318    
319     <div class="method-signature">
320     <span class="method-result">string</span>
321     <span class="method-name">
322     onClick
323     </span>
324     ()
325     </div>
326    
327    
328     <hr class="separator" />
329     <div class="notes">Redefinition of:</div>
330 jonen 1.1 <dl>
331 jonen 1.2 <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></dt>
332     <dd>This function return the javaScript code for an onClick event</dd>
333     </dl>
334    
335     <hr class="separator" />
336     <div class="notes">Redefined in descendants as:</div>
337     <ul class="redefinitions">
338     <li>
339     <a href="../../phpHtmlLib/FormProcessing/FESubmitButton.html#methodonClick">FESubmitButton::onClick()</a>
340     : This function return the javaScript code for an onSubmit event
341     </li>
342     </ul>
343     </div>
344     <h4>Inherited Methods</h4>
345     <a name='inherited_methods'><!-- --></a>
346     <!-- =========== Summary =========== -->
347     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
348     <blockquote>
349     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br>
350     </blockquote>
351     <!-- =========== Summary =========== -->
352     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
353     <blockquote>
354     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
355     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
356     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
357     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
358     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
359     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
360     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
361     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
362     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
363     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
364     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
365     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
366     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
367     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
368     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
369     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
370     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
371     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
372     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
373     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
374     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
375     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
376     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
377     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
378     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
379     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
380     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
381     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
382     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
383     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
384     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
385     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
386     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
387     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
388     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
389     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
390     </blockquote>
391    
392     </div>
393     </div>
394    
395     <p class="notes" id="credit">
396     Documention generated on Thu, 31 Jul 2003 18:32:28 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
397 jonen 1.1 </p>
398 jonen 1.2 </div></body>
399 jonen 1.1 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed