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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu Jan 30 03:29:34 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:24 -0800' -->
6 <TITLE>Docs For Class BODYtag</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10
11
12 <!-- Links -->
13 <a NAME="top"></A>
14 <table WIDTH="100%" class="links">
15 <TR>
16 <TD class="font10">
17 Links:
18 <A HREF="#children_summary" class="links" title="Classes extended from BODYtag">Child Classes</A>
19 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
20 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
21 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>
22 <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>
23 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
24 <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>
25 </TD>
26 </TR>
27 </TABLE>
28 <BR>
29
30 <!-- Start of Class Data -->
31 <H2>
32 Class BODYtag
33 </H2>
34
35 <pre>
36 <pre><a href="../phpHtmlLib/Container.html">Container</a>
37 |
38 --<a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a>
39 |
40 --<a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a>
41 |
42 --BODYtag</pre>
43 </pre>
44
45 <A NAME="children_summary"</A>
46 <H3>
47 Classes extended from BODYtag: <A HREF="#top" CLASS="links">^TOP</A>
48 </H3>
49
50 <p>
51 <b><i>Located in File: Program_Root/tag_classes/ALLTAGS.inc</i></b><br>
52 </p>
53 <hr>
54 <!-- ========== Info from phpDoc block ========= -->
55 &lt;BODY&gt; tag class
56 <BR>
57 Defines the documents' body.
58
59 OPTIONAL ATTRIBUTES (all depricated)
60 alink =&gt; color : DEPRICATED
61 background =&gt; filename : DEPRICATED
62 bgcolor =&gt; color : DEPRICATED
63 link =&gt; color : DEPRICATED
64 text =&gt; color : DEPRICATED
65 vlink =&gt; color : DEPRICATED
66
67 <UL>
68
69 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
70
71 </UL>
72
73 <hr>
74 <!-- =========== VAR SUMMARY =========== -->
75 <A NAME='var_summary'><!-- --></A>
76 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
77 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
78 <TD>
79 <span CLASS="font12bold">Class Variable Summary</span>
80 <A HREF="#top" CLASS="links">^TOP</A>
81 </TD>
82 </TR>
83
84
85 <!-- =========== Summary =========== -->
86 <TR BGCOLOR='white' CLASS='TableRowColor'>
87 <TD>
88 <CODE><B><A HREF='BODYtag.html#$_tag'>$_tag</A></B></CODE>
89 <BR>
90 <blockquote> </blockquote>
91 <blockquote> Default Value: <CODE>->body<-</CODE> </blockquote>
92 </TD>
93 </TR>
94
95 </TABLE>
96
97 <hr>
98 <!-- =========== VAR INHERITED SUMMARY =========== -->
99 <A NAME='var_inherited_summary'><!-- --></A>
100 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
101 <TR CLASS='TableHeadingColor'>
102 <TD>
103 <span CLASS="font12bold">Inherited Class Variable Summary</span>
104 <A HREF="#top" CLASS="links">^TOP</A>
105 </TD>
106 </TR>
107
108
109 <!-- =========== Summary =========== -->
110 <TR BGCOLOR='white'>
111 <TD>
112 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></span>
113 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
114 <tr CLASS="tableheadingcolor">
115 <th>Variable</th>
116 <th>Default Value</th>
117 <th>Description</th>
118 </tr>
119
120 <tr>
121 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#$_depricated'>$_depricated</A></td>
122 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
123 <td CLASS="font10">Flag to denote that this tag is
124 depricated by the HTML standard.</td>
125 </tr>
126
127 <tr>
128 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#$_no_finish_slash_xhtml'>$_no_finish_slash_xhtml</A></td>
129 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
130 <td CLASS="font10">Flag to tell the renderer not to
131 place the /&gt; if we are in xhtml
132 compliant mode.</td>
133 </tr>
134
135 <tr>
136 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#$_xhtml_strict_attributes'>$_xhtml_strict_attributes</A></td>
137 <td CLASS="font10" STYLE="white-space: nowrap">->array()<-</td>
138 <td CLASS="font10">The list of attributes not to render
139 if HTML_RENDER_TYPE is &quot;XHTML STRICT&quot;</td>
140 </tr>
141
142 </table>
143 <BR>
144 </TD>
145 </TR>
146
147 <!-- =========== Summary =========== -->
148 <TR BGCOLOR='white'>
149 <TD>
150 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
151 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
152 <tr CLASS="tableheadingcolor">
153 <th>Variable</th>
154 <th>Default Value</th>
155 <th>Description</th>
156 </tr>
157
158 <tr>
159 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_closetag'>$newline_after_closetag</A></td>
160 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
161 <td CLASS="font10">Flag to place a newline after close tag.</td>
162 </tr>
163
164 <tr>
165 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$newline_after_opentag'>$newline_after_opentag</A></td>
166 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
167 <td CLASS="font10">Flag to place a newline after open tag.</td>
168 </tr>
169
170 <tr>
171 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_cdata_content_wrap'>$_cdata_content_wrap</A></td>
172 <td CLASS="font10" STYLE="white-space: nowrap">->FALSE<-</td>
173 <td CLASS="font10">Automatically wrap ALL content</td>
174 </tr>
175
176 <tr>
177 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_postfix'>$_tag_postfix</A></td>
178 <td CLASS="font10" STYLE="white-space: nowrap">->&gt;<-</td>
179 <td CLASS="font10">holds the tag postfix</td>
180 </tr>
181
182 <tr>
183 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#$_tag_prefix'>$_tag_prefix</A></td>
184 <td CLASS="font10" STYLE="white-space: nowrap">->&lt;<-</td>
185 <td CLASS="font10">holds the tag prefix</td>
186 </tr>
187
188 </table>
189 <BR>
190 </TD>
191 </TR>
192
193 <!-- =========== Summary =========== -->
194 <TR BGCOLOR='white'>
195 <TD>
196 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
197 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
198 <tr CLASS="tableheadingcolor">
199 <th>Variable</th>
200 <th>Default Value</th>
201 <th>Description</th>
202 </tr>
203
204 <tr>
205 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
206 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
207 <td CLASS="font10">Flag for pretty (indented) output</td>
208 </tr>
209
210 <tr>
211 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
212 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
213 <td CLASS="font10">Do we render a newline after the
214 contents has been rendered?</td>
215 </tr>
216
217 </table>
218 <BR>
219 </TD>
220 </TR>
221
222 </TABLE>
223
224 <hr>
225 <!-- =========== INHERITED METHOD SUMMARY =========== -->
226 <A NAME='functions_inherited'><!-- --></A>
227 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
228 <TR CLASS='TableHeadingColor'>
229 <TD>
230 <span CLASS="font12bold">Inherited Method Summary</span>
231 <A HREF="#top" CLASS="links">^TOP</A>
232 </TD>
233 </TR>
234
235
236 <!-- =========== Summary =========== -->
237 <TR BGCOLOR='white' CLASS='TableRowColor'>
238 <TD>
239 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></span>
240 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
241 <tr CLASS="tableheadingcolor">
242 <th>Function</th>
243 <th>Description</th>
244 </tr>
245
246 <tr>
247 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#constructor HTMLTagClass'>constructor HTMLTagClass ( [$attributes = NULL] )</A></td>
248 <td CLASS="font10">Class Constructor</td>
249
250 <tr>
251 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#render'>render ( [$indent_level = NULL], [$output_debug = 0] )</A></td>
252 <td CLASS="font10">Renders the tag, attributes, content and close tag.</td>
253
254 <tr>
255 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#set_class'>set_class ( $value )</A></td>
256 <td CLASS="font10">This function is a shorthand helper
257 to setting the class attribute on a
258 tag.</td>
259
260 <tr>
261 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#set_id'>set_id ( $value )</A></td>
262 <td CLASS="font10">This function is a shorthand helper
263 to setting the id attribute on a
264 tag.</td>
265
266 <tr>
267 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#set_style'>set_style ( $value )</A></td>
268 <td CLASS="font10">This function is a shorthand helper
269 to setting the style attribute on a
270 tag.</td>
271
272 <tr>
273 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#_build_attribute_string'>_build_attribute_string ( $name, $value, [$debug = 0] )</A></td>
274 <td CLASS="font10">this builds an attribute for a tag.</td>
275
276 <tr>
277 <td CLASS="font10bold"><A HREF='../phpHtmlLib/HTMLTagClass.html#_render_tag_debug'>_render_tag_debug ( $indent_level )</A></td>
278 <td CLASS="font10">This renders that open tag in debug mode.</td>
279
280 </table>
281 <br>
282 </TD>
283 </TR>
284
285 <!-- =========== Summary =========== -->
286 <TR BGCOLOR='white' CLASS='TableRowColor'>
287 <TD>
288 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></span>
289 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
290 <tr CLASS="tableheadingcolor">
291 <th>Function</th>
292 <th>Description</th>
293 </tr>
294
295 <tr>
296 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#constructor XMLTagClass'>constructor XMLTagClass ( [$name = ], [$attributes = array()] )</A></td>
297 <td CLASS="font10">The constructor</td>
298
299 <tr>
300 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag'>get_tag ( )</A></td>
301 <td CLASS="font10">This returns the tag declared for this class.</td>
302
303 <tr>
304 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#get_tag_name'>get_tag_name ( )</A></td>
305 <td CLASS="font10">This method gets the name of the tag</td>
306
307 <tr>
308 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#render'>render ( [$indent_level = 0] )</A></td>
309 <td CLASS="font10">This function is responsible</td>
310
311 <tr>
312 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#reset_attributes'>reset_attributes ( [$attributes = array()] )</A></td>
313 <td CLASS="font10">clear all attributes and start with new attributes</td>
314
315 <tr>
316 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
317 <td CLASS="font10">This function turns on the collapse flag</td>
318
319 <tr>
320 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_closetag'>set_newline_after_closetag ( $flag )</A></td>
321 <td CLASS="font10">set the newline_after_content flag</td>
322
323 <tr>
324 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_newline_after_opentag'>set_newline_after_opentag ( $flag )</A></td>
325 <td CLASS="font10">set the newline_after_opentag flag</td>
326
327 <tr>
328 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attribute'>set_tag_attribute ( $name, [$value = NULL] )</A></td>
329 <td CLASS="font10">add a single attribute (name=&quot;value&quot;)</td>
330
331 <tr>
332 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_attributes'>set_tag_attributes ( [$attributes = array()] )</A></td>
333 <td CLASS="font10">add multiple attributes (name=&quot;value&quot;)</td>
334
335 <tr>
336 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#set_tag_name'>set_tag_name ( $name )</A></td>
337 <td CLASS="font10">This method sets the name of the tag</td>
338
339 <tr>
340 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_build_attribute_string'>_build_attribute_string ( $name, $value )</A></td>
341 <td CLASS="font10">this builds an attribute for an XML tag.</td>
342
343 <tr>
344 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_get_element'>_get_element ( $cell )</A></td>
345 <td CLASS="font10">get the nth element from content array</td>
346
347 <tr>
348 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_prepare_flags'>_prepare_flags ( )</A></td>
349 <td CLASS="font10">This function checks to see if</td>
350
351 <tr>
352 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_close_tag'>_render_close_tag ( $indent_level )</A></td>
353 <td CLASS="font10">this function is reposnsible for
354 rendering the closing tag (if any)</td>
355
356 <tr>
357 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_content'>_render_content ( $indent_level, [$output_debug = 0] )</A></td>
358 <td CLASS="font10">this function is reponsible for</td>
359
360 <tr>
361 <td CLASS="font10bold"><A HREF='../phpHtmlLib/XMLTagClass.html#_render_open_tag'>_render_open_tag ( $indent_level, [$finish_slash = TRUE] )</A></td>
362 <td CLASS="font10">this function is responsible for
363 rendering the open tag.</td>
364
365 </table>
366 <br>
367 </TD>
368 </TR>
369
370 <!-- =========== Summary =========== -->
371 <TR BGCOLOR='white' CLASS='TableRowColor'>
372 <TD>
373 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
374 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
375 <tr CLASS="tableheadingcolor">
376 <th>Function</th>
377 <th>Description</th>
378 </tr>
379
380 <tr>
381 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
382 <td CLASS="font10">The constructor.</td>
383
384 <tr>
385 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
386 <td CLASS="font10">add content onto content stack</td>
387
388 <tr>
389 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
390 <td CLASS="font10">Add content onto content stack
391 so you can change the item later.</td>
392
393 <tr>
394 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
395 <td CLASS="font10">counts the number of content objects</td>
396
397 <tr>
398 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
399 <td CLASS="font10">This flag gets the current value
400 of the indent flag</td>
401
402 <tr>
403 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
404 <td CLASS="font10">Same as add().</td>
405
406 <tr>
407 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
408 <td CLASS="font10">Same as add_reference
409 NOTE : only exists for compatibility with 1.1.x</td>
410
411 <tr>
412 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
413 <td CLASS="font10">This function is compatible with the
414 rest of the phpHtmllib API spec.</td>
415
416 <tr>
417 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
418 <td CLASS="font10">destroy existing content and start with new content.</td>
419
420 <tr>
421 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
422 <td CLASS="font10">This function turns on the collapse flag</td>
423
424 <tr>
425 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
426 <td CLASS="font10">function to set the indent flag</td>
427
428 </table>
429 <br>
430 </TD>
431 </TR>
432
433 </TABLE>
434
435 <hr>
436 <!-- should have constructor at some point -->
437 <!-- =========== Method SUMMARY =========== -->
438 <A NAME='Method_summary'><!-- --></A>
439 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
440 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
441 <TD>
442 <span class="font12bold">Method Summary</span>
443 <A HREF="#top" CLASS="links">^TOP</A>
444 </TD>
445 </TR>
446
447
448 </TABLE>
449
450 <hr>
451 <!-- ============ VARIABLE DETAIL =========== -->
452
453 <A NAME='variable_detail'></A>
454 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
455 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
456 <TD>
457 <span CLASS="font12bold">Variable Detail</span>
458 <A HREF="#top" CLASS="links">^TOP</A>
459 </TD>
460 </TR>
461 </TABLE>
462
463
464 <A NAME='$_tag'><!-- --></A><H3>$_tag</H3>
465 <b>Data type:</b> mixed<br>
466 <!-- ========== Info from phpDoc block ========= -->
467
468 <BR>
469
470
471 <UL>
472
473 </UL>
474
475 <HR>
476
477
478 <hr>
479 <!-- ============ FUNCTION DETAIL =========== -->
480
481 <A NAME='function_detail'></A>
482 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
483 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
484 <TD>
485 <span class="font12bold">Method Detail</span>
486 <A HREF="#top" CLASS="links">^TOP</A>
487 </TD>
488 </TR>
489 </TABLE>
490 <BR>
491
492
493 <hr>
494 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed