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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Sep 20 00:36:27 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.1: +403 -441 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 FEDataList</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 FEDataList</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 DataList FormElement which builds a a complex FEBoxElement. 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_FEDataList_inc.html">Program_Root/form/form_elements/FEDataList.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     --FEDataList</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/FEListBox.html">FEListBox</a></td>
64     <td>
65     This is the ListBox FormElement which builds a select field with all of its options.
66     </td>
67 jonen 1.1 </tr>
68     </table>
69 jonen 1.2 </div>
70     </div>
71 jonen 1.1
72 jonen 1.2 <a name="sec-var-summary"></a>
73     <div class="info-box">
74     <div class="info-box-title">Variable Summary</span></div>
75     <div class="nav-bar">
76     <a href="#sec-description">Description</a> |
77     <a href="#sec-descendents">Descendents</a> |
78     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
79     |
80     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
81    
82     </div>
83     <div class="info-box-body">
84     <div class="var-summary">
85     <div class="var-title">
86     <span class="var-type">mixed</span>
87     <a href="#$_data_list" title="details" class="var-name">$_data_list</a>
88     </div>
89     </div>
90     </div>
91     </div>
92 jonen 1.1
93 jonen 1.2 <a name="sec-method-summary"></a>
94     <div class="info-box">
95     <div class="info-box-title">Method Summary</span></div>
96     <div class="nav-bar">
97     <a href="#sec-description">Description</a> |
98     <a href="#sec-descendents">Descendents</a> |
99     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
100    
101     |
102     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
103     </div>
104     <div class="info-box-body">
105     <div class="method-summary">
106    
107     <div class="method-definition">
108     <span class="method-result">void</span>
109     <a href="#FEDataList" title="details" class="method-name">FEDataList</a>
110     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">array</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>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
111     </div>
112    
113     <div class="method-definition">
114     <span class="method-result">string</span>
115     <a href="#get_value_text" title="details" class="method-name">get_value_text</a>
116     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
117     </div>
118    
119     <div class="method-definition">
120     <span class="method-result">void</span>
121     <a href="#set_list_data" title="details" class="method-name">set_list_data</a>
122     ([<span class="var-type">array</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
123     </div>
124    
125     <div class="method-definition">
126     <span class="method-result">void</span>
127     <a href="#validate" title="details" class="method-name">validate</a>
128     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
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$_data_list" id="$_data_list"><!-- --></A>
149     <div class="oddrow">
150    
151     <div class="var-header">
152     <span class="var-title">
153     <span class="var-type">mixed</span>
154     <span class="var-name">$_data_list</span>
155     = <span class="var-default">array()</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 list of available</p>
161     <p class="description"><p>data elements</p></p>
162    
163    
164    
165    
166 jonen 1.1
167 jonen 1.2 </div>
168     <h4>Inherited Variables</h4>
169     <A NAME='inherited_vars'><!-- --></A>
170     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
171     <blockquote>
172     <span class="var-title">
173     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_height">FEBoxElement::$_height</a></span><br>
174     </span>
175     <span class="var-title">
176     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#var$_width">FEBoxElement::$_width</a></span><br>
177     </span>
178     </blockquote>
179     <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
180     <blockquote>
181     <span class="var-title">
182     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_attributes">FormElement::$_attributes</a></span><br>
183     </span>
184     <span class="var-title">
185     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_element_name">FormElement::$_element_name</a></span><br>
186     </span>
187     <span class="var-title">
188     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_errors">FormElement::$_errors</a></span><br>
189     </span>
190     <span class="var-title">
191     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_error_message">FormElement::$_error_message</a></span><br>
192     </span>
193     <span class="var-title">
194     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_form_name">FormElement::$_form_name</a></span><br>
195     </span>
196     <span class="var-title">
197     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_has_error">FormElement::$_has_error</a></span><br>
198     </span>
199     <span class="var-title">
200     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_disabled">FormElement::$_is_disabled</a></span><br>
201     </span>
202     <span class="var-title">
203     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_is_required">FormElement::$_is_required</a></span><br>
204     </span>
205     <span class="var-title">
206     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_label_text">FormElement::$_label_text</a></span><br>
207     </span>
208     <span class="var-title">
209     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_stripslashes">FormElement::$_stripslashes</a></span><br>
210     </span>
211     <span class="var-title">
212     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_style_attributes">FormElement::$_style_attributes</a></span><br>
213     </span>
214     <span class="var-title">
215     <span class="var-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#var$_value">FormElement::$_value</a></span><br>
216     </span>
217     </blockquote>
218    
219     </div>
220     </div>
221    
222     <a name="sec-methods"></a>
223     <div class="info-box">
224     <div class="info-box-title">Methods</div>
225     <div class="nav-bar">
226     <a href="#sec-description">Description</a> |
227     <a href="#sec-descendents">Descendents</a> |
228     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
229     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
230    
231     </div>
232     <div class="info-box-body">
233     <A NAME='method_detail'></A>
234     <a name="methodFEDataList" id="FEDataList"><!-- --></a>
235     <div class="evenrow">
236    
237     <div class="method-header">
238     <span class="method-title">Constructor FEDataList</span> (line <span class="line-number">45</span>)
239     </div>
240    
241     <!-- ========== Info from phpDoc block ========= -->
242     <p class="short-description">The constructor</p>
243    
244     <div class="method-signature">
245     <span class="method-result">void</span>
246     <span class="method-name">
247     FEDataList
248     </span>
249     (<span class="var-type">label</span>&nbsp;<span class="var-name">$label</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">TRUE</span>], [<span class="var-type">array</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>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
250     </div>
251    
252     <ul class="parameters">
253     <li>
254     <span class="var-type">label</span>
255     <span class="var-name">$label</span><span class="var-description">: <p>string - text label for the element</p></span> </li>
256     <li>
257     <span class="var-type">bool</span>
258     <span class="var-name">$required</span><span class="var-description">: <p>required - is this a required element</p></span> </li>
259     <li>
260     <span class="var-type">array</span>
261     <span class="var-name">$width</span><span class="var-description">: <p>data_list - list of data elements (name=&gt;value)</p></span> </li>
262     <li>
263     <span class="var-type">int</span>
264     <span class="var-name">$height</span><span class="var-description">: <p>required - element width in characters, pixels (px), percentage (%) or elements (em)</p></span> </li>
265     </ul>
266    
267    
268     </div>
269     <a name="methodget_value_text" id="get_value_text"><!-- --></a>
270     <div class="oddrow">
271    
272     <div class="method-header">
273     <span class="method-title">get_value_text</span> (line <span class="line-number">74</span>)
274     </div>
275    
276     <!-- ========== Info from phpDoc block ========= -->
277     <p class="short-description">This provides a method</p>
278     <p class="description"><p>for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation</p></p>
279     <ul class="tags">
280     <li><span class="field">return:</span> <p>- the text associated</p></li>
281     </ul>
282    
283     <div class="method-signature">
284     <span class="method-result">string</span>
285     <span class="method-name">
286     get_value_text
287     </span>
288     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
289     </div>
290    
291     <ul class="parameters">
292     <li>
293     <span class="var-type">mixed</span>
294     <span class="var-name">$value</span><span class="var-description">: <p>- the value to look up</p></span> </li>
295     </ul>
296    
297     <hr class="separator" />
298     <div class="notes">Redefinition of:</div>
299     <dl>
300     <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></dt>
301     <dd>This provides a method</dd>
302     </dl>
303    
304     </div>
305     <a name="methodset_list_data" id="set_list_data"><!-- --></a>
306     <div class="evenrow">
307    
308     <div class="method-header">
309     <span class="method-title">set_list_data</span> (line <span class="line-number">56</span>)
310     </div>
311    
312     <!-- ========== Info from phpDoc block ========= -->
313     <p class="short-description">This function sets the array of data to be used in the data list</p>
314    
315     <div class="method-signature">
316     <span class="method-result">void</span>
317     <span class="method-name">
318     set_list_data
319     </span>
320     ([<span class="var-type">array</span>&nbsp;<span class="var-name">$data_list</span> = <span class="var-default">array()</span>])
321     </div>
322    
323     <ul class="parameters">
324     <li>
325     <span class="var-type">array</span>
326     <span class="var-name">$data_list</span><span class="var-description">: <p>data_list - list of data elements (name=&gt;value)</p></span> </li>
327     </ul>
328    
329    
330     </div>
331     <a name="methodvalidate" id="validate"><!-- --></a>
332     <div class="oddrow">
333    
334     <div class="method-header">
335     <span class="method-title">validate</span> (line <span class="line-number">91</span>)
336     </div>
337    
338     <!-- ========== Info from phpDoc block ========= -->
339     <p class="short-description">This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation</p>
340    
341     <div class="method-signature">
342     <span class="method-result">void</span>
343     <span class="method-name">
344     validate
345     </span>
346     (<span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>&nbsp;<span class="var-name">&$_FormValidation</span>)
347     </div>
348    
349     <ul class="parameters">
350     <li>
351     <span class="var-type"><a href="../../phpHtmlLib/FormProcessing/FormValidation.html">FormValidation</a></span>
352     <span class="var-name">&$_FormValidation</span><span class="var-description">: <p>object</p></span> </li>
353     </ul>
354    
355     <hr class="separator" />
356     <div class="notes">Redefinition of:</div>
357     <dl>
358     <dt><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></dt>
359     <dd>This function performs the actual validation It is called only if the validation is required by this element</dd>
360     </dl>
361    
362     </div>
363     <h4>Inherited Methods</h4>
364     <a name='inherited_methods'><!-- --></a>
365     <!-- =========== Summary =========== -->
366     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html">FEBoxElement</a></span></p>
367     <blockquote>
368     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FEBoxElement.html#methodFEBoxElement">FEBoxElement::FEBoxElement()</a></span><br>
369     </blockquote>
370     <!-- =========== Summary =========== -->
371     <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/FormProcessing/FormElement.html">FormElement</a></span></p>
372     <blockquote>
373     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodFormElement">FormElement::FormElement()</a></span><br>
374     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodcreate_element_name">FormElement::create_element_name()</a></span><br>
375     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_attribute">FormElement::get_attribute()</a></span><br>
376     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element">FormElement::get_element()</a></span><br>
377     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_element_name">FormElement::get_element_name()</a></span><br>
378     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_errors">FormElement::get_errors()</a></span><br>
379     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_error_message">FormElement::get_error_message()</a></span><br>
380     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_init_value">FormElement::get_init_value()</a></span><br>
381     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label">FormElement::get_label()</a></span><br>
382     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_label_text">FormElement::get_label_text()</a></span><br>
383     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_required_symbol">FormElement::get_required_symbol()</a></span><br>
384     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value">FormElement::get_value()</a></span><br>
385     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodget_value_text">FormElement::get_value_text()</a></span><br>
386     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodhas_error">FormElement::has_error()</a></span><br>
387     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_disabled">FormElement::is_disabled()</a></span><br>
388     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodis_required">FormElement::is_required()</a></span><br>
389     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodjavascript">FormElement::javascript()</a></span><br>
390     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonBlur">FormElement::onBlur()</a></span><br>
391     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonChange">FormElement::onChange()</a></span><br>
392     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonClick">FormElement::onClick()</a></span><br>
393     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonFocus">FormElement::onFocus()</a></span><br>
394     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodonSubmit">FormElement::onSubmit()</a></span><br>
395     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_attribute">FormElement::set_attribute()</a></span><br>
396     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_disabled">FormElement::set_disabled()</a></span><br>
397     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_error_message">FormElement::set_error_message()</a></span><br>
398     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_form_name">FormElement::set_form_name()</a></span><br>
399     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_label_text">FormElement::set_label_text()</a></span><br>
400     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_required">FormElement::set_required()</a></span><br>
401     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_stripslashes">FormElement::set_stripslashes()</a></span><br>
402     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_style_attribute">FormElement::set_style_attribute()</a></span><br>
403     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_title">FormElement::set_title()</a></span><br>
404     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodset_value">FormElement::set_value()</a></span><br>
405     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#methodvalidate">FormElement::validate()</a></span><br>
406     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_element_attributes">FormElement::_build_element_attributes()</a></span><br>
407     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_build_javascript">FormElement::_build_javascript()</a></span><br>
408     <span class="method-name"><a href="../../phpHtmlLib/FormProcessing/FormElement.html#method_do_validation">FormElement::_do_validation()</a></span><br>
409     </blockquote>
410    
411     </div>
412 jonen 1.1 </div>
413 jonen 1.2
414     <p class="notes" id="credit">
415     Documention generated on Thu, 31 Jul 2003 18:32:30 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
416     </p>
417     </div></body>
418 jonen 1.1 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed