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

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

Parent Directory Parent Directory | Revision Log Revision Log

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