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