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

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

Parent Directory Parent Directory | Revision Log Revision Log

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