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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (hide annotations)
Sat Feb 22 20:56:31 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Changes since 1.1: +285 -469 lines
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 jonen 1.2 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 jonen 1.1 <!--NewPage-->
3     <HTML>
4     <HEAD>
5 jonen 1.2 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:06 -0800' -->
6 jonen 1.1 <TITLE>Docs For Class PageWidget</TITLE>
7 jonen 1.2 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 jonen 1.1 </HEAD>
9     <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10     <!-- Links -->
11     <a NAME="top"></A>
12     <table WIDTH="100%" class="links">
13     <TR>
14     <TD class="font10">
15     Links:
16     <A HREF="#children_summary" class="links" title="Classes extended from PageWidget">Child Classes</A>
17     <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18     <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19 jonen 1.2 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20     <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21 jonen 1.1 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 jonen 1.2 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 jonen 1.1 </TD>
24     </TR>
25     </TABLE>
26     <BR>
27     <!-- Start of Class Data -->
28     <H2>
29     Class PageWidget
30 jonen 1.2 </H2> (line <span class="linenumber">25</span>)
31 jonen 1.1 <pre>
32 jonen 1.2 <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a>
33 jonen 1.1 |
34     --PageWidget</pre>
35 jonen 1.2 <SPAN class="type">Classes extended from PageWidget:</SPAN>
36     <dl>
37     <dt><a href="../phpHtmlLib/examples/MyLayoutPage.html">MyLayoutPage</a></dt>
38     <dd>This is an example Child of the PageWidget</dd>
39     </dl>
40     </p>
41 jonen 1.1 <p>
42     <b><i>Located in File: Program_Root/widgets/PageWidget.inc</i></b><br>
43     </p>
44     <hr>
45 jonen 1.2 This class is used to build content for an entire page. It uses the HTMLPageClass widget from phphtmllib to render the final output.
46     <br />
47 jonen 1.1
48     <UL>
49 jonen 1.2 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
50     </UL>
51 jonen 1.1 <hr>
52     <!-- =========== VAR SUMMARY =========== -->
53     <A NAME='var_summary'><!-- --></A>
54     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
55     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
56     <TD>
57     <span CLASS="font12bold">Class Variable Summary</span>
58     <A HREF="#top" CLASS="links">^TOP</A>
59     </TD>
60     </TR>
61    
62 jonen 1.2 <!-- =========== Summary =========== -->
63 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
64     <TD>
65 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/PageWidget.html#var$_enable_debug">$_enable_debug</A></B></CODE>
66 jonen 1.1 <BR>
67 jonen 1.2 <blockquote> This enables the ability to view the source of a page bu setting debug=1 in the query string. </blockquote>
68     <blockquote> Default Value: <CODE>->&nbsp;FALSE<-</CODE> </blockquote>
69 jonen 1.1 </TD>
70     </TR>
71 jonen 1.2 <!-- =========== Summary =========== -->
72 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
73     <TD>
74 jonen 1.2 <CODE><B><A HREF="../phpHtmlLib/PageWidget.html#var$_title_text">$_title_text</A></B></CODE>
75 jonen 1.1 <BR>
76 jonen 1.2 <blockquote> holds the page title text for </blockquote>
77     <blockquote> Default Value: <CODE>->&nbsp;NULL<-</CODE> </blockquote>
78 jonen 1.1 </TD>
79     </TR>
80 jonen 1.2 </TABLE>
81 jonen 1.1 <hr>
82     <!-- =========== VAR INHERITED SUMMARY =========== -->
83     <A NAME='var_inherited_summary'><!-- --></A>
84     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
85 jonen 1.2 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
86 jonen 1.1 <TD>
87     <span CLASS="font12bold">Inherited Class Variable Summary</span>
88     <A HREF="#top" CLASS="links">^TOP</A>
89     </TD>
90     </TR>
91    
92 jonen 1.2 <!-- =========== Summary =========== -->
93 jonen 1.1 <TR BGCOLOR='white'>
94     <TD>
95     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span>
96     <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
97     <tr CLASS="tableheadingcolor">
98     <th>Variable</th>
99     <th>Default Value</th>
100     <th>Description</th>
101     </tr>
102 jonen 1.2 <tr>
103     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></td>
104 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
105 jonen 1.2 <td CLASS="font10">This holds the attributes for the &lt;html&gt; tag.</td>
106 jonen 1.1 </tr>
107 jonen 1.2 <tr>
108     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></td>
109     <td CLASS="font10" STYLE="white-space: nowrap">-> 0<-</td>
110     <td CLASS="font10">Holds the value of the indent style the user wants to render the page w/</td>
111 jonen 1.1 </tr>
112 jonen 1.2 <tr>
113     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></td>
114 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
115 jonen 1.2 <td CLASS="font10">keeps track of which widgets we have automatically pulled in css for</td>
116 jonen 1.1 </tr>
117 jonen 1.2 <tr>
118     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></td>
119 jonen 1.1 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
120 jonen 1.2 <td CLASS="font10">keeps track of which widgets we have automatically pulled in js for</td>
121 jonen 1.1 </tr>
122 jonen 1.2 </table>
123 jonen 1.1 <BR>
124     </TD>
125     </TR>
126 jonen 1.2 </TABLE>
127 jonen 1.1
128     <hr>
129 jonen 1.2 <!-- =========== METHOD SUMMARY =========== -->
130     <A NAME='method_summary'><!-- --></A>
131 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
132     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
133     <TD>
134     <span class="font12bold">Method Summary</span>
135     <A HREF="#top" CLASS="links">^TOP</A>
136     </TD>
137     </TR>
138    
139 jonen 1.2 <!-- =========== Summary =========== -->
140 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
141     <TD>
142 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodPageWidget'>void constructor PageWidget ( $title, [$render_type = HTML], [$indent_style = INDENT_NICE] )</A></B></CODE>
143 jonen 1.1 <BR>
144     <blockquote> Constructor: </blockquote>
145     </TD>
146     </TR>
147 jonen 1.2 <!-- =========== Summary =========== -->
148 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
149     <TD>
150 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodbody_content'>mixed. body_content ( )</A></B></CODE>
151 jonen 1.1 <BR>
152 jonen 1.2 <blockquote> This function is meant to be overridden by the child class. </blockquote>
153 jonen 1.1 </TD>
154     </TR>
155 jonen 1.2 <!-- =========== Summary =========== -->
156 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
157     <TD>
158 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodenable_debug'>void enable_debug ( [$flag = TRUE] )</A></B></CODE>
159 jonen 1.1 <BR>
160 jonen 1.2 <blockquote> This sets the debug option for the HTMLPageClass </blockquote>
161 jonen 1.1 </TD>
162     </TR>
163 jonen 1.2 <!-- =========== Summary =========== -->
164 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
165     <TD>
166 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodframeset'>void frameset ( )</A></B></CODE>
167 jonen 1.1 <BR>
168 jonen 1.2 <blockquote> This function is used to save </blockquote>
169 jonen 1.1 </TD>
170     </TR>
171 jonen 1.2 <!-- =========== Summary =========== -->
172 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
173     <TD>
174 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodget_title'>string get_title ( )</A></B></CODE>
175 jonen 1.1 <BR>
176     <blockquote> gets the current title of the page. </blockquote>
177     </TD>
178     </TR>
179 jonen 1.2 <!-- =========== Summary =========== -->
180 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
181     <TD>
182 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodhead_content'>mixed. head_content ( )</A></B></CODE>
183 jonen 1.1 <BR>
184 jonen 1.2 <blockquote> This function is used to build addition head content that isn't built by the HTMLPageClass parent class by default. </blockquote>
185 jonen 1.1 </TD>
186     </TR>
187 jonen 1.2 <!-- =========== Summary =========== -->
188 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
189     <TD>
190 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodhead_javascript'>string head_javascript ( )</A></B></CODE>
191 jonen 1.1 <BR>
192 jonen 1.2 <blockquote> This function is called to build any JavaScript that is needed in the &lt;HEAD&gt; portion of a document. </blockquote>
193 jonen 1.1 </TD>
194     </TR>
195 jonen 1.2 <!-- =========== Summary =========== -->
196 jonen 1.1 <TR BGCOLOR='white' CLASS='TableRowColor'>
197     <TD>
198 jonen 1.2 <CODE><B><A HREF='../phpHtmlLib/PageWidget.html#methodrender'>string render ( )</A></B></CODE>
199 jonen 1.1 <BR>
200 jonen 1.2 <blockquote> This is the function that renders the HTML for this widget. </blockquote>
201     </TD>
202     </TR>
203     </TABLE>
204     <!-- =========== INHERITED METHOD SUMMARY =========== -->
205     <A NAME='functions_inherited'><!-- --></A>
206     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
207     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
208     <TD>
209     <span CLASS="font12bold">Inherited Method Summary</span>
210     <A HREF="#top" CLASS="links">^TOP</A>
211 jonen 1.1 </TD>
212     </TR>
213    
214 jonen 1.2 <!-- =========== Summary =========== -->
215     <TR BGCOLOR='white' CLASS='TableRowColor'>
216     <TD>
217     <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span>
218     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
219     <tr CLASS="tableheadingcolor">
220     <th>Function</th>
221     <th>Description</th>
222     </tr>
223     <tr>
224     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></td>
225     <td CLASS="font10">Class Constructor</td>
226     <tr>
227     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></td>
228     <td CLASS="font10">This function adds content to the &lt;body&gt; area of the page.</td>
229     <tr>
230     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></td>
231     <td CLASS="font10">pushes a css external reference to the head area</td>
232     <tr>
233     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></td>
234     <td CLASS="font10">this adds content to the head tag of the page</td>
235     <tr>
236     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></td>
237     <td CLASS="font10">this function adds raw css to the &lt;head&gt; tag. It will automatically be wrapped in a &lt;style type="text/css"&gt;</td>
238     <tr>
239     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></td>
240     <td CLASS="font10">adds raw javascript to the head which will automatically get wrapped in a &lt;script language="JavaScript"&gt; tag.</td>
241     <tr>
242     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></td>
243     <td CLASS="font10">Adds the content reference to the &lt;body&gt; tag for later use.</td>
244     <tr>
245     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></td>
246     <td CLASS="font10">This function is used to build the DOCTYPE</td>
247     <tr>
248     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></td>
249     <td CLASS="font10">This function returns the attributes to be used for the &lt;html&gt; tag.</td>
250     <tr>
251     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></td>
252     <td CLASS="font10">Same as add()</td>
253     <tr>
254     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></td>
255     <td CLASS="font10">Same ass add_css_link()</td>
256     <tr>
257     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></td>
258     <td CLASS="font10">Same ass add_head_content()</td>
259     <tr>
260     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></td>
261     <td CLASS="font10">Same ass add_head_js()</td>
262     <tr>
263     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></td>
264     <td CLASS="font10">pushes an link to an externally referenced javascript file, which will get rendered in the head.</td>
265     <tr>
266     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></td>
267     <td CLASS="font10">Same as add()</td>
268     <tr>
269     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></td>
270     <td CLASS="font10">render the page.</td>
271     <tr>
272     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></td>
273     <td CLASS="font10">set attributes of body tag</td>
274     <tr>
275     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></td>
276     <td CLASS="font10">set the character set</td>
277     <tr>
278     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></td>
279     <td CLASS="font10">This function is used to set the FRAMSETtag object for this page. This automatically sets the output for this page object to be a frameset.</td>
280     <tr>
281     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></td>
282     <td CLASS="font10">This function sets the attributes for the &lt;html&gt; tag</td>
283     <tr>
284     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></td>
285     <td CLASS="font10">Automatically set a page meta tag refresh</td>
286     <tr>
287     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></td>
288     <td CLASS="font10">set the $_text_debug flag</td>
289     <tr>
290     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></td>
291     <td CLASS="font10">set the title of the page output.</td>
292     <tr>
293     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></td>
294     <td CLASS="font10">this builds the content type meta tag.</td>
295     <tr>
296     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></td>
297     <td CLASS="font10">builds the head object and its content.</td>
298     <tr>
299     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></td>
300     <td CLASS="font10">This is responsible for creating the BODYtag object. We only will create a new $this-&gt;_body if it doesn't already exist.</td>
301     <tr>
302     <td CLASS="font10bold"><a href="../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></td>
303     <td CLASS="font10">This builds a frameset body tag wrapped in a &lt;noframes&gt; tag.</td>
304     </table>
305     <br>
306     </TD>
307     </TR>
308     </TABLE>
309 jonen 1.1 <hr>
310     <!-- ============ VARIABLE DETAIL =========== -->
311    
312     <A NAME='variable_detail'></A>
313     <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
314     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
315     <TD>
316     <span CLASS="font12bold">Variable Detail</span>
317     <A HREF="#top" CLASS="links">^TOP</A>
318     </TD>
319     </TR>
320     </TABLE>
321    
322 jonen 1.2 <A NAME='var$_enable_debug'><!-- --></A><H3>$_enable_debug</H3> (line <span class="linenumber">35</span>)<br />
323     <b>Data type:</b> mixed<br>This enables the ability to view the source of a page bu setting debug=1 in the query string.
324     <br />
325 jonen 1.1
326     <UL>
327 jonen 1.2 </UL>
328 jonen 1.1 <HR>
329 jonen 1.2 <A NAME='var$_title_text'><!-- --></A><H3>$_title_text</H3> (line <span class="linenumber">43</span>)<br />
330     <b>Data type:</b> mixed<br>holds the page title text for
331     <br />
332     <p>a page</p>
333 jonen 1.1 <UL>
334 jonen 1.2 </UL>
335 jonen 1.1 <HR>
336     <hr>
337 jonen 1.2 <!-- ============ METHOD DETAIL =========== -->
338 jonen 1.1
339 jonen 1.2 <A NAME='method_detail'></A>
340 jonen 1.1 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
341     <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
342     <TD>
343     <span class="font12bold">Method Detail</span>
344     <A HREF="#top" CLASS="links">^TOP</A>
345     </TD>
346     </TR>
347     </TABLE>
348     <BR>
349     <DIV CLASS="function">
350 jonen 1.2 <A NAME='methodPageWidget'><!-- --></A>
351     <SPAN CLASS="font12bold">Constructor PageWidget</SPAN> (line <span class="linenumber">70</span>)
352 jonen 1.1 <BR>
353 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
354 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
355 jonen 1.2 <span class="font10bold" style="color: #0000FF">PageWidget(
356     mixed
357     $title, [string
358     $render_type = HTML], [int
359     $indent_style = INDENT_NICE])</SPAN>
360 jonen 1.1 <BR>
361    
362     <BR>
363     <SPAN CLASS="font10bold">Description : </SPAN>
364     Constructor:
365 jonen 1.2 <br />
366 jonen 1.1
367     <DL>
368 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
369     <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$title</SPAN></SPAN> - $title Title string or TITLEtag object for the page.</DD>
370     <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">$render_type</SPAN></SPAN> - one of 3 types of html to render. Setting this will make the object declare the gobal define which tells all of the tag objects what type of html tags to render. some tags support special features. such as the &lt;IMG&gt; tag. If xhtml is selected, the the IMGtag object and all utility functions will not render "border=0" as a default attribute, since this is not proper xhtml. "html" - HTML 4.0 (default) "xhtml_transitional" - render xhtml instead of html - doctype is XHTML transitional. "xhtml_strict" - render xhtml instead of html 4.0. - doctype is XHTML strict.</DD>
371     <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">$indent_style</SPAN></SPAN> - one of 2 types. INDENT_NICE or INDENT_LEFT_JUSTIFY This tells the page how to render the indenting of the output. By default it is set to INDENT_NICE, which nicely indents each nested tag. You can have all tags rendered left justified (smaller size in output) by using INDENT_LEFT_JUSTIFY</DD>
372    
373     <DT class="font10bold">Function Info:</DT>
374     </DL>
375 jonen 1.1 </DIV>
376     <BR>
377     <DIV CLASS="function">
378 jonen 1.2 <A NAME='methodbody_content'><!-- --></A>
379     <SPAN CLASS="font12bold">body_content</SPAN> (line <span class="linenumber">130</span>)
380 jonen 1.1 <BR>
381 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
382 jonen 1.1 <span class="font10bold" style="color: #FF0000">mixed.</SPAN>&nbsp;
383 jonen 1.2 <span class="font10bold" style="color: #0000FF">body_content(
384     )</SPAN>
385 jonen 1.1 <BR>
386 jonen 1.2 <p>Overridden in child classes as:<br />
387     <dl>
388     <dt><a href="../phpHtmlLib/examples/MyLayoutPage.html#methodbody_content">MyLayoutPage::body_content()</a></dt>
389     <dd>This builds the main content for the page.</dd>
390     </dl>
391     </p>
392    
393 jonen 1.1 <BR>
394     <SPAN CLASS="font10bold">Description : </SPAN>
395 jonen 1.2 This function is meant to be overridden by the child class.
396     <br />
397     <p>This provides all of the content for the page. NOTE: You add the content to the body in 1 of 2 ways. 1) return the content from this call. 2) inside the call, you can just call $this-&gt;add(); and then return NULL;</p>
398 jonen 1.1 <DL>
399    
400 jonen 1.2 <DT class="font10bold">Function Info:</DT>
401     </DL>
402 jonen 1.1 </DIV>
403     <BR>
404     <DIV CLASS="function">
405 jonen 1.2 <A NAME='methodenable_debug'><!-- --></A>
406     <SPAN CLASS="font12bold">enable_debug</SPAN> (line <span class="linenumber">164</span>)
407 jonen 1.1 <BR>
408 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
409 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
410 jonen 1.2 <span class="font10bold" style="color: #0000FF">enable_debug(
411     [boolean
412     $flag = TRUE])</SPAN>
413 jonen 1.1 <BR>
414    
415     <BR>
416     <SPAN CLASS="font10bold">Description : </SPAN>
417 jonen 1.2 This sets the debug option for the HTMLPageClass
418     <br />
419 jonen 1.1
420     <DL>
421 jonen 1.2 <DT class="font10bold">Function Parameters:</DT>
422     <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>
423    
424     <DT class="font10bold">Function Info:</DT>
425     </DL>
426 jonen 1.1 </DIV>
427     <BR>
428     <DIV CLASS="function">
429 jonen 1.2 <A NAME='methodframeset'><!-- --></A>
430     <SPAN CLASS="font12bold">frameset</SPAN> (line <span class="linenumber">141</span>)
431 jonen 1.1 <BR>
432 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
433 jonen 1.1 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
434 jonen 1.2 <span class="font10bold" style="color: #0000FF">frameset(
435     )</SPAN>
436 jonen 1.1 <BR>
437    
438     <BR>
439     <SPAN CLASS="font10bold">Description : </SPAN>
440     This function is used to save
441 jonen 1.2 <br />
442     <p>a frameset to the page. This will automatically output a properly formatted</p>
443 jonen 1.1 <DL>
444    
445 jonen 1.2 <DT class="font10bold">Function Info:</DT>
446     </DL>
447 jonen 1.1 </DIV>
448     <BR>
449     <DIV CLASS="function">
450 jonen 1.2 <A NAME='methodget_title'><!-- --></A>
451     <SPAN CLASS="font12bold">get_title</SPAN> (line <span class="linenumber">89</span>)
452 jonen 1.1 <BR>
453 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
454 jonen 1.1 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
455 jonen 1.2 <span class="font10bold" style="color: #0000FF">get_title(
456     )</SPAN>
457 jonen 1.1 <BR>
458    
459     <BR>
460     <SPAN CLASS="font10bold">Description : </SPAN>
461     gets the current title of the page.
462 jonen 1.2 <br />
463 jonen 1.1
464     <DL>
465    
466 jonen 1.2 <DT class="font10bold">Function Info:</DT>
467     </DL>
468 jonen 1.1 </DIV>
469     <BR>
470     <DIV CLASS="function">
471 jonen 1.2 <A NAME='methodhead_content'><!-- --></A>
472     <SPAN CLASS="font12bold">head_content</SPAN> (line <span class="linenumber">110</span>)
473 jonen 1.1 <BR>
474 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
475 jonen 1.1 <span class="font10bold" style="color: #FF0000">mixed.</SPAN>&nbsp;
476 jonen 1.2 <span class="font10bold" style="color: #0000FF">head_content(
477     )</SPAN>
478 jonen 1.1 <BR>
479    
480     <BR>
481     <SPAN CLASS="font10bold">Description : </SPAN>
482 jonen 1.2 This function is used to build addition head content that isn't built by the HTMLPageClass parent class by default.
483     <br />
484     <p>NOTE: you can add addition content to the head in 1 of 2 ways. 1) inside the call return the addition content in the return $foo; 2) or use the HTMLPageClass' $this-&gt;add_head_content() from within the head_content() call.</p>
485 jonen 1.1 <DL>
486    
487 jonen 1.2 <DT class="font10bold">Function Info:</DT>
488     </DL>
489 jonen 1.1 </DIV>
490     <BR>
491     <DIV CLASS="function">
492 jonen 1.2 <A NAME='methodhead_javascript'><!-- --></A>
493     <SPAN CLASS="font12bold">head_javascript</SPAN> (line <span class="linenumber">153</span>)
494 jonen 1.1 <BR>
495 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
496 jonen 1.1 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
497 jonen 1.2 <span class="font10bold" style="color: #0000FF">head_javascript(
498     )</SPAN>
499 jonen 1.1 <BR>
500    
501     <BR>
502     <SPAN CLASS="font10bold">Description : </SPAN>
503 jonen 1.2 This function is called to build any JavaScript that is needed in the &lt;HEAD&gt; portion of a document.
504     <br />
505 jonen 1.1
506     <DL>
507    
508 jonen 1.2 <DT class="font10bold">Function Info:</DT>
509     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the raw JS code to be put inside the &lt;head&gt;</DD>
510     </DL>
511 jonen 1.1 </DIV>
512     <BR>
513     <DIV CLASS="function">
514 jonen 1.2 <A NAME='methodrender'><!-- --></A>
515     <SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">175</span>)
516 jonen 1.1 <BR>
517 jonen 1.2 <SPAN CLASS="font10bold">Usage : </SPAN>
518 jonen 1.1 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
519 jonen 1.2 <span class="font10bold" style="color: #0000FF">render(
520     )</SPAN>
521 jonen 1.1 <BR>
522 jonen 1.2
523     <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a> render the page.
524 jonen 1.1 <BR>
525     <SPAN CLASS="font10bold">Description : </SPAN>
526 jonen 1.2 This is the function that renders the HTML for this widget.
527     <br />
528 jonen 1.1
529     <DL>
530    
531 jonen 1.2 <DT class="font10bold">Function Info:</DT>
532     <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the HTML</DD>
533     </DL>
534 jonen 1.1 </DIV>
535     <BR>
536 jonen 1.2 <div id="credit">
537     <hr>
538     Documention generated on Thu, 20 Feb 2003 16:23:06 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
539     </div>
540     </body>
541     </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed