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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu Jan 30 03:29:22 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:33 -0800' -->
6 <TITLE>Docs For Class PageWidget</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 PageWidget">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 PageWidget
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a>
37 |
38 --PageWidget</pre>
39 </pre>
40
41 <A NAME="children_summary"</A>
42 <H3>
43 Classes extended from PageWidget: <A HREF="#top" CLASS="links">^TOP</A>
44 </H3>
45 <a href="../phpHtmlLib/examples/MyLayoutPage.html">MyLayoutPage</a>
46 <p>
47 <b><i>Located in File: Program_Root/widgets/PageWidget.inc</i></b><br>
48 </p>
49 <hr>
50 <!-- ========== Info from phpDoc block ========= -->
51 This class is used to build content
52 for an entire page.
53 <BR>
54 It uses the
55 HTMLPageClass widget from phphtmllib
56 to render the final output.
57
58 <UL>
59
60 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
61
62 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
63
64 </UL>
65
66 <hr>
67 <!-- =========== VAR SUMMARY =========== -->
68 <A NAME='var_summary'><!-- --></A>
69 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
70 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
71 <TD>
72 <span CLASS="font12bold">Class Variable Summary</span>
73 <A HREF="#top" CLASS="links">^TOP</A>
74 </TD>
75 </TR>
76
77
78 <!-- =========== Summary =========== -->
79 <TR BGCOLOR='white' CLASS='TableRowColor'>
80 <TD>
81 <CODE><B><A HREF='PageWidget.html#$_enable_debug'>$_enable_debug</A></B></CODE>
82 <BR>
83 <blockquote> This enables the ability to view the
84 source of a page bu setting debug=1
85 in the query string. </blockquote>
86 <blockquote> Default Value: <CODE>->FALSE<-</CODE> </blockquote>
87 </TD>
88 </TR>
89
90 <!-- =========== Summary =========== -->
91 <TR BGCOLOR='white' CLASS='TableRowColor'>
92 <TD>
93 <CODE><B><A HREF='PageWidget.html#$_title_text'>$_title_text</A></B></CODE>
94 <BR>
95 <blockquote> holds the page title text for
96 a page </blockquote>
97 <blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote>
98 </TD>
99 </TR>
100
101 </TABLE>
102
103 <hr>
104 <!-- =========== VAR INHERITED SUMMARY =========== -->
105 <A NAME='var_inherited_summary'><!-- --></A>
106 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
107 <TR CLASS='TableHeadingColor'>
108 <TD>
109 <span CLASS="font12bold">Inherited Class Variable Summary</span>
110 <A HREF="#top" CLASS="links">^TOP</A>
111 </TD>
112 </TR>
113
114
115 <!-- =========== Summary =========== -->
116 <TR BGCOLOR='white'>
117 <TD>
118 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span>
119 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
120 <tr CLASS="tableheadingcolor">
121 <th>Variable</th>
122 <th>Default Value</th>
123 <th>Description</th>
124 </tr>
125
126 <tr>
127 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_html_attributes'>$_html_attributes</A></td>
128 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
129 <td CLASS="font10">This holds the attributes for the
130 &lt;html&gt; tag.</td>
131 </tr>
132
133 <tr>
134 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_indent_style'>$_indent_style</A></td>
135 <td CLASS="font10" STYLE="white-space: nowrap">->0<-</td>
136 <td CLASS="font10">Holds the value of the indent</td>
137 </tr>
138
139 <tr>
140 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_widget_css_auto'>$_widget_css_auto</A></td>
141 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
142 <td CLASS="font10">keeps track of which widgets we have
143 automatically pulled in css for</td>
144 </tr>
145
146 <tr>
147 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#$_widget_js_auto'>$_widget_js_auto</A></td>
148 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
149 <td CLASS="font10">keeps track of which widgets we have
150 automatically pulled in js for</td>
151 </tr>
152
153 </table>
154 <BR>
155 </TD>
156 </TR>
157
158 </TABLE>
159
160 <hr>
161 <!-- =========== INHERITED METHOD SUMMARY =========== -->
162 <A NAME='functions_inherited'><!-- --></A>
163 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
164 <TR CLASS='TableHeadingColor'>
165 <TD>
166 <span CLASS="font12bold">Inherited Method Summary</span>
167 <A HREF="#top" CLASS="links">^TOP</A>
168 </TD>
169 </TR>
170
171
172 <!-- =========== Summary =========== -->
173 <TR BGCOLOR='white' CLASS='TableRowColor'>
174 <TD>
175 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span>
176 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
177 <tr CLASS="tableheadingcolor">
178 <th>Function</th>
179 <th>Description</th>
180 </tr>
181
182 <tr>
183 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#constructor HTMLPageClass'>constructor HTMLPageClass ( [$title = NULL], [$html_type = HTML], [$indent_style = INDENT_NICE] )</A></td>
184 <td CLASS="font10">Class Constructor</td>
185
186 <tr>
187 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add'>add ( )</A></td>
188 <td CLASS="font10">This function adds content to the &lt;body&gt;
189 area of the page.</td>
190
191 <tr>
192 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_css_link'>add_css_link ( $link )</A></td>
193 <td CLASS="font10">pushes a css external reference to the head area</td>
194
195 <tr>
196 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_content'>add_head_content ( )</A></td>
197 <td CLASS="font10">this adds content to the head tag
198 of the page</td>
199
200 <tr>
201 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_css'>add_head_css ( $css )</A></td>
202 <td CLASS="font10">this function adds raw css to the
203 &lt;head&gt; tag.</td>
204
205 <tr>
206 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_head_js'>add_head_js ( $content )</A></td>
207 <td CLASS="font10">adds raw javascript to the head which
208 will automatically get wrapped in a
209 &lt;script language=&quot;JavaScript&quot;&gt; tag.</td>
210
211 <tr>
212 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#add_reference'>add_reference ( &$content )</A></td>
213 <td CLASS="font10">Adds the content reference to the &lt;body&gt;
214 tag for later use.</td>
215
216 <tr>
217 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#build_doctype'>build_doctype ( $link1, [$link2 = NULL] )</A></td>
218 <td CLASS="font10">This function is used to build the DOCTYPE
219 tag for the page.</td>
220
221 <tr>
222 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#get_html_attributes'>get_html_attributes ( )</A></td>
223 <td CLASS="font10">This function returns the
224 attributes to be used for the
225 &lt;html&gt; tag.</td>
226
227 <tr>
228 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push'>push ( )</A></td>
229 <td CLASS="font10">Same as add()</td>
230
231 <tr>
232 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_css_link'>push_css_link ( $link )</A></td>
233 <td CLASS="font10">Same ass add_css_link()</td>
234
235 <tr>
236 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_head_content'>push_head_content ( )</A></td>
237 <td CLASS="font10">Same ass add_head_content()</td>
238
239 <tr>
240 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_head_js'>push_head_js ( $content )</A></td>
241 <td CLASS="font10">Same ass add_head_js()</td>
242
243 <tr>
244 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_js_link'>push_js_link ( $link )</A></td>
245 <td CLASS="font10">pushes an link to an externally referenced javascript
246 file, which will get rendered in the head.</td>
247
248 <tr>
249 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#push_reference'>push_reference ( &$content )</A></td>
250 <td CLASS="font10">Same as add()</td>
251
252 <tr>
253 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#render'>render ( )</A></td>
254 <td CLASS="font10">render the page.</td>
255
256 <tr>
257 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_body_attributes'>set_body_attributes ( $attributes )</A></td>
258 <td CLASS="font10">set attributes of body tag</td>
259
260 <tr>
261 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_charset'>set_charset ( $charset )</A></td>
262 <td CLASS="font10">set the character set</td>
263
264 <tr>
265 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_frameset'>set_frameset ( $frameset )</A></td>
266 <td CLASS="font10">This function is used to set the FRAMSETtag
267 object for this page.</td>
268
269 <tr>
270 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_html_attributes'>set_html_attributes ( $attributes )</A></td>
271 <td CLASS="font10">This function sets the attributes
272 for the &lt;html&gt; tag</td>
273
274 <tr>
275 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_refresh'>set_refresh ( $time, [$url = NULL] )</A></td>
276 <td CLASS="font10">Automatically set a page meta tag refresh</td>
277
278 <tr>
279 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_text_debug'>set_text_debug ( $flag )</A></td>
280 <td CLASS="font10">set the $_text_debug flag</td>
281
282 <tr>
283 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#set_title'>set_title ( $title )</A></td>
284 <td CLASS="font10">set the title of the page output.</td>
285
286 <tr>
287 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_build_content_type_tag'>_build_content_type_tag ( )</A></td>
288 <td CLASS="font10">this builds the content type meta tag.</td>
289
290 <tr>
291 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_build_head'>_build_head ( )</A></td>
292 <td CLASS="font10">builds the head object and its content.</td>
293
294 <tr>
295 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_create_body'>_create_body ( )</A></td>
296 <td CLASS="font10">This is responsible for creating the</td>
297
298 <tr>
299 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLPageClass.html#_frameset_wrap_body'>_frameset_wrap_body ( )</A></td>
300 <td CLASS="font10">This builds a frameset body tag
301 wrapped in a &lt;noframes&gt; tag.</td>
302
303 </table>
304 <br>
305 </TD>
306 </TR>
307
308 </TABLE>
309
310 <hr>
311 <!-- should have constructor at some point -->
312 <!-- =========== Method SUMMARY =========== -->
313 <A NAME='Method_summary'><!-- --></A>
314 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
315 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
316 <TD>
317 <span class="font12bold">Method Summary</span>
318 <A HREF="#top" CLASS="links">^TOP</A>
319 </TD>
320 </TR>
321
322
323 <!-- =========== Summary =========== -->
324 <TR BGCOLOR='white' CLASS='TableRowColor'>
325 <TD>
326 <CODE><B><A HREF='PageWidget.html#constructor PageWidget'>void constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</A></B></CODE>
327 <BR>
328 <blockquote> Constructor: </blockquote>
329 </TD>
330 </TR>
331
332 <!-- =========== Summary =========== -->
333 <TR BGCOLOR='white' CLASS='TableRowColor'>
334 <TD>
335 <CODE><B><A HREF='PageWidget.html#body_content'>mixed. body_content ( )</A></B></CODE>
336 <BR>
337 <blockquote> This function is meant to be overridden
338 by the child class. </blockquote>
339 </TD>
340 </TR>
341
342 <!-- =========== Summary =========== -->
343 <TR BGCOLOR='white' CLASS='TableRowColor'>
344 <TD>
345 <CODE><B><A HREF='PageWidget.html#enable_debug'>void enable_debug ( [$flag = TRUE] )</A></B></CODE>
346 <BR>
347 <blockquote> This sets the debug option for
348 the HTMLPageClass </blockquote>
349 </TD>
350 </TR>
351
352 <!-- =========== Summary =========== -->
353 <TR BGCOLOR='white' CLASS='TableRowColor'>
354 <TD>
355 <CODE><B><A HREF='PageWidget.html#frameset'>void frameset ( )</A></B></CODE>
356 <BR>
357 <blockquote> This function is used to save
358 a frameset to the page. </blockquote>
359 </TD>
360 </TR>
361
362 <!-- =========== Summary =========== -->
363 <TR BGCOLOR='white' CLASS='TableRowColor'>
364 <TD>
365 <CODE><B><A HREF='PageWidget.html#get_title'>string get_title ( )</A></B></CODE>
366 <BR>
367 <blockquote> gets the current title of the page. </blockquote>
368 </TD>
369 </TR>
370
371 <!-- =========== Summary =========== -->
372 <TR BGCOLOR='white' CLASS='TableRowColor'>
373 <TD>
374 <CODE><B><A HREF='PageWidget.html#head_content'>mixed. head_content ( )</A></B></CODE>
375 <BR>
376 <blockquote> This function is used to build </blockquote>
377 </TD>
378 </TR>
379
380 <!-- =========== Summary =========== -->
381 <TR BGCOLOR='white' CLASS='TableRowColor'>
382 <TD>
383 <CODE><B><A HREF='PageWidget.html#head_javascript'>string head_javascript ( )</A></B></CODE>
384 <BR>
385 <blockquote> This function is called to build
386 any JavaScript that is needed in the
387 &lt;HEAD&gt; portion of a document. </blockquote>
388 </TD>
389 </TR>
390
391 <!-- =========== Summary =========== -->
392 <TR BGCOLOR='white' CLASS='TableRowColor'>
393 <TD>
394 <CODE><B><A HREF='PageWidget.html#render'>string render ( )</A></B></CODE>
395 <BR>
396 <blockquote> This is the function that renders the HTML
397 for this widget. </blockquote>
398 </TD>
399 </TR>
400
401 </TABLE>
402
403 <hr>
404 <!-- ============ VARIABLE DETAIL =========== -->
405
406 <A NAME='variable_detail'></A>
407 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
408 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
409 <TD>
410 <span CLASS="font12bold">Variable Detail</span>
411 <A HREF="#top" CLASS="links">^TOP</A>
412 </TD>
413 </TR>
414 </TABLE>
415
416
417 <A NAME='$_enable_debug'><!-- --></A><H3>$_enable_debug</H3>
418 <b>Data type:</b> mixed<br>
419 <!-- ========== Info from phpDoc block ========= -->
420 This enables the ability to view the
421 source of a page bu setting debug=1
422 in the query string.
423 <BR>
424
425
426 <UL>
427
428 </UL>
429
430 <HR>
431
432 <A NAME='$_title_text'><!-- --></A><H3>$_title_text</H3>
433 <b>Data type:</b> mixed<br>
434 <!-- ========== Info from phpDoc block ========= -->
435 holds the page title text for
436 a page
437 <BR>
438
439
440 <UL>
441
442 </UL>
443
444 <HR>
445
446
447 <hr>
448 <!-- ============ FUNCTION DETAIL =========== -->
449
450 <A NAME='function_detail'></A>
451 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
452 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
453 <TD>
454 <span class="font12bold">Method Detail</span>
455 <A HREF="#top" CLASS="links">^TOP</A>
456 </TD>
457 </TR>
458 </TABLE>
459 <BR>
460
461 <DIV CLASS="function">
462 <A NAME='constructor PageWidget'><!-- --></A>
463 <SPAN CLASS="font12bold">constructor PageWidget</SPAN>
464 <BR>
465 <SPAN CLASS="font10bold">Useage : </SPAN>
466 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
467 <span class="font10bold" style="color: #0000FF">constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</SPAN>
468 <BR>
469
470 <BR>
471 <SPAN CLASS="font10bold">Description : </SPAN>
472 <!-- ========== Info from phpDoc block ========= -->
473 Constructor:
474 <BR>
475
476 <DL>
477 <DT class="font10bold">Function Parameters:</DT>
478
479 <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> - one of 3 types of html to render. Setting this will
480 make the object declare the gobal define which tells
481 all of the tag objects what type of html tags to render.
482 some tags support special features. such as the &lt;IMG&gt;
483 tag. If xhtml is selected, the the IMGtag object and all
484 utility functions will not render &quot;border=0&quot; as a default
485 attribute, since this is not proper xhtml.
486 &quot;html&quot; - HTML 4.0 (default)
487 &quot;xhtml_transitional&quot; - render xhtml instead of html
488 - doctype is XHTML transitional.
489 &quot;xhtml_strict&quot; - render xhtml instead of html 4.0.
490 - doctype is XHTML strict.</DD>
491
492 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$render_type</SPAN></SPAN> - one of 2 types. INDENT_NICE or INDENT_LEFT_JUSTIFY
493 This tells the page how to render the indenting of the
494 output. By default it is set to INDENT_NICE, which nicely
495 indents each nested tag. You can have all tags rendered
496 left justified (smaller size in output) by using
497 INDENT_LEFT_JUSTIFY</DD>
498
499
500 <DT class="font10bold">Function Info:</DT>
501
502 </DL>
503
504 </DIV>
505 <BR>
506
507 <DIV CLASS="function">
508 <A NAME='body_content'><!-- --></A>
509 <SPAN CLASS="font12bold">body_content</SPAN>
510 <BR>
511 <SPAN CLASS="font10bold">Useage : </SPAN>
512 <span class="font10bold" style="color: #FF0000">mixed.</SPAN>&nbsp;
513 <span class="font10bold" style="color: #0000FF">body_content ( )</SPAN>
514 <BR>
515 Overridden in child class(es) as: <a href="../phpHtmlLib/examples/MyLayoutPage.html#body_content">MyLayoutPage::body_content()</a><br>
516 <BR>
517 <SPAN CLASS="font10bold">Description : </SPAN>
518 <!-- ========== Info from phpDoc block ========= -->
519 This function is meant to be overridden
520 by the child class.
521 <BR>
522 This provides all of the content
523 for the page.
524 NOTE: You add the content to the
525 body in 1 of 2 ways.
526 1) return the content from this
527 call.
528 2) inside the call, you can
529 just call $this-&gt;add();
530 and then return NULL;
531 <DL>
532 <DT class="font10bold">Function Parameters:</DT>
533
534
535 <DT class="font10bold">Function Info:</DT>
536
537 </DL>
538
539 </DIV>
540 <BR>
541
542 <DIV CLASS="function">
543 <A NAME='enable_debug'><!-- --></A>
544 <SPAN CLASS="font12bold">enable_debug</SPAN>
545 <BR>
546 <SPAN CLASS="font10bold">Useage : </SPAN>
547 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
548 <span class="font10bold" style="color: #0000FF">enable_debug ( [$flag = TRUE] )</SPAN>
549 <BR>
550
551 <BR>
552 <SPAN CLASS="font10bold">Description : </SPAN>
553 <!-- ========== Info from phpDoc block ========= -->
554 This sets the debug option for
555 the HTMLPageClass
556 <BR>
557
558 <DL>
559 <DT class="font10bold">Function Parameters:</DT>
560
561 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> TRUE for on, FALSE for off</DD>
562
563
564 <DT class="font10bold">Function Info:</DT>
565
566 </DL>
567
568 </DIV>
569 <BR>
570
571 <DIV CLASS="function">
572 <A NAME='frameset'><!-- --></A>
573 <SPAN CLASS="font12bold">frameset</SPAN>
574 <BR>
575 <SPAN CLASS="font10bold">Useage : </SPAN>
576 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
577 <span class="font10bold" style="color: #0000FF">frameset ( )</SPAN>
578 <BR>
579
580 <BR>
581 <SPAN CLASS="font10bold">Description : </SPAN>
582 <!-- ========== Info from phpDoc block ========= -->
583 This function is used to save
584 a frameset to the page.
585 <BR>
586 This will
587 automatically output a properly
588 formatted
589 <DL>
590 <DT class="font10bold">Function Parameters:</DT>
591
592
593 <DT class="font10bold">Function Info:</DT>
594
595 </DL>
596
597 </DIV>
598 <BR>
599
600 <DIV CLASS="function">
601 <A NAME='get_title'><!-- --></A>
602 <SPAN CLASS="font12bold">get_title</SPAN>
603 <BR>
604 <SPAN CLASS="font10bold">Useage : </SPAN>
605 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
606 <span class="font10bold" style="color: #0000FF">get_title ( )</SPAN>
607 <BR>
608
609 <BR>
610 <SPAN CLASS="font10bold">Description : </SPAN>
611 <!-- ========== Info from phpDoc block ========= -->
612 gets the current title of the page.
613 <BR>
614
615 <DL>
616 <DT class="font10bold">Function Parameters:</DT>
617
618
619 <DT class="font10bold">Function Info:</DT>
620
621 </DL>
622
623 </DIV>
624 <BR>
625
626 <DIV CLASS="function">
627 <A NAME='head_content'><!-- --></A>
628 <SPAN CLASS="font12bold">head_content</SPAN>
629 <BR>
630 <SPAN CLASS="font10bold">Useage : </SPAN>
631 <span class="font10bold" style="color: #FF0000">mixed.</SPAN>&nbsp;
632 <span class="font10bold" style="color: #0000FF">head_content ( )</SPAN>
633 <BR>
634
635 <BR>
636 <SPAN CLASS="font10bold">Description : </SPAN>
637 <!-- ========== Info from phpDoc block ========= -->
638 This function is used to build
639 <BR>
640 addition head content that isn't
641 built by the HTMLPageClass parent
642 class by default.
643 NOTE: you can add addition content
644 to the head in 1 of 2 ways.
645 1) inside the call return the
646 addition content in the
647 return $foo;
648 2) or use the HTMLPageClass'
649 $this-&gt;add_head_content()
650 from within the head_content()
651 call.
652 <DL>
653 <DT class="font10bold">Function Parameters:</DT>
654
655
656 <DT class="font10bold">Function Info:</DT>
657
658 </DL>
659
660 </DIV>
661 <BR>
662
663 <DIV CLASS="function">
664 <A NAME='head_javascript'><!-- --></A>
665 <SPAN CLASS="font12bold">head_javascript</SPAN>
666 <BR>
667 <SPAN CLASS="font10bold">Useage : </SPAN>
668 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
669 <span class="font10bold" style="color: #0000FF">head_javascript ( )</SPAN>
670 <BR>
671
672 <BR>
673 <SPAN CLASS="font10bold">Description : </SPAN>
674 <!-- ========== Info from phpDoc block ========= -->
675 This function is called to build
676 any JavaScript that is needed in the
677 &lt;HEAD&gt; portion of a document.
678 <BR>
679
680 <DL>
681 <DT class="font10bold">Function Parameters:</DT>
682
683
684 <DT class="font10bold">Function Info:</DT>
685
686 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the raw JS code to be
687 put inside the &lt;head&gt;</DD>
688
689 </DL>
690
691 </DIV>
692 <BR>
693
694 <DIV CLASS="function">
695 <A NAME='render'><!-- --></A>
696 <SPAN CLASS="font12bold">render</SPAN>
697 <BR>
698 <SPAN CLASS="font10bold">Useage : </SPAN>
699 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
700 <span class="font10bold" style="color: #0000FF">render ( )</SPAN>
701 <BR>
702 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/HTMLPageClass.html#render">HTMLPageClass::render()</a>
703 <BR>
704 <SPAN CLASS="font10bold">Description : </SPAN>
705 <!-- ========== Info from phpDoc block ========= -->
706 This is the function that renders the HTML
707 for this widget.
708 <BR>
709
710 <DL>
711 <DT class="font10bold">Function Parameters:</DT>
712
713
714 <DT class="font10bold">Function Info:</DT>
715
716 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the HTML</DD>
717
718 </DL>
719
720 </DIV>
721 <BR>
722
723
724 <hr>
725 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed