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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.2 - (show annotations)
Sat Feb 22 20:56:38 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Changes since 1.1: +451 -650 lines
File MIME type: text/html 
+ updated whole lib to version 2.2.1 (new FormProcessing since 2.2.0!)
1 <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:24:02 -0800' -->
6 <TITLE>Docs For Class XMLTagClass</TITLE>
7 <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>
8 </HEAD>
9 <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">
10 <!-- Links -->
11 <a NAME="top"></A>
12 <table WIDTH="100%" class="links">
13 <TR>
14 <TD class="font10">
15 Links:
16 <A HREF="#children_summary" class="links" title="Classes extended from XMLTagClass">Child Classes</A>
17 <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>
18 <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>
19 <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>
20 <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>
21 <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>
22 <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>
23 </TD>
24 </TR>
25 </TABLE>
26 <BR>
27 <!-- Start of Class Data -->
28 <H2>
29 Class XMLTagClass
30 </H2> (line <span class="linenumber">35</span>)
31 <pre>
32 <a href="../phpHtmlLib/Container.html">Container</a>
33 |
34 --XMLTagClass</pre>
35 <SPAN class="type">Classes extended from XMLTagClass:</SPAN>
36 <dl>
37 <dt><a href="../phpHtmlLib/HTMLTagClass.html">HTMLTagClass</a></dt>
38 <dd>Base class for all HTML Tag classes.</dd>
39 </dl>
40 <dl>
41 <dt><a href="../phpHtmlLib/SVGTagClass.html">SVGTagClass</a></dt>
42 <dd>This overrides the WMLTagClass to define some methods that set some commonly used SVG tag attributes.</dd>
43 </dl>
44 <dl>
45 <dt><a href="../phpHtmlLib/WMLTagClass.html">WMLTagClass</a></dt>
46 <dd>Base class for all WML Tag classes.</dd>
47 </dl>
48 <dl>
49 <dt><a href="../phpHtmlLib/DOCTYPEtag.html">DOCTYPEtag</a></dt>
50 <dd>&lt;!DOCTYPE&gt; tag class</dd>
51 </dl>
52 <dl>
53 <dt><a href="../phpHtmlLib/XMLtag.html">XMLtag</a></dt>
54 <dd>xml tag class</dd>
55 </dl>
56 </p>
57 <p>
58 <b><i>Located in File: Program_Root/XMLTagClass.inc</i></b><br>
59 </p>
60 <hr>
61 This class is used for building and rendering an XML tag.
62 <br />
63 <p>This class is the base class for the HTMLTagClass.</p><p>This is part of the phphtmllib libraries released under the LGPL license.</p>
64 <UL>
65 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>
66 </UL>
67 <hr>
68 <!-- =========== VAR SUMMARY =========== -->
69 <A NAME='var_summary'><!-- --></A>
70 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
71 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
72 <TD>
73 <span CLASS="font12bold">Class Variable Summary</span>
74 <A HREF="#top" CLASS="links">^TOP</A>
75 </TD>
76 </TR>
77
78 </TABLE>
79 <hr>
80 <!-- =========== VAR INHERITED SUMMARY =========== -->
81 <A NAME='var_inherited_summary'><!-- --></A>
82 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
83 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
84 <TD>
85 <span CLASS="font12bold">Inherited Class Variable Summary</span>
86 <A HREF="#top" CLASS="links">^TOP</A>
87 </TD>
88 </TR>
89
90 <!-- =========== Summary =========== -->
91 <TR BGCOLOR='white'>
92 <TD>
93 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
94 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
95 <tr CLASS="tableheadingcolor">
96 <th>Variable</th>
97 <th>Default Value</th>
98 <th>Description</th>
99 </tr>
100 <tr>
101 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td>
102 <td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td>
103 <td CLASS="font10">The flags that tell us</td>
104 </tr>
105 </table>
106 <BR>
107 </TD>
108 </TR>
109 </TABLE>
110
111 <hr>
112 <!-- =========== METHOD SUMMARY =========== -->
113 <A NAME='method_summary'><!-- --></A>
114 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
115 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
116 <TD>
117 <span class="font12bold">Method Summary</span>
118 <A HREF="#top" CLASS="links">^TOP</A>
119 </TD>
120 </TR>
121
122 <!-- =========== Summary =========== -->
123 <TR BGCOLOR='white' CLASS='TableRowColor'>
124 <TD>
125 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodXMLTagClass'>void constructor XMLTagClass ( $name, [$attributes = array()] )</A></B></CODE>
126 <BR>
127 <blockquote> The constructor </blockquote>
128 </TD>
129 </TR>
130 <!-- =========== Summary =========== -->
131 <TR BGCOLOR='white' CLASS='TableRowColor'>
132 <TD>
133 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodget_tag'>string get_tag ( )</A></B></CODE>
134 <BR>
135 <blockquote> This returns the tag declared for this class. </blockquote>
136 </TD>
137 </TR>
138 <!-- =========== Summary =========== -->
139 <TR BGCOLOR='white' CLASS='TableRowColor'>
140 <TD>
141 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodget_tag_name'>string get_tag_name ( )</A></B></CODE>
142 <BR>
143 <blockquote> This method gets the name of the tag </blockquote>
144 </TD>
145 </TR>
146 <!-- =========== Summary =========== -->
147 <TR BGCOLOR='white' CLASS='TableRowColor'>
148 <TD>
149 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodrender'>void render ( [$indent_level = 0] )</A></B></CODE>
150 <BR>
151 <blockquote> This function is responsible for rendering the tag and its contents </blockquote>
152 </TD>
153 </TR>
154 <!-- =========== Summary =========== -->
155 <TR BGCOLOR='white' CLASS='TableRowColor'>
156 <TD>
157 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodreset_attributes'>void reset_attributes ( [$attributes = array()] )</A></B></CODE>
158 <BR>
159 <blockquote> clear all attributes and start with new attributes </blockquote>
160 </TD>
161 </TR>
162 <!-- =========== Summary =========== -->
163 <TR BGCOLOR='white' CLASS='TableRowColor'>
164 <TD>
165 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodset_collapse'>void set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></B></CODE>
166 <BR>
167 <blockquote> This function turns on the collapse flag </blockquote>
168 </TD>
169 </TR>
170 <!-- =========== Summary =========== -->
171 <TR BGCOLOR='white' CLASS='TableRowColor'>
172 <TD>
173 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodset_newline_after_closetag'>void set_newline_after_closetag ( $flag )</A></B></CODE>
174 <BR>
175 <blockquote> set the newline_after_content flag </blockquote>
176 </TD>
177 </TR>
178 <!-- =========== Summary =========== -->
179 <TR BGCOLOR='white' CLASS='TableRowColor'>
180 <TD>
181 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodset_newline_after_opentag'>void set_newline_after_opentag ( $flag )</A></B></CODE>
182 <BR>
183 <blockquote> set the newline_after_opentag flag </blockquote>
184 </TD>
185 </TR>
186 <!-- =========== Summary =========== -->
187 <TR BGCOLOR='white' CLASS='TableRowColor'>
188 <TD>
189 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodset_tag_attribute'>void set_tag_attribute ( $name, [$value = NULL] )</A></B></CODE>
190 <BR>
191 <blockquote> add a single attribute (name="value") </blockquote>
192 </TD>
193 </TR>
194 <!-- =========== Summary =========== -->
195 <TR BGCOLOR='white' CLASS='TableRowColor'>
196 <TD>
197 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodset_tag_attributes'>void set_tag_attributes ( [$attributes = array()] )</A></B></CODE>
198 <BR>
199 <blockquote> add multiple attributes (name="value") </blockquote>
200 </TD>
201 </TR>
202 <!-- =========== Summary =========== -->
203 <TR BGCOLOR='white' CLASS='TableRowColor'>
204 <TD>
205 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#methodset_tag_name'>void set_tag_name ( $name )</A></B></CODE>
206 <BR>
207 <blockquote> This method sets the name of the tag </blockquote>
208 </TD>
209 </TR>
210 <!-- =========== Summary =========== -->
211 <TR BGCOLOR='white' CLASS='TableRowColor'>
212 <TD>
213 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_build_attribute_string'>the _build_attribute_string ( $name, $value )</A></B></CODE>
214 <BR>
215 <blockquote> this builds an attribute for an XML tag. </blockquote>
216 </TD>
217 </TR>
218 <!-- =========== Summary =========== -->
219 <TR BGCOLOR='white' CLASS='TableRowColor'>
220 <TD>
221 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_get_element'>mixed _get_element ( $cell )</A></B></CODE>
222 <BR>
223 <blockquote> get the nth element from content array </blockquote>
224 </TD>
225 </TR>
226 <!-- =========== Summary =========== -->
227 <TR BGCOLOR='white' CLASS='TableRowColor'>
228 <TD>
229 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_prepare_flags'>void _prepare_flags ( )</A></B></CODE>
230 <BR>
231 <blockquote> This function checks to see if </blockquote>
232 </TD>
233 </TR>
234 <!-- =========== Summary =========== -->
235 <TR BGCOLOR='white' CLASS='TableRowColor'>
236 <TD>
237 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_render_close_tag'>void _render_close_tag ( $indent_level )</A></B></CODE>
238 <BR>
239 <blockquote> this function is reposnsible for rendering the closing tag (if any) </blockquote>
240 </TD>
241 </TR>
242 <!-- =========== Summary =========== -->
243 <TR BGCOLOR='white' CLASS='TableRowColor'>
244 <TD>
245 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_render_content'>void _render_content ( $indent_level, [$output_debug = 0] )</A></B></CODE>
246 <BR>
247 <blockquote> this function is reponsible for rendering the pcdata, or content of the tag (if any) </blockquote>
248 </TD>
249 </TR>
250 <!-- =========== Summary =========== -->
251 <TR BGCOLOR='white' CLASS='TableRowColor'>
252 <TD>
253 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_render_open_tag'>void _render_open_tag ( $indent_level, [$finish_slash = TRUE] )</A></B></CODE>
254 <BR>
255 <blockquote> this function is responsible for rendering the open tag. </blockquote>
256 </TD>
257 </TR>
258 <!-- =========== Summary =========== -->
259 <TR BGCOLOR='white' CLASS='TableRowColor'>
260 <TD>
261 <CODE><B><A HREF='../phpHtmlLib/XMLTagClass.html#method_set_flags'>void _set_flags ( )</A></B></CODE>
262 <BR>
263 <blockquote> This method is used to set the bitmask flags for this tag. It tells the class how to render the tag. </blockquote>
264 </TD>
265 </TR>
266 </TABLE>
267 <!-- =========== INHERITED METHOD SUMMARY =========== -->
268 <A NAME='functions_inherited'><!-- --></A>
269 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
270 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
271 <TD>
272 <span CLASS="font12bold">Inherited Method Summary</span>
273 <A HREF="#top" CLASS="links">^TOP</A>
274 </TD>
275 </TR>
276
277 <!-- =========== Summary =========== -->
278 <TR BGCOLOR='white' CLASS='TableRowColor'>
279 <TD>
280 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
281 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
282 <tr CLASS="tableheadingcolor">
283 <th>Function</th>
284 <th>Description</th>
285 </tr>
286 <tr>
287 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td>
288 <td CLASS="font10">The constructor.</td>
289 <tr>
290 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td>
291 <td CLASS="font10">add content onto content stack</td>
292 <tr>
293 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td>
294 <td CLASS="font10">Add content onto content stack so you can change the item later.</td>
295 <tr>
296 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td>
297 <td CLASS="font10">counts the number of content objects</td>
298 <tr>
299 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td>
300 <td CLASS="font10">This flag gets the current value of the indent flag</td>
301 <tr>
302 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td>
303 <td CLASS="font10">Same as add().</td>
304 <tr>
305 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td>
306 <td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td>
307 <tr>
308 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td>
309 <td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td>
310 <tr>
311 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td>
312 <td CLASS="font10">destroy existing content and start with new content.</td>
313 <tr>
314 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td>
315 <td CLASS="font10">This function turns on the collapse flag</td>
316 <tr>
317 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td>
318 <td CLASS="font10">function to set the indent flag</td>
319 <tr>
320 <td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td>
321 <td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td>
322 </table>
323 <br>
324 </TD>
325 </TR>
326 </TABLE>
327 <hr>
328 <!-- ============ VARIABLE DETAIL =========== -->
329
330 <A NAME='variable_detail'></A>
331 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
332 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
333 <TD>
334 <span CLASS="font12bold">Variable Detail</span>
335 <A HREF="#top" CLASS="links">^TOP</A>
336 </TD>
337 </TR>
338 </TABLE>
339
340 <hr>
341 <!-- ============ METHOD DETAIL =========== -->
342
343 <A NAME='method_detail'></A>
344 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
345 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
346 <TD>
347 <span class="font12bold">Method Detail</span>
348 <A HREF="#top" CLASS="links">^TOP</A>
349 </TD>
350 </TR>
351 </TABLE>
352 <BR>
353 <DIV CLASS="function">
354 <A NAME='methodXMLTagClass'><!-- --></A>
355 <SPAN CLASS="font12bold">Constructor XMLTagClass</SPAN> (line <span class="linenumber">68</span>)
356 <BR>
357 <SPAN CLASS="font10bold">Usage : </SPAN>
358 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
359 <span class="font10bold" style="color: #0000FF">XMLTagClass(
360 string
361 $name, [array
362 $attributes = array()], mixed
363 2)</SPAN>
364 <BR>
365
366 <BR>
367 <SPAN CLASS="font10bold">Description : </SPAN>
368 The constructor
369 <br />
370
371 <DL>
372 <DT class="font10bold">Function Parameters:</DT>
373 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">2</SPAN></SPAN> - n items of content to add</DD>
374 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - the tag name</DD>
375 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> - the attributes array can be in name =&gt; value or just value</DD>
376
377 <DT class="font10bold">Function Info:</DT>
378 </DL>
379 </DIV>
380 <BR>
381 <DIV CLASS="function">
382 <A NAME='methodget_tag'><!-- --></A>
383 <SPAN CLASS="font12bold">get_tag</SPAN> (line <span class="linenumber">147</span>)
384 <BR>
385 <SPAN CLASS="font10bold">Usage : </SPAN>
386 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
387 <span class="font10bold" style="color: #0000FF">get_tag(
388 )</SPAN>
389 <BR>
390
391 <BR>
392 <SPAN CLASS="font10bold">Description : </SPAN>
393 This returns the tag declared for this class.
394 <br />
395 <p>This should be used in favor of accessing the $this-&gt;_tag directly.</p>
396 <DL>
397
398 <DT class="font10bold">Function Info:</DT>
399 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the _tag var for this class.</DD>
400 </DL>
401 </DIV>
402 <BR>
403 <DIV CLASS="function">
404 <A NAME='methodget_tag_name'><!-- --></A>
405 <SPAN CLASS="font12bold">get_tag_name</SPAN> (line <span class="linenumber">136</span>)
406 <BR>
407 <SPAN CLASS="font10bold">Usage : </SPAN>
408 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
409 <span class="font10bold" style="color: #0000FF">get_tag_name(
410 )</SPAN>
411 <BR>
412
413 <BR>
414 <SPAN CLASS="font10bold">Description : </SPAN>
415 This method gets the name of the tag
416 <br />
417
418 <DL>
419
420 <DT class="font10bold">Function Info:</DT>
421 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the tag name</DD>
422 </DL>
423 </DIV>
424 <BR>
425 <DIV CLASS="function">
426 <A NAME='methodrender'><!-- --></A>
427 <SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">89</span>)
428 <BR>
429 <SPAN CLASS="font10bold">Usage : </SPAN>
430 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
431 <span class="font10bold" style="color: #0000FF">render(
432 int
433 $indent_level)</SPAN>
434 <BR>
435 <p>Overridden in child classes as:<br />
436 <dl>
437 <dt><a href="../phpHtmlLib/HTMLTagClass.html#methodrender">HTMLTagClass::render()</a></dt>
438 <dd>Renders the tag, attributes, content and close tag.</dd>
439 </dl>
440 </p>
441
442 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a> This function is compatible with the rest of the phpHtmllib API spec.
443 <BR>
444 <SPAN CLASS="font10bold">Description : </SPAN>
445 This function is responsible for rendering the tag and its contents
446 <br />
447
448 <DL>
449 <DT class="font10bold">Function Parameters:</DT>
450 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the current indentation level for the tag</DD>
451
452 <DT class="font10bold">Function Info:</DT>
453 </DL>
454 </DIV>
455 <BR>
456 <DIV CLASS="function">
457 <A NAME='methodreset_attributes'><!-- --></A>
458 <SPAN CLASS="font12bold">reset_attributes</SPAN> (line <span class="linenumber">180</span>)
459 <BR>
460 <SPAN CLASS="font10bold">Usage : </SPAN>
461 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
462 <span class="font10bold" style="color: #0000FF">reset_attributes(
463 [array
464 $attributes = array()])</SPAN>
465 <BR>
466
467 <BR>
468 <SPAN CLASS="font10bold">Description : </SPAN>
469 clear all attributes and start with new attributes
470 <br />
471
472 <DL>
473 <DT class="font10bold">Function Parameters:</DT>
474 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> Associative array of name="value" pairs of tag atributes. ie array("border"=&gt;"0", "class"=&gt;"hover");</DD>
475
476 <DT class="font10bold">Function Info:</DT>
477 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>
478 </DL>
479 </DIV>
480 <BR>
481 <DIV CLASS="function">
482 <A NAME='methodset_collapse'><!-- --></A>
483 <SPAN CLASS="font12bold">set_collapse</SPAN> (line <span class="linenumber">231</span>)
484 <BR>
485 <SPAN CLASS="font10bold">Usage : </SPAN>
486 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
487 <span class="font10bold" style="color: #0000FF">set_collapse(
488 [boolean
489 $collapse = TRUE], [boolean
490 $indent = TRUE])</SPAN>
491 <BR>
492
493 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a> This function turns on the collapse flag
494 <BR>
495 <SPAN CLASS="font10bold">Description : </SPAN>
496 This function turns on the collapse flag
497 <br />
498
499 <DL>
500 <DT class="font10bold">Function Parameters:</DT>
501 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$collapse</SPAN></SPAN> - the collapse flag</DD>
502 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$indent</SPAN></SPAN> - the indent flag DEFAULT: TRUE;</DD>
503
504 <DT class="font10bold">Function Info:</DT>
505 </DL>
506 </DIV>
507 <BR>
508 <DIV CLASS="function">
509 <A NAME='methodset_newline_after_closetag'><!-- --></A>
510 <SPAN CLASS="font12bold">set_newline_after_closetag</SPAN> (line <span class="linenumber">216</span>)
511 <BR>
512 <SPAN CLASS="font10bold">Usage : </SPAN>
513 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
514 <span class="font10bold" style="color: #0000FF">set_newline_after_closetag(
515 boolean
516 $flag)</SPAN>
517 <BR>
518
519 <BR>
520 <SPAN CLASS="font10bold">Description : </SPAN>
521 set the newline_after_content flag
522 <br />
523
524 <DL>
525 <DT class="font10bold">Function Parameters:</DT>
526 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> TRUE or FALSE</DD>
527
528 <DT class="font10bold">Function Info:</DT>
529 </DL>
530 </DIV>
531 <BR>
532 <DIV CLASS="function">
533 <A NAME='methodset_newline_after_opentag'><!-- --></A>
534 <SPAN CLASS="font12bold">set_newline_after_opentag</SPAN> (line <span class="linenumber">204</span>)
535 <BR>
536 <SPAN CLASS="font10bold">Usage : </SPAN>
537 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
538 <span class="font10bold" style="color: #0000FF">set_newline_after_opentag(
539 boolean
540 $flag)</SPAN>
541 <BR>
542
543 <BR>
544 <SPAN CLASS="font10bold">Description : </SPAN>
545 set the newline_after_opentag flag
546 <br />
547
548 <DL>
549 <DT class="font10bold">Function Parameters:</DT>
550 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$flag</SPAN></SPAN> TRUE or FALSE</DD>
551
552 <DT class="font10bold">Function Info:</DT>
553 </DL>
554 </DIV>
555 <BR>
556 <DIV CLASS="function">
557 <A NAME='methodset_tag_attribute'><!-- --></A>
558 <SPAN CLASS="font12bold">set_tag_attribute</SPAN> (line <span class="linenumber">158</span>)
559 <BR>
560 <SPAN CLASS="font10bold">Usage : </SPAN>
561 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
562 <span class="font10bold" style="color: #0000FF">set_tag_attribute(
563 string
564 $name, [mixed
565 $value = NULL])</SPAN>
566 <BR>
567
568 <BR>
569 <SPAN CLASS="font10bold">Description : </SPAN>
570 add a single attribute (name="value")
571 <br />
572
573 <DL>
574 <DT class="font10bold">Function Parameters:</DT>
575 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> attribute name</DD>
576 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> the value.</DD>
577
578 <DT class="font10bold">Function Info:</DT>
579 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>
580 </DL>
581 </DIV>
582 <BR>
583 <DIV CLASS="function">
584 <A NAME='methodset_tag_attributes'><!-- --></A>
585 <SPAN CLASS="font12bold">set_tag_attributes</SPAN> (line <span class="linenumber">169</span>)
586 <BR>
587 <SPAN CLASS="font10bold">Usage : </SPAN>
588 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
589 <span class="font10bold" style="color: #0000FF">set_tag_attributes(
590 [array
591 $attributes = array()])</SPAN>
592 <BR>
593
594 <BR>
595 <SPAN CLASS="font10bold">Description : </SPAN>
596 add multiple attributes (name="value")
597 <br />
598
599 <DL>
600 <DT class="font10bold">Function Parameters:</DT>
601 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array</SPAN> <span style="color: #0000FF;font-weight:bold">$attributes</SPAN></SPAN> Associative array of name="value" pairs of tag atributes. ie array("border"=&gt;"0", "class"=&gt;"hover");</DD>
602
603 <DT class="font10bold">Function Info:</DT>
604 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>
605 </DL>
606 </DIV>
607 <BR>
608 <DIV CLASS="function">
609 <A NAME='methodset_tag_name'><!-- --></A>
610 <SPAN CLASS="font12bold">set_tag_name</SPAN> (line <span class="linenumber">127</span>)
611 <BR>
612 <SPAN CLASS="font10bold">Usage : </SPAN>
613 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
614 <span class="font10bold" style="color: #0000FF">set_tag_name(
615 string
616 $name)</SPAN>
617 <BR>
618
619 <BR>
620 <SPAN CLASS="font10bold">Description : </SPAN>
621 This method sets the name of the tag
622 <br />
623
624 <DL>
625 <DT class="font10bold">Function Parameters:</DT>
626 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - the tag name</DD>
627
628 <DT class="font10bold">Function Info:</DT>
629 </DL>
630 </DIV>
631 <BR>
632 <DIV CLASS="function">
633 <A NAME='method_build_attribute_string'><!-- --></A>
634 <SPAN CLASS="font12bold">_build_attribute_string</SPAN> (line <span class="linenumber">406</span>)
635 <BR>
636 <SPAN CLASS="font10bold">Usage : </SPAN>
637 <span class="font10bold" style="color: #FF0000">the</SPAN>&nbsp;
638 <span class="font10bold" style="color: #0000FF">_build_attribute_string(
639 string
640 $name, mixed
641 $value)</SPAN>
642 <BR>
643 <p>Overridden in child classes as:<br />
644 <dl>
645 <dt><a href="../phpHtmlLib/HTMLTagClass.html#method_build_attribute_string">HTMLTagClass::_build_attribute_string()</a></dt>
646 <dd>this builds an attribute for a tag.</dd>
647 </dl>
648 </p>
649
650 <BR>
651 <SPAN CLASS="font10bold">Description : </SPAN>
652 this builds an attribute for an XML tag.
653 <br />
654 <p>XML attributes MUST have a name AND a value.</p>
655 <DL>
656 <DT class="font10bold">Function Parameters:</DT>
657 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$name</SPAN></SPAN> - $name attribute name</DD>
658 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$value</SPAN></SPAN> - $value attribute value</DD>
659
660 <DT class="font10bold">Function Info:</DT>
661 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - tag attribute name=value pair. to be added to the tag.</DD>
662 </DL>
663 </DIV>
664 <BR>
665 <DIV CLASS="function">
666 <A NAME='method_get_element'><!-- --></A>
667 <SPAN CLASS="font12bold">_get_element</SPAN> (line <span class="linenumber">190</span>)
668 <BR>
669 <SPAN CLASS="font10bold">Usage : </SPAN>
670 <span class="font10bold" style="color: #FF0000">mixed</SPAN>&nbsp;
671 <span class="font10bold" style="color: #0000FF">_get_element(
672 int
673 $cell)</SPAN>
674 <BR>
675
676 <BR>
677 <SPAN CLASS="font10bold">Description : </SPAN>
678 get the nth element from content array
679 <br />
680
681 <DL>
682 <DT class="font10bold">Function Parameters:</DT>
683 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$cell</SPAN></SPAN> the cell to get</DD>
684
685 <DT class="font10bold">Function Info:</DT>
686 </DL>
687 </DIV>
688 <BR>
689 <DIV CLASS="function">
690 <A NAME='method_prepare_flags'><!-- --></A>
691 <SPAN CLASS="font12bold">_prepare_flags</SPAN> (line <span class="linenumber">254</span>)
692 <BR>
693 <SPAN CLASS="font10bold">Usage : </SPAN>
694 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
695 <span class="font10bold" style="color: #0000FF">_prepare_flags(
696 )</SPAN>
697 <BR>
698 <p>Overridden in child classes as:<br />
699 <dl>
700 <dt><a href="../phpHtmlLib/SVGTagClass.html#method_prepare_flags">SVGTagClass::_prepare_flags()</a></dt>
701 <dd>we override this method to automatically check to see if the tag has content.</dd>
702 </dl>
703 </p>
704
705 <BR>
706 <SPAN CLASS="font10bold">Description : </SPAN>
707 This function checks to see if
708 <br />
709 <p>there is only 1 content data, and its not an object, then it auto sets some of the indentation flags</p>
710 <DL>
711
712 <DT class="font10bold">Function Info:</DT>
713 </DL>
714 </DIV>
715 <BR>
716 <DIV CLASS="function">
717 <A NAME='method_render_close_tag'><!-- --></A>
718 <SPAN CLASS="font12bold">_render_close_tag</SPAN> (line <span class="linenumber">378</span>)
719 <BR>
720 <SPAN CLASS="font10bold">Usage : </SPAN>
721 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
722 <span class="font10bold" style="color: #0000FF">_render_close_tag(
723 int
724 $indent_level)</SPAN>
725 <BR>
726 <p>Overridden in child classes as:<br />
727 <dl>
728 <dt></dt>
729 <dd>Renders the close tag (if needed)</dd>
730 </dl>
731 </p>
732
733 <BR>
734 <SPAN CLASS="font10bold">Description : </SPAN>
735 this function is reposnsible for rendering the closing tag (if any)
736 <br />
737
738 <DL>
739 <DT class="font10bold">Function Parameters:</DT>
740 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indent level</DD>
741
742 <DT class="font10bold">Function Info:</DT>
743 </DL>
744 </DIV>
745 <BR>
746 <DIV CLASS="function">
747 <A NAME='method_render_content'><!-- --></A>
748 <SPAN CLASS="font12bold">_render_content</SPAN> (line <span class="linenumber">321</span>)
749 <BR>
750 <SPAN CLASS="font10bold">Usage : </SPAN>
751 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
752 <span class="font10bold" style="color: #0000FF">_render_content(
753 int
754 $indent_level, mixed
755 $output_debug)</SPAN>
756 <BR>
757 <p>Overridden in child classes as:<br />
758 <dl>
759 <dt></dt>
760 <dd>Renders all of the content.</dd>
761 </dl>
762 </p>
763
764 <BR>
765 <SPAN CLASS="font10bold">Description : </SPAN>
766 this function is reponsible for rendering the pcdata, or content of the tag (if any)
767 <br />
768
769 <DL>
770 <DT class="font10bold">Function Parameters:</DT>
771 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indent level</DD>
772
773 <DT class="font10bold">Function Info:</DT>
774 </DL>
775 </DIV>
776 <BR>
777 <DIV CLASS="function">
778 <A NAME='method_render_open_tag'><!-- --></A>
779 <SPAN CLASS="font12bold">_render_open_tag</SPAN> (line <span class="linenumber">282</span>)
780 <BR>
781 <SPAN CLASS="font10bold">Usage : </SPAN>
782 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
783 <span class="font10bold" style="color: #0000FF">_render_open_tag(
784 int
785 $indent_level, [boolean
786 $finish_slash = TRUE])</SPAN>
787 <BR>
788
789 <BR>
790 <SPAN CLASS="font10bold">Description : </SPAN>
791 this function is responsible for rendering the open tag.
792 <br />
793
794 <DL>
795 <DT class="font10bold">Function Parameters:</DT>
796 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$indent_level</SPAN></SPAN> - the indent level</DD>
797 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">boolean</SPAN> <span style="color: #0000FF;font-weight:bold">$finish_slash</SPAN></SPAN> - do we add the finish / if we have no close tag and no content?</DD>
798
799 <DT class="font10bold">Function Info:</DT>
800 </DL>
801 </DIV>
802 <BR>
803 <DIV CLASS="function">
804 <A NAME='method_set_flags'><!-- --></A>
805 <SPAN CLASS="font12bold">_set_flags</SPAN> (line <span class="linenumber">116</span>)
806 <BR>
807 <SPAN CLASS="font10bold">Usage : </SPAN>
808 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
809 <span class="font10bold" style="color: #0000FF">_set_flags(
810 )</SPAN>
811 <BR>
812 <p>Overridden in child classes as:<br />
813 <dl>
814 <dt><a href="../phpHtmlLib/DOCTYPEtag.html#method_set_flags">DOCTYPEtag::_set_flags()</a></dt>
815 <dd></dd>
816 </dl>
817 <dl>
818 <dt><a href="../phpHtmlLib/XMLtag.html#method_set_flags">XMLtag::_set_flags()</a></dt>
819 <dd></dd>
820 </dl>
821 </p>
822
823 <span class="font10bold" style="padding-left: 10px;">Overrides :</span> <a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a> This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.
824 <BR>
825 <SPAN CLASS="font10bold">Description : </SPAN>
826 This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.
827 <br />
828 <p>NOTE: the child class can override this to set the options</p>
829 <DL>
830
831 <DT class="font10bold">Function Info:</DT>
832 </DL>
833 </DIV>
834 <BR>
835 <div id="credit">
836 <hr>
837 Documention generated on Thu, 20 Feb 2003 16:24:02 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>
838 </div>
839 </body>
840 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed