1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN' 'http://www.w3.org/TR/REC-html40/loose.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Thu, 20 Feb 2003 16:23:51 -0800' --> |
6 |
<TITLE>Docs For Class VerticalCSSNavTable</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='../media/stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
<!-- Links --> |
11 |
<a NAME="top"></A> |
12 |
<table WIDTH="100%" class="links"> |
13 |
<TR> |
14 |
<TD class="font10"> |
15 |
Links: |
16 |
<A HREF="#children_summary" class="links" title="Classes extended from VerticalCSSNavTable">Child Classes</A> |
17 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
18 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
19 |
<A HREF="#functions_inherited" class="links" title="Inherited Method Summary">Inherited Methods</A> |
20 |
<A HREF="#method_summary" class="links" title="Method Summary">Methods</A> |
21 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
22 |
<A HREF="#method_detail" class="links" title="Method Detail">Method Detail</A> |
23 |
</TD> |
24 |
</TR> |
25 |
</TABLE> |
26 |
<BR> |
27 |
<!-- Start of Class Data --> |
28 |
<H2> |
29 |
Class VerticalCSSNavTable |
30 |
</H2> (line <span class="linenumber">36</span>) |
31 |
<pre> |
32 |
<a href="../phpHtmlLib/Container.html">Container</a> |
33 |
| |
34 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
35 |
| |
36 |
--VerticalCSSNavTable</pre> |
37 |
<p> |
38 |
<b><i>Located in File: Program_Root/widgets/VerticalCSSNavTable.inc</i></b><br> |
39 |
</p> |
40 |
<hr> |
41 |
This class builds a nice table that conains clickable cells. |
42 |
<br /> |
43 |
<p>--------------------- | TITLE | --------------------- | SUBTITLE | --------------------- | link 1 | --------------------- | link 2 | ---------------------</p> |
44 |
<UL> |
45 |
<LI><b>author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></CODE></LI> |
46 |
</UL> |
47 |
<hr> |
48 |
<!-- =========== VAR SUMMARY =========== --> |
49 |
<A NAME='var_summary'><!-- --></A> |
50 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
51 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
52 |
<TD> |
53 |
<span CLASS="font12bold">Class Variable Summary</span> |
54 |
<A HREF="#top" CLASS="links">^TOP</A> |
55 |
</TD> |
56 |
</TR> |
57 |
|
58 |
<!-- =========== Summary =========== --> |
59 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
60 |
<TD> |
61 |
<CODE><B><A HREF="../phpHtmlLib/VerticalCSSNavTable.html#var$_subtitle">$_subtitle</A></B></CODE> |
62 |
<BR> |
63 |
<blockquote> the subtitle if any </blockquote> |
64 |
<blockquote> Default Value: <CODE>-> ""<-</CODE> </blockquote> |
65 |
</TD> |
66 |
</TR> |
67 |
<!-- =========== Summary =========== --> |
68 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
69 |
<TD> |
70 |
<CODE><B><A HREF="../phpHtmlLib/VerticalCSSNavTable.html#var$_table">$_table</A></B></CODE> |
71 |
<BR> |
72 |
<blockquote> Holds the outer table object </blockquote> |
73 |
<blockquote> Default Value: <CODE>-> NULL<-</CODE> </blockquote> |
74 |
</TD> |
75 |
</TR> |
76 |
</TABLE> |
77 |
<hr> |
78 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
79 |
<A NAME='var_inherited_summary'><!-- --></A> |
80 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
81 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
82 |
<TD> |
83 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
84 |
<A HREF="#top" CLASS="links">^TOP</A> |
85 |
</TD> |
86 |
</TR> |
87 |
|
88 |
<!-- =========== Summary =========== --> |
89 |
<TR BGCOLOR='white'> |
90 |
<TD> |
91 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
92 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
93 |
<tr CLASS="tableheadingcolor"> |
94 |
<th>Variable</th> |
95 |
<th>Default Value</th> |
96 |
<th>Description</th> |
97 |
</tr> |
98 |
<tr> |
99 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></td> |
100 |
<td CLASS="font10" STYLE="white-space: nowrap">->''<-</td> |
101 |
<td CLASS="font10">The title of the table.</td> |
102 |
</tr> |
103 |
<tr> |
104 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></td> |
105 |
<td CLASS="font10" STYLE="white-space: nowrap">->"100%"<-</td> |
106 |
<td CLASS="font10">the width of the widget</td> |
107 |
</tr> |
108 |
</table> |
109 |
<BR> |
110 |
</TD> |
111 |
</TR> |
112 |
<!-- =========== Summary =========== --> |
113 |
<TR BGCOLOR='white'> |
114 |
<TD> |
115 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
116 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
117 |
<tr CLASS="tableheadingcolor"> |
118 |
<th>Variable</th> |
119 |
<th>Default Value</th> |
120 |
<th>Description</th> |
121 |
</tr> |
122 |
<tr> |
123 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></td> |
124 |
<td CLASS="font10" STYLE="white-space: nowrap">-> _NEWLINEAFTERCONTENT<-</td> |
125 |
<td CLASS="font10">The flags that tell us</td> |
126 |
</tr> |
127 |
</table> |
128 |
<BR> |
129 |
</TD> |
130 |
</TR> |
131 |
</TABLE> |
132 |
|
133 |
<hr> |
134 |
<!-- =========== METHOD SUMMARY =========== --> |
135 |
<A NAME='method_summary'><!-- --></A> |
136 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
137 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
138 |
<TD> |
139 |
<span class="font12bold">Method Summary</span> |
140 |
<A HREF="#top" CLASS="links">^TOP</A> |
141 |
</TD> |
142 |
</TR> |
143 |
|
144 |
<!-- =========== Summary =========== --> |
145 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
146 |
<TD> |
147 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#methodVerticalCSSNavTable'>void constructor VerticalCSSNavTable ( $title, [$subtitle = ""], [$width = "100%"] )</A></B></CODE> |
148 |
<BR> |
149 |
<blockquote> Constructor for this class It just sets the width for the widget. </blockquote> |
150 |
</TD> |
151 |
</TR> |
152 |
<!-- =========== Summary =========== --> |
153 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
154 |
<TD> |
155 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#methodadd'>void add ( $url, $text, [$title = ""], [$target = ""] )</A></B></CODE> |
156 |
<BR> |
157 |
<blockquote> this function adds a clickable link. </blockquote> |
158 |
</TD> |
159 |
</TR> |
160 |
<!-- =========== Summary =========== --> |
161 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
162 |
<TD> |
163 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#methodadd_text'>void add_text ( $text )</A></B></CODE> |
164 |
<BR> |
165 |
<blockquote> this adds a text item in the nav </blockquote> |
166 |
</TD> |
167 |
</TR> |
168 |
<!-- =========== Summary =========== --> |
169 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
170 |
<TD> |
171 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#methodget_subtitle'>string get_subtitle ( )</A></B></CODE> |
172 |
<BR> |
173 |
<blockquote> This function returns the current subtitle. </blockquote> |
174 |
</TD> |
175 |
</TR> |
176 |
<!-- =========== Summary =========== --> |
177 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
178 |
<TD> |
179 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#methodrender'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
180 |
<BR> |
181 |
<blockquote> function that will render the widget. </blockquote> |
182 |
</TD> |
183 |
</TR> |
184 |
<!-- =========== Summary =========== --> |
185 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
186 |
<TD> |
187 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#methodset_subtitle'>void set_subtitle ( $subtitle )</A></B></CODE> |
188 |
<BR> |
189 |
<blockquote> This sets the subtitle </blockquote> |
190 |
</TD> |
191 |
</TR> |
192 |
<!-- =========== Summary =========== --> |
193 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
194 |
<TD> |
195 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#method_build_links'>Container _build_links ( )</A></B></CODE> |
196 |
<BR> |
197 |
<blockquote> This function is used to build the links to click on </blockquote> |
198 |
</TD> |
199 |
</TR> |
200 |
<!-- =========== Summary =========== --> |
201 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
202 |
<TD> |
203 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#method_build_subtitle'>void _build_subtitle ( )</A></B></CODE> |
204 |
<BR> |
205 |
<blockquote> This function builds the subtitle if needed. </blockquote> |
206 |
</TD> |
207 |
</TR> |
208 |
<!-- =========== Summary =========== --> |
209 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
210 |
<TD> |
211 |
<CODE><B><A HREF='../phpHtmlLib/VerticalCSSNavTable.html#method_build_title'>void _build_title ( )</A></B></CODE> |
212 |
<BR> |
213 |
<blockquote> This function builds the title tr </blockquote> |
214 |
</TD> |
215 |
</TR> |
216 |
</TABLE> |
217 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
218 |
<A NAME='functions_inherited'><!-- --></A> |
219 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
220 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
221 |
<TD> |
222 |
<span CLASS="font12bold">Inherited Method Summary</span> |
223 |
<A HREF="#top" CLASS="links">^TOP</A> |
224 |
</TD> |
225 |
</TR> |
226 |
|
227 |
<!-- =========== Summary =========== --> |
228 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
229 |
<TD> |
230 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
231 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
232 |
<tr CLASS="tableheadingcolor"> |
233 |
<th>Function</th> |
234 |
<th>Description</th> |
235 |
</tr> |
236 |
<tr> |
237 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></td> |
238 |
<td CLASS="font10">This gets the alignment value for the outer table</td> |
239 |
<tr> |
240 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></td> |
241 |
<td CLASS="font10">This function provides the mechanism to build and return the css needed by this widget</td> |
242 |
<tr> |
243 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></td> |
244 |
<td CLASS="font10">Function for returning the raw javascript that is required for this widget.</td> |
245 |
<tr> |
246 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></td> |
247 |
<td CLASS="font10">Function for accessing the title of this widget</td> |
248 |
<tr> |
249 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></td> |
250 |
<td CLASS="font10">Function for getting the current widget width setting.</td> |
251 |
<tr> |
252 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></td> |
253 |
<td CLASS="font10">This function sets the align attribute for the outer table.</td> |
254 |
<tr> |
255 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></td> |
256 |
<td CLASS="font10">Set the title for the widget.</td> |
257 |
<tr> |
258 |
<td CLASS="font10bold"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></td> |
259 |
<td CLASS="font10">Set the width for the widget.</td> |
260 |
</table> |
261 |
<br> |
262 |
</TD> |
263 |
</TR> |
264 |
<!-- =========== Summary =========== --> |
265 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
266 |
<TD> |
267 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
268 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
269 |
<tr CLASS="tableheadingcolor"> |
270 |
<th>Function</th> |
271 |
<th>Description</th> |
272 |
</tr> |
273 |
<tr> |
274 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></td> |
275 |
<td CLASS="font10">The constructor.</td> |
276 |
<tr> |
277 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></td> |
278 |
<td CLASS="font10">add content onto content stack</td> |
279 |
<tr> |
280 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></td> |
281 |
<td CLASS="font10">Add content onto content stack so you can change the item later.</td> |
282 |
<tr> |
283 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></td> |
284 |
<td CLASS="font10">counts the number of content objects</td> |
285 |
<tr> |
286 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></td> |
287 |
<td CLASS="font10">This flag gets the current value of the indent flag</td> |
288 |
<tr> |
289 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></td> |
290 |
<td CLASS="font10">Same as add().</td> |
291 |
<tr> |
292 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></td> |
293 |
<td CLASS="font10">Same as add_reference NOTE : only exists for compatibility with 1.1.x</td> |
294 |
<tr> |
295 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></td> |
296 |
<td CLASS="font10">This function is compatible with the rest of the phpHtmllib API spec.</td> |
297 |
<tr> |
298 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></td> |
299 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
300 |
<tr> |
301 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></td> |
302 |
<td CLASS="font10">This function turns on the collapse flag</td> |
303 |
<tr> |
304 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></td> |
305 |
<td CLASS="font10">function to set the indent flag</td> |
306 |
<tr> |
307 |
<td CLASS="font10bold"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></td> |
308 |
<td CLASS="font10">This method is used to set the bitmask flags for this tag. It tells the class how to render the tag.</td> |
309 |
</table> |
310 |
<br> |
311 |
</TD> |
312 |
</TR> |
313 |
</TABLE> |
314 |
<hr> |
315 |
<!-- ============ VARIABLE DETAIL =========== --> |
316 |
|
317 |
<A NAME='variable_detail'></A> |
318 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
319 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
320 |
<TD> |
321 |
<span CLASS="font12bold">Variable Detail</span> |
322 |
<A HREF="#top" CLASS="links">^TOP</A> |
323 |
</TD> |
324 |
</TR> |
325 |
</TABLE> |
326 |
|
327 |
<A NAME='var$_subtitle'><!-- --></A><H3>$_subtitle</H3> (line <span class="linenumber">43</span>)<br /> |
328 |
<b>Data type:</b> string<br>the subtitle if any |
329 |
<br /> |
330 |
|
331 |
<UL> |
332 |
</UL> |
333 |
<HR> |
334 |
<A NAME='var$_table'><!-- --></A><H3>$_table</H3> (line <span class="linenumber">51</span>)<br /> |
335 |
<b>Data type:</b> <a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a><br>Holds the outer table object |
336 |
<br /> |
337 |
|
338 |
<UL> |
339 |
<LI><b>var</b> - <CODE>object</CODE></LI> |
340 |
</UL> |
341 |
<HR> |
342 |
<hr> |
343 |
<!-- ============ METHOD DETAIL =========== --> |
344 |
|
345 |
<A NAME='method_detail'></A> |
346 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
347 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
348 |
<TD> |
349 |
<span class="font12bold">Method Detail</span> |
350 |
<A HREF="#top" CLASS="links">^TOP</A> |
351 |
</TD> |
352 |
</TR> |
353 |
</TABLE> |
354 |
<BR> |
355 |
<DIV CLASS="function"> |
356 |
<A NAME='methodVerticalCSSNavTable'><!-- --></A> |
357 |
<SPAN CLASS="font12bold">Constructor VerticalCSSNavTable</SPAN> (line <span class="linenumber">61</span>) |
358 |
<BR> |
359 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
360 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
361 |
<span class="font10bold" style="color: #0000FF">VerticalCSSNavTable( |
362 |
mixed |
363 |
$title, [mixed |
364 |
$subtitle = ""], [int |
365 |
$width = "100%"])</SPAN> |
366 |
<BR> |
367 |
|
368 |
<BR> |
369 |
<SPAN CLASS="font10bold">Description : </SPAN> |
370 |
Constructor for this class It just sets the width for the widget. |
371 |
<br /> |
372 |
|
373 |
<DL> |
374 |
<DT class="font10bold">Function Parameters:</DT> |
375 |
<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> |
376 |
|
377 |
<DT class="font10bold">Function Info:</DT> |
378 |
</DL> |
379 |
</DIV> |
380 |
<BR> |
381 |
<DIV CLASS="function"> |
382 |
<A NAME='methodadd'><!-- --></A> |
383 |
<SPAN CLASS="font12bold">add</SPAN> (line <span class="linenumber">122</span>) |
384 |
<BR> |
385 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
386 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
387 |
<span class="font10bold" style="color: #0000FF">add( |
388 |
string |
389 |
$url, string |
390 |
$text, [string |
391 |
$title = ""], [string |
392 |
$target = ""])</SPAN> |
393 |
<BR> |
394 |
|
395 |
<BR> |
396 |
<SPAN CLASS="font10bold">Description : </SPAN> |
397 |
this function adds a clickable link. |
398 |
<br /> |
399 |
<p>It automatically adds the link based on $url, with $text as the viewable text.</p> |
400 |
<DL> |
401 |
<DT class="font10bold">Function Parameters:</DT> |
402 |
<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">$url</SPAN></SPAN> - the url for the link</DD> |
403 |
<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 link text</DD> |
404 |
<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">$title</SPAN></SPAN> - the title text</DD> |
405 |
<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">$target</SPAN></SPAN> - the link target</DD> |
406 |
|
407 |
<DT class="font10bold">Function Info:</DT> |
408 |
</DL> |
409 |
</DIV> |
410 |
<BR> |
411 |
<DIV CLASS="function"> |
412 |
<A NAME='methodadd_text'><!-- --></A> |
413 |
<SPAN CLASS="font12bold">add_text</SPAN> (line <span class="linenumber">133</span>) |
414 |
<BR> |
415 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
416 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
417 |
<span class="font10bold" style="color: #0000FF">add_text( |
418 |
string |
419 |
$text)</SPAN> |
420 |
<BR> |
421 |
|
422 |
<BR> |
423 |
<SPAN CLASS="font10bold">Description : </SPAN> |
424 |
this adds a text item in the nav |
425 |
<br /> |
426 |
|
427 |
<DL> |
428 |
<DT class="font10bold">Function Parameters:</DT> |
429 |
<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 to display</DD> |
430 |
|
431 |
<DT class="font10bold">Function Info:</DT> |
432 |
</DL> |
433 |
</DIV> |
434 |
<BR> |
435 |
<DIV CLASS="function"> |
436 |
<A NAME='methodget_subtitle'><!-- --></A> |
437 |
<SPAN CLASS="font12bold">get_subtitle</SPAN> (line <span class="linenumber">105</span>) |
438 |
<BR> |
439 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
440 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
441 |
<span class="font10bold" style="color: #0000FF">get_subtitle( |
442 |
)</SPAN> |
443 |
<BR> |
444 |
|
445 |
<BR> |
446 |
<SPAN CLASS="font10bold">Description : </SPAN> |
447 |
This function returns the current subtitle. |
448 |
<br /> |
449 |
|
450 |
<DL> |
451 |
|
452 |
<DT class="font10bold">Function Info:</DT> |
453 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - - the subtitle</DD> |
454 |
</DL> |
455 |
</DIV> |
456 |
<BR> |
457 |
<DIV CLASS="function"> |
458 |
<A NAME='methodrender'><!-- --></A> |
459 |
<SPAN CLASS="font12bold">render</SPAN> (line <span class="linenumber">77</span>) |
460 |
<BR> |
461 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
462 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
463 |
<span class="font10bold" style="color: #0000FF">render( |
464 |
[int |
465 |
$indent_level = 1], int |
466 |
$output_debug)</SPAN> |
467 |
<BR> |
468 |
|
469 |
<BR> |
470 |
<SPAN CLASS="font10bold">Description : </SPAN> |
471 |
function that will render the widget. |
472 |
<br /> |
473 |
|
474 |
<DL> |
475 |
<DT class="font10bold">Function Parameters:</DT> |
476 |
<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> |
477 |
<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> |
478 |
|
479 |
<DT class="font10bold">Function Info:</DT> |
480 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>return</b> - the raw html output.</DD> |
481 |
</DL> |
482 |
</DIV> |
483 |
<BR> |
484 |
<DIV CLASS="function"> |
485 |
<A NAME='methodset_subtitle'><!-- --></A> |
486 |
<SPAN CLASS="font12bold">set_subtitle</SPAN> (line <span class="linenumber">95</span>) |
487 |
<BR> |
488 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
489 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
490 |
<span class="font10bold" style="color: #0000FF">set_subtitle( |
491 |
string |
492 |
$subtitle)</SPAN> |
493 |
<BR> |
494 |
|
495 |
<BR> |
496 |
<SPAN CLASS="font10bold">Description : </SPAN> |
497 |
This sets the subtitle |
498 |
<br /> |
499 |
|
500 |
<DL> |
501 |
<DT class="font10bold">Function Parameters:</DT> |
502 |
<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">$subtitle</SPAN></SPAN> - the subtitle</DD> |
503 |
|
504 |
<DT class="font10bold">Function Info:</DT> |
505 |
</DL> |
506 |
</DIV> |
507 |
<BR> |
508 |
<DIV CLASS="function"> |
509 |
<A NAME='method_build_links'><!-- --></A> |
510 |
<SPAN CLASS="font12bold">_build_links</SPAN> (line <span class="linenumber">171</span>) |
511 |
<BR> |
512 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
513 |
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
514 |
<span class="font10bold" style="color: #0000FF">_build_links( |
515 |
)</SPAN> |
516 |
<BR> |
517 |
|
518 |
<BR> |
519 |
<SPAN CLASS="font10bold">Description : </SPAN> |
520 |
This function is used to build the links to click on |
521 |
<br /> |
522 |
|
523 |
<DL> |
524 |
|
525 |
<DT class="font10bold">Function Info:</DT> |
526 |
</DL> |
527 |
</DIV> |
528 |
<BR> |
529 |
<DIV CLASS="function"> |
530 |
<A NAME='method_build_subtitle'><!-- --></A> |
531 |
<SPAN CLASS="font12bold">_build_subtitle</SPAN> (line <span class="linenumber">151</span>) |
532 |
<BR> |
533 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
534 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
535 |
<span class="font10bold" style="color: #0000FF">_build_subtitle( |
536 |
)</SPAN> |
537 |
<BR> |
538 |
|
539 |
<BR> |
540 |
<SPAN CLASS="font10bold">Description : </SPAN> |
541 |
This function builds the subtitle if needed. |
542 |
<br /> |
543 |
|
544 |
<DL> |
545 |
|
546 |
<DT class="font10bold">Function Info:</DT> |
547 |
</DL> |
548 |
</DIV> |
549 |
<BR> |
550 |
<DIV CLASS="function"> |
551 |
<A NAME='method_build_title'><!-- --></A> |
552 |
<SPAN CLASS="font12bold">_build_title</SPAN> (line <span class="linenumber">142</span>) |
553 |
<BR> |
554 |
<SPAN CLASS="font10bold">Usage : </SPAN> |
555 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
556 |
<span class="font10bold" style="color: #0000FF">_build_title( |
557 |
)</SPAN> |
558 |
<BR> |
559 |
|
560 |
<BR> |
561 |
<SPAN CLASS="font10bold">Description : </SPAN> |
562 |
This function builds the title tr |
563 |
<br /> |
564 |
|
565 |
<DL> |
566 |
|
567 |
<DT class="font10bold">Function Info:</DT> |
568 |
</DL> |
569 |
</DIV> |
570 |
<BR> |
571 |
<div id="credit"> |
572 |
<hr> |
573 |
Documention generated on Thu, 20 Feb 2003 16:23:51 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0rc1</a> |
574 |
</div> |
575 |
</body> |
576 |
</html> |