1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.dtd'> |
2 |
<!--NewPage--> |
3 |
<HTML> |
4 |
<HEAD> |
5 |
<!-- Generated by PhpDoc date: 'Mon, 25 Nov 2002 09:21:39 -0800' --> |
6 |
<TITLE>Docs For Class VerticalCSSNavTable</TITLE> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='stylesheet.css' TITLE='Style'> |
8 |
</HEAD> |
9 |
<BODY style="background-color: #eeeeee; font-family: arial; font-size: .9em;"> |
10 |
|
11 |
|
12 |
<!-- Links --> |
13 |
<a NAME="top"></A> |
14 |
<table WIDTH="100%" class="links"> |
15 |
<TR> |
16 |
<TD class="font10"> |
17 |
Links: |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from VerticalCSSNavTable">Child Classes</A> |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</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> |
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
25 |
</TD> |
26 |
</TR> |
27 |
</TABLE> |
28 |
<BR> |
29 |
|
30 |
<!-- Start of Class Data --> |
31 |
<H2> |
32 |
Class VerticalCSSNavTable |
33 |
</H2> |
34 |
|
35 |
<pre> |
36 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
37 |
| |
38 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
39 |
| |
40 |
--VerticalCSSNavTable</pre> |
41 |
</pre> |
42 |
|
43 |
<A NAME="children_summary"</A> |
44 |
<H3> |
45 |
Classes extended from VerticalCSSNavTable: <A HREF="#top" CLASS="links">^TOP</A> |
46 |
</H3> |
47 |
|
48 |
<p> |
49 |
<b><i>Located in File: Program_Root/widgets/VerticalCSSNavTable.inc</i></b><br> |
50 |
</p> |
51 |
<hr> |
52 |
<!-- ========== Info from phpDoc block ========= --> |
53 |
This class builds a nice table |
54 |
that conains clickable cells. |
55 |
<BR> |
56 |
--------------------- |
57 |
| TITLE | |
58 |
--------------------- |
59 |
| SUBTITLE | |
60 |
--------------------- |
61 |
| link 1 | |
62 |
--------------------- |
63 |
| link 2 | |
64 |
--------------------- |
65 |
|
66 |
<UL> |
67 |
|
68 |
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
69 |
|
70 |
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></CODE></LI> |
71 |
|
72 |
</UL> |
73 |
|
74 |
<hr> |
75 |
<!-- =========== VAR SUMMARY =========== --> |
76 |
<A NAME='var_summary'><!-- --></A> |
77 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
78 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
79 |
<TD> |
80 |
<span CLASS="font12bold">Class Variable Summary</span> |
81 |
<A HREF="#top" CLASS="links">^TOP</A> |
82 |
</TD> |
83 |
</TR> |
84 |
|
85 |
|
86 |
<!-- =========== Summary =========== --> |
87 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
88 |
<TD> |
89 |
<CODE><B><A HREF='VerticalCSSNavTable.html#$_subtitle'>$_subtitle</A></B></CODE> |
90 |
<BR> |
91 |
<blockquote> the subtitle if any </blockquote> |
92 |
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote> |
93 |
</TD> |
94 |
</TR> |
95 |
|
96 |
<!-- =========== Summary =========== --> |
97 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
98 |
<TD> |
99 |
<CODE><B><A HREF='VerticalCSSNavTable.html#$_table'>$_table</A></B></CODE> |
100 |
<BR> |
101 |
<blockquote> Holds the outer table object </blockquote> |
102 |
<blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote> |
103 |
</TD> |
104 |
</TR> |
105 |
|
106 |
</TABLE> |
107 |
|
108 |
<hr> |
109 |
<!-- =========== VAR INHERITED SUMMARY =========== --> |
110 |
<A NAME='var_inherited_summary'><!-- --></A> |
111 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
112 |
<TR CLASS='TableHeadingColor'> |
113 |
<TD> |
114 |
<span CLASS="font12bold">Inherited Class Variable Summary</span> |
115 |
<A HREF="#top" CLASS="links">^TOP</A> |
116 |
</TD> |
117 |
</TR> |
118 |
|
119 |
|
120 |
<!-- =========== Summary =========== --> |
121 |
<TR BGCOLOR='white'> |
122 |
<TD> |
123 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
124 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
125 |
<tr CLASS="tableheadingcolor"> |
126 |
<th>Variable</th> |
127 |
<th>Default Value</th> |
128 |
<th>Description</th> |
129 |
</tr> |
130 |
|
131 |
<tr> |
132 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td> |
133 |
<td CLASS="font10" STYLE="white-space: nowrap">-><-</td> |
134 |
<td CLASS="font10">The title of the table.</td> |
135 |
</tr> |
136 |
|
137 |
<tr> |
138 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td> |
139 |
<td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td> |
140 |
<td CLASS="font10">the width of the widget</td> |
141 |
</tr> |
142 |
|
143 |
</table> |
144 |
<BR> |
145 |
</TD> |
146 |
</TR> |
147 |
|
148 |
<!-- =========== Summary =========== --> |
149 |
<TR BGCOLOR='white'> |
150 |
<TD> |
151 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
152 |
<table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
153 |
<tr CLASS="tableheadingcolor"> |
154 |
<th>Variable</th> |
155 |
<th>Default Value</th> |
156 |
<th>Description</th> |
157 |
</tr> |
158 |
|
159 |
<tr> |
160 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td> |
161 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
162 |
<td CLASS="font10">Flag for pretty (indented) output</td> |
163 |
</tr> |
164 |
|
165 |
<tr> |
166 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> |
167 |
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
168 |
<td CLASS="font10">Do we render a newline after the |
169 |
contents has been rendered?</td> |
170 |
</tr> |
171 |
|
172 |
</table> |
173 |
<BR> |
174 |
</TD> |
175 |
</TR> |
176 |
|
177 |
</TABLE> |
178 |
|
179 |
<hr> |
180 |
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
181 |
<A NAME='functions_inherited'><!-- --></A> |
182 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
183 |
<TR CLASS='TableHeadingColor'> |
184 |
<TD> |
185 |
<span CLASS="font12bold">Inherited Method Summary</span> |
186 |
<A HREF="#top" CLASS="links">^TOP</A> |
187 |
</TD> |
188 |
</TR> |
189 |
|
190 |
|
191 |
<!-- =========== Summary =========== --> |
192 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
193 |
<TD> |
194 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span> |
195 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
196 |
<tr CLASS="tableheadingcolor"> |
197 |
<th>Function</th> |
198 |
<th>Description</th> |
199 |
</tr> |
200 |
|
201 |
<tr> |
202 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td> |
203 |
<td CLASS="font10">This gets the alignment value |
204 |
for the outer table</td> |
205 |
|
206 |
<tr> |
207 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td> |
208 |
<td CLASS="font10">This function provides the</td> |
209 |
|
210 |
<tr> |
211 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td> |
212 |
<td CLASS="font10">Function for returning the raw javascript |
213 |
that is required for this widget.</td> |
214 |
|
215 |
<tr> |
216 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td> |
217 |
<td CLASS="font10">Function for accessing the |
218 |
title of this widget</td> |
219 |
|
220 |
<tr> |
221 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td> |
222 |
<td CLASS="font10">Function for getting the current |
223 |
widget width setting.</td> |
224 |
|
225 |
<tr> |
226 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td> |
227 |
<td CLASS="font10">This function sets the align attribute |
228 |
for the outer table.</td> |
229 |
|
230 |
<tr> |
231 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td> |
232 |
<td CLASS="font10">Set the title for the widget.</td> |
233 |
|
234 |
<tr> |
235 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td> |
236 |
<td CLASS="font10">Set the width for the widget.</td> |
237 |
|
238 |
</table> |
239 |
<br> |
240 |
</TD> |
241 |
</TR> |
242 |
|
243 |
<!-- =========== Summary =========== --> |
244 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
245 |
<TD> |
246 |
<span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span> |
247 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center"> |
248 |
<tr CLASS="tableheadingcolor"> |
249 |
<th>Function</th> |
250 |
<th>Description</th> |
251 |
</tr> |
252 |
|
253 |
<tr> |
254 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td> |
255 |
<td CLASS="font10">The constructor.</td> |
256 |
|
257 |
<tr> |
258 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td> |
259 |
<td CLASS="font10">add content onto content stack</td> |
260 |
|
261 |
<tr> |
262 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td> |
263 |
<td CLASS="font10">Add content onto content stack |
264 |
so you can change the item later.</td> |
265 |
|
266 |
<tr> |
267 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td> |
268 |
<td CLASS="font10">counts the number of content objects</td> |
269 |
|
270 |
<tr> |
271 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td> |
272 |
<td CLASS="font10">This flag gets the current value |
273 |
of the indent flag</td> |
274 |
|
275 |
<tr> |
276 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td> |
277 |
<td CLASS="font10">Same as add().</td> |
278 |
|
279 |
<tr> |
280 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td> |
281 |
<td CLASS="font10">Same as add_reference |
282 |
NOTE : only exists for compatibility with 1.1.x</td> |
283 |
|
284 |
<tr> |
285 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td> |
286 |
<td CLASS="font10">This function is compatible with the |
287 |
rest of the phpHtmllib API spec.</td> |
288 |
|
289 |
<tr> |
290 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td> |
291 |
<td CLASS="font10">destroy existing content and start with new content.</td> |
292 |
|
293 |
<tr> |
294 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
295 |
<td CLASS="font10">This function turns on the collapse flag</td> |
296 |
|
297 |
<tr> |
298 |
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> |
299 |
<td CLASS="font10">function to set the indent flag</td> |
300 |
|
301 |
</table> |
302 |
<br> |
303 |
</TD> |
304 |
</TR> |
305 |
|
306 |
</TABLE> |
307 |
|
308 |
<hr> |
309 |
<!-- should have constructor at some point --> |
310 |
<!-- =========== Method SUMMARY =========== --> |
311 |
<A NAME='Method_summary'><!-- --></A> |
312 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border"> |
313 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
314 |
<TD> |
315 |
<span class="font12bold">Method Summary</span> |
316 |
<A HREF="#top" CLASS="links">^TOP</A> |
317 |
</TD> |
318 |
</TR> |
319 |
|
320 |
|
321 |
<!-- =========== Summary =========== --> |
322 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
323 |
<TD> |
324 |
<CODE><B><A HREF='VerticalCSSNavTable.html#constructor VerticalCSSNavTable'>void constructor VerticalCSSNavTable ( $title, $subtitle, [$width = "100%"] )</A></B></CODE> |
325 |
<BR> |
326 |
<blockquote> Constructor for this class |
327 |
It just sets the width for the |
328 |
widget. </blockquote> |
329 |
</TD> |
330 |
</TR> |
331 |
|
332 |
<!-- =========== Summary =========== --> |
333 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
334 |
<TD> |
335 |
<CODE><B><A HREF='VerticalCSSNavTable.html#add'>void add ( $url, $text, $title, $target )</A></B></CODE> |
336 |
<BR> |
337 |
<blockquote> this function adds a clickable link. </blockquote> |
338 |
</TD> |
339 |
</TR> |
340 |
|
341 |
<!-- =========== Summary =========== --> |
342 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
343 |
<TD> |
344 |
<CODE><B><A HREF='VerticalCSSNavTable.html#add_text'>void add_text ( $text )</A></B></CODE> |
345 |
<BR> |
346 |
<blockquote> this adds a text item in the nav </blockquote> |
347 |
</TD> |
348 |
</TR> |
349 |
|
350 |
<!-- =========== Summary =========== --> |
351 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
352 |
<TD> |
353 |
<CODE><B><A HREF='VerticalCSSNavTable.html#get_subtitle'>string get_subtitle ( )</A></B></CODE> |
354 |
<BR> |
355 |
<blockquote> This function returns the current |
356 |
subtitle. </blockquote> |
357 |
</TD> |
358 |
</TR> |
359 |
|
360 |
<!-- =========== Summary =========== --> |
361 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
362 |
<TD> |
363 |
<CODE><B><A HREF='VerticalCSSNavTable.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
364 |
<BR> |
365 |
<blockquote> function that will render the widget. </blockquote> |
366 |
</TD> |
367 |
</TR> |
368 |
|
369 |
<!-- =========== Summary =========== --> |
370 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
371 |
<TD> |
372 |
<CODE><B><A HREF='VerticalCSSNavTable.html#set_subtitle'>void set_subtitle ( $subtitle )</A></B></CODE> |
373 |
<BR> |
374 |
<blockquote> This sets the subtitle </blockquote> |
375 |
</TD> |
376 |
</TR> |
377 |
|
378 |
<!-- =========== Summary =========== --> |
379 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
380 |
<TD> |
381 |
<CODE><B><A HREF='VerticalCSSNavTable.html#_build_links'>Container _build_links ( )</A></B></CODE> |
382 |
<BR> |
383 |
<blockquote> This function is used to build the links |
384 |
to click on </blockquote> |
385 |
</TD> |
386 |
</TR> |
387 |
|
388 |
<!-- =========== Summary =========== --> |
389 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
390 |
<TD> |
391 |
<CODE><B><A HREF='VerticalCSSNavTable.html#_build_subtitle'>void _build_subtitle ( )</A></B></CODE> |
392 |
<BR> |
393 |
<blockquote> This function builds the subtitle |
394 |
if needed. </blockquote> |
395 |
</TD> |
396 |
</TR> |
397 |
|
398 |
<!-- =========== Summary =========== --> |
399 |
<TR BGCOLOR='white' CLASS='TableRowColor'> |
400 |
<TD> |
401 |
<CODE><B><A HREF='VerticalCSSNavTable.html#_build_title'>void _build_title ( )</A></B></CODE> |
402 |
<BR> |
403 |
<blockquote> This function builds the title tr </blockquote> |
404 |
</TD> |
405 |
</TR> |
406 |
|
407 |
</TABLE> |
408 |
|
409 |
<hr> |
410 |
<!-- ============ VARIABLE DETAIL =========== --> |
411 |
|
412 |
<A NAME='variable_detail'></A> |
413 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
414 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
415 |
<TD> |
416 |
<span CLASS="font12bold">Variable Detail</span> |
417 |
<A HREF="#top" CLASS="links">^TOP</A> |
418 |
</TD> |
419 |
</TR> |
420 |
</TABLE> |
421 |
|
422 |
|
423 |
<A NAME='$_subtitle'><!-- --></A><H3>$_subtitle</H3> |
424 |
<b>Data type:</b> string<br> |
425 |
<!-- ========== Info from phpDoc block ========= --> |
426 |
the subtitle if any |
427 |
<BR> |
428 |
|
429 |
|
430 |
<UL> |
431 |
|
432 |
</UL> |
433 |
|
434 |
<HR> |
435 |
|
436 |
<A NAME='$_table'><!-- --></A><H3>$_table</H3> |
437 |
<b>Data type:</b> <a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a><br> |
438 |
<!-- ========== Info from phpDoc block ========= --> |
439 |
Holds the outer table object |
440 |
<BR> |
441 |
|
442 |
|
443 |
<UL> |
444 |
|
445 |
<LI><b>Var</b> - <CODE>object</CODE></LI> |
446 |
|
447 |
</UL> |
448 |
|
449 |
<HR> |
450 |
|
451 |
|
452 |
<hr> |
453 |
<!-- ============ FUNCTION DETAIL =========== --> |
454 |
|
455 |
<A NAME='function_detail'></A> |
456 |
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
457 |
<TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'> |
458 |
<TD> |
459 |
<span class="font12bold">Method Detail</span> |
460 |
<A HREF="#top" CLASS="links">^TOP</A> |
461 |
</TD> |
462 |
</TR> |
463 |
</TABLE> |
464 |
<BR> |
465 |
|
466 |
<DIV CLASS="function"> |
467 |
<A NAME='constructor VerticalCSSNavTable'><!-- --></A> |
468 |
<SPAN CLASS="font12bold">constructor VerticalCSSNavTable</SPAN> |
469 |
<BR> |
470 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
471 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
472 |
<span class="font10bold" style="color: #0000FF">constructor VerticalCSSNavTable ( $title, $subtitle, [$width = "100%"] )</SPAN> |
473 |
<BR> |
474 |
|
475 |
<BR> |
476 |
<SPAN CLASS="font10bold">Description : </SPAN> |
477 |
<!-- ========== Info from phpDoc block ========= --> |
478 |
Constructor for this class |
479 |
It just sets the width for the |
480 |
widget. |
481 |
<BR> |
482 |
|
483 |
<DL> |
484 |
<DT class="font10bold">Function Parameters:</DT> |
485 |
|
486 |
<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> |
487 |
|
488 |
|
489 |
<DT class="font10bold">Function Info:</DT> |
490 |
|
491 |
</DL> |
492 |
|
493 |
</DIV> |
494 |
<BR> |
495 |
|
496 |
<DIV CLASS="function"> |
497 |
<A NAME='add'><!-- --></A> |
498 |
<SPAN CLASS="font12bold">add</SPAN> |
499 |
<BR> |
500 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
501 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
502 |
<span class="font10bold" style="color: #0000FF">add ( $url, $text, $title, $target )</SPAN> |
503 |
<BR> |
504 |
|
505 |
<BR> |
506 |
<SPAN CLASS="font10bold">Description : </SPAN> |
507 |
<!-- ========== Info from phpDoc block ========= --> |
508 |
this function adds a clickable link. |
509 |
<BR> |
510 |
It automatically adds the link based on $url, |
511 |
with $text as the viewable text. |
512 |
<DL> |
513 |
<DT class="font10bold">Function Parameters:</DT> |
514 |
|
515 |
<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> |
516 |
|
517 |
<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> |
518 |
|
519 |
<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> |
520 |
|
521 |
<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> |
522 |
|
523 |
|
524 |
<DT class="font10bold">Function Info:</DT> |
525 |
|
526 |
</DL> |
527 |
|
528 |
</DIV> |
529 |
<BR> |
530 |
|
531 |
<DIV CLASS="function"> |
532 |
<A NAME='add_text'><!-- --></A> |
533 |
<SPAN CLASS="font12bold">add_text</SPAN> |
534 |
<BR> |
535 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
536 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
537 |
<span class="font10bold" style="color: #0000FF">add_text ( $text )</SPAN> |
538 |
<BR> |
539 |
|
540 |
<BR> |
541 |
<SPAN CLASS="font10bold">Description : </SPAN> |
542 |
<!-- ========== Info from phpDoc block ========= --> |
543 |
this adds a text item in the nav |
544 |
<BR> |
545 |
|
546 |
<DL> |
547 |
<DT class="font10bold">Function Parameters:</DT> |
548 |
|
549 |
<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> |
550 |
|
551 |
|
552 |
<DT class="font10bold">Function Info:</DT> |
553 |
|
554 |
</DL> |
555 |
|
556 |
</DIV> |
557 |
<BR> |
558 |
|
559 |
<DIV CLASS="function"> |
560 |
<A NAME='get_subtitle'><!-- --></A> |
561 |
<SPAN CLASS="font12bold">get_subtitle</SPAN> |
562 |
<BR> |
563 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
564 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
565 |
<span class="font10bold" style="color: #0000FF">get_subtitle ( )</SPAN> |
566 |
<BR> |
567 |
|
568 |
<BR> |
569 |
<SPAN CLASS="font10bold">Description : </SPAN> |
570 |
<!-- ========== Info from phpDoc block ========= --> |
571 |
This function returns the current |
572 |
subtitle. |
573 |
<BR> |
574 |
|
575 |
<DL> |
576 |
<DT class="font10bold">Function Parameters:</DT> |
577 |
|
578 |
|
579 |
<DT class="font10bold">Function Info:</DT> |
580 |
|
581 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the subtitle</DD> |
582 |
|
583 |
</DL> |
584 |
|
585 |
</DIV> |
586 |
<BR> |
587 |
|
588 |
<DIV CLASS="function"> |
589 |
<A NAME='render'><!-- --></A> |
590 |
<SPAN CLASS="font12bold">render</SPAN> |
591 |
<BR> |
592 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
593 |
<span class="font10bold" style="color: #FF0000">string</SPAN> |
594 |
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
595 |
<BR> |
596 |
|
597 |
<BR> |
598 |
<SPAN CLASS="font10bold">Description : </SPAN> |
599 |
<!-- ========== Info from phpDoc block ========= --> |
600 |
function that will render the widget. |
601 |
<BR> |
602 |
|
603 |
<DL> |
604 |
<DT class="font10bold">Function Parameters:</DT> |
605 |
|
606 |
<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 |
607 |
the container.</DD> |
608 |
|
609 |
<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 |
610 |
maintain compatibility w/ the API.</DD> |
611 |
|
612 |
|
613 |
<DT class="font10bold">Function Info:</DT> |
614 |
|
615 |
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD> |
616 |
|
617 |
</DL> |
618 |
|
619 |
</DIV> |
620 |
<BR> |
621 |
|
622 |
<DIV CLASS="function"> |
623 |
<A NAME='set_subtitle'><!-- --></A> |
624 |
<SPAN CLASS="font12bold">set_subtitle</SPAN> |
625 |
<BR> |
626 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
627 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
628 |
<span class="font10bold" style="color: #0000FF">set_subtitle ( $subtitle )</SPAN> |
629 |
<BR> |
630 |
|
631 |
<BR> |
632 |
<SPAN CLASS="font10bold">Description : </SPAN> |
633 |
<!-- ========== Info from phpDoc block ========= --> |
634 |
This sets the subtitle |
635 |
<BR> |
636 |
|
637 |
<DL> |
638 |
<DT class="font10bold">Function Parameters:</DT> |
639 |
|
640 |
<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> |
641 |
|
642 |
|
643 |
<DT class="font10bold">Function Info:</DT> |
644 |
|
645 |
</DL> |
646 |
|
647 |
</DIV> |
648 |
<BR> |
649 |
|
650 |
<DIV CLASS="function"> |
651 |
<A NAME='_build_links'><!-- --></A> |
652 |
<SPAN CLASS="font12bold">_build_links</SPAN> |
653 |
<BR> |
654 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
655 |
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
656 |
<span class="font10bold" style="color: #0000FF">_build_links ( )</SPAN> |
657 |
<BR> |
658 |
|
659 |
<BR> |
660 |
<SPAN CLASS="font10bold">Description : </SPAN> |
661 |
<!-- ========== Info from phpDoc block ========= --> |
662 |
This function is used to build the links |
663 |
to click on |
664 |
<BR> |
665 |
|
666 |
<DL> |
667 |
<DT class="font10bold">Function Parameters:</DT> |
668 |
|
669 |
|
670 |
<DT class="font10bold">Function Info:</DT> |
671 |
|
672 |
</DL> |
673 |
|
674 |
</DIV> |
675 |
<BR> |
676 |
|
677 |
<DIV CLASS="function"> |
678 |
<A NAME='_build_subtitle'><!-- --></A> |
679 |
<SPAN CLASS="font12bold">_build_subtitle</SPAN> |
680 |
<BR> |
681 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
682 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
683 |
<span class="font10bold" style="color: #0000FF">_build_subtitle ( )</SPAN> |
684 |
<BR> |
685 |
|
686 |
<BR> |
687 |
<SPAN CLASS="font10bold">Description : </SPAN> |
688 |
<!-- ========== Info from phpDoc block ========= --> |
689 |
This function builds the subtitle |
690 |
if needed. |
691 |
<BR> |
692 |
|
693 |
<DL> |
694 |
<DT class="font10bold">Function Parameters:</DT> |
695 |
|
696 |
|
697 |
<DT class="font10bold">Function Info:</DT> |
698 |
|
699 |
</DL> |
700 |
|
701 |
</DIV> |
702 |
<BR> |
703 |
|
704 |
<DIV CLASS="function"> |
705 |
<A NAME='_build_title'><!-- --></A> |
706 |
<SPAN CLASS="font12bold">_build_title</SPAN> |
707 |
<BR> |
708 |
<SPAN CLASS="font10bold">Useage : </SPAN> |
709 |
<span class="font10bold" style="color: #FF0000">void</SPAN> |
710 |
<span class="font10bold" style="color: #0000FF">_build_title ( )</SPAN> |
711 |
<BR> |
712 |
|
713 |
<BR> |
714 |
<SPAN CLASS="font10bold">Description : </SPAN> |
715 |
<!-- ========== Info from phpDoc block ========= --> |
716 |
This function builds the title tr |
717 |
<BR> |
718 |
|
719 |
<DL> |
720 |
<DT class="font10bold">Function Parameters:</DT> |
721 |
|
722 |
|
723 |
<DT class="font10bold">Function Info:</DT> |
724 |
|
725 |
</DL> |
726 |
|
727 |
</DIV> |
728 |
<BR> |
729 |
|
730 |
|
731 |
<hr> |
732 |
</HTML> |