/[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.3 - (show annotations)
Sat Sep 20 00:24:03 2003 UTC (20 years, 11 months ago) by jonen
Branch: MAIN
Changes since 1.2: +490 -533 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 PageWidget</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 PageWidget</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-var-summary">Vars</a> (<a href="#sec-vars">details</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="_widgets_PageWidget_inc.html">Program_Root/widgets/PageWidget.inc</a> (line <span class="field">25</span>)
32 </p>
33
34
35 <pre><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a>
36 |
37 --PageWidget</pre>
38
39 </div>
40 </div>
41
42 <a name="sec-descendents"></a>
43 <div class="info-box">
44 <div class="info-box-title">Direct descendents</div>
45 <div class="nav-bar">
46 <a href="#sec-description">Description</a> |
47 <span class="disabled">Descendents</span>
48 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
49 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50
51 </div>
52 <div class="info-box-body">
53 <table cellpadding="2" cellspacing="0" class="class-table">
54 <tr>
55 <th class="class-table-header">Class</th>
56 <th class="class-table-header">Description</th>
57 </tr>
58 <tr>
59 <td style="padding-right: 2em"><a href="../phpHtmlLib/examples/MyLayoutPage.html">MyLayoutPage</a></td>
60 <td>
61 This is an example Child of the PageWidget
62 </td>
63 </tr>
64 </table>
65 </div>
66 </div>
67
68 <a name="sec-var-summary"></a>
69 <div class="info-box">
70 <div class="info-box-title">Variable Summary</span></div>
71 <div class="nav-bar">
72 <a href="#sec-description">Description</a> |
73 <a href="#sec-descendents">Descendents</a> |
74 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
75 |
76 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
77
78 </div>
79 <div class="info-box-body">
80 <div class="var-summary">
81 <div class="var-title">
82 <span class="var-type">mixed</span>
83 <a href="#$_enable_debug" title="details" class="var-name">$_enable_debug</a>
84 </div>
85 <div class="var-title">
86 <span class="var-type">mixed</span>
87 <a href="#$_title_text" title="details" class="var-name">$_title_text</a>
88 </div>
89 </div>
90 </div>
91 </div>
92
93 <a name="sec-method-summary"></a>
94 <div class="info-box">
95 <div class="info-box-title">Method Summary</span></div>
96 <div class="nav-bar">
97 <a href="#sec-description">Description</a> |
98 <a href="#sec-descendents">Descendents</a> |
99 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
100
101 |
102 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
103 </div>
104 <div class="info-box-body">
105 <div class="method-summary">
106
107 <div class="method-definition">
108 <span class="method-result">void</span>
109 <a href="#PageWidget" title="details" class="method-name">PageWidget</a>
110 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$render_type</span> = <span class="var-default">HTML</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_style</span> = <span class="var-default">INDENT_NICE</span>])
111 </div>
112
113 <div class="method-definition">
114 <span class="method-result">mixed.</span>
115 <a href="#body_content" title="details" class="method-name">body_content</a>
116 ()
117 </div>
118
119 <div class="method-definition">
120 <span class="method-result">void</span>
121 <a href="#enable_debug" title="details" class="method-name">enable_debug</a>
122 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
123 </div>
124
125 <div class="method-definition">
126 <span class="method-result">void</span>
127 <a href="#frameset" title="details" class="method-name">frameset</a>
128 ()
129 </div>
130
131 <div class="method-definition">
132 <span class="method-result">string</span>
133 <a href="#get_title" title="details" class="method-name">get_title</a>
134 ()
135 </div>
136
137 <div class="method-definition">
138 <span class="method-result">mixed.</span>
139 <a href="#head_content" title="details" class="method-name">head_content</a>
140 ()
141 </div>
142
143 <div class="method-definition">
144 <span class="method-result">string</span>
145 <a href="#head_javascript" title="details" class="method-name">head_javascript</a>
146 ()
147 </div>
148
149 <div class="method-definition">
150 <span class="method-result">string</span>
151 <a href="#render" title="details" class="method-name">render</a>
152 ()
153 </div>
154 </div>
155 </div>
156 </div>
157
158 <a name="sec-vars"></a>
159 <div class="info-box">
160 <div class="info-box-title">Variables</div>
161 <div class="nav-bar">
162 <a href="#sec-description">Description</a> |
163 <a href="#sec-descendents">Descendents</a> |
164 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
165
166
167 |
168 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
169
170 </div>
171 <div class="info-box-body">
172 <a name="var$_enable_debug" id="$_enable_debug"><!-- --></A>
173 <div class="oddrow">
174
175 <div class="var-header">
176 <span class="var-title">
177 <span class="var-type">mixed</span>
178 <span class="var-name">$_enable_debug</span>
179 = <span class="var-default"> FALSE</span> (line <span class="line-number">35</span>)
180 </span>
181 </div>
182
183 <!-- ========== Info from phpDoc block ========= -->
184 <p class="short-description">This enables the ability to view the source of a page bu setting debug=1 in the query string.</p>
185
186
187
188
189
190 </div>
191 <a name="var$_title_text" id="$_title_text"><!-- --></A>
192 <div class="evenrow">
193
194 <div class="var-header">
195 <span class="var-title">
196 <span class="var-type">mixed</span>
197 <span class="var-name">$_title_text</span>
198 = <span class="var-default"> NULL</span> (line <span class="line-number">43</span>)
199 </span>
200 </div>
201
202 <!-- ========== Info from phpDoc block ========= -->
203 <p class="short-description">holds the page title text for</p>
204 <p class="description"><p>a page</p></p>
205
206
207
208
209
210 </div>
211 <h4>Inherited Variables</h4>
212 <A NAME='inherited_vars'><!-- --></A>
213 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p>
214 <blockquote>
215 <span class="var-title">
216 <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_html_attributes">HTMLPageClass::$_html_attributes</a></span><br>
217 </span>
218 <span class="var-title">
219 <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_indent_style">HTMLPageClass::$_indent_style</a></span><br>
220 </span>
221 <span class="var-title">
222 <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_css_auto">HTMLPageClass::$_widget_css_auto</a></span><br>
223 </span>
224 <span class="var-title">
225 <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_widget_js_auto">HTMLPageClass::$_widget_js_auto</a></span><br>
226 </span>
227 <span class="var-title">
228 <span class="var-name"><a href="../phpHtmlLib/HTMLPageClass.html#var$_xml_encoding">HTMLPageClass::$_xml_encoding</a></span><br>
229 </span>
230 </blockquote>
231
232 </div>
233 </div>
234
235 <a name="sec-methods"></a>
236 <div class="info-box">
237 <div class="info-box-title">Methods</div>
238 <div class="nav-bar">
239 <a href="#sec-description">Description</a> |
240 <a href="#sec-descendents">Descendents</a> |
241 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
242 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
243
244 </div>
245 <div class="info-box-body">
246 <A NAME='method_detail'></A>
247 <a name="methodPageWidget" id="PageWidget"><!-- --></a>
248 <div class="oddrow">
249
250 <div class="method-header">
251 <span class="method-title">Constructor PageWidget</span> (line <span class="line-number">70</span>)
252 </div>
253
254 <!-- ========== Info from phpDoc block ========= -->
255 <p class="short-description">Constructor:</p>
256
257 <div class="method-signature">
258 <span class="method-result">void</span>
259 <span class="method-name">
260 PageWidget
261 </span>
262 (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$render_type</span> = <span class="var-default">HTML</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_style</span> = <span class="var-default">INDENT_NICE</span>])
263 </div>
264
265 <ul class="parameters">
266 <li>
267 <span class="var-type">mixed</span>
268 <span class="var-name">$title</span><span class="var-description">: <p>- $title Title string or TITLEtag object for the page.</p></span> </li>
269 <li>
270 <span class="var-type">string</span>
271 <span class="var-name">$render_type</span><span class="var-description">: <p>- 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 &quot;border=0&quot; as a default attribute, since this is not proper xhtml. &quot;html&quot; - HTML 4.0 (default) &quot;xhtml_transitional&quot; - render xhtml instead of html <ul><li>doctype is XHTML transitional.</li></ul> &quot;xhtml_strict&quot; - render xhtml instead of html 4.0. <ul><li>doctype is XHTML strict.</li></ul></p></span> </li>
272 <li>
273 <span class="var-type">int</span>
274 <span class="var-name">$indent_style</span><span class="var-description">: <p>- 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</p></span> </li>
275 </ul>
276
277
278 </div>
279 <a name="methodbody_content" id="body_content"><!-- --></a>
280 <div class="evenrow">
281
282 <div class="method-header">
283 <span class="method-title">body_content</span> (line <span class="line-number">130</span>)
284 </div>
285
286 <!-- ========== Info from phpDoc block ========= -->
287 <p class="short-description">This function is meant to be overridden by the child class.</p>
288 <p class="description"><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></p>
289
290 <div class="method-signature">
291 <span class="method-result">mixed.</span>
292 <span class="method-name">
293 body_content
294 </span>
295 ()
296 </div>
297
298
299
300 <hr class="separator" />
301 <div class="notes">Redefined in descendants as:</div>
302 <ul class="redefinitions">
303 <li>
304 <a href="../phpHtmlLib/examples/MyLayoutPage.html#methodbody_content">MyLayoutPage::body_content()</a>
305 : This builds the main content for the page.
306 </li>
307 </ul>
308 </div>
309 <a name="methodenable_debug" id="enable_debug"><!-- --></a>
310 <div class="oddrow">
311
312 <div class="method-header">
313 <span class="method-title">enable_debug</span> (line <span class="line-number">164</span>)
314 </div>
315
316 <!-- ========== Info from phpDoc block ========= -->
317 <p class="short-description">This sets the debug option for the HTMLPageClass</p>
318
319 <div class="method-signature">
320 <span class="method-result">void</span>
321 <span class="method-name">
322 enable_debug
323 </span>
324 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span> = <span class="var-default">TRUE</span>])
325 </div>
326
327 <ul class="parameters">
328 <li>
329 <span class="var-type">boolean</span>
330 <span class="var-name">$flag</span><span class="var-description">: <p>TRUE for on, FALSE for off</p></span> </li>
331 </ul>
332
333
334 </div>
335 <a name="methodframeset" id="frameset"><!-- --></a>
336 <div class="evenrow">
337
338 <div class="method-header">
339 <span class="method-title">frameset</span> (line <span class="line-number">141</span>)
340 </div>
341
342 <!-- ========== Info from phpDoc block ========= -->
343 <p class="short-description">This function is used to save</p>
344 <p class="description"><p>a frameset to the page. This will automatically output a properly formatted</p></p>
345
346 <div class="method-signature">
347 <span class="method-result">void</span>
348 <span class="method-name">
349 frameset
350 </span>
351 ()
352 </div>
353
354
355
356 </div>
357 <a name="methodget_title" id="get_title"><!-- --></a>
358 <div class="oddrow">
359
360 <div class="method-header">
361 <span class="method-title">get_title</span> (line <span class="line-number">89</span>)
362 </div>
363
364 <!-- ========== Info from phpDoc block ========= -->
365 <p class="short-description">gets the current title of the page.</p>
366
367 <div class="method-signature">
368 <span class="method-result">string</span>
369 <span class="method-name">
370 get_title
371 </span>
372 ()
373 </div>
374
375
376
377 </div>
378 <a name="methodhead_content" id="head_content"><!-- --></a>
379 <div class="evenrow">
380
381 <div class="method-header">
382 <span class="method-title">head_content</span> (line <span class="line-number">110</span>)
383 </div>
384
385 <!-- ========== Info from phpDoc block ========= -->
386 <p class="short-description">This function is used to build addition head content that isn't built by the HTMLPageClass parent class by default.</p>
387 <p class="description"><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></p>
388
389 <div class="method-signature">
390 <span class="method-result">mixed.</span>
391 <span class="method-name">
392 head_content
393 </span>
394 ()
395 </div>
396
397
398
399 </div>
400 <a name="methodhead_javascript" id="head_javascript"><!-- --></a>
401 <div class="oddrow">
402
403 <div class="method-header">
404 <span class="method-title">head_javascript</span> (line <span class="line-number">153</span>)
405 </div>
406
407 <!-- ========== Info from phpDoc block ========= -->
408 <p class="short-description">This function is called to build any JavaScript that is needed in the &lt;HEAD&gt; portion of a document.</p>
409 <ul class="tags">
410 <li><span class="field">return:</span> <p>- the raw JS code to be put inside the &lt;head&gt;</p></li>
411 </ul>
412
413 <div class="method-signature">
414 <span class="method-result">string</span>
415 <span class="method-name">
416 head_javascript
417 </span>
418 ()
419 </div>
420
421
422
423 </div>
424 <a name="methodrender" id="render"><!-- --></a>
425 <div class="evenrow">
426
427 <div class="method-header">
428 <span class="method-title">render</span> (line <span class="line-number">175</span>)
429 </div>
430
431 <!-- ========== Info from phpDoc block ========= -->
432 <p class="short-description">This is the function that renders the HTML for this widget.</p>
433 <ul class="tags">
434 <li><span class="field">return:</span> <p>- the HTML</p></li>
435 </ul>
436
437 <div class="method-signature">
438 <span class="method-result">string</span>
439 <span class="method-name">
440 render
441 </span>
442 ()
443 </div>
444
445
446 <hr class="separator" />
447 <div class="notes">Redefinition of:</div>
448 <dl>
449 <dt><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></dt>
450 <dd>render the page.</dd>
451 </dl>
452
453 </div>
454 <h4>Inherited Methods</h4>
455 <a name='inherited_methods'><!-- --></a>
456 <!-- =========== Summary =========== -->
457 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/HTMLPageClass.html">HTMLPageClass</a></span></p>
458 <blockquote>
459 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodHTMLPageClass">HTMLPageClass::HTMLPageClass()</a></span><br>
460 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd">HTMLPageClass::add()</a></span><br>
461 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_css_link">HTMLPageClass::add_css_link()</a></span><br>
462 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_content">HTMLPageClass::add_head_content()</a></span><br>
463 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_css">HTMLPageClass::add_head_css()</a></span><br>
464 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_head_js">HTMLPageClass::add_head_js()</a></span><br>
465 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_js_link">HTMLPageClass::add_js_link()</a></span><br>
466 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodadd_reference">HTMLPageClass::add_reference()</a></span><br>
467 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodbuild_doctype">HTMLPageClass::build_doctype()</a></span><br>
468 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodget_html_attributes">HTMLPageClass::get_html_attributes()</a></span><br>
469 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush">HTMLPageClass::push()</a></span><br>
470 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_css_link">HTMLPageClass::push_css_link()</a></span><br>
471 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_content">HTMLPageClass::push_head_content()</a></span><br>
472 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_head_js">HTMLPageClass::push_head_js()</a></span><br>
473 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_js_link">HTMLPageClass::push_js_link()</a></span><br>
474 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodpush_reference">HTMLPageClass::push_reference()</a></span><br>
475 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodrender">HTMLPageClass::render()</a></span><br>
476 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_body_attributes">HTMLPageClass::set_body_attributes()</a></span><br>
477 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_charset">HTMLPageClass::set_charset()</a></span><br>
478 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_encoding">HTMLPageClass::set_encoding()</a></span><br>
479 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_frameset">HTMLPageClass::set_frameset()</a></span><br>
480 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_html_attributes">HTMLPageClass::set_html_attributes()</a></span><br>
481 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_language">HTMLPageClass::set_language()</a></span><br>
482 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_refresh">HTMLPageClass::set_refresh()</a></span><br>
483 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_text_debug">HTMLPageClass::set_text_debug()</a></span><br>
484 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#methodset_title">HTMLPageClass::set_title()</a></span><br>
485 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_content_type_tag">HTMLPageClass::_build_content_type_tag()</a></span><br>
486 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_build_head">HTMLPageClass::_build_head()</a></span><br>
487 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_create_body">HTMLPageClass::_create_body()</a></span><br>
488 <span class="method-name"><a href="../phpHtmlLib/HTMLPageClass.html#method_frameset_wrap_body">HTMLPageClass::_frameset_wrap_body()</a></span><br>
489 </blockquote>
490
491 </div>
492 </div>
493
494 <p class="notes" id="credit">
495 Documention generated on Thu, 31 Jul 2003 18:32:56 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
496 </p>
497 </div></body>
498 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed