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

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

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

revision 1.1.1.1 by jonen, Thu Jan 30 03:29:18 2003 UTC revision 1.3 by jonen, Sat Sep 20 00:24:04 2003 UTC
# Line 1  Line 1 
1  <!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.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: 'Mon, 25 Nov 2002 09:21:39 -0800' -->                          <!-- template designed by Marco Von Ballmoos -->
6          <TITLE>Docs For Class TreeNav</TITLE>                          <title>Docs For Class TreeNav</title>
7  <LINK REL ='stylesheet' TYPE='text/css' HREF='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                        <body>
11                            <div class="page-body">                
12  <!-- Links -->  <h2 class="class-name">Class TreeNav</h2>
13  <a NAME="top"></A>  
14  <table WIDTH="100%" class="links">  <a name="sec-description"></a>
15   <TR>  <div class="info-box">
16     <TD class="font10">          <div class="info-box-title">Description</div>
17        Links:          <div class="nav-bar">
18        <A HREF="#children_summary" class="links" title="Classes extended from TreeNav">Child Classes</A>                                          <span class="disabled">Description</span> |
19        <A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A>                                                                                                          <a href="#sec-vars">Vars</a>
20        <A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A>                                                  |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21        <A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inerited Methods</A>                                                  
22        <A HREF="#functions_summary" class="links" title="Method Summary">Methods</A>                          </div>
23        <A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A>          <div class="info-box-body">
24        <A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A>                  <!-- ========== Info from phpDoc block ========= -->
25     </TD>  <p class="short-description">This class tries to build a tree  navigational widget.</p>
26   </TR>  <p class="description"><p>definetly not done.</p></p>
27  </TABLE>          <ul class="tags">
28  <BR>                                  <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>
29                            </ul>
30  <!-- Start of Class Data -->                  <p class="notes">
31  <H2>                          Located in <a class="field" href="_widgets_TreeNav_inc.html">Program_Root/widgets/TreeNav.inc</a> (line <span class="field">25</span>)
32          Class TreeNav                  </p>
33  </H2>                  
34                            
35  <pre>                  <pre><a href="../phpHtmlLib/Container.html">Container</a>
 <pre><a href="../phpHtmlLib/Container.html">Container</a>  
36     |     |
37     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
38        |        |
39        --TreeNav</pre>        --TreeNav</pre>
 </pre>  
   
 <A NAME="children_summary"</A>  
 <H3>  
         Classes extended from TreeNav: <A HREF="#top" CLASS="links">^TOP</A>  
 </H3>  
   
 <p>  
         <b><i>Located in File: Program_Root/widgets/TreeNav.inc</i></b><br>  
 </p>  
 <hr>  
 <!-- ========== Info from phpDoc block ========= -->  
 This class tries to build a tree  
 navigational widget.  
 <BR>  
 definetly not done.  
   
 <UL>  
           
         <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>  
           
         <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</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>  
   
40                    
41  </TABLE>                          </div>
42    </div>
 <hr>  
 <!-- =========== VAR INHERITED SUMMARY =========== -->  
 <A NAME='var_inherited_summary'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Class Variable Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>  
             <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                         <tr CLASS="tableheadingcolor">  
                                 <th>Variable</th>  
                                 <th>Default Value</th>  
                                 <th>Description</th>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>  
                                 <td CLASS="font10">The title of the table.</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>  
                                 <td CLASS="font10">the width of the widget</td>  
                         </tr>  
                                   
                         </table>  
             <BR>  
         </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>  
             <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                         <tr CLASS="tableheadingcolor">  
                                 <th>Variable</th>  
                                 <th>Default Value</th>  
                                 <th>Description</th>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>  
                                 <td CLASS="font10">Flag for pretty (indented) output</td>  
                         </tr>  
                                   
                         <tr>  
                                 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>  
                                 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>  
                                 <td CLASS="font10">Do we render a newline after the  
 contents has been rendered?</td>  
                         </tr>  
                                   
                         </table>  
             <BR>  
         </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- =========== INHERITED METHOD SUMMARY =========== -->  
 <A NAME='functions_inherited'><!-- --></A>  
 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">  
         <TR CLASS='TableHeadingColor'>  
                 <TD>  
                         <span CLASS="font12bold">Inherited Method Summary</span>  
             <A HREF="#top" CLASS="links">^TOP</A>  
                 </TD>  
         </TR>  
   
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
                                 </tr>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align (  )</A></td>  
                                         <td CLASS="font10">This gets the alignment value  
 for the outer table</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css (  )</A></td>  
                                         <td CLASS="font10">This function provides the</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript (  )</A></td>  
                                         <td CLASS="font10">Function for returning the raw javascript  
 that is required for this widget.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title (  )</A></td>  
                                         <td CLASS="font10">Function for accessing the  
 title of this widget</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width (  )</A></td>  
                                         <td CLASS="font10">Function for getting the current  
 widget width setting.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>  
                                         <td CLASS="font10">This function sets the align attribute  
 for the outer table.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>  
                                         <td CLASS="font10">Set the title for the widget.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>  
                                         <td CLASS="font10">Set the width for the widget.</td>  
                                   
                         </table>  
             <br>                          
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>  
             <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">  
                                 <tr CLASS="tableheadingcolor">  
                                         <th>Function</th>  
                                         <th>Description</th>  
                                 </tr>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container (  )</A></td>  
                                         <td CLASS="font10">The constructor.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add (  )</A></td>  
                                         <td CLASS="font10">add content onto content stack</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>  
                                         <td CLASS="font10">Add content onto content stack  
 so you can change the item later.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content (  )</A></td>  
                                         <td CLASS="font10">counts the number of content objects</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag (  )</A></td>  
                                         <td CLASS="font10">This flag gets the current value  
 of the indent flag</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push (  )</A></td>  
                                         <td CLASS="font10">Same as add().</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>  
                                         <td CLASS="font10">Same as add_reference  
 NOTE : only exists for compatibility with 1.1.x</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>  
                                         <td CLASS="font10">This function is compatible with the  
 rest of the phpHtmllib API spec.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content (  )</A></td>  
                                         <td CLASS="font10">destroy existing content and start with new content.</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>  
                                         <td CLASS="font10">This function turns on the collapse flag</td>  
                                   
                                 <tr>  
                                         <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>  
                                         <td CLASS="font10">function to set the indent flag</td>  
                                   
                         </table>  
             <br>                          
                 </TD>  
         </TR>  
           
 </TABLE>  
   
 <hr>  
 <!-- should have constructor at some point -->  
 <!-- =========== 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='TreeNav.html#constructor TreeNav'>void constructor TreeNav ( [$width = 760] )</A></B></CODE>  
                         <BR>  
                         <blockquote> Constructor for this class  
 It just sets the width for the  
 widget. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#build_img_td'>void build_img_td (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> build the image seperator td </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#build_innertable'>void build_innertable (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> build all of the idividual nav elements. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#build_link_td'>void build_link_td ( $nav )</A></B></CODE>  
                         <BR>  
                         <blockquote> build the link td. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#build_spacer_td'>void build_spacer_td (  )</A></B></CODE>  
                         <BR>  
                         <blockquote> build a spacer td. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#push'>void push ( $url, $text, [$selected = FALSE] )</A></B></CODE>  
                         <BR>  
                         <blockquote>  </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#push_blank'>void push_blank ( [$num = 1] )</A></B></CODE>  
                         <BR>  
                         <blockquote>  </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#push_text'>void push_text ( $text, [$selected = FALSE] )</A></B></CODE>  
                         <BR>  
                         <blockquote>  </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>  
                         <BR>  
                         <blockquote> function that will render the widget. </blockquote>  
                 </TD>  
         </TR>  
           
         <!-- =========== Summary =========== -->  
         <TR BGCOLOR='white' CLASS='TableRowColor'>  
                 <TD>  
                         <CODE><B><A HREF='TreeNav.html#set_selected'>void set_selected ( $text )</A></B></CODE>  
                         <BR>  
                         <blockquote> Set this text as the selected  
 item </blockquote>  
                 </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>  
   
   
   
 <hr>  
 <!-- ============ FUNCTION DETAIL =========== -->  
   
 <A NAME='function_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='constructor TreeNav'><!-- --></A>  
 <SPAN CLASS="font12bold">constructor TreeNav</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">constructor TreeNav ( [$width = 760] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 Constructor for this class  
 It just sets the width for the  
 widget.  
 <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;">int</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width of the widget</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='build_img_td'><!-- --></A>  
 <SPAN CLASS="font12bold">build_img_td</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">build_img_td (  )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 build the image seperator td  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='build_innertable'><!-- --></A>  
 <SPAN CLASS="font12bold">build_innertable</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">build_innertable (  )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 build all of the idividual nav elements.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='build_link_td'><!-- --></A>  
 <SPAN CLASS="font12bold">build_link_td</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">build_link_td ( $nav )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 build the link td.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='build_spacer_td'><!-- --></A>  
 <SPAN CLASS="font12bold">build_spacer_td</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">build_spacer_td (  )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 build a spacer td.  
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='push'><!-- --></A>  
 <SPAN CLASS="font12bold">push</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">push ( $url, $text, [$selected = FALSE] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
   
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='push_blank'><!-- --></A>  
 <SPAN CLASS="font12bold">push_blank</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">push_blank ( [$num = 1] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
   
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='push_text'><!-- --></A>  
 <SPAN CLASS="font12bold">push_text</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">push_text ( $text, [$selected = FALSE] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
   
 <BR>  
   
 <DL>  
   <DT class="font10bold">Function Parameters:</DT>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
   
 </DIV>  
 <BR>  
   
 <DIV CLASS="function">  
 <A NAME='render'><!-- --></A>  
 <SPAN CLASS="font12bold">render</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 function that will render the widget.  
 <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;">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='set_selected'><!-- --></A>  
 <SPAN CLASS="font12bold">set_selected</SPAN>  
 <BR>  
 <SPAN CLASS="font10bold">Useage : </SPAN>  
 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;  
 <span class="font10bold" style="color: #0000FF">set_selected ( $text )</SPAN>  
 <BR>  
   
 <BR>  
 <SPAN CLASS="font10bold">Description : </SPAN>  
 <!-- ========== Info from phpDoc block ========= -->  
 Set this text as the selected  
 item  
 <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;">string</SPAN> <span style="color: #0000FF;font-weight:bold">$text</SPAN></SPAN> - the text item selected.</DD>  
     
   
   <DT class="font10bold">Function Info:</DT>  
     
 </DL>  
