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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (show annotations)
Thu May 6 16:24:10 2004 UTC (20 years, 2 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +598 -572 lines
File MIME type: text/html
 updated all to v2.4.1 - Apr 01, 2004

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

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