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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations)
Wed Sep 24 12:50:38 2003 UTC (21 years ago) by jonen
Branch: MAIN
Changes since 1.2: +424 -536 lines
File MIME type: text/html
+ updated whole phphtmllib to v2.3.0

1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class MyLayoutPage</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9 </head>
10 <body>
11 <div class="page-body">
12 <h2 class="class-name">Class MyLayoutPage</h2>
13
14 <a name="sec-description"></a>
15 <div class="info-box">
16 <div class="info-box-title">Description</div>
17 <div class="nav-bar">
18 <span class="disabled">Description</span> |
19 <a href="#sec-descendents">Descendents</a>
20 | <a href="#sec-vars">Vars</a>
21 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22
23 </div>
24 <div class="info-box-body">
25 <!-- ========== Info from phpDoc block ========= -->
26 <p class="short-description">This class is used to build content for an entire page. It uses the HTMLPageClass widget from phphtmllib to render the final output.</p>
27 <ul class="tags">
28 <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
29 </ul>
30 <p class="notes">
31 Located in <a class="field" href="_examples_example3_php.html">Program_Root/examples/example3.php</a> (line <span class="field">94</span>)
32 </p>
33
34
35 <pre><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a>
36 |
37 --<a href="../../phpHtmlLib/PageWidget.html">PageWidget</a>
38 |
39 --MyLayoutPage</pre>
40
41 </div>
42 </div>
43
44 <a name="sec-descendents"></a>
45 <div class="info-box">
46 <div class="info-box-title">Direct descendents</div>
47 <div class="nav-bar">
48 <a href="#sec-description">Description</a> |
49 <span class="disabled">Descendents</span>
50 | <a href="#sec-vars">Vars</a>
51 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
52
53 </div>
54 <div class="info-box-body">
55 <table cellpadding="2" cellspacing="0" class="class-table">
56 <tr>
57 <th class="class-table-header">Class</th>
58 <th class="class-table-header">Description</th>
59 </tr>
60 <tr>
61 <td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/Form1Page.html">Form1Page</a></td>
62 <td>
63 A simple Page Layout object child.
64 </td>
65 </tr>
66 <tr>
67 <td style="padding-right: 2em"><a href="../../phpHtmlLib/form-examples/Form2Page.html">Form2Page</a></td>
68 <td>
69 A simple Page Layout object child.
70 </td>
71 </tr>
72 </table>
73 </div>
74 </div>
75
76
77 <a name="sec-method-summary"></a>
78 <div class="info-box">
79 <div class="info-box-title">Method Summary</span></div>
80 <div class="nav-bar">
81 <a href="#sec-description">Description</a> |
82 <a href="#sec-descendents">Descendents</a> |
83 <a href="#sec-vars">Vars</a>
84
85 |
86 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
87 </div>
88 <div class="info-box-body">
89 <div class="method-summary">
90
91 <div class="method-definition">
92 <span class="method-result">void</span>
93 <a href="#MyLayoutPage" title="details" class="method-name">MyLayoutPage</a>
94 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">-</span>&nbsp;<span class="var-name">$render_type</span> = <span class="var-default">HTML</span>])
95 </div>
96
97 <div class="method-definition">
98 <span class="method-result">void</span>
99 <a href="#body_content" title="details" class="method-name">body_content</a>
100 ()
101 </div>
102
103 <div class="method-definition">
104 <span class="method-result">HTMLTag</span>
105 <a href="#content_block" title="details" class="method-name">content_block</a>
106 ()
107 </div>
108
109 <div class="method-definition">
110 <span class="method-result"><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a></span>
111 <a href="#footer_block" title="details" class="method-name">footer_block</a>
112 ()
113 </div>
114
115 <div class="method-definition">
116 <span class="method-result"><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a></span>
117 <a href="#header_block" title="details" class="method-name">header_block</a>
118 ()
119 </div>
120
121 <div class="method-definition">
122 <span class="method-result">HTMLTag</span>
123 <a href="#left_block" title="details" class="method-name">left_block</a>
124 ()
125 </div>
126
127 <div class="method-definition">
128 <span class="method-result">void</span>
129 <a href="#main_block" title="details" class="method-name">main_block</a>
130 (<span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>&nbsp;<span class="var-name">0</span>)
131 </div>
132 </div>
133 </div>
134 </div>
135
136 <a name="sec-vars"></a>
137 <div class="info-box">
138 <div class="info-box-title">Variables</div>
139 <div class="nav-bar">
140 <a href="#sec-description">Description</a> |
141 <a href="#sec-descendents">Descendents</a> |
142 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
143
144
145 |
146 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
147
148 </div>
149 <div class="info-box-body">
150 <h4>Inherited Variables</h4>
151 <A NAME='inherited_vars'><!-- --></A>
152 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/PageWidget.html">PageWidget</a></span></p>
153 <blockquote>
154 <span class="var-title">
155 <span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_enable_debug">PageWidget::$_enable_debug</a></span><br>
156 </span>
157 <span class="var-title">
158 <span class="var-name"><a href="../../phpHtmlLib/PageWidget.html#var$_title_text">PageWidget::$_title_text</a></span><br>
159 </span>
160 </blockquote>
161 <p>Inherited from <span class="classname"><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p>
162 <blockquote>
163 <span class="var-title">
164 <span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></span><br>
165 </span>
166 <span class="var-title">
167 <span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></span><br>
168 </span>
169 <span class="var-title">
170 <span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></span><br>
171 </span>
172 <span class="var-title">
173 <span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></span><br>
174 </span>
175 <span class="var-title">
176 <span class="var-name"><a href="../../phpHtmlLib/HTMLPageClass.html#var$_xml_encoding">HTMLPageClass::$_xml_encoding</a></span><br>
177 </span>
178 </blockquote>
179
180 </div>
181 </div>
182
183 <a name="sec-methods"></a>
184 <div class="info-box">
185 <div class="info-box-title">Methods</div>
186 <div class="nav-bar">
187 <a href="#sec-description">Description</a> |
188 <a href="#sec-descendents">Descendents</a> |
189 <a href="#sec-vars">Vars</a>
190 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
191
192 </div>
193 <div class="info-box-body">
194 <A NAME='method_detail'></A>
195 <a name="methodMyLayoutPage" id="MyLayoutPage"><!-- --></a>
196 <div class="evenrow">
197
198 <div class="method-header">
199 <span class="method-title">Constructor MyLayoutPage</span> (line <span class="line-number">105</span>)
200 </div>
201
202 <!-- ========== Info from phpDoc block ========= -->
203 <p class="short-description">This is the constructor.</p>
204
205 <div class="method-signature">
206 <span class="method-result">void</span>
207 <span class="method-name">
208 MyLayoutPage
209 </span>
210 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">-</span>&nbsp;<span class="var-name">$render_type</span> = <span class="var-default">HTML</span>])
211 </div>
212
213 <ul class="parameters">
214 <li>
215 <span class="var-type">string</span>
216 <span class="var-name">$title</span><span class="var-description">: <p>- $title - the title for the page and the titlebar object.</p></span> </li>
217 <li>
218 <span class="var-type">-</span>
219 <span class="var-name">$render_type</span><span class="var-description">: <p>string - The render type (HTML, XHTML, etc. )</p></span> </li>
220 </ul>
221
222
223 </div>
224 <a name="methodbody_content" id="body_content"><!-- --></a>
225 <div class="oddrow">
226
227 <div class="method-header">
228 <span class="method-title">body_content</span> (line <span class="line-number">124</span>)
229 </div>
230
231 <!-- ========== Info from phpDoc block ========= -->
232 <p class="short-description">This builds the main content for the page.</p>
233
234 <div class="method-signature">
235 <span class="method-result">void</span>
236 <span class="method-name">
237 body_content
238 </span>
239 ()
240 </div>
241
242
243 <hr class="separator" />
244 <div class="notes">Redefinition of:</div>
245 <dl>
246 <dt><a href="../../phpHtmlLib/PageWidget.html#methodbody_content">PageWidget::body_content()</a></dt>
247 <dd>This function is meant to be overridden by the child class.</dd>
248 </dl>
249
250 </div>
251 <a name="methodcontent_block" id="content_block"><!-- --></a>
252 <div class="evenrow">
253
254 <div class="method-header">
255 <span class="method-title">content_block</span> (line <span class="line-number">215</span>)
256 </div>
257
258 <!-- ========== Info from phpDoc block ========= -->
259 <p class="short-description">this function returns the contents of the right block. It is already wrapped in a TD</p>
260 <ul class="tags">
261 <li><span class="field">return:</span> <p>object</p></li>
262 </ul>
263
264 <div class="method-signature">
265 <span class="method-result">HTMLTag</span>
266 <span class="method-name">
267 content_block
268 </span>
269 ()
270 </div>
271
272
273
274 <hr class="separator" />
275 <div class="notes">Redefined in descendants as:</div>
276 <ul class="redefinitions">
277 <li>
278 <a href="../../phpHtmlLib/form-examples/Form1Page.html#methodcontent_block">Form1Page::content_block()</a>
279 </li>
280 <li>
281 <a href="../../phpHtmlLib/form-examples/Form2Page.html#methodcontent_block">Form2Page::content_block()</a>
282 </li>
283 </ul>
284 </div>
285 <a name="methodfooter_block" id="footer_block"><!-- --></a>
286 <div class="oddrow">
287
288 <div class="method-header">
289 <span class="method-title">footer_block</span> (line <span class="line-number">230</span>)
290 </div>
291
292 <!-- ========== Info from phpDoc block ========= -->
293 <p class="short-description">This function is responsible for building the footer block for every page.</p>
294 <ul class="tags">
295 <li><span class="field">return:</span> <p>object.</p></li>
296 </ul>
297
298 <div class="method-signature">
299 <span class="method-result"><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a></span>
300 <span class="method-name">
301 footer_block
302 </span>
303 ()
304 </div>
305
306
307
308 </div>
309 <a name="methodheader_block" id="header_block"><!-- --></a>
310 <div class="evenrow">
311
312 <div class="method-header">
313 <span class="method-title">header_block</span> (line <span class="line-number">159</span>)
314 </div>
315
316 <!-- ========== Info from phpDoc block ========= -->
317 <p class="short-description">This function is responsible for building the header block that lives at the top of every page.</p>
318 <ul class="tags">
319 <li><span class="field">return:</span> <p>object.</p></li>
320 </ul>
321
322 <div class="method-signature">
323 <span class="method-result"><a href="../../phpHtmlLib/HTMLtag.html">HTMLtag</a></span>
324 <span class="method-name">
325 header_block
326 </span>
327 ()
328 </div>
329
330
331
332 </div>
333 <a name="methodleft_block" id="left_block"><!-- --></a>
334 <div class="oddrow">
335
336 <div class="method-header">
337 <span class="method-title">left_block</span> (line <span class="line-number">198</span>)
338 </div>
339
340 <!-- ========== Info from phpDoc block ========= -->
341 <p class="short-description">this function returns the contents of the left block. It is already wrapped in a TD</p>
342 <ul class="tags">
343 <li><span class="field">return:</span> <p>object</p></li>
344 </ul>
345
346 <div class="method-signature">
347 <span class="method-result">HTMLTag</span>
348 <span class="method-name">
349 left_block
350 </span>
351 ()
352 </div>
353
354
355
356 </div>
357 <a name="methodmain_block" id="main_block"><!-- --></a>
358 <div class="evenrow">
359
360 <div class="method-header">
361 <span class="method-title">main_block</span> (line <span class="line-number">174</span>)
362 </div>
363
364 <!-- ========== Info from phpDoc block ========= -->
365 <p class="short-description">We override this method to automatically break up the main block into a left block and a right block</p>
366
367 <div class="method-signature">
368 <span class="method-result">void</span>
369 <span class="method-name">
370 main_block
371 </span>
372 (<span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>&nbsp;<span class="var-name">0</span>)
373 </div>
374
375 <ul class="parameters">
376 <li>
377 <span class="var-type"><a href="../../phpHtmlLib/TABLEtag.html">TABLEtag</a></span>
378 <span class="var-name">0</span><span class="var-description">: <p>object.</p></span> </li>
379 </ul>
380
381
382 </div>
383 <h4>Inherited Methods</h4>
384 <a name='inherited_methods'><!-- --></a>
385 <!-- =========== Summary =========== -->
386 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/PageWidget.html">PageWidget</a></span></p>
387 <blockquote>
388 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodPageWidget">PageWidget::PageWidget()</a></span><br>
389 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodbody_content">PageWidget::body_content()</a></span><br>
390 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodenable_debug">PageWidget::enable_debug()</a></span><br>
391 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodframeset">PageWidget::frameset()</a></span><br>
392 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodget_title">PageWidget::get_title()</a></span><br>
393 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodhead_content">PageWidget::head_content()</a></span><br>
394 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodhead_javascript">PageWidget::head_javascript()</a></span><br>
395 <span class="method-name"><a href="../../phpHtmlLib/PageWidget.html#methodrender">PageWidget::render()</a></span><br>
396 </blockquote>
397 <!-- =========== Summary =========== -->
398 <p>Inherited From <span class="classname"><a href="../../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p>
399 <blockquote>
400 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></span><br>
401 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></span><br>
402 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></span><br>
403 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></span><br>
404 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></span><br>
405 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></span><br>
406 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_js_link">HTMLPageClass::add_js_link()</a></span><br>
407 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></span><br>
408 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></span><br>
409 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></span><br>
410 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></span><br>
411 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></span><br>
412 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></span><br>
413 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></span><br>
414 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></span><br>
415 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></span><br>
416 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></span><br>
417 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></span><br>
418 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></span><br>
419 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_encoding">HTMLPageClass::set_encoding()</a></span><br>
420 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></span><br>
421 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></span><br>
422 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_language">HTMLPageClass::set_language()</a></span><br>
423 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></span><br>
424 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></span><br>
425 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></span><br>
426 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></span><br>
427 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></span><br>
428 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></span><br>
429 <span class="method-name"><a href="../../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></span><br>
430 </blockquote>
431
432 </div>
433 </div>
434
435 <p class="notes" id="credit">
436 Documention generated on Thu, 31 Jul 2003 18:32:27 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
437 </p>
438 </div></body>
439 </html>

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