43    
 </DIV>  
 <BR>  
44    
45    
46  <hr>          <a name="sec-method-summary"></a>
47  </HTML>          <div class="info-box">
48                    <div class="info-box-title">Method Summary</span></div>
49                    <div class="nav-bar">
50                            <a href="#sec-description">Description</a> |
51                                                                                                                            <a href="#sec-vars">Vars</a>
52                                    
53                                    |
54                                                    <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
55                    </div>
56                    <div class="info-box-body">                    
57                            <div class="method-summary">
58                                                                    
59                                    <div class="method-definition">
60                                                                                            <span class="method-result">void</span>
61                                                                                    <a href="#TreeNav" title="details" class="method-name">TreeNav</a>
62                                                                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
63                                                                            </div>
64                                                                    
65                                    <div class="method-definition">
66                                                                                            <span class="method-result">void</span>
67                                                                                    <a href="#build_img_td" title="details" class="method-name">build_img_td</a>
68                                                                                    ()
69                                                                            </div>
70                                                                    
71                                    <div class="method-definition">
72                                                                                            <span class="method-result">void</span>
73                                                                                    <a href="#build_innertable" title="details" class="method-name">build_innertable</a>
74                                                                                    ()
75                                                                            </div>
76                                                                    
77                                    <div class="method-definition">
78                                                                                            <span class="method-result">void</span>
79                                                                                    <a href="#build_link_td" title="details" class="method-name">build_link_td</a>
80                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$nav</span>)
81                                                                            </div>
82                                                                    
83                                    <div class="method-definition">
84                                                                                            <span class="method-result">void</span>
85                                                                                    <a href="#build_spacer_td" title="details" class="method-name">build_spacer_td</a>
86                                                                                    ()
87                                                                            </div>
88                                                                    
89                                    <div class="method-definition">
90                                                                                            <span class="method-result">void</span>
91                                                                                    <a href="#push" title="details" class="method-name">push</a>
92                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">FALSE</span>])
93                                                                            </div>
94                                                                    
95                                    <div class="method-definition">
96                                                                                            <span class="method-result">void</span>
97                                                                                    <a href="#push_blank" title="details" class="method-name">push_blank</a>
98                                                                                            ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
99                                                                            </div>
100                                                                    
101                                    <div class="method-definition">
102                                                                                            <span class="method-result">void</span>
103                                                                                    <a href="#push_text" title="details" class="method-name">push_text</a>
104                                                                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">FALSE</span>])
105                                                                            </div>
106                                                                    
107                                    <div class="method-definition">
108                                                                                            <span class="method-result">string</span>
109                                                                                    <a href="#render" title="details" class="method-name">render</a>
110                                                                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
111                                                                            </div>
112                                                                    
113                                    <div class="method-definition">
114                                                                                            <span class="method-result">void</span>
115                                                                                    <a href="#set_selected" title="details" class="method-name">set_selected</a>
116                                                                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
117                                                                            </div>
118                                                            </div>
119                    </div>
120            </div>          
121    
122            <a name="sec-vars"></a>
123            <div class="info-box">
124                    <div class="info-box-title">Variables</div>
125                    <div class="nav-bar">
126                            <a href="#sec-description">Description</a> |
127                                                                                    <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
128                                                    
129                            
130                                                            |
131                                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
132                                                            
133                                            </div>
134                    <div class="info-box-body">
135                                                                                    <h4>Inherited Variables</h4>
136                                    <A NAME='inherited_vars'><!-- --></A>
137                                                                            <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
138                                            <blockquote>
139                                                                                                            <span class="var-title">
140                                                                    <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
141                                                            </span>
142                                                                                                            <span class="var-title">
143                                                                    <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
144                                                            </span>
145                                                                                            </blockquote>
146                                                                            <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
147                                            <blockquote>
148                                                                                                            <span class="var-title">
149                                                                    <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>
150                                                            </span>
151                                                                                            </blockquote>
152                                                                                    
153                    </div>
154            </div>
155            
156            <a name="sec-methods"></a>
157            <div class="info-box">
158                    <div class="info-box-title">Methods</div>
159                    <div class="nav-bar">
160                            <a href="#sec-description">Description</a> |
161                                                                                                                            <a href="#sec-vars">Vars</a>
162                                                                                                                    <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
163                                                    
164                    </div>
165                    <div class="info-box-body">
166                            <A NAME='method_detail'></A>
167    <a name="methodTreeNav" id="TreeNav"><!-- --></a>
168    <div class="evenrow">
169            
170            <div class="method-header">
171                    <span class="method-title">Constructor TreeNav</span> (line <span class="line-number">34</span>)
172            </div>
173            
174            <!-- ========== Info from phpDoc block ========= -->
175    <p class="short-description">Constructor for this class  It just sets the width for the  widget.</p>
176            
177            <div class="method-signature">
178                    <span class="method-result">void</span>
179                    <span class="method-name">
180                            TreeNav
181                    </span>
182                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
183                            </div>
184            
185                            <ul class="parameters">
186                                            <li>
187                                    <span class="var-type">int</span>
188                                    <span class="var-name">$width</span><span class="var-description">: <p>- the width of the widget</p></span>                     </li>
189                                    </ul>
190                    
191                    
192            </div>
193    <a name="methodbuild_img_td" id="build_img_td"><!-- --></a>
194    <div class="oddrow">
195            
196            <div class="method-header">
197                    <span class="method-title">build_img_td</span> (line <span class="line-number">70</span>)
198            </div>
199            
200            <!-- ========== Info from phpDoc block ========= -->
201    <p class="short-description">build the image seperator td</p>
202            
203            <div class="method-signature">
204                    <span class="method-result">void</span>
205                    <span class="method-name">
206                            build_img_td
207                    </span>
208                                    ()
209                            </div>
210            
211                    
212                    
213            </div>
214    <a name="methodbuild_innertable" id="build_innertable"><!-- --></a>
215    <div class="evenrow">
216            
217            <div class="method-header">
218                    <span class="method-title">build_innertable</span> (line <span class="line-number">121</span>)
219            </div>
220            
221            <!-- ========== Info from phpDoc block ========= -->
222    <p class="short-description">build all of the idividual nav elements.</p>
223            
224            <div class="method-signature">
225                    <span class="method-result">void</span>
226                    <span class="method-name">
227                            build_innertable
228                    </span>
229                                    ()
230                            </div>
231            
232                    
233                    
234            </div>
235    <a name="methodbuild_link_td" id="build_link_td"><!-- --></a>
236    <div class="oddrow">
237            
238            <div class="method-header">
239                    <span class="method-title">build_link_td</span> (line <span class="line-number">86</span>)
240            </div>
241            
242            <!-- ========== Info from phpDoc block ========= -->
243    <p class="short-description">build the link td.</p>
244            
245            <div class="method-signature">
246                    <span class="method-result">void</span>
247                    <span class="method-name">
248                            build_link_td
249                    </span>
250                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$nav</span>)
251                            </div>
252            
253                    
254                    
255            </div>
256    <a name="methodbuild_spacer_td" id="build_spacer_td"><!-- --></a>
257    <div class="evenrow">
258            
259            <div class="method-header">
260                    <span class="method-title">build_spacer_td</span> (line <span class="line-number">103</span>)
261            </div>
262            
263            <!-- ========== Info from phpDoc block ========= -->
264    <p class="short-description">build a spacer td.</p>
265            
266            <div class="method-signature">
267                    <span class="method-result">void</span>
268                    <span class="method-name">
269                            build_spacer_td
270                    </span>
271                                    ()
272                            </div>
273            
274                    
275                    
276            </div>
277    <a name="methodpush" id="push"><!-- --></a>
278    <div class="oddrow">
279            
280            <div class="method-header">
281                    <span class="method-title">push</span> (line <span class="line-number">41</span>)
282            </div>
283            
284            <!-- ========== Info from phpDoc block ========= -->
285            
286            <div class="method-signature">
287                    <span class="method-result">void</span>
288                    <span class="method-name">
289                            push
290                    </span>
291                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">FALSE</span>])
292                            </div>
293            
294                    
295                            <hr class="separator" />
296                    <div class="notes">Redefinition of:</div>
297                    <dl>
298                            <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
299                                                    <dd>Same as add().</dd>
300                                            </dl>
301                    
302            </div>
303    <a name="methodpush_blank" id="push_blank"><!-- --></a>
304    <div class="evenrow">
305            
306            <div class="method-header">
307                    <span class="method-title">push_blank</span> (line <span class="line-number">46</span>)
308            </div>
309            
310            <!-- ========== Info from phpDoc block ========= -->
311            
312            <div class="method-signature">
313                    <span class="method-result">void</span>
314                    <span class="method-name">
315                            push_blank
316                    </span>
317                                            ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
318                            </div>
319            
320                    
321                    
322            </div>
323    <a name="methodpush_text" id="push_text"><!-- --></a>
324    <div class="oddrow">
325            
326            <div class="method-header">
327                    <span class="method-title">push_text</span> (line <span class="line-number">51</span>)
328            </div>
329            
330            <!-- ========== Info from phpDoc block ========= -->
331            
332            <div class="method-signature">
333                    <span class="method-result">void</span>
334                    <span class="method-name">
335                            push_text
336                    </span>
337                                            (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$text</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">FALSE</span>])
338                            </div>
339            
340                    
341                    
342            </div>
343    <a name="methodrender" id="render"><!-- --></a>
344    <div class="evenrow">
345            
346            <div class="method-header">
347                    <span class="method-title">render</span> (line <span class="line-number">156</span>)
348            </div>
349            
350            <!-- ========== Info from phpDoc block ========= -->
351    <p class="short-description">function that will render the widget.</p>
352            <ul class="tags">
353                                    <li><span class="field">return:</span> <p>the raw html output.</p></li>
354                            </ul>
355            
356            <div class="method-signature">
357                    <span class="method-result">string</span>
358                    <span class="method-name">
359                            render
360                    </span>
361                                            ([<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
362                            </div>
363            
364                            <ul class="parameters">
365                                            <li>
366                                    <span class="var-type">int</span>
367                                    <span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for               the container.</p></span>                       </li>
368                                            <li>
369                                    <span class="var-type">int</span>
370                                    <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>
371                                    </ul>
372                    
373                            <hr class="separator" />
374                    <div class="notes">Redefinition of:</div>
375                    <dl>
376                            <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
377                                                    <dd>This function is compatible with the  rest of the phpHtmllib API spec.</dd>
378                                            </dl>
379                    
380            </div>
381    <a name="methodset_selected" id="set_selected"><!-- --></a>
382    <div class="oddrow">
383            
384            <div class="method-header">
385                    <span class="method-title">set_selected</span> (line <span class="line-number">62</span>)
386            </div>
387            
388            <!-- ========== Info from phpDoc block ========= -->
389    <p class="short-description">Set this text as the selected  item</p>
390            
391            <div class="method-signature">
392                    <span class="method-result">void</span>
393                    <span class="method-name">
394                            set_selected
395                    </span>
396                                            (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
397                            </div>
398            
399                            <ul class="parameters">
400                                            <li>
401                                    <span class="var-type">string</span>
402                                    <span class="var-name">$text</span><span class="var-description">: <p>- the text item selected.</p></span>                      </li>
403                                    </ul>
404                    
405                    
406            </div>
407                                                            <h4>Inherited Methods</h4>
408                                    <a name='inherited_methods'><!-- --></a>        
409                                                                            <!-- =========== Summary =========== -->
410                                            <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
411                                            <blockquote>
412                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
413                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
414                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
415                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
416                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
417                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
418                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
419                                                                                                            <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
420                                                                                            </blockquote>
421                                                                            <!-- =========== Summary =========== -->
422                                            <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
423                                            <blockquote>
424                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
425                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
426                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
427                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
428                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
429                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
430                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
431                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
432                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
433                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
434                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
435                                                                                                            <span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br>
436                                                                                            </blockquote>
437                                                                                    
438                    </div>
439            </div>
440            
441            <p class="notes" id="credit">
442                    Documention generated on Thu, 31 Jul 2003 18:33:52 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
443            </p>
444            </div></body>
445    </html>
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.3
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed