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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (hide annotations)
Sat Sep 20 00:24:00 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.2: +565 -519 lines
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

1 jonen 1.3 <?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 BaseWidget</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 BaseWidget</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 base widget class, that all widgets are based off of. It provides some basic members and methods</p>
27     <ul class="tags">
28     <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>
29     </ul>
30     <p class="notes">
31     Located in <a class="field" href="_widgets_BaseWidget_inc.html">Program_Root/widgets/BaseWidget.inc</a> (line <span class="field">21</span>)
32     </p>
33    
34    
35     <pre><a href="../phpHtmlLib/Container.html">Container</a>
36 jonen 1.1 |
37     --BaseWidget</pre>
38 jonen 1.3
39     </div>
40     </div>
41    
42     <a name="sec-descendents"></a>
43     <div class="info-box">
44     <div class="info-box-title">Direct descendents</div>
45     <div class="nav-bar">
46     <a href="#sec-description">Description</a> |
47     <span class="disabled">Descendents</span>
48     | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
49     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50    
51     </div>
52     <div class="info-box-body">
53     <table cellpadding="2" cellspacing="0" class="class-table">
54     <tr>
55     <th class="class-table-header">Class</th>
56     <th class="class-table-header">Description</th>
57     </tr>
58     <tr>
59     <td style="padding-right: 2em"><a href="../phpHtmlLib/ActiveTab.html">ActiveTab</a></td>
60     <td>
61     This class is used for creating a tab panel of content where the tabs can be switched on the fly w/ JS, thereby eliminating a page turn to see the other tab's content.
62     </td>
63     </tr>
64     <tr>
65     <td style="padding-right: 2em"><a href="../phpHtmlLib/FooterNav.html">FooterNav</a></td>
66     <td>
67     Use this class to render footer navigation that is displayed at the bottom of a page.
68     </td>
69     </tr>
70     <tr>
71     <td style="padding-right: 2em"><a href="../phpHtmlLib/ImageThumbnailWidget.html">ImageThumbnailWidget</a></td>
72     <td>
73     This widget creates a N by x visual table of thumbnails.
74     </td>
75     </tr>
76     <tr>
77     <td style="padding-right: 2em"><a href="../phpHtmlLib/InfoTable.html">InfoTable</a></td>
78     <td>
79     This is a widget class that can build and render data in a nicely formated table with a title, column headers and data
80     </td>
81     </tr>
82     <tr>
83     <td style="padding-right: 2em"><a href="../phpHtmlLib/NavTable.html">NavTable</a></td>
84     <td>
85     This builds a navigational table widget that has a title, any # of subtitles and then navigational links.
86     </td>
87     </tr>
88     <tr>
89     <td style="padding-right: 2em"><a href="../phpHtmlLib/TextCSSNav.html">TextCSSNav</a></td>
90     <td>
91     This class builds a simple text navigational widget.
92     </td>
93     </tr>
94     <tr>
95     <td style="padding-right: 2em"><a href="../phpHtmlLib/SVG/SVGGraph.html">SVGGraph</a></td>
96     <td>
97     This is the base Graph class for doing SVG graphs
98     </td>
99     </tr>
100     <tr>
101     <td style="padding-right: 2em"><a href="../phpHtmlLib/RoundTitleTable.html">RoundTitleTable</a></td>
102     <td>
103     This builds a table widget that has a nice rounded title, a subtitle area and any amount of data.
104     </td>
105     </tr>
106     <tr>
107     <td style="padding-right: 2em"><a href="../phpHtmlLib/TextNav.html">TextNav</a></td>
108     <td>
109     This class builds a simple text navigational widget.
110     </td>
111     </tr>
112     <tr>
113     <td style="padding-right: 2em"><a href="../phpHtmlLib/TreeNav.html">TreeNav</a></td>
114     <td>
115     This class tries to build a tree navigational widget.
116     </td>
117     </tr>
118 jonen 1.2 <tr>
119 jonen 1.3 <td style="padding-right: 2em"><a href="../phpHtmlLib/VerticalCSSNavTable.html">VerticalCSSNavTable</a></td>
120     <td>
121     This class builds a nice table that conains clickable cells.
122     </td>
123     </tr>
124 jonen 1.2 <tr>
125 jonen 1.3 <td style="padding-right: 2em"><a href="../phpHtmlLib/DataList.html">DataList</a></td>
126     <td>
127     This object is the base class that can be
128     </td>
129     </tr>
130 jonen 1.2 <tr>
131 jonen 1.3 <td style="padding-right: 2em"><a href="../phpHtmlLib/CSSContainer.html">CSSContainer</a></td>
132     <td>
133     This class is a container for CSSBuilder objects. It is meant to make the theming of many CSSBuilder objects easy to manage.
134     </td>
135     </tr>
136 jonen 1.2 </table>
137 jonen 1.3 </div>
138     </div>
139    
140     <a name="sec-var-summary"></a>
141     <div class="info-box">
142     <div class="info-box-title">Variable Summary</span></div>
143     <div class="nav-bar">
144     <a href="#sec-description">Description</a> |
145     <a href="#sec-descendents">Descendents</a> |
146     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
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     <div class="var-summary">
153     <div class="var-title">
154     <span class="var-type">string</span>
155     <a href="#$title" title="details" class="var-name">$title</a>
156     </div>
157     <div class="var-title">
158     <span class="var-type">string</span>
159     <a href="#$width" title="details" class="var-name">$width</a>
160     </div>
161     </div>
162     </div>
163     </div>
164    
165     <a name="sec-method-summary"></a>
166     <div class="info-box">
167     <div class="info-box-title">Method Summary</span></div>
168     <div class="nav-bar">
169     <a href="#sec-description">Description</a> |
170     <a href="#sec-descendents">Descendents</a> |
171     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
172    
173     |
174     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
175     </div>
176     <div class="info-box-body">
177     <div class="method-summary">
178    
179     <div class="method-definition">
180     <span class="method-result">string</span>
181     <a href="#get_align" title="details" class="method-name">get_align</a>
182     ()
183     </div>
184    
185     <div class="method-definition">
186     <span class="method-result">string</span>
187     <a href="#get_css" title="details" class="method-name">get_css</a>
188     ()
189     </div>
190    
191     <div class="method-definition">
192     <span class="method-result">string</span>
193     <a href="#get_javascript" title="details" class="method-name">get_javascript</a>
194     ()
195     </div>
196    
197     <div class="method-definition">
198     <span class="method-result">string</span>
199     <a href="#get_title" title="details" class="method-name">get_title</a>
200     ()
201     </div>
202    
203     <div class="method-definition">
204     <span class="method-result">string</span>
205     <a href="#get_width" title="details" class="method-name">get_width</a>
206     ()
207     </div>
208    
209     <div class="method-definition">
210     <span class="method-result">void</span>
211     <a href="#set_align" title="details" class="method-name">set_align</a>
212     (<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span>)
213     </div>
214    
215     <div class="method-definition">
216     <span class="method-result">void</span>
217     <a href="#set_title" title="details" class="method-name">set_title</a>
218     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
219     </div>
220    
221     <div class="method-definition">
222     <span class="method-result">void</span>
223     <a href="#set_width" title="details" class="method-name">set_width</a>
224     (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
225     </div>
226     </div>
227     </div>
228     </div>
229    
230     <a name="sec-vars"></a>
231     <div class="info-box">
232     <div class="info-box-title">Variables</div>
233     <div class="nav-bar">
234     <a href="#sec-description">Description</a> |
235     <a href="#sec-descendents">Descendents</a> |
236     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
237    
238    
239     |
240     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
241    
242     </div>
243     <div class="info-box-body">
244     <a name="var$title" id="$title"><!-- --></A>
245     <div class="evenrow">
246    
247     <div class="var-header">
248     <span class="var-title">
249     <span class="var-type">string</span>
250     <span class="var-name">$title</span>
251     = <span class="var-default">''</span> (line <span class="line-number">35</span>)
252     </span>
253     </div>
254    
255     <!-- ========== Info from phpDoc block ========= -->
256     <p class="short-description">The title of the table.</p>
257     <ul class="tags">
258     <li><span class="field">access:</span> public</li>
259     </ul>
260    
261    
262    
263    
264    
265     </div>
266     <a name="var$width" id="$width"><!-- --></A>
267     <div class="oddrow">
268    
269     <div class="var-header">
270     <span class="var-title">
271     <span class="var-type">string</span>
272     <span class="var-name">$width</span>
273     = <span class="var-default">&quot;100%&quot;</span> (line <span class="line-number">42</span>)
274     </span>
275     </div>
276    
277     <!-- ========== Info from phpDoc block ========= -->
278     <p class="short-description">the width of the widget</p>
279     <ul class="tags">
280     <li><span class="field">access:</span> public</li>
281     </ul>
282    
283    
284    
285    
286 jonen 1.2
287 jonen 1.3 </div>
288     <h4>Inherited Variables</h4>
289     <A NAME='inherited_vars'><!-- --></A>
290     <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
291     <blockquote>
292     <span class="var-title">
293     <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>
294     </span>
295     </blockquote>
296    
297     </div>
298     </div>
299    
300     <a name="sec-methods"></a>
301     <div class="info-box">
302     <div class="info-box-title">Methods</div>
303     <div class="nav-bar">
304     <a href="#sec-description">Description</a> |
305     <a href="#sec-descendents">Descendents</a> |
306     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
307     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
308    
309     </div>
310     <div class="info-box-body">
311     <A NAME='method_detail'></A>
312     <a name="methodget_align" id="get_align"><!-- --></a>
313     <div class="evenrow">
314    
315     <div class="method-header">
316     <span class="method-title">get_align</span> (line <span class="line-number">145</span>)
317     </div>
318    
319     <!-- ========== Info from phpDoc block ========= -->
320     <p class="short-description">This gets the alignment value for the outer table</p>
321     <ul class="tags">
322     <li><span class="field">return:</span> <p>- the alignment</p></li>
323     </ul>
324    
325     <div class="method-signature">
326     <span class="method-result">string</span>
327     <span class="method-name">
328     get_align
329     </span>
330     ()
331     </div>
332    
333    
334    
335     </div>
336     <a name="methodget_css" id="get_css"><!-- --></a>
337     <div class="oddrow">
338    
339     <div class="method-header">
340     <span class="method-title">get_css</span> (line <span class="line-number">80</span>)
341     </div>
342    
343     <!-- ========== Info from phpDoc block ========= -->
344     <p class="short-description">This function provides the mechanism to build and return the css needed by this widget</p>
345     <ul class="tags">
346     <li><span class="field">return:</span> <p>the raw css</p></li>
347     </ul>
348    
349     <div class="method-signature">
350     <span class="method-result">string</span>
351     <span class="method-name">
352     get_css
353     </span>
354     ()
355     </div>
356    
357    
358    
359     </div>
360     <a name="methodget_javascript" id="get_javascript"><!-- --></a>
361     <div class="evenrow">
362    
363     <div class="method-header">
364     <span class="method-title">get_javascript</span> (line <span class="line-number">69</span>)
365     </div>
366    
367     <!-- ========== Info from phpDoc block ========= -->
368     <p class="short-description">Function for returning the raw javascript that is required for this widget.</p>
369     <ul class="tags">
370     <li><span class="field">return:</span> <p>- the raw javascript</p></li>
371     </ul>
372    
373     <div class="method-signature">
374     <span class="method-result">string</span>
375     <span class="method-name">
376     get_javascript
377     </span>
378     ()
379     </div>
380    
381    
382    
383     <hr class="separator" />
384     <div class="notes">Redefined in descendants as:</div>
385     <ul class="redefinitions">
386     <li>
387     <a href="../phpHtmlLib/ActiveTab.html#methodget_javascript">ActiveTab::get_javascript()</a>
388     : This function MUST be called AFTER ALL content has been added, in order for the js to work properly
389     </li>
390     </ul>
391 jonen 1.2 </div>
392 jonen 1.3 <a name="methodget_title" id="get_title"><!-- --></a>
393     <div class="oddrow">
394    
395     <div class="method-header">
396     <span class="method-title">get_title</span> (line <span class="line-number">102</span>)
397     </div>
398    
399     <!-- ========== Info from phpDoc block ========= -->
400     <p class="short-description">Function for accessing the title of this widget</p>
401     <ul class="tags">
402     <li><span class="field">return:</span> <p>- the title</p></li>
403     </ul>
404    
405     <div class="method-signature">
406     <span class="method-result">string</span>
407     <span class="method-name">
408     get_title
409     </span>
410     ()
411     </div>
412    
413    
414    
415     </div>
416     <a name="methodget_width" id="get_width"><!-- --></a>
417     <div class="evenrow">
418    
419     <div class="method-header">
420     <span class="method-title">get_width</span> (line <span class="line-number">125</span>)
421     </div>
422    
423     <!-- ========== Info from phpDoc block ========= -->
424     <p class="short-description">Function for getting the current widget width setting.</p>
425     <ul class="tags">
426     <li><span class="field">return:</span> <p>- the width</p></li>
427     </ul>
428    
429     <div class="method-signature">
430     <span class="method-result">string</span>
431     <span class="method-name">
432     get_width
433     </span>
434     ()
435     </div>
436    
437    
438    
439     </div>
440     <a name="methodset_align" id="set_align"><!-- --></a>
441     <div class="oddrow">
442    
443     <div class="method-header">
444     <span class="method-title">set_align</span> (line <span class="line-number">135</span>)
445     </div>
446    
447     <!-- ========== Info from phpDoc block ========= -->
448     <p class="short-description">This function sets the align attribute for the outer table.</p>
449    
450     <div class="method-signature">
451     <span class="method-result">void</span>
452     <span class="method-name">
453     set_align
454     </span>
455     (<span class="var-type">string</span>&nbsp;<span class="var-name">$align</span>)
456     </div>
457    
458     <ul class="parameters">
459     <li>
460     <span class="var-type">string</span>
461     <span class="var-name">$align</span><span class="var-description">: <p>- $align - the align value</p></span> </li>
462     </ul>
463    
464    
465     <hr class="separator" />
466     <div class="notes">Redefined in descendants as:</div>
467     <ul class="redefinitions">
468     <li>
469     <a href="../phpHtmlLib/DefaultGUIDatalist.html#methodset_align">DefaultGUIDatalist::set_align()</a>
470     : this function is used to set the overall alignment of the widget
471     </li>
472     <li>
473     <a href="../phpHtmlLib/ListAction.html#methodset_align">ListAction::set_align()</a>
474     : this function is used to set the overall alignment of the widget
475     </li>
476     </ul>
477     </div>
478     <a name="methodset_title" id="set_title"><!-- --></a>
479     <div class="evenrow">
480    
481     <div class="method-header">
482     <span class="method-title">set_title</span> (line <span class="line-number">92</span>)
483     </div>
484    
485     <!-- ========== Info from phpDoc block ========= -->
486     <p class="short-description">Set the title for the widget.</p>
487     <p class="description"><p>this is just a generic title string that can be used however the child class wants to use it.</p></p>
488    
489     <div class="method-signature">
490     <span class="method-result">void</span>
491     <span class="method-name">
492     set_title
493     </span>
494     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
495     </div>
496    
497     <ul class="parameters">
498     <li>
499     <span class="var-type">string</span>
500     <span class="var-name">$title</span><span class="var-description">: <p>- $title</p></span> </li>
501     </ul>
502    
503    
504     <hr class="separator" />
505     <div class="notes">Redefined in descendants as:</div>
506     <ul class="redefinitions">
507     <li>
508     <a href="../phpHtmlLib/SVG/SVGGraph.html#methodset_title">SVGGraph::set_title()</a>
509     : This method sets the title for the graph
510     </li>
511     </ul>
512     </div>
513     <a name="methodset_width" id="set_width"><!-- --></a>
514     <div class="oddrow">
515    
516     <div class="method-header">
517     <span class="method-title">set_width</span> (line <span class="line-number">115</span>)
518     </div>
519    
520     <!-- ========== Info from phpDoc block ========= -->
521     <p class="short-description">Set the width for the widget.</p>
522     <p class="description"><p>this is meant to be the overall width expected to be used to control the generated html.</p></p>
523    
524     <div class="method-signature">
525     <span class="method-result">void</span>
526     <span class="method-name">
527     set_width
528     </span>
529     (<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span>)
530     </div>
531    
532     <ul class="parameters">
533     <li>
534     <span class="var-type">string</span>
535     <span class="var-name">$width</span><span class="var-description">: <p>- $width (ie. 80, 100%)</p></span> </li>
536     </ul>
537    
538    
539     <hr class="separator" />
540     <div class="notes">Redefined in descendants as:</div>
541     <ul class="redefinitions">
542     <li>
543     <a href="../phpHtmlLib/SVG/SVGGraph.html#methodset_width">SVGGraph::set_width()</a>
544     : This method sets the width of the graph
545     </li>
546     </ul>
547     </div>
548     <h4>Inherited Methods</h4>
549     <a name='inherited_methods'><!-- --></a>
550     <!-- =========== Summary =========== -->
551     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
552     <blockquote>
553     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
554     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
555     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
556     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
557     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
558     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
559     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
560     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
561     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
562     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
563     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
564     <span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br>
565     </blockquote>
566    
567     </div>
568     </div>
569    
570     <p class="notes" id="credit">
571     Documention generated on Thu, 31 Jul 2003 18:32:18 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
572     </p>
573     </div></body>
574 jonen 1.2 </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed