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

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

Parent Directory Parent Directory | Revision Log Revision Log

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