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

Diff of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/Container.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.2 by jonen, Sat Feb 22 20:56:16 2003 UTC revision 1.3 by jonen, Sat Sep 20 00:24:00 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'>  <?xml version="1.0" encoding="iso-8859-1"?>
2  <!--NewPage-->  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3  <HTML>    <html xmlns="http://www.w3.org/1999/xhtml">
4  <HEAD>                  <head>
5          <!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:22:32 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class Container</TITLE>                          <title>Docs For Class Container</title>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'>                          <link rel="stylesheet" href="../media/stylesheet.css" />
8  </HEAD>                          <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9  <BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;">                  </head>
10  <!-- Links -->                  <body>
11  <a NAME="top"></A>                          <div class="page-body">                
12  <table WIDTH="100%" class="links">  <h2 class="class-name">Class Container</h2>
13   <TR>  
14     <TD class="font10">  <a name="sec-description"></a>
15        Links:  <div class="info-box">
16        <A HREF="#children_summary" class="links" title="Classes extended from Container">Child Classes</A>          <div class="info-box-title">Description</div>
17        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>          <div class="nav-bar">
18        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A>                                                          <a href="#sec-descendents">Descendents</a>
20        <A HREF="#method_summary" class="links" title="Method Summary">Methods</A>                          |                                                                                       <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
21        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
22        <A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A>                                                  
23     </TD>                          </div>
24   </TR>          <div class="info-box-body">
25  </TABLE>                  <!-- ========== Info from phpDoc block ========= -->
26  <BR>  <p class="short-description">This class is nothing more then a</p>
27  <!-- Start of Class Data -->  <p class="description"><p>container widget.  It lets you  push data into it, and it will  render each item indented properly  so it works with the rest of the libs.</p><p>This is helpfull when you have a function  that wants to return multiple Tag Objects  or widgets.  Just wrap them in this container  and they will all get rendered with the  current indentation level.</p><p>Base Class for phpHtmlLib</p></p>
28  <H2>          <ul class="tags">
29          Class Container                                  <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
30  </H2> (line <span class="linenumber">38</span>)                                  <li><span class="field">link:</span> <a href="http://phphtmllib.sourceforge.net">http://phphtmllib.sourceforge.net</a></li>
31  <pre>                          </ul>
32  </pre>                  <p class="notes">
33  <SPAN class="type">Classes extended from Container:</SPAN>                          Located in <a class="field" href="_ContainerClass_inc.html">Program_Root/ContainerClass.inc</a> (line <span class="field">38</span>)
34                  <dl>                  </p>
35          <dt><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></dt>                  
36                  <dd>This class is used for building and rendering  an XML tag.</dd>                          
37          </dl>                  <pre></pre>
38                  <dl>          
39          <dt><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></dt>                          </div>
40                  <dd>this is the base widget class, that all widgets  are based off of.  It provides some basic  members and methods</dd>  </div>
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></dt>  
                 <dd>This is just to maintain  compatibility with the  1.1.0 release of phphtmllib</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></dt>  
                 <dd>This class lets you build a complete  xml document and render it.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></dt>  
                 <dd>This is the main engine for the processing</dd>  
         </dl>  
         </p>  
 <p>  
         <b><i>Located in File: Program_Root/ContainerClass.inc</i></b><br>  
 </p>  
 <hr>  
 This class is nothing more then a  
 <br />  
 <p>container widget.  It lets you  push data into it, and it will  render each item indented properly  so it works with the rest of the libs.</p><p>This is helpfull when you have a function  that wants to return multiple Tag Objects  or widgets.  Just wrap them in this container  and they will all get rendered with the  current indentation level.</p><p>Base Class for phpHtmlLib</p>  
 <UL>  
                 <LI><b>author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</CODE></LI>  
                 <LI><b>link</b> - <CODE><a href="http://phphtmllib.sourceforge.net">http://phphtmllib.sourceforge.net</a></CODE></LI>  
         </UL>  
 <hr>  
 <!-- =========== VAR SUMMARY =========== -->  
 <A NAME='var_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF="../phpHtmlLib/Container.html#var$_flags">$_flags</A></B></CODE>  
                         <BR>  
                         <blockquote> The flags that tell us </blockquote>  
                         <blockquote> Default Value: <CODE>->&nbsp;_NEWLINEAFTERCONTENT<-</CODE> </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <hr>  
 <!-- =========== VAR INHERITED SUMMARY =========== -->  
 <A NAME='var_inherited_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
         </TABLE>  
   
 <hr>  
 <!-- =========== METHOD SUMMARY =========== -->  
 <A NAME='method_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodContainer'>void constructor Container (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> The constructor. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodadd'>void add (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> add content onto content stack </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodadd_reference'>void add_reference ( &$content )</A></B></CODE>  
                         <BR>  
                         <blockquote> Add content onto content stack  so you can change the item later. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodcount_content'>int count_content (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> counts the number of content objects </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodget_indent_flag'>boolean get_indent_flag (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This flag gets the current value  of the indent flag </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodpush'>void push (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> Same as add(). </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodpush_reference'>void push_reference ( &$content )</A></B></CODE>  
                         <BR>  
                         <blockquote> Same as add_reference  NOTE : only exists for compatibility with 1.1.x </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodrender'>string render ( [$indent_level = 0], [$output_debug = 0] )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function is compatible with the  rest of the phpHtmllib API spec. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodreset_content'>void reset_content (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> destroy existing content and start with new content. </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodset_collapse'>void set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></B></CODE>  
                         <BR>  
                         <blockquote> This function turns on the collapse flag </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#methodset_indent_flag'>void set_indent_flag ( $flag )</A></B></CODE>  
                         <BR>  
                         <blockquote> function to set the indent flag </blockquote>  
                 </TD>  
         </TR>  
                 <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='../phpHtmlLib/Container.html#method_set_flags'>void _set_flags (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> This method is used to set the bitmask  flags for this tag.  It tells the  class how to render the tag. </blockquote>  
                 </TD>  
         </TR>  
         </TABLE>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
         </TABLE>  
 <hr>  
 <!-- ============ VARIABLE DETAIL =========== -->  
   
 <A NAME='variable_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Variable Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
   
 <A NAME='var$_flags'><!-- --></A><H3>$_flags</H3> (line <span class="linenumber">64</span>)<br />  
 <b>Data type:</b> mixed<br>The flags that tell us  
 <br />  
 <p>how to render the tag  its contents, and the close</p>  
 <UL>  
         </UL>  
 <HR>  
 <hr>  
 <!-- ============ METHOD DETAIL =========== -->  
   
 <A NAME='method_detail'></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>  
                 <TD>  
                         <span class="font12bold">Method Detail</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
 </TABLE>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodContainer'><!-- --></A>  
 <SPAN CLASS="font12bold">Constructor Container</SPAN> (line <span class="linenumber">76</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">Container(  
 )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 The constructor.  
 <br />  
 <p>This lets you pass in data  that you want automatically  added to the container.  This  works in the same manner as  the push() method.</p>  
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodadd'><!-- --></A>  
 <SPAN CLASS="font12bold">add</SPAN> (line <span class="linenumber">172</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">add(  
 mixed  
 $content)</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodadd">XMLDocumentClass::add()</a></dt>  
                 <dd>we override this class to make sure  we push all content inside the  local _xml_obj tag</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 add content onto content stack  
 <br />  
 <p>adds content to tag as a FIFO.  You can have n number of parameters.  each one will get added in succession to the content.</p>  
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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">$content</SPAN></SPAN> - either string, or tag object.</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodadd_reference'><!-- --></A>  
 <SPAN CLASS="font12bold">add_reference</SPAN> (line <span class="linenumber">214</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">add_reference(  
 mixed  
 &$content, mixed  
 $content)</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodadd_reference">XMLDocumentClass::add_reference()</a></dt>  
                 <dd>we override this class to make sure  we push all content inside the  local _xml_obj tag</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 Add content onto content stack  so you can change the item later.  
 <br />  
 <p>adds content to tag as a FIFO  You can only add 1 element at a time, and  it will be added as a reference.  So you can't do  push_reference("something");, since "something" is a  static.</p>  
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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">$content</SPAN></SPAN> - either string, or tag object. the tag object gets stored as a reference to the original, so you can push it, then modify it later.</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodcount_content'><!-- --></A>  
 <SPAN CLASS="font12bold">count_content</SPAN> (line <span class="linenumber">239</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">int</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">count_content(  
 )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 counts the number of content objects  
 <br />  
   
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodget_indent_flag'><!-- --></A>  
 <SPAN CLASS="font12bold">get_indent_flag</SPAN> (line <span class="linenumber">280</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">boolean</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">get_indent_flag(  
 )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This flag gets the current value  of the indent flag  
 <br />  
   
 <DL>  
   
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodpush'><!-- --></A>  
 <SPAN CLASS="font12bold">push</SPAN> (line <span class="linenumber">158</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">push(  
 mixed  
 $content)</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodpush">XMLDocumentClass::push()</a></dt>  
                 <dd>Same as add().</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 Same as add().  
 <br />  
 <p>NOTE: only exists for 1.1.x compatibility</p>  
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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">$content</SPAN></SPAN> - either string, or tag object.</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>deprecated</b> - </DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodpush_reference'><!-- --></A>  
 <SPAN CLASS="font12bold">push_reference</SPAN> (line <span class="linenumber">193</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">push_reference(  
 mixed  
 &$content)</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodpush_reference">XMLDocumentClass::push_reference()</a></dt>  
                 <dd>Same as add_reference  NOTE : only exists for compatibility with 1.1.x</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 Same as add_reference  NOTE : only exists for compatibility with 1.1.x  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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">&$content</SPAN></SPAN> - a reference to some variable.</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodrender'><!-- --></A>  
 <SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">106</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">render(  
 int  
 $indent_level, int  
 $output_debug)</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLTagClass.html#methodrender">XMLTagClass::render()</a></dt>  
                 <dd>This function is responsible  for rendering the tag and  its contents</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodrender">XMLDocumentClass::render()</a></dt>  
                 <dd>function that will render the XML Document.</dd>  
         </dl>  
                 <dl>  
         <dt><a href="../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a></dt>  
                 <dd>This method is called to render the form's html</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function is compatible with the  rest of the phpHtmllib API spec.  
 <br />  
 <p>It just walks through each of the  class' data and renders it with the  appropriate indentation.</p>  
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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 indentation level for the container.</DD>  
                 <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">$output_debug</SPAN></SPAN> - the output debug flag to maintain compatibility w/ the API.</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodreset_content'><!-- --></A>  
 <SPAN CLASS="font12bold">reset_content</SPAN> (line <span class="linenumber">226</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">reset_content(  
 mixed  
 $content)</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLDocumentClass.html#methodreset_content">XMLDocumentClass::reset_content()</a></dt>  
                 <dd>we override this class to make sure  we push all content inside the  local _xml_obj tag</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 destroy existing content and start with new content.  
 <br />  
   
 <DL>  
         <DT class="font10bold">Function Parameters:</DT>  
                 <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">$content</SPAN></SPAN> can be tag object, or raw (string).</DD>  
           
         <DT class="font10bold">Function Info:</DT>  
                 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>  
         </DL>  
 </DIV>  
 <BR>  
 <DIV CLASS="function">  
 <A NAME='methodset_collapse'><!-- --></A>  
 <SPAN CLASS="font12bold">set_collapse</SPAN> (line <span class="linenumber">294</span>)  
 <BR>  
 <SPAN CLASS="font10bold">Usage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">set_collapse(  
 [boolean  
 $collapse = TRUE], [boolean  
 $indent = TRUE])</SPAN>  
 <BR>  
         <p>Overridden in child classes as:<br />  
                 <dl>  
         <dt><a href="../phpHtmlLib/XMLTagClass.html#methodset_collapse">XMLTagClass::set_collapse()</a></dt>  
                 <dd>This function turns on the collapse flag</dd>  
         </dl>  
         </p>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 This function turns on the collapse flag  
 <br />  
41    
42  <DL>          <a name="sec-descendents"></a>
43          <DT class="font10bold">Function Parameters:</DT>          <div class="info-box">
44                  <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>                  <div class="info-box-title">Direct descendents</div>
45                  <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>                  <div class="nav-bar">
46                                    <a href="#sec-description">Description</a> |
47          <DT class="font10bold">Function Info:</DT>                          <span class="disabled">Descendents</span>
48                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>                          |                                                                                               <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
49          </DL>                                                                  |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
50  </DIV>                                                          
51  <BR>                                          </div>
52  <DIV CLASS="function">                  <div class="info-box-body">
53  <A NAME='methodset_indent_flag'><!-- --></A>                          <table cellpadding="2" cellspacing="0" class="class-table">
54  <SPAN CLASS="font12bold">set_indent_flag</SPAN> (line <span class="linenumber">263</span>)                                  <tr>
55  <BR>                                          <th class="class-table-header">Class</th>
56  <SPAN CLASS="font10bold">Usage : </SPAN>                                          <th class="class-table-header">Description</th>
57  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                                  </tr>
58  <span class="font10bold" style="color: #0000FF">set_indent_flag(                                                                  <tr>
59  boolean                                          <td style="padding-right: 2em"><a href="../phpHtmlLib/XMLTagClass.html">XMLTagClass</a></td>
60  $flag)</SPAN>                                          <td>
61  <BR>                                                                                          This class is used for building and rendering  an XML tag.
62                                                                                    </td>
63                                    </tr>
64                                                                    <tr>
65                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></td>
66                                            <td>
67                                                                                            this is the base widget class, that all widgets  are based off of.  It provides some basic  members and methods
68                                                                                    </td>
69                                    </tr>
70                                                                    <tr>
71                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/ContainerWidget.html">ContainerWidget</a></td>
72                                            <td>
73                                                                                            This is just to maintain  compatibility with the  1.1.0 release of phphtmllib
74                                                                                    </td>
75                                    </tr>
76                                                                    <tr>
77                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/XMLDocumentClass.html">XMLDocumentClass</a></td>
78                                            <td>
79                                                                                            This class lets you build a complete  xml document and render it.
80                                                                                    </td>
81                                    </tr>
82                                                                    <tr>
83                                            <td style="padding-right: 2em"><a href="../phpHtmlLib/FormProcessing/FormProcessor.html">FormProcessor</a></td>
84                                            <td>
85                                                                                            This is the main engine for the processing
86                                                                                    </td>
87                                    </tr>
88                                                            </table>
89                    </div>
90            </div>
91    
92  <BR>          <a name="sec-var-summary"></a>
93  <SPAN CLASS="font10bold">Description : </SPAN>          <div class="info-box">
94  function to set the indent flag                  <div class="info-box-title">Variable Summary</span></div>
95  <br />                  <div class="nav-bar">
96                            <a href="#sec-description">Description</a> |
97                                                            <a href="#sec-descendents">Descendents</a> |
98                                                    <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
99                                                            |
100                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
101                                                            
102                                            </div>
103                    <div class="info-box-body">
104                            <div class="var-summary">
105                                                                    <div class="var-title">
106                                            <span class="var-type">mixed</span>
107                                            <a href="#$_flags" title="details" class="var-name">$_flags</a>
108                                    </div>
109                                                            </div>
110                    </div>
111            </div>
112    
113  <DL>          <a name="sec-method-summary"></a>
114          <DT class="font10bold">Function Parameters:</DT>          <div class="info-box">
115                  <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>                  <div class="info-box-title">Method Summary</span></div>
116                            <div class="nav-bar">
117          <DT class="font10bold">Function Info:</DT>                          <a href="#sec-description">Description</a> |
118                  <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>access</b> - public</DD>                                                          <a href="#sec-descendents">Descendents</a> |
119          </DL>                                                                                                                          <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
120  </DIV>                                  
121  <BR>                                  |
122  <DIV CLASS="function">                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
123  <A NAME='method_set_flags'><!-- --></A>                  </div>
124  <SPAN CLASS="font12bold">_set_flags</SPAN> (line <span class="linenumber">252</span>)                  <div class="info-box-body">                    
125  <BR>                          <div class="method-summary">
126  <SPAN CLASS="font10bold">Usage : </SPAN>                                                                  
127  <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;                                  <div class="method-definition">
128  <span class="font10bold" style="color: #0000FF">_set_flags(                                                                                          <span class="method-result">void</span>
129  )</SPAN>                                                                                  <a href="#Container" title="details" class="method-name">Container</a>
130  <BR>                                                                                  ()
131          <p>Overridden in child classes as:<br />                                                                          </div>
132                  <dl>                                                                  
133          <dt><a href="../phpHtmlLib/XMLTagClass.html#method_set_flags">XMLTagClass::_set_flags()</a></dt>                                  <div class="method-definition">
134                  <dd>This method is used to set the bitmask  flags for this tag.  It tells the  class how to render the tag.</dd>                                                                                          <span class="method-result">void</span>
135          </dl>                                                                                  <a href="#add" title="details" class="method-name">add</a>
136          </p>                                                                                          (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
137                                                                            </div>
138                                                                    
139                                    <div class="method-definition">
140                                                                                            <span class="method-result">void</span>
141                                                                                    <a href="#add_reference" title="details" class="method-name">add_reference</a>
142                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
143                                                                            </div>
144                                                                    
145                                    <div class="method-definition">
146                                                                                            <span class="method-result">int</span>
147                                                                                    <a href="#count_content" title="details" class="method-name">count_content</a>
148                                                                                    ()
149                                                                            </div>
150                                                                    
151                                    <div class="method-definition">
152                                                                                            <span class="method-result">boolean</span>
153                                                                                    <a href="#get_indent_flag" title="details" class="method-name">get_indent_flag</a>
154                                                                                    ()
155                                                                            </div>
156                                                                    
157                                    <div class="method-definition">
158                                                                                            <span class="method-result">void</span>
159                                                                                    <a href="#push" title="details" class="method-name">push</a>
160                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
161                                                                            </div>
162                                                                    
163                                    <div class="method-definition">
164                                                                                            <span class="method-result">void</span>
165                                                                                    <a href="#push_reference" title="details" class="method-name">push_reference</a>
166                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
167                                                                            </div>
168                                                                    
169                                    <div class="method-definition">
170                                                                                            <span class="method-result">string</span>
171                                                                                    <a href="#render" title="details" class="method-name">render</a>
172                                                                                            (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
173                                                                            </div>
174                                                                    
175                                    <div class="method-definition">
176                                                                                            <span class="method-result">void</span>
177                                                                                    <a href="#reset_content" title="details" class="method-name">reset_content</a>
178                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
179                                                                            </div>
180                                                                    
181                                    <div class="method-definition">
182                                                                                            <span class="method-result">void</span>
183                                                                                    <a href="#set_collapse" title="details" class="method-name">set_collapse</a>
184                                                                                            ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$collapse</span> = <span class="var-default">TRUE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">TRUE</span>])
185                                                                            </div>
186                                                                    
187                                    <div class="method-definition">
188                                                                                            <span class="method-result">void</span>
189                                                                                    <a href="#set_indent_flag" title="details" class="method-name">set_indent_flag</a>
190                                                                                            (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
191                                                                            </div>
192                                                                    
193                                    <div class="method-definition">
194                                                                                            <span class="method-result">void</span>
195                                                                                    <a href="#_set_flags" title="details" class="method-name">_set_flags</a>
196                                                                                    ()
197                                                                            </div>
198                                                            </div>
199                    </div>
200            </div>          
201    
202            <a name="sec-vars"></a>
203            <div class="info-box">
204                    <div class="info-box-title">Variables</div>
205                    <div class="nav-bar">
206                            <a href="#sec-description">Description</a> |
207                                                            <a href="#sec-descendents">Descendents</a> |
208                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
209                                                    
210                            
211                                                            |
212                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
213                                                            
214                                            </div>
215                    <div class="info-box-body">
216                            <a name="var$_flags" id="$_flags"><!-- --></A>
217    <div class="evenrow">
218    
219            <div class="var-header">
220                    <span class="var-title">
221                            <span class="var-type">mixed</span>
222                            <span class="var-name">$_flags</span>
223                             = <span class="var-default"> _NEWLINEAFTERCONTENT</span>                       (line <span class="line-number">64</span>)
224                    </span>
225            </div>
226    
227  <BR>          <!-- ========== Info from phpDoc block ========= -->
228  <SPAN CLASS="font10bold">Description : </SPAN>  <p class="short-description">The flags that tell us</p>
229  This method is used to set the bitmask  flags for this tag.  It tells the  class how to render the tag.  <p class="description"><p>how to render the tag  its contents, and the close</p></p>
230  <br />          
231  <p>NOTE: the child class can override this        to set the options</p>          
232  <DL>                  
233                    
234    
235          <DT class="font10bold">Function Info:</DT>  </div>
236          </DL>                                                  
237  </DIV>                  </div>
238  <BR>          </div>
239          <div id="credit">          
240                  <hr>          <a name="sec-methods"></a>
241                  Documention generated on Thu, 20 Feb 2003 16:22:32 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a>          <div class="info-box">
242                    <div class="info-box-title">Methods</div>
243                    <div class="nav-bar">
244                            <a href="#sec-description">Description</a> |
245                                                            <a href="#sec-descendents">Descendents</a> |
246                                                                                                                            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
247                                                                                                                    <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
248                                                    
249                    </div>
250                    <div class="info-box-body">
251                            <A NAME='method_detail'></A>
252    <a name="methodContainer" id="Container"><!-- --></a>
253    <div class="oddrow">
254            
255            <div class="method-header">
256                    <span class="method-title">Constructor Container</span> (line <span class="line-number">76</span>)
257            </div>
258            
259            <!-- ========== Info from phpDoc block ========= -->
260    <p class="short-description">The constructor.</p>
261    <p class="description"><p>This lets you pass in data  that you want automatically  added to the container.  This  works in the same manner as  the push() method.</p></p>
262            
263            <div class="method-signature">
264                    <span class="method-result">void</span>
265                    <span class="method-name">
266                            Container
267                    </span>
268                                    ()
269                            </div>
270            
271                    
272                    
273            </div>
274    <a name="methodadd" id="add"><!-- --></a>
275    <div class="evenrow">
276            
277            <div class="method-header">
278                    <span class="method-title">add</span> (line <span class="line-number">172</span>)
279            </div>
280            
281            <!-- ========== Info from phpDoc block ========= -->
282    <p class="short-description">add content onto content stack</p>
283    <p class="description"><p>adds content to tag as a FIFO.  You can have n number of parameters.  each one will get added in succession to the content.</p></p>
284            <ul class="tags">
285                                    <li><span class="field">access:</span> public</li>
286                            </ul>
287            
288            <div class="method-signature">
289                    <span class="method-result">void</span>
290                    <span class="method-name">
291                            add
292                    </span>
293                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
294                            </div>
295            
296                            <ul class="parameters">
297                                            <li>
298                                    <span class="var-type">mixed</span>
299                                    <span class="var-name">$content</span><span class="var-description">: <p>- either string, or tag object.</p></span>                     </li>
300                                    </ul>
301                    
302                    
303                            <hr class="separator" />
304                    <div class="notes">Redefined in descendants as:</div>
305                    <ul class="redefinitions">
306                                            <li>
307                                    <a href="../phpHtmlLib/OLtag.html#methodadd">OLtag::add()</a>
308                                                                    : add content onto content stack  adds content to tag as a FIFO.
309                                                            </li>
310                                            <li>
311                                    <a href="../phpHtmlLib/TRtag.html#methodadd">TRtag::add()</a>
312                                                                    : add content onto content stack  adds content to tag as a FIFO.
313                                                            </li>
314                                            <li>
315                                    <a href="../phpHtmlLib/FooterNav.html#methodadd">FooterNav::add()</a>
316                                                                    : add an entry to the footer nav
317                                                            </li>
318                                            <li>
319                                    <a href="../phpHtmlLib/NavTable.html#methodadd">NavTable::add()</a>
320                                                                    : this function adds an entry to the navtable.
321                                                            </li>
322                                            <li>
323                                    <a href="../phpHtmlLib/TextCSSNav.html#methodadd">TextCSSNav::add()</a>
324                                                                    : this function adds a clickable link.
325                                                            </li>
326                                            <li>
327                                    <a href="../phpHtmlLib/TextNav.html#methodadd">TextNav::add()</a>
328                                                                    : this function adds a clickable link.
329                                                            </li>
330                                            <li>
331                                    <a href="../phpHtmlLib/VerticalCSSNavTable.html#methodadd">VerticalCSSNavTable::add()</a>
332                                                                    : this function adds a clickable link.
333                                                            </li>
334                                            <li>
335                                    <a href="../phpHtmlLib/CSSContainer.html#methodadd">CSSContainer::add()</a>
336                                                                    : Only allow the adding of CSSBuilder
337                                                            </li>
338                                            <li>
339                                    <a href="../phpHtmlLib/XMLDocumentClass.html#methodadd">XMLDocumentClass::add()</a>
340                                                                    : we override this class to make sure  we push all content inside the  local _xml_obj tag
341                                                            </li>
342                                    </ul>
343            </div>
344    <a name="methodadd_reference" id="add_reference"><!-- --></a>
345    <div class="oddrow">
346            
347            <div class="method-header">
348                    <span class="method-title">add_reference</span> (line <span class="line-number">214</span>)
349            </div>
350            
351            <!-- ========== Info from phpDoc block ========= -->
352    <p class="short-description">Add content onto content stack  so you can change the item later.</p>
353    <p class="description"><p>adds content to tag as a FIFO  You can only add 1 element at a time, and  it will be added as a reference.  So you can't do  push_reference(&quot;something&quot;);, since &quot;something&quot; is a  static.</p></p>
354            <ul class="tags">
355                                    <li><span class="field">access:</span> public</li>
356                            </ul>
357            
358            <div class="method-signature">
359                    <span class="method-result">void</span>
360                    <span class="method-name">
361                            add_reference
362                    </span>
363                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
364                            </div>
365            
366                            <ul class="parameters">
367                                            <li>
368                                    <span class="var-type">mixed</span>
369                                    <span class="var-name">$content</span><span class="var-description">: <p>- either string, or tag object.                              the tag object gets stored as a                              reference to the original, so you                              can push it, then modify it later.</p></span>                 </li>
370                                    </ul>
371                    
372                    
373                            <hr class="separator" />
374                    <div class="notes">Redefined in descendants as:</div>
375                    <ul class="redefinitions">
376                                            <li>
377                                    <a href="../phpHtmlLib/OLtag.html#methodadd_reference">OLtag::add_reference()</a>
378                                                                    : push content onto content stack
379                                                            </li>
380                                            <li>
381                                    <a href="../phpHtmlLib/TRtag.html#methodadd_reference">TRtag::add_reference()</a>
382                                                                    : add content onto content stack
383                                                            </li>
384                                            <li>
385                                    <a href="../phpHtmlLib/XMLDocumentClass.html#methodadd_reference">XMLDocumentClass::add_reference()</a>
386                                                                    : we override this class to make sure  we push all content inside the  local _xml_obj tag
387                                                            </li>
388                                    </ul>
389            </div>
390    <a name="methodcount_content" id="count_content"><!-- --></a>
391    <div class="evenrow">
392            
393            <div class="method-header">
394                    <span class="method-title">count_content</span> (line <span class="line-number">239</span>)
395            </div>
396            
397            <!-- ========== Info from phpDoc block ========= -->
398    <p class="short-description">counts the number of content objects</p>
399            <ul class="tags">
400                                    <li><span class="field">access:</span> public</li>
401                            </ul>
402            
403            <div class="method-signature">
404                    <span class="method-result">int</span>
405                    <span class="method-name">
406                            count_content
407                    </span>
408                                    ()
409                            </div>
410            
411                    
412                    
413            </div>
414    <a name="methodget_indent_flag" id="get_indent_flag"><!-- --></a>
415    <div class="oddrow">
416            
417            <div class="method-header">
418                    <span class="method-title">get_indent_flag</span> (line <span class="line-number">280</span>)
419            </div>
420            
421            <!-- ========== Info from phpDoc block ========= -->
422    <p class="short-description">This flag gets the current value  of the indent flag</p>
423            <ul class="tags">
424                                    <li><span class="field">access:</span> public</li>
425                            </ul>
426            
427            <div class="method-signature">
428                    <span class="method-result">boolean</span>
429                    <span class="method-name">
430                            get_indent_flag
431                    </span>
432                                    ()
433                            </div>
434            
435                    
436                    
437            </div>
438    <a name="methodpush" id="push"><!-- --></a>
439    <div class="evenrow">
440            
441            <div class="method-header">
442                    <span class="method-title">push</span> (line <span class="line-number">158</span>)
443            </div>
444            
445            <!-- ========== Info from phpDoc block ========= -->
446    <p class="short-description">Same as add().</p>
447    <p class="description"><p>NOTE: only exists for 1.1.x compatibility</p></p>
448            <ul class="tags">
449                                    <li><span class="field">access:</span> public</li>
450                                    <li><span class="field">deprecated:</span> </li>
451                            </ul>
452            
453            <div class="method-signature">
454                    <span class="method-result">void</span>
455                    <span class="method-name">
456                            push
457                    </span>
458                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
459                            </div>
460            
461                            <ul class="parameters">
462                                            <li>
463                                    <span class="var-type">mixed</span>
464                                    <span class="var-name">$content</span><span class="var-description">: <p>- either string, or tag object.</p></span>                     </li>
465                                    </ul>
466                    
467                    
468                            <hr class="separator" />
469                    <div class="notes">Redefined in descendants as:</div>
470                    <ul class="redefinitions">
471                                            <li>
472                                    <a href="../phpHtmlLib/TRtag.html#methodpush">TRtag::push()</a>
473                                                                    : Same ass add()
474                                                            </li>
475                                            <li>
476                                    <a href="../phpHtmlLib/FooterNav.html#methodpush">FooterNav::push()</a>
477                                                                    : add an entry to the footer nav.
478                                                            </li>
479                                            <li>
480                                    <a href="../phpHtmlLib/ImageThumbnailWidget.html#methodpush">ImageThumbnailWidget::push()</a>
481                                                            </li>
482                                            <li>
483                                    <a href="../phpHtmlLib/NavTable.html#methodpush">NavTable::push()</a>
484                                                                    : depricated version of add()
485                                                            </li>
486                                            <li>
487                                    <a href="../phpHtmlLib/TextCSSNav.html#methodpush">TextCSSNav::push()</a>
488                                                                    : depricated version of add()
489                                                            </li>
490                                            <li>
491                                    <a href="../phpHtmlLib/TextNav.html#methodpush">TextNav::push()</a>
492                                                                    : depricated version of add()
493                                                            </li>
494                                            <li>
495                                    <a href="../phpHtmlLib/TreeNav.html#methodpush">TreeNav::push()</a>
496                                                            </li>
497                                            <li>
498                                    <a href="../phpHtmlLib/XMLDocumentClass.html#methodpush">XMLDocumentClass::push()</a>
499                                                                    : Same as add().
500                                                            </li>
501                                    </ul>
502            </div>
503    <a name="methodpush_reference" id="push_reference"><!-- --></a>
504    <div class="oddrow">
505            
506            <div class="method-header">
507                    <span class="method-title">push_reference</span> (line <span class="line-number">193</span>)
508            </div>
509            
510            <!-- ========== Info from phpDoc block ========= -->
511    <p class="short-description">Same as add_reference  NOTE : only exists for compatibility with 1.1.x</p>
512            <ul class="tags">
513                                    <li><span class="field">access:</span> public</li>
514                            </ul>
515            
516            <div class="method-signature">
517                    <span class="method-result">void</span>
518                    <span class="method-name">
519                            push_reference
520                    </span>
521                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">&$content</span>)
522                            </div>
523            
524                            <ul class="parameters">
525                                            <li>
526                                    <span class="var-type">mixed</span>
527                                    <span class="var-name">&$content</span><span class="var-description">: <p>- a reference to some variable.</p></span>                    </li>
528                                    </ul>
529                    
530                    
531                            <hr class="separator" />
532                    <div class="notes">Redefined in descendants as:</div>
533                    <ul class="redefinitions">
534                                            <li>
535                                    <a href="../phpHtmlLib/TRtag.html#methodpush_reference">TRtag::push_reference()</a>
536                                                                    : Same ass add_reference()
537                                                            </li>
538                                            <li>
539                                    <a href="../phpHtmlLib/XMLDocumentClass.html#methodpush_reference">XMLDocumentClass::push_reference()</a>
540                                                                    : Same as add_reference  NOTE : only exists for compatibility with 1.1.x
541                                                            </li>
542                                    </ul>
543            </div>
544    <a name="methodrender" id="render"><!-- --></a>
545    <div class="evenrow">
546            
547            <div class="method-header">
548                    <span class="method-title">render</span> (line <span class="line-number">106</span>)
549            </div>
550            
551            <!-- ========== Info from phpDoc block ========= -->
552    <p class="short-description">This function is compatible with the  rest of the phpHtmllib API spec.</p>
553    <p class="description"><p>It just walks through each of the  class' data and renders it with the  appropriate indentation.</p></p>
554            <ul class="tags">
555                                    <li><span class="field">return:</span> <p>the raw html output.</p></li>
556                            </ul>
557            
558            <div class="method-signature">
559                    <span class="method-result">string</span>
560                    <span class="method-name">
561                            render
562                    </span>
563                                            (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
564                            </div>
565            
566                            <ul class="parameters">
567                                            <li>
568                                    <span class="var-type">int</span>
569                                    <span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for               the container.</p></span>                       </li>
570                                            <li>
571                                    <span class="var-type">int</span>
572                                    <span class="var-name">$output_debug</span><span class="var-description">: <p>- the output debug flag to               maintain compatibility w/ the API.</p></span>                    </li>
573                                    </ul>
574                    
575                    
576                            <hr class="separator" />
577                    <div class="notes">Redefined in descendants as:</div>
578                    <ul class="redefinitions">
579                                            <li>
580                                    <a href="../phpHtmlLib/XMLTagClass.html#methodrender">XMLTagClass::render()</a>
581                                                                    : This function is responsible  for rendering the tag and  its contents
582                                                            </li>
583                                            <li>
584                                    <a href="../phpHtmlLib/HTMLTagClass.html#methodrender">HTMLTagClass::render()</a>
585                                                                    : Renders the tag, attributes, content and close tag.
586                                                            </li>
587                                            <li>
588                                    <a href="../phpHtmlLib/ActiveTab.html#methodrender">ActiveTab::render()</a>
589                                                            </li>
590                                            <li>
591                                    <a href="../phpHtmlLib/FooterNav.html#methodrender">FooterNav::render()</a>
592                                                                    : render the code for this widget.
593                                                            </li>
594                                            <li>
595                                    <a href="../phpHtmlLib/ImageThumbnailWidget.html#methodrender">ImageThumbnailWidget::render()</a>
596                                                                    : Render the entire widget.  this includes the  page offset links, as well as the thumbnails.
597                                                            </li>
598                                            <li>
599                                    <a href="../phpHtmlLib/InfoTable.html#methodrender">InfoTable::render()</a>
600                                                                    : This function renders the object.
601                                                            </li>
602                                            <li>
603                                    <a href="../phpHtmlLib/NavTable.html#methodrender">NavTable::render()</a>
604                                                                    : Render the Navtable and its content.
605                                                            </li>
606                                            <li>
607                                    <a href="../phpHtmlLib/TextCSSNav.html#methodrender">TextCSSNav::render()</a>
608                                                                    : function that will render the widget.
609                                                            </li>
610                                            <li>
611                                    <a href="../phpHtmlLib/SVG/SVGGraph.html#methodrender">SVGGraph::render()</a>
612                                                            </li>
613                                            <li>
614                                    <a href="../phpHtmlLib/RoundTitleTable.html#methodrender">RoundTitleTable::render()</a>
615                                                                    : Render the Navtable and its content.
616                                                            </li>
617                                            <li>
618                                    <a href="../phpHtmlLib/TextNav.html#methodrender">TextNav::render()</a>
619                                                                    : function that will render the widget.
620                                                            </li>
621                                            <li>
622                                    <a href="../phpHtmlLib/TreeNav.html#methodrender">TreeNav::render()</a>
623                                                                    : function that will render the widget.
624                                                            </li>
625                                            <li>
626                                    <a href="../phpHtmlLib/VerticalCSSNavTable.html#methodrender">VerticalCSSNavTable::render()</a>
627                                                                    : function that will render the widget.
628                                                            </li>
629                                            <li>
630                                    <a href="../phpHtmlLib/DataList.html#methodrender">DataList::render()</a>
631                                                                    : This function renders the final
632                                                            </li>
633                                            <li>
634                                    <a href="../phpHtmlLib/XMLDocumentClass.html#methodrender">XMLDocumentClass::render()</a>
635                                                                    : function that will render the XML Document.
636                                                            </li>
637                                            <li>
638                                    <a href="../phpHtmlLib/FormProcessing/FormProcessor.html#methodrender">FormProcessor::render()</a>
639                                                                    : This method is called to render the form's html
640                                                            </li>
641                                            <li>
642                                    <a href="../phpHtmlLib/FormProcessing/FormWizard.html#methodrender">FormWizard::render()</a>
643                                                                    : This function renders the
644                                                            </li>
645                                    </ul>
646            </div>
647    <a name="methodreset_content" id="reset_content"><!-- --></a>
648    <div class="oddrow">
649            
650            <div class="method-header">
651                    <span class="method-title">reset_content</span> (line <span class="line-number">226</span>)
652            </div>
653            
654            <!-- ========== Info from phpDoc block ========= -->
655    <p class="short-description">destroy existing content and start with new content.</p>
656            <ul class="tags">
657                                    <li><span class="field">access:</span> public</li>
658                            </ul>
659            
660            <div class="method-signature">
661                    <span class="method-result">void</span>
662                    <span class="method-name">
663                            reset_content
664                    </span>
665                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>)
666                            </div>
667            
668                            <ul class="parameters">
669                                            <li>
670                                    <span class="var-type">mixed</span>
671                                    <span class="var-name">$content</span><span class="var-description">: <p>can be tag object, or raw (string).</p></span>                 </li>
672                                    </ul>
673                    
674                    
675                            <hr class="separator" />
676                    <div class="notes">Redefined in descendants as:</div>
677                    <ul class="redefinitions">
678                                            <li>
679                                    <a href="../phpHtmlLib/XMLDocumentClass.html#methodreset_content">XMLDocumentClass::reset_content()</a>
680                                                                    : we override this class to make sure  we push all content inside the  local _xml_obj tag
681                                                            </li>
682                                    </ul>
683            </div>
684    <a name="methodset_collapse" id="set_collapse"><!-- --></a>
685    <div class="evenrow">
686            
687            <div class="method-header">
688                    <span class="method-title">set_collapse</span> (line <span class="line-number">294</span>)
689            </div>
690            
691            <!-- ========== Info from phpDoc block ========= -->
692    <p class="short-description">This function turns on the collapse flag</p>
693            <ul class="tags">
694                                    <li><span class="field">access:</span> public</li>
695                            </ul>
696            
697            <div class="method-signature">
698                    <span class="method-result">void</span>
699                    <span class="method-name">
700                            set_collapse
701                    </span>
702                                            ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$collapse</span> = <span class="var-default">TRUE</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$indent</span> = <span class="var-default">TRUE</span>])
703                            </div>
704            
705                            <ul class="parameters">
706                                            <li>
707                                    <span class="var-type">boolean</span>
708                                    <span class="var-name">$collapse</span><span class="var-description">: <p>- the collapse flag</p></span>                        </li>
709                                            <li>
710                                    <span class="var-type">boolean</span>
711                                    <span class="var-name">$indent</span><span class="var-description">: <p>- the indent flag                   DEFAULT: TRUE;</p></span>                   </li>
712                                    </ul>
713                    
714                    
715                            <hr class="separator" />
716                    <div class="notes">Redefined in descendants as:</div>
717                    <ul class="redefinitions">
718                                            <li>
719                                    <a href="../phpHtmlLib/XMLTagClass.html#methodset_collapse">XMLTagClass::set_collapse()</a>
720                                                                    : This function turns on the collapse flag
721                                                            </li>
722                                    </ul>
723          </div>          </div>
724  </body>  <a name="methodset_indent_flag" id="set_indent_flag"><!-- --></a>
725    <div class="oddrow">
726            
727            <div class="method-header">
728                    <span class="method-title">set_indent_flag</span> (line <span class="line-number">263</span>)
729            </div>
730            
731            <!-- ========== Info from phpDoc block ========= -->
732    <p class="short-description">function to set the indent flag</p>
733            <ul class="tags">
734                                    <li><span class="field">access:</span> public</li>
735                            </ul>
736            
737            <div class="method-signature">
738                    <span class="method-result">void</span>
739                    <span class="method-name">
740                            set_indent_flag
741                    </span>
742                                            (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
743                            </div>
744            
745                            <ul class="parameters">
746                                            <li>
747                                    <span class="var-type">boolean</span>
748                                    <span class="var-name">$flag</span><span class="var-description">: <p>TRUE or FALSE</p></span>                  </li>
749                                    </ul>
750                    
751                    
752            </div>
753    <a name="method_set_flags" id="_set_flags"><!-- --></a>
754    <div class="evenrow">
755            
756            <div class="method-header">
757                    <span class="method-title">_set_flags</span> (line <span class="line-number">252</span>)
758            </div>
759            
760            <!-- ========== Info from phpDoc block ========= -->
761    <p class="short-description">This method is used to set the bitmask  flags for this tag.  It tells the  class how to render the tag.</p>
762    <p class="description"><p>NOTE: the child class can override this        to set the options</p></p>
763            
764            <div class="method-signature">
765                    <span class="method-result">void</span>
766                    <span class="method-name">
767                            _set_flags
768                    </span>
769                                    ()
770                            </div>
771            
772                    
773                    
774                            <hr class="separator" />
775                    <div class="notes">Redefined in descendants as:</div>
776                    <ul class="redefinitions">
777                                            <li>
778                                    <a href="../phpHtmlLib/XMLTagClass.html#method_set_flags">XMLTagClass::_set_flags()</a>
779                                                                    : This method is used to set the bitmask  flags for this tag.  It tells the  class how to render the tag.
780                                                            </li>
781                                            <li>
782                                    <a href="../phpHtmlLib/Atag.html#method_set_flags">Atag::_set_flags()</a>
783                                                            </li>
784                                            <li>
785                                    <a href="../phpHtmlLib/APPLETtag.html#method_set_flags">APPLETtag::_set_flags()</a>
786                                                            </li>
787                                            <li>
788                                    <a href="../phpHtmlLib/AREAtag.html#method_set_flags">AREAtag::_set_flags()</a>
789                                                            </li>
790                                            <li>
791                                    <a href="../phpHtmlLib/Btag.html#method_set_flags">Btag::_set_flags()</a>
792                                                            </li>
793                                            <li>
794                                    <a href="../phpHtmlLib/BASEtag.html#method_set_flags">BASEtag::_set_flags()</a>
795                                                            </li>
796                                            <li>
797                                    <a href="../phpHtmlLib/BRtag.html#method_set_flags">BRtag::_set_flags()</a>
798                                                            </li>
799                                            <li>
800                                    <a href="../phpHtmlLib/CENTERtag.html#method_set_flags">CENTERtag::_set_flags()</a>
801                                                            </li>
802                                            <li>
803                                    <a href="../phpHtmlLib/DOCTYPEtag.html#method_set_flags">DOCTYPEtag::_set_flags()</a>
804                                                            </li>
805                                            <li>
806                                    <a href="../phpHtmlLib/FONTtag.html#method_set_flags">FONTtag::_set_flags()</a>
807                                                            </li>
808                                            <li>
809                                    <a href="../phpHtmlLib/FRAMEtag.html#method_set_flags">FRAMEtag::_set_flags()</a>
810                                                            </li>
811                                            <li>
812                                    <a href="../phpHtmlLib/H1tag.html#method_set_flags">H1tag::_set_flags()</a>
813                                                            </li>
814                                            <li>
815                                    <a href="../phpHtmlLib/H2tag.html#method_set_flags">H2tag::_set_flags()</a>
816                                                            </li>
817                                            <li>
818                                    <a href="../phpHtmlLib/H3tag.html#method_set_flags">H3tag::_set_flags()</a>
819                                                            </li>
820                                            <li>
821                                    <a href="../phpHtmlLib/H4tag.html#method_set_flags">H4tag::_set_flags()</a>
822                                                            </li>
823                                            <li>
824                                    <a href="../phpHtmlLib/H5tag.html#method_set_flags">H5tag::_set_flags()</a>
825                                                            </li>
826                                            <li>
827                                    <a href="../phpHtmlLib/H6tag.html#method_set_flags">H6tag::_set_flags()</a>
828                                                            </li>
829                                            <li>
830                                    <a href="../phpHtmlLib/HRtag.html#method_set_flags">HRtag::_set_flags()</a>
831                                                            </li>
832                                            <li>
833                                    <a href="../phpHtmlLib/IMGtag.html#method_set_flags">IMGtag::_set_flags()</a>
834                                                            </li>
835                                            <li>
836                                    <a href="../phpHtmlLib/INPUTtag.html#method_set_flags">INPUTtag::_set_flags()</a>
837                                                            </li>
838                                            <li>
839                                    <a href="../phpHtmlLib/LINKtag.html#method_set_flags">LINKtag::_set_flags()</a>
840                                                            </li>
841                                            <li>
842                                    <a href="../phpHtmlLib/METAtag.html#method_set_flags">METAtag::_set_flags()</a>
843                                                            </li>
844                                            <li>
845                                    <a href="../phpHtmlLib/NOBRtag.html#method_set_flags">NOBRtag::_set_flags()</a>
846                                                            </li>
847                                            <li>
848                                    <a href="../phpHtmlLib/OPTIONtag.html#method_set_flags">OPTIONtag::_set_flags()</a>
849                                                            </li>
850                                            <li>
851                                    <a href="../phpHtmlLib/PREtag.html#method_set_flags">PREtag::_set_flags()</a>
852                                                            </li>
853                                            <li>
854                                    <a href="../phpHtmlLib/Stag.html#method_set_flags">Stag::_set_flags()</a>
855                                                            </li>
856                                            <li>
857                                    <a href="../phpHtmlLib/TEXTAREAtag.html#method_set_flags">TEXTAREAtag::_set_flags()</a>
858                                                            </li>
859                                            <li>
860                                    <a href="../phpHtmlLib/DEFINITIONSRCsvgtag.html#method_set_flags">DEFINITIONSRCsvgtag::_set_flags()</a>
861                                                            </li>
862                                            <li>
863                                    <a href="../phpHtmlLib/ELLIPSEsvgtag.html#method_set_flags">ELLIPSEsvgtag::_set_flags()</a>
864                                                            </li>
865                                            <li>
866                                    <a href="../phpHtmlLib/FONTFACEFORMATsvgtag.html#method_set_flags">FONTFACEFORMATsvgtag::_set_flags()</a>
867                                                            </li>
868                                            <li>
869                                    <a href="../phpHtmlLib/FONTFACENAMEsvgtag.html#method_set_flags">FONTFACENAMEsvgtag::_set_flags()</a>
870                                                            </li>
871                                            <li>
872                                    <a href="../phpHtmlLib/HKERNsvgtag.html#method_set_flags">HKERNsvgtag::_set_flags()</a>
873                                                            </li>
874                                            <li>
875                                    <a href="../phpHtmlLib/SCRIPTsvgtag.html#method_set_flags">SCRIPTsvgtag::_set_flags()</a>
876                                                            </li>
877                                            <li>
878                                    <a href="../phpHtmlLib/STYLEsvgtag.html#method_set_flags">STYLEsvgtag::_set_flags()</a>
879                                                            </li>
880                                            <li>
881                                    <a href="../phpHtmlLib/VKERNsvgtag.html#method_set_flags">VKERNsvgtag::_set_flags()</a>
882                                                            </li>
883                                            <li>
884                                    <a href="../phpHtmlLib/ACCESStag.html#method_set_flags">ACCESStag::_set_flags()</a>
885                                                            </li>
886                                            <li>
887                                    <a href="../phpHtmlLib/NOOPtag.html#method_set_flags">NOOPtag::_set_flags()</a>
888                                                            </li>
889                                            <li>
890                                    <a href="../phpHtmlLib/TIMERtag.html#method_set_flags">TIMERtag::_set_flags()</a>
891                                                            </li>
892                                            <li>
893                                    <a href="../phpHtmlLib/XMLtag.html#method_set_flags">XMLtag::_set_flags()</a>
894                                                            </li>
895                                            <li>
896                                    <a href="../phpHtmlLib/CDATAtag.html#method_set_flags">CDATAtag::_set_flags()</a>
897                                                            </li>
898                                    </ul>
899            </div>
900                                                    
901                    </div>
902            </div>
903            
904            <p class="notes" id="credit">
905                    Documention generated on Thu, 31 Jul 2003 18:32:19 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
906            </p>
907            </div></body>
908  </html>  </html>
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed