/[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.1 - (show annotations)
Thu Jan 30 03:29:20 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:29 -0800' -->
6 <TITLE>Docs For Class BaseWidget</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from BaseWidget">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class BaseWidget
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --BaseWidget</pre>
39 </pre>
40
41 <A NAME="children_summary"</A>
42 <H3>
43 Classes extended from BaseWidget: <A HREF="#top" CLASS="links">^TOP</A>
44 </H3>
45 <a href="../phpHtmlLib/FooterNav.html">FooterNav</a>, <a href="../phpHtmlLib/ActiveTab.html">ActiveTab</a>, <a href="../phpHtmlLib/InfoTable.html">InfoTable</a>, <a href="../phpHtmlLib/NavTable.html">NavTable</a>, <a href="../phpHtmlLib/TextNav.html">TextNav</a>, <a href="../phpHtmlLib/TreeNav.html">TreeNav</a>, <a href="../phpHtmlLib/TextCSSNav.html">TextCSSNav</a>, <a href="../phpHtmlLib/VerticalCSSNavTable.html">VerticalCSSNavTable</a>, <a href="../phpHtmlLib/ImageThumbnailWidget.html">ImageThumbnailWidget</a>, <a href="../phpHtmlLib/DataList.html">DataList</a>
46 <p>
47 <b><i>Located in File: Program_Root/widgets/BaseWidget.inc</i></b><br>
48 </p>
49 <hr>
50 <!-- ========== Info from phpDoc block ========= -->
51 this is the base widget class, that all widgets
52 are based off of.
53 <BR>
54 It provides some basic
55 members and methods
56
57 <UL>
58
59 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
60
61 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
62
63 </UL>
64
65 <hr>
66 <!-- =========== VAR SUMMARY =========== -->
67 <A NAME='var_summary'><!-- --></A>
68 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
69 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
70 <TD>
71 <span CLASS="font12bold">Class Variable Summary</span>
72 <A HREF="#top" CLASS="links">^TOP</A>
73 </TD>
74 </TR>
75
76
77 <!-- =========== Summary =========== -->
78 <TR BGCOLOR='white' CLASS='TableRowColor'>
79 <TD>
80 <CODE><B><A HREF='BaseWidget.html#$title'>$title</A></B></CODE>
81 <BR>
82 <blockquote> The title of the table. </blockquote>
83 <blockquote> Default Value: <CODE>-><-</CODE> </blockquote>
84 </TD>
85 </TR>
86
87 <!-- =========== Summary =========== -->
88 <TR BGCOLOR='white' CLASS='TableRowColor'>
89 <TD>
90 <CODE><B><A HREF='BaseWidget.html#$width'>$width</A></B></CODE>
91 <BR>
92 <blockquote> the width of the widget </blockquote>
93 <blockquote> Default Value: <CODE>->100%<-</CODE> </blockquote>
94 </TD>
95 </TR>
96
97 </TABLE>
98
99 <hr>
100 <!-- =========== VAR INHERITED SUMMARY =========== -->
101 <A NAME='var_inherited_summary'><!-- --></A>
102 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
103 <TR CLASS='TableHeadingColor'>
104 <TD>
105 <span CLASS="font12bold">Inherited Class Variable Summary</span>
106 <A HREF="#top" CLASS="links">^TOP</A>
107 </TD>
108 </TR>
109
110
111 <!-- =========== Summary =========== -->
112 <TR BGCOLOR='white'>
113 <TD>
114 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
115 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
116 <tr CLASS="tableheadingcolor">
117 <th>Variable</th>
118 <th>Default Value</th>
119 <th>Description</th>
120 </tr>
121
122 <tr>
123 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
124 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
125 <td CLASS="font10">Flag for pretty (indented) output</td>
126 </tr>
127
128 <tr>
129 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
130 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
131 <td CLASS="font10">Do we render a newline after the
132 contents has been rendered?</td>
133 </tr>
134
135 </table>
136 <BR>
137 </TD>
138 </TR>
139
140 </TABLE>
141
142 <hr>
143 <!-- =========== INHERITED METHOD SUMMARY =========== -->
144 <A NAME='functions_inherited'><!-- --></A>
145 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
146 <TR CLASS='TableHeadingColor'>
147 <TD>
148 <span CLASS="font12bold">Inherited Method Summary</span>
149 <A HREF="#top" CLASS="links">^TOP</A>
150 </TD>
151 </TR>
152
153
154 <!-- =========== Summary =========== -->
155 <TR BGCOLOR='white' CLASS='TableRowColor'>
156 <TD>
157 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
158 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
159 <tr CLASS="tableheadingcolor">
160 <th>Function</th>
161 <th>Description</th>
162 </tr>
163
164 <tr>
165 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
166 <td CLASS="font10">The constructor.</td>
167
168 <tr>
169 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
170 <td CLASS="font10">add content onto content stack</td>
171
172 <tr>
173 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
174 <td CLASS="font10">Add content onto content stack
175 so you can change the item later.</td>
176
177 <tr>
178 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
179 <td CLASS="font10">counts the number of content objects</td>
180
181 <tr>
182 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
183 <td CLASS="font10">This flag gets the current value
184 of the indent flag</td>
185
186 <tr>
187 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
188 <td CLASS="font10">Same as add().</td>
189
190 <tr>
191 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
192 <td CLASS="font10">Same as add_reference
193 NOTE : only exists for compatibility with 1.1.x</td>
194
195 <tr>
196 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
197 <td CLASS="font10">This function is compatible with the
198 rest of the phpHtmllib API spec.</td>
199
200 <tr>
201 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
202 <td CLASS="font10">destroy existing content and start with new content.</td>
203
204 <tr>
205 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
206 <td CLASS="font10">This function turns on the collapse flag</td>
207
208 <tr>
209 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
210 <td CLASS="font10">function to set the indent flag</td>
211
212 </table>
213 <br>
214 </TD>
215 </TR>
216
217 </TABLE>
218
219 <hr>
220 <!-- should have constructor at some point -->
221 <!-- =========== Method SUMMARY =========== -->
222 <A NAME='Method_summary'><!-- --></A>
223 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
224 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
225 <TD>
226 <span class="font12bold">Method Summary</span>
227 <A HREF="#top" CLASS="links">^TOP</A>
228 </TD>
229 </TR>
230
231
232 <!-- =========== Summary =========== -->
233 <TR BGCOLOR='white' CLASS='TableRowColor'>
234 <TD>
235 <CODE><B><A HREF='BaseWidget.html#get_align'>string get_align ( )</A></B></CODE>
236 <BR>
237 <blockquote> This gets the alignment value
238 for the outer table </blockquote>
239 </TD>
240 </TR>
241
242 <!-- =========== Summary =========== -->
243 <TR BGCOLOR='white' CLASS='TableRowColor'>
244 <TD>
245 <CODE><B><A HREF='BaseWidget.html#get_css'>string get_css ( )</A></B></CODE>
246 <BR>
247 <blockquote> This function provides the </blockquote>
248 </TD>
249 </TR>
250
251 <!-- =========== Summary =========== -->
252 <TR BGCOLOR='white' CLASS='TableRowColor'>
253 <TD>
254 <CODE><B><A HREF='BaseWidget.html#get_javascript'>string get_javascript ( )</A></B></CODE>
255 <BR>
256 <blockquote> Function for returning the raw javascript
257 that is required for this widget. </blockquote>
258 </TD>
259 </TR>
260
261 <!-- =========== Summary =========== -->
262 <TR BGCOLOR='white' CLASS='TableRowColor'>
263 <TD>
264 <CODE><B><A HREF='BaseWidget.html#get_title'>string get_title ( )</A></B></CODE>
265 <BR>
266 <blockquote> Function for accessing the
267 title of this widget </blockquote>
268 </TD>
269 </TR>
270
271 <!-- =========== Summary =========== -->
272 <TR BGCOLOR='white' CLASS='TableRowColor'>
273 <TD>
274 <CODE><B><A HREF='BaseWidget.html#get_width'>string get_width ( )</A></B></CODE>
275 <BR>
276 <blockquote> Function for getting the current
277 widget width setting. </blockquote>
278 </TD>
279 </TR>
280
281 <!-- =========== Summary =========== -->
282 <TR BGCOLOR='white' CLASS='TableRowColor'>
283 <TD>
284 <CODE><B><A HREF='BaseWidget.html#set_align'>void set_align ( $align )</A></B></CODE>
285 <BR>
286 <blockquote> This function sets the align attribute
287 for the outer table. </blockquote>
288 </TD>
289 </TR>
290
291 <!-- =========== Summary =========== -->
292 <TR BGCOLOR='white' CLASS='TableRowColor'>
293 <TD>
294 <CODE><B><A HREF='BaseWidget.html#set_title'>void set_title ( $title )</A></B></CODE>
295 <BR>
296 <blockquote> Set the title for the widget. </blockquote>
297 </TD>
298 </TR>
299
300 <!-- =========== Summary =========== -->
301 <TR BGCOLOR='white' CLASS='TableRowColor'>
302 <TD>
303 <CODE><B><A HREF='BaseWidget.html#set_width'>void set_width ( $width )</A></B></CODE>
304 <BR>
305 <blockquote> Set the width for the widget. </blockquote>
306 </TD>
307 </TR>
308
309 </TABLE>
310
311 <hr>
312 <!-- ============ VARIABLE DETAIL =========== -->
313
314 <A NAME='variable_detail'></A>
315 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
316 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
317 <TD>
318 <span CLASS="font12bold">Variable Detail</span>
319 <A HREF="#top" CLASS="links">^TOP</A>
320 </TD>
321 </TR>
322 </TABLE>
323
324
325 <A NAME='$title'><!-- --></A><H3>$title</H3>
326 <b>Data type:</b> string<br>
327 <!-- ========== Info from phpDoc block ========= -->
328 The title of the table.
329 <BR>
330
331
332 <UL>
333
334 <LI><b>Access</b> - <CODE>public</CODE></LI>
335
336 </UL>
337
338 <HR>
339
340 <A NAME='$width'><!-- --></A><H3>$width</H3>
341 <b>Data type:</b> string<br>
342 <!-- ========== Info from phpDoc block ========= -->
343 the width of the widget
344 <BR>
345
346
347 <UL>
348
349 <LI><b>Access</b> - <CODE>public</CODE></LI>
350
351 </UL>
352
353 <HR>
354
355
356 <hr>
357 <!-- ============ FUNCTION DETAIL =========== -->
358
359 <A NAME='function_detail'></A>
360 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
361 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
362 <TD>
363 <span class="font12bold">Method Detail</span>
364 <A HREF="#top" CLASS="links">^TOP</A>
365 </TD>
366 </TR>
367 </TABLE>
368 <BR>
369
370 <DIV CLASS="function">
371 <A NAME='get_align'><!-- --></A>
372 <SPAN CLASS="font12bold">get_align</SPAN>
373 <BR>
374 <SPAN CLASS="font10bold">Useage : </SPAN>
375 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
376 <span class="font10bold" style="color: #0000FF">get_align ( )</SPAN>
377 <BR>
378
379 <BR>
380 <SPAN CLASS="font10bold">Description : </SPAN>
381 <!-- ========== Info from phpDoc block ========= -->
382 This gets the alignment value
383 for the outer table
384 <BR>
385
386 <DL>
387 <DT class="font10bold">Function Parameters:</DT>
388
389
390 <DT class="font10bold">Function Info:</DT>
391
392 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the alignment</DD>
393
394 </DL>
395
396 </DIV>
397 <BR>
398
399 <DIV CLASS="function">
400 <A NAME='get_css'><!-- --></A>
401 <SPAN CLASS="font12bold">get_css</SPAN>
402 <BR>
403 <SPAN CLASS="font10bold">Useage : </SPAN>
404 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
405 <span class="font10bold" style="color: #0000FF">get_css ( )</SPAN>
406 <BR>
407
408 <BR>
409 <SPAN CLASS="font10bold">Description : </SPAN>
410 <!-- ========== Info from phpDoc block ========= -->
411 This function provides the
412 <BR>
413 mechanism to build and return
414 the css needed by this widget
415 <DL>
416 <DT class="font10bold">Function Parameters:</DT>
417
418
419 <DT class="font10bold">Function Info:</DT>
420
421 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw css</DD>
422
423 </DL>
424
425 </DIV>
426 <BR>
427
428 <DIV CLASS="function">
429 <A NAME='get_javascript'><!-- --></A>
430 <SPAN CLASS="font12bold">get_javascript</SPAN>
431 <BR>
432 <SPAN CLASS="font10bold">Useage : </SPAN>
433 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
434 <span class="font10bold" style="color: #0000FF">get_javascript ( )</SPAN>
435 <BR>
436 Overridden in child class(es) as: <a href="../phpHtmlLib/ActiveTab.html#get_javascript">ActiveTab::get_javascript()</a><br>
437 <BR>
438 <SPAN CLASS="font10bold">Description : </SPAN>
439 <!-- ========== Info from phpDoc block ========= -->
440 Function for returning the raw javascript
441 that is required for this widget.
442 <BR>
443
444 <DL>
445 <DT class="font10bold">Function Parameters:</DT>
446
447
448 <DT class="font10bold">Function Info:</DT>
449
450 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the raw javascript</DD>
451
452 </DL>
453
454 </DIV>
455 <BR>
456
457 <DIV CLASS="function">
458 <A NAME='get_title'><!-- --></A>
459 <SPAN CLASS="font12bold">get_title</SPAN>
460 <BR>
461 <SPAN CLASS="font10bold">Useage : </SPAN>
462 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
463 <span class="font10bold" style="color: #0000FF">get_title ( )</SPAN>
464 <BR>
465
466 <BR>
467 <SPAN CLASS="font10bold">Description : </SPAN>
468 <!-- ========== Info from phpDoc block ========= -->
469 Function for accessing the
470 title of this widget
471 <BR>
472
473 <DL>
474 <DT class="font10bold">Function Parameters:</DT>
475
476
477 <DT class="font10bold">Function Info:</DT>
478
479 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the title</DD>
480
481 </DL>
482
483 </DIV>
484 <BR>
485
486 <DIV CLASS="function">
487 <A NAME='get_width'><!-- --></A>
488 <SPAN CLASS="font12bold">get_width</SPAN>
489 <BR>
490 <SPAN CLASS="font10bold">Useage : </SPAN>
491 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
492 <span class="font10bold" style="color: #0000FF">get_width ( )</SPAN>
493 <BR>
494
495 <BR>
496 <SPAN CLASS="font10bold">Description : </SPAN>
497 <!-- ========== Info from phpDoc block ========= -->
498 Function for getting the current
499 widget width setting.
500 <BR>
501
502 <DL>
503 <DT class="font10bold">Function Parameters:</DT>
504
505
506 <DT class="font10bold">Function Info:</DT>
507
508 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the width</DD>
509
510 </DL>
511
512 </DIV>
513 <BR>
514
515 <DIV CLASS="function">
516 <A NAME='set_align'><!-- --></A>
517 <SPAN CLASS="font12bold">set_align</SPAN>
518 <BR>
519 <SPAN CLASS="font10bold">Useage : </SPAN>
520 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
521 <span class="font10bold" style="color: #0000FF">set_align ( $align )</SPAN>
522 <BR>
523
524 <BR>
525 <SPAN CLASS="font10bold">Description : </SPAN>
526 <!-- ========== Info from phpDoc block ========= -->
527 This function sets the align attribute
528 for the outer table.
529 <BR>
530
531 <DL>
532 <DT class="font10bold">Function Parameters:</DT>
533
534 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$align</SPAN></SPAN> - - the align value</DD>
535
536
537 <DT class="font10bold">Function Info:</DT>
538
539 </DL>
540
541 </DIV>
542 <BR>
543
544 <DIV CLASS="function">
545 <A NAME='set_title'><!-- --></A>
546 <SPAN CLASS="font12bold">set_title</SPAN>
547 <BR>
548 <SPAN CLASS="font10bold">Useage : </SPAN>
549 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
550 <span class="font10bold" style="color: #0000FF">set_title ( $title )</SPAN>
551 <BR>
552
553 <BR>
554 <SPAN CLASS="font10bold">Description : </SPAN>
555 <!-- ========== Info from phpDoc block ========= -->
556 Set the title for the widget.
557 <BR>
558 this is just a generic title string
559 that can be used however the child class
560 wants to use it.
561 <DL>
562 <DT class="font10bold">Function Parameters:</DT>
563
564 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> -</DD>
565
566
567 <DT class="font10bold">Function Info:</DT>
568
569 </DL>
570
571 </DIV>
572 <BR>
573
574 <DIV CLASS="function">
575 <A NAME='set_width'><!-- --></A>
576 <SPAN CLASS="font12bold">set_width</SPAN>
577 <BR>
578 <SPAN CLASS="font10bold">Useage : </SPAN>
579 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
580 <span class="font10bold" style="color: #0000FF">set_width ( $width )</SPAN>
581 <BR>
582
583 <BR>
584 <SPAN CLASS="font10bold">Description : </SPAN>
585 <!-- ========== Info from phpDoc block ========= -->
586 Set the width for the widget.
587 <BR>
588 this is meant to be the overall
589 width expected to be used to
590 control the generated html.
591 <DL>
592 <DT class="font10bold">Function Parameters:</DT>
593
594 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - (ie. 80, 100%)</DD>
595
596
597 <DT class="font10bold">Function Info:</DT>
598
599 </DL>
600
601 </DIV>
602 <BR>
603
604
605 <hr>
606 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed