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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

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