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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.4 - (hide annotations)
Thu May 6 16:24:24 2004 UTC (20 years, 3 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
Changes since 1.3: +437 -441 lines
File MIME type: text/html
 updated all to v2.4.1 - Apr 01, 2004

1 jonen 1.4 <?xml version="1.0" encoding="iso-8859-1"?>
2     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3     <html xmlns="http://www.w3.org/1999/xhtml">
4     <head>
5     <!-- template designed by Marco Von Ballmoos -->
6     <title>Docs For Class TreeNav</title>
7     <link rel="stylesheet" href="../media/stylesheet.css" />
8     <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
9     </head>
10     <body>
11     <div class="page-body">
12     <h2 class="class-name">Class TreeNav</h2>
13    
14     <a name="sec-description"></a>
15     <div class="info-box">
16     <div class="info-box-title">Description</div>
17     <div class="nav-bar">
18     <span class="disabled">Description</span> |
19     <a href="#sec-vars">Vars</a>
20     | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
21    
22     </div>
23     <div class="info-box-body">
24     <!-- ========== Info from phpDoc block ========= -->
25     <p class="short-description">This class tries to build a tree navigational widget.</p>
26     <p class="description"><p>definetly not done.</p></p>
27     <ul class="tags">
28     <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     <p class="notes">
31     Located in <a class="field" href="_widgets_TreeNav_inc.html">/widgets/TreeNav.inc</a> (line <span class="field">25</span>)
32     </p>
33    
34    
35 jonen 1.3 <pre><a href="../phpHtmlLib/Container.html">Container</a>
36 jonen 1.1 |
37     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
38     |
39 jonen 1.4 --TreeNav</pre>
40    
41     </div>
42     </div>
43    
44    
45    
46    
47     <a name="sec-method-summary"></a>
48     <div class="info-box">
49     <div class="info-box-title">Method Summary</span></div>
50     <div class="nav-bar">
51     <a href="#sec-description">Description</a> |
52     <a href="#sec-vars">Vars</a>
53    
54     |
55     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
56     </div>
57     <div class="info-box-body">
58     <div class="method-summary">
59    
60     <div class="method-definition">
61     <span class="method-result">TreeNav</span>
62     <a href="#TreeNav" title="details" class="method-name">TreeNav</a>
63     ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
64     </div>
65    
66     <div class="method-definition">
67     <span class="method-result">void</span>
68     <a href="#build_img_td" title="details" class="method-name">build_img_td</a>
69     ()
70     </div>
71    
72     <div class="method-definition">
73     <span class="method-result">void</span>
74     <a href="#build_innertable" title="details" class="method-name">build_innertable</a>
75     ()
76     </div>
77    
78     <div class="method-definition">
79     <span class="method-result">void</span>
80     <a href="#build_link_td" title="details" class="method-name">build_link_td</a>
81     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$nav</span>)
82     </div>
83    
84     <div class="method-definition">
85     <span class="method-result">void</span>
86     <a href="#build_spacer_td" title="details" class="method-name">build_spacer_td</a>
87     ()
88     </div>
89    
90     <div class="method-definition">
91     <span class="method-result">void</span>
92     <a href="#push" title="details" class="method-name">push</a>
93     (<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     </div>
95    
96     <div class="method-definition">
97     <span class="method-result">void</span>
98     <a href="#push_blank" title="details" class="method-name">push_blank</a>
99     ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
100     </div>
101    
102     <div class="method-definition">
103     <span class="method-result">void</span>
104     <a href="#push_text" title="details" class="method-name">push_text</a>
105     (<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     </div>
107    
108     <div class="method-definition">
109     <span class="method-result">string</span>
110     <a href="#render" title="details" class="method-name">render</a>
111     ([<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     </div>
113    
114     <div class="method-definition">
115     <span class="method-result">void</span>
116     <a href="#set_selected" title="details" class="method-name">set_selected</a>
117     (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
118     </div>
119     </div>
120     </div>
121     </div>
122    
123     <a name="sec-vars"></a>
124     <div class="info-box">
125     <div class="info-box-title">Variables</div>
126     <div class="nav-bar">
127     <a href="#sec-description">Description</a> |
128     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
129    
130    
131     |
132     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
133    
134     </div>
135     <div class="info-box-body">
136     <h4>Inherited Variables</h4>
137     <A NAME='inherited_vars'><!-- --></A>
138     <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
139     <blockquote>
140     <span class="var-title">
141     <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
142     </span>
143     <span class="var-title">
144     <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
145     </span>
146     </blockquote>
147    
148     </div>
149     </div>
150    
151     <a name="sec-methods"></a>
152     <div class="info-box">
153     <div class="info-box-title">Methods</div>
154     <div class="nav-bar">
155     <a href="#sec-description">Description</a> |
156     <a href="#sec-vars">Vars</a>
157     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
158    
159     </div>
160     <div class="info-box-body">
161     <A NAME='method_detail'></A>
162     <a name="methodTreeNav" id="TreeNav"><!-- --></a>
163     <div class="oddrow">
164    
165     <div class="method-header">
166     <span class="method-title">Constructor TreeNav</span> (line <span class="line-number">34</span>)
167     </div>
168    
169     <!-- ========== Info from phpDoc block ========= -->
170     <p class="short-description">Constructor for this class It just sets the width for the widget.</p>
171    
172     <div class="method-signature">
173     <span class="method-result">TreeNav</span>
174     <span class="method-name">
175     TreeNav
176     </span>
177     ([<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">760</span>])
178     </div>
179    
180     <ul class="parameters">
181     <li>
182     <span class="var-type">int</span>
183     <span class="var-name">$width</span><span class="var-description">: - the width of the widget</span> </li>
184     </ul>
185    
186    
187     </div>
188     <a name="methodbuild_img_td" id="build_img_td"><!-- --></a>
189     <div class="evenrow">
190    
191     <div class="method-header">
192     <span class="method-title">build_img_td</span> (line <span class="line-number">70</span>)
193     </div>
194    
195     <!-- ========== Info from phpDoc block ========= -->
196     <p class="short-description">build the image seperator td</p>
197    
198     <div class="method-signature">
199     <span class="method-result">void</span>
200     <span class="method-name">
201     build_img_td
202     </span>
203     ()
204     </div>
205    
206    
207    
208     </div>
209     <a name="methodbuild_innertable" id="build_innertable"><!-- --></a>
210     <div class="oddrow">
211    
212     <div class="method-header">
213     <span class="method-title">build_innertable</span> (line <span class="line-number">121</span>)
214     </div>
215    
216     <!-- ========== Info from phpDoc block ========= -->
217     <p class="short-description">build all of the idividual nav elements.</p>
218    
219     <div class="method-signature">
220     <span class="method-result">void</span>
221     <span class="method-name">
222     build_innertable
223     </span>
224     ()
225     </div>
226    
227    
228    
229     </div>
230     <a name="methodbuild_link_td" id="build_link_td"><!-- --></a>
231     <div class="evenrow">
232    
233     <div class="method-header">
234     <span class="method-title">build_link_td</span> (line <span class="line-number">86</span>)
235     </div>
236    
237     <!-- ========== Info from phpDoc block ========= -->
238     <p class="short-description">build the link td.</p>
239    
240     <div class="method-signature">
241     <span class="method-result">void</span>
242     <span class="method-name">
243     build_link_td
244     </span>
245     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$nav</span>)
246     </div>
247    
248    
249    
250     </div>
251     <a name="methodbuild_spacer_td" id="build_spacer_td"><!-- --></a>
252     <div class="oddrow">
253    
254     <div class="method-header">
255     <span class="method-title">build_spacer_td</span> (line <span class="line-number">103</span>)
256     </div>
257    
258     <!-- ========== Info from phpDoc block ========= -->
259     <p class="short-description">build a spacer td.</p>
260    
261     <div class="method-signature">
262     <span class="method-result">void</span>
263     <span class="method-name">
264     build_spacer_td
265     </span>
266     ()
267     </div>
268    
269    
270    
271     </div>
272     <a name="methodpush" id="push"><!-- --></a>
273     <div class="evenrow">
274    
275     <div class="method-header">
276     <span class="method-title">push</span> (line <span class="line-number">41</span>)
277     </div>
278    
279     <!-- ========== Info from phpDoc block ========= -->
280    
281     <div class="method-signature">
282     <span class="method-result">void</span>
283     <span class="method-name">
284     push
285     </span>
286     (<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     </div>
288    
289    
290     <hr class="separator" />
291     <div class="notes">Redefinition of:</div>
292     <dl>
293     <dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
294     <dd>Same as add().</dd>
295     </dl>
296    
297     </div>
298     <a name="methodpush_blank" id="push_blank"><!-- --></a>
299     <div class="oddrow">
300    
301     <div class="method-header">
302     <span class="method-title">push_blank</span> (line <span class="line-number">46</span>)
303     </div>
304    
305     <!-- ========== Info from phpDoc block ========= -->
306    
307     <div class="method-signature">
308     <span class="method-result">void</span>
309     <span class="method-name">
310     push_blank
311     </span>
312     ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$num</span> = <span class="var-default">1</span>])
313     </div>
314    
315    
316    
317     </div>
318     <a name="methodpush_text" id="push_text"><!-- --></a>
319     <div class="evenrow">
320    
321     <div class="method-header">
322     <span class="method-title">push_text</span> (line <span class="line-number">51</span>)
323     </div>
324    
325     <!-- ========== Info from phpDoc block ========= -->
326    
327     <div class="method-signature">
328     <span class="method-result">void</span>
329     <span class="method-name">
330     push_text
331     </span>
332     (<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     </div>
334    
335    
336    
337     </div>
338     <a name="methodrender" id="render"><!-- --></a>
339     <div class="oddrow">
340    
341     <div class="method-header">
342     <span class="method-title">render</span> (line <span class="line-number">156</span>)
343     </div>
344    
345     <!-- ========== Info from phpDoc block ========= -->
346     <p class="short-description">function that will render the widget.</p>
347     <ul class="tags">
348     <li><span class="field">return:</span> the raw html output.</li>
349     </ul>
350    
351     <div class="method-signature">
352     <span class="method-result">string</span>
353     <span class="method-name">
354     render
355     </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     </div>
358    
359     <ul class="parameters">
360     <li>
361     <span class="var-type">int</span>
362     <span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li>
363     <li>
364     <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     </ul>
367    
368     <hr class="separator" />
369     <div class="notes">Redefinition of:</div>
370     <dl>
371     <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
372     <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
373     </dl>
374    
375     </div>
376     <a name="methodset_selected" id="set_selected"><!-- --></a>
377     <div class="evenrow">
378    
379     <div class="method-header">
380     <span class="method-title">set_selected</span> (line <span class="line-number">62</span>)
381     </div>
382    
383     <!-- ========== Info from phpDoc block ========= -->
384     <p class="short-description">Set this text as the selected item</p>
385    
386     <div class="method-signature">
387     <span class="method-result">void</span>
388     <span class="method-name">
389     set_selected
390     </span>
391     (<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
392     </div>
393    
394     <ul class="parameters">
395     <li>
396     <span class="var-type">string</span>
397     <span class="var-name">$text</span><span class="var-description">: - the text item selected.</span> </li>
398     </ul>
399    
400    
401     </div>
402     <h4>Inherited Methods</h4>
403     <a name='inherited_methods'><!-- --></a>
404     <!-- =========== Summary =========== -->
405     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
406     <blockquote>
407     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
408     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
409     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
410     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
411     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
412     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
413     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
414     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
415     </blockquote>
416     <!-- =========== Summary =========== -->
417     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
418     <blockquote>
419     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
420     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
421     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
422     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
423     <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     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
426     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
427     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
428     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
429     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
430     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
431     </blockquote>
432    
433     </div>
434     </div>
435    
436    
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     </p>
440     </div></body>
441     </html>

MailToCvsAdmin">MailToCvsAdmin
ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed