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

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/NavTable.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu Jan 30 03:29:38 2003 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
Branch point for: no_vendor_tag
File MIME type: text/html 
Initial revision
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:32 -0800' -->
6 <TITLE>Docs For Class NavTable</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 NavTable">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 NavTable
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 --NavTable</pre>
41 </pre>
42
43 <A NAME="children_summary"</A>
44 <H3>
45 Classes extended from NavTable: <A HREF="#top" CLASS="links">^TOP</A>
46 </H3>
47
48 <p>
49 <b><i>Located in File: Program_Root/widgets/NavTable.inc</i></b><br>
50 </p>
51 <hr>
52 <!-- ========== Info from phpDoc block ========= -->
53 This builds a navigational table
54 <BR>
55 widget that has a title, any #
56 of subtitles and then navigational
57 links.
58
59 <UL>
60
61 <LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI>
62
63 <LI><b>Author</b> - <CODE>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>&gt;</CODE></LI>
64
65 </UL>
66
67 <hr>
68 <!-- =========== VAR SUMMARY =========== -->
69 <A NAME='var_summary'><!-- --></A>
70 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
71 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
72 <TD>
73 <span CLASS="font12bold">Class Variable Summary</span>
74 <A HREF="#top" CLASS="links">^TOP</A>
75 </TD>
76 </TR>
77
78
79 </TABLE>
80
81 <hr>
82 <!-- =========== VAR INHERITED SUMMARY =========== -->
83 <A NAME='var_inherited_summary'><!-- --></A>
84 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
85 <TR CLASS='TableHeadingColor'>
86 <TD>
87 <span CLASS="font12bold">Inherited Class Variable Summary</span>
88 <A HREF="#top" CLASS="links">^TOP</A>
89 </TD>
90 </TR>
91
92
93 <!-- =========== Summary =========== -->
94 <TR BGCOLOR='white'>
95 <TD>
96 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
97 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
98 <tr CLASS="tableheadingcolor">
99 <th>Variable</th>
100 <th>Default Value</th>
101 <th>Description</th>
102 </tr>
103
104 <tr>
105 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$title'>$title</A></td>
106 <td CLASS="font10" STYLE="white-space: nowrap">-><-</td>
107 <td CLASS="font10">The title of the table.</td>
108 </tr>
109
110 <tr>
111 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#$width'>$width</A></td>
112 <td CLASS="font10" STYLE="white-space: nowrap">->100%<-</td>
113 <td CLASS="font10">the width of the widget</td>
114 </tr>
115
116 </table>
117 <BR>
118 </TD>
119 </TR>
120
121 <!-- =========== Summary =========== -->
122 <TR BGCOLOR='white'>
123 <TD>
124 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
125 <table CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
126 <tr CLASS="tableheadingcolor">
127 <th>Variable</th>
128 <th>Default Value</th>
129 <th>Description</th>
130 </tr>
131
132 <tr>
133 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$indent_flag'>$indent_flag</A></td>
134 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
135 <td CLASS="font10">Flag for pretty (indented) output</td>
136 </tr>
137
138 <tr>
139 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td>
140 <td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td>
141 <td CLASS="font10">Do we render a newline after the
142 contents has been rendered?</td>
143 </tr>
144
145 </table>
146 <BR>
147 </TD>
148 </TR>
149
150 </TABLE>
151
152 <hr>
153 <!-- =========== INHERITED METHOD SUMMARY =========== -->
154 <A NAME='functions_inherited'><!-- --></A>
155 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
156 <TR CLASS='TableHeadingColor'>
157 <TD>
158 <span CLASS="font12bold">Inherited Method Summary</span>
159 <A HREF="#top" CLASS="links">^TOP</A>
160 </TD>
161 </TR>
162
163
164 <!-- =========== Summary =========== -->
165 <TR BGCOLOR='white' CLASS='TableRowColor'>
166 <TD>
167 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span>
168 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
169 <tr CLASS="tableheadingcolor">
170 <th>Function</th>
171 <th>Description</th>
172 </tr>
173
174 <tr>
175 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_align'>get_align ( )</A></td>
176 <td CLASS="font10">This gets the alignment value
177 for the outer table</td>
178
179 <tr>
180 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_css'>get_css ( )</A></td>
181 <td CLASS="font10">This function provides the</td>
182
183 <tr>
184 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>get_javascript ( )</A></td>
185 <td CLASS="font10">Function for returning the raw javascript
186 that is required for this widget.</td>
187
188 <tr>
189 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_title'>get_title ( )</A></td>
190 <td CLASS="font10">Function for accessing the
191 title of this widget</td>
192
193 <tr>
194 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_width'>get_width ( )</A></td>
195 <td CLASS="font10">Function for getting the current
196 widget width setting.</td>
197
198 <tr>
199 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_align'>set_align ( $align )</A></td>
200 <td CLASS="font10">This function sets the align attribute
201 for the outer table.</td>
202
203 <tr>
204 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_title'>set_title ( [$title = ] )</A></td>
205 <td CLASS="font10">Set the title for the widget.</td>
206
207 <tr>
208 <td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $width )</A></td>
209 <td CLASS="font10">Set the width for the widget.</td>
210
211 </table>
212 <br>
213 </TD>
214 </TR>
215
216 <!-- =========== Summary =========== -->
217 <TR BGCOLOR='white' CLASS='TableRowColor'>
218 <TD>
219 <span CLASS="font10bold">Inherited From Class <a href="../phpHtmlLib/Container.html">Container</a></span>
220 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='95%' CLASS="border" ALIGN="center">
221 <tr CLASS="tableheadingcolor">
222 <th>Function</th>
223 <th>Description</th>
224 </tr>
225
226 <tr>
227 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#constructor Container'>constructor Container ( )</A></td>
228 <td CLASS="font10">The constructor.</td>
229
230 <tr>
231 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td>
232 <td CLASS="font10">add content onto content stack</td>
233
234 <tr>
235 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</A></td>
236 <td CLASS="font10">Add content onto content stack
237 so you can change the item later.</td>
238
239 <tr>
240 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#count_content'>count_content ( )</A></td>
241 <td CLASS="font10">counts the number of content objects</td>
242
243 <tr>
244 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>get_indent_flag ( )</A></td>
245 <td CLASS="font10">This flag gets the current value
246 of the indent flag</td>
247
248 <tr>
249 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push'>push ( )</A></td>
250 <td CLASS="font10">Same as add().</td>
251
252 <tr>
253 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</A></td>
254 <td CLASS="font10">Same as add_reference
255 NOTE : only exists for compatibility with 1.1.x</td>
256
257 <tr>
258 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#render'>render ( [$indent_level = 1], [$output_debug = 0] )</A></td>
259 <td CLASS="font10">This function is compatible with the
260 rest of the phpHtmllib API spec.</td>
261
262 <tr>
263 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#reset_content'>reset_content ( )</A></td>
264 <td CLASS="font10">destroy existing content and start with new content.</td>
265
266 <tr>
267 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td>
268 <td CLASS="font10">This function turns on the collapse flag</td>
269
270 <tr>
271 <td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td>
272 <td CLASS="font10">function to set the indent flag</td>
273
274 </table>
275 <br>
276 </TD>
277 </TR>
278
279 </TABLE>
280
281 <hr>
282 <!-- should have constructor at some point -->
283 <!-- =========== Method SUMMARY =========== -->
284 <A NAME='Method_summary'><!-- --></A>
285 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' Class="border">
286 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
287 <TD>
288 <span class="font12bold">Method Summary</span>
289 <A HREF="#top" CLASS="links">^TOP</A>
290 </TD>
291 </TR>
292
293
294 <!-- =========== Summary =========== -->
295 <TR BGCOLOR='white' CLASS='TableRowColor'>
296 <TD>
297 <CODE><B><A HREF='NavTable.html#constructor NavTable'>void constructor NavTable ( $title, [$subtitle = NULL], [$width = "100%"] )</A></B></CODE>
298 <BR>
299 <blockquote> the constructor for this class. </blockquote>
300 </TD>
301 </TR>
302
303 <!-- =========== Summary =========== -->
304 <TR BGCOLOR='white' CLASS='TableRowColor'>
305 <TD>
306 <CODE><B><A HREF='NavTable.html#add'>void add ( $url, $text, [$title = NULL], [$target = NULL] )</A></B></CODE>
307 <BR>
308 <blockquote> this function adds an entry to the navtable. </blockquote>
309 </TD>
310 </TR>
311
312 <!-- =========== Summary =========== -->
313 <TR BGCOLOR='white' CLASS='TableRowColor'>
314 <TD>
315 <CODE><B><A HREF='NavTable.html#add_blank'>void add_blank ( [$num = 1] )</A></B></CODE>
316 <BR>
317 <blockquote> This lets you add a blank line
318 between 2 links </blockquote>
319 </TD>
320 </TR>
321
322 <!-- =========== Summary =========== -->
323 <TR BGCOLOR='white' CLASS='TableRowColor'>
324 <TD>
325 <CODE><B><A HREF='NavTable.html#add_heading'>void add_heading ( $title )</A></B></CODE>
326 <BR>
327 <blockquote> This adds a new heading in the nav. </blockquote>
328 </TD>
329 </TR>
330
331 <!-- =========== Summary =========== -->
332 <TR BGCOLOR='white' CLASS='TableRowColor'>
333 <TD>
334 <CODE><B><A HREF='NavTable.html#add_text'>void add_text ( $text )</A></B></CODE>
335 <BR>
336 <blockquote> this adds a text item in the nav </blockquote>
337 </TD>
338 </TR>
339
340 <!-- =========== Summary =========== -->
341 <TR BGCOLOR='white' CLASS='TableRowColor'>
342 <TD>
343 <CODE><B><A HREF='NavTable.html#push'>void push ( $url, $text, [$title = NULL], [$target = NULL] )</A></B></CODE>
344 <BR>
345 <blockquote> depricated version of add() </blockquote>
346 </TD>
347 </TR>
348
349 <!-- =========== Summary =========== -->
350 <TR BGCOLOR='white' CLASS='TableRowColor'>
351 <TD>
352 <CODE><B><A HREF='NavTable.html#push_blank'>void push_blank ( [$num = 1] )</A></B></CODE>
353 <BR>
354 <blockquote> depricated version of add_blank() </blockquote>
355 </TD>
356 </TR>
357
358 <!-- =========== Summary =========== -->
359 <TR BGCOLOR='white' CLASS='TableRowColor'>
360 <TD>
361 <CODE><B><A HREF='NavTable.html#push_heading'>void push_heading ( $title )</A></B></CODE>
362 <BR>
363 <blockquote> depricated version of add_heading() </blockquote>
364 </TD>
365 </TR>
366
367 <!-- =========== Summary =========== -->
368 <TR BGCOLOR='white' CLASS='TableRowColor'>
369 <TD>
370 <CODE><B><A HREF='NavTable.html#push_text'>void push_text ( $text )</A></B></CODE>
371 <BR>
372 <blockquote> depricated version of add_text() </blockquote>
373 </TD>
374 </TR>
375
376 <!-- =========== Summary =========== -->
377 <TR BGCOLOR='white' CLASS='TableRowColor'>
378 <TD>
379 <CODE><B><A HREF='NavTable.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE>
380 <BR>
381 <blockquote> Render the Navtable and its content. </blockquote>
382 </TD>
383 </TR>
384
385 <!-- =========== Summary =========== -->
386 <TR BGCOLOR='white' CLASS='TableRowColor'>
387 <TD>
388 <CODE><B><A HREF='NavTable.html#set_subtitle'>void set_subtitle ( $subtitle )</A></B></CODE>
389 <BR>
390 <blockquote> </blockquote>
391 </TD>
392 </TR>
393
394 <!-- =========== Summary =========== -->
395 <TR BGCOLOR='white' CLASS='TableRowColor'>
396 <TD>
397 <CODE><B><A HREF='NavTable.html#_build_subtitle'><a href="../phpHtmlLib/TDtag.html">TDtag</a> _build_subtitle ( )</A></B></CODE>
398 <BR>
399 <blockquote> this function builds the subtitle td
400 to hold the...subtitle! </blockquote>
401 </TD>
402 </TR>
403
404 <!-- =========== Summary =========== -->
405 <TR BGCOLOR='white' CLASS='TableRowColor'>
406 <TD>
407 <CODE><B><A HREF='NavTable.html#_render_text'>void _render_text ( $val )</A></B></CODE>
408 <BR>
409 <blockquote> render a text row. </blockquote>
410 </TD>
411 </TR>
412
413 <!-- =========== Summary =========== -->
414 <TR BGCOLOR='white' CLASS='TableRowColor'>
415 <TD>
416 <CODE><B><A HREF='NavTable.html#_render_url'>void _render_url ( $val )</A></B></CODE>
417 <BR>
418 <blockquote> render a url row. </blockquote>
419 </TD>
420 </TR>
421
422 </TABLE>
423
424 <hr>
425 <!-- ============ VARIABLE DETAIL =========== -->
426
427 <A NAME='variable_detail'></A>
428 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
429 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
430 <TD>
431 <span CLASS="font12bold">Variable Detail</span>
432 <A HREF="#top" CLASS="links">^TOP</A>
433 </TD>
434 </TR>
435 </TABLE>
436
437
438
439 <hr>
440 <!-- ============ FUNCTION DETAIL =========== -->
441
442 <A NAME='function_detail'></A>
443 <TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border">
444 <TR BGCOLOR='#CCCCFF' CLASS='TableHeadingColor'>
445 <TD>
446 <span class="font12bold">Method Detail</span>
447 <A HREF="#top" CLASS="links">^TOP</A>
448 </TD>
449 </TR>
450 </TABLE>
451 <BR>
452
453 <DIV CLASS="function">
454 <A NAME='constructor NavTable'><!-- --></A>
455 <SPAN CLASS="font12bold">constructor NavTable</SPAN>
456 <BR>
457 <SPAN CLASS="font10bold">Useage : </SPAN>
458 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
459 <span class="font10bold" style="color: #0000FF">constructor NavTable ( $title, [$subtitle = NULL], [$width = "100%"] )</SPAN>
460 <BR>
461
462 <BR>
463 <SPAN CLASS="font10bold">Description : </SPAN>
464 <!-- ========== Info from phpDoc block ========= -->
465 the constructor for this class.
466 <BR>
467
468 <DL>
469 <DT class="font10bold">Function Parameters:</DT>
470
471 <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 for the widget.</DD>
472
473 <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 if any.</DD>
474
475 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">mixed</SPAN> <span style="color: #0000FF;font-weight:bold">$width</SPAN></SPAN> - the width of the widget.
476 can be a % or an int.</DD>
477
478
479 <DT class="font10bold">Function Info:</DT>
480
481 </DL>
482
483 </DIV>
484 <BR>
485
486 <DIV CLASS="function">
487 <A NAME='add'><!-- --></A>
488 <SPAN CLASS="font12bold">add</SPAN>
489 <BR>
490 <SPAN CLASS="font10bold">Useage : </SPAN>
491 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
492 <span class="font10bold" style="color: #0000FF">add ( $url, $text, [$title = NULL], [$target = NULL] )</SPAN>
493 <BR>
494
495 <BR>
496 <SPAN CLASS="font10bold">Description : </SPAN>
497 <!-- ========== Info from phpDoc block ========= -->
498 this function adds an entry to the navtable.
499 <BR>
500 It automatically adds the link based on $url,
501 with $text as the viewable text.
502 <DL>
503 <DT class="font10bold">Function Parameters:</DT>
504
505 <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>
506
507 <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>
508
509 <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 link title text</DD>
510
511 <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>
512
513
514 <DT class="font10bold">Function Info:</DT>
515
516 </DL>
517
518 </DIV>
519 <BR>
520
521 <DIV CLASS="function">
522 <A NAME='add_blank'><!-- --></A>
523 <SPAN CLASS="font12bold">add_blank</SPAN>
524 <BR>
525 <SPAN CLASS="font10bold">Useage : </SPAN>
526 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
527 <span class="font10bold" style="color: #0000FF">add_blank ( [$num = 1] )</SPAN>
528 <BR>
529
530 <BR>
531 <SPAN CLASS="font10bold">Description : </SPAN>
532 <!-- ========== Info from phpDoc block ========= -->
533 This lets you add a blank line
534 between 2 links
535 <BR>
536
537 <DL>
538 <DT class="font10bold">Function Parameters:</DT>
539
540 <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">$num</SPAN></SPAN> - the # of blank lines to insert</DD>
541
542
543 <DT class="font10bold">Function Info:</DT>
544
545 </DL>
546
547 </DIV>
548 <BR>
549
550 <DIV CLASS="function">
551 <A NAME='add_heading'><!-- --></A>
552 <SPAN CLASS="font12bold">add_heading</SPAN>
553 <BR>
554 <SPAN CLASS="font10bold">Useage : </SPAN>
555 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
556 <span class="font10bold" style="color: #0000FF">add_heading ( $title )</SPAN>
557 <BR>
558
559 <BR>
560 <SPAN CLASS="font10bold">Description : </SPAN>
561 <!-- ========== Info from phpDoc block ========= -->
562 This adds a new heading in the nav.
563 <BR>
564 It will look just like the sub title area
565 <DL>
566 <DT class="font10bold">Function Parameters:</DT>
567
568 <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 text in the heading</DD>
569
570
571 <DT class="font10bold">Function Info:</DT>
572
573 </DL>
574
575 </DIV>
576 <BR>
577
578 <DIV CLASS="function">
579 <A NAME='add_text'><!-- --></A>
580 <SPAN CLASS="font12bold">add_text</SPAN>
581 <BR>
582 <SPAN CLASS="font10bold">Useage : </SPAN>
583 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
584 <span class="font10bold" style="color: #0000FF">add_text ( $text )</SPAN>
585 <BR>
586
587 <BR>
588 <SPAN CLASS="font10bold">Description : </SPAN>
589 <!-- ========== Info from phpDoc block ========= -->
590 this adds a text item in the nav
591 <BR>
592
593 <DL>
594 <DT class="font10bold">Function Parameters:</DT>
595
596 <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>
597
598
599 <DT class="font10bold">Function Info:</DT>
600
601 </DL>
602
603 </DIV>
604 <BR>
605
606 <DIV CLASS="function">
607 <A NAME='push'><!-- --></A>
608 <SPAN CLASS="font12bold">push</SPAN>
609 <BR>
610 <SPAN CLASS="font10bold">Useage : </SPAN>
611 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
612 <span class="font10bold" style="color: #0000FF">push ( $url, $text, [$title = NULL], [$target = NULL] )</SPAN>
613 <BR>
614
615 <BR>
616 <SPAN CLASS="font10bold">Description : </SPAN>
617 <!-- ========== Info from phpDoc block ========= -->
618 depricated version of add()
619 <BR>
620
621 <DL>
622 <DT class="font10bold">Function Parameters:</DT>
623
624
625 <DT class="font10bold">Function Info:</DT>
626
627 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add() instead</DD>
628
629 </DL>
630
631 </DIV>
632 <BR>
633
634 <DIV CLASS="function">
635 <A NAME='push_blank'><!-- --></A>
636 <SPAN CLASS="font12bold">push_blank</SPAN>
637 <BR>
638 <SPAN CLASS="font10bold">Useage : </SPAN>
639 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
640 <span class="font10bold" style="color: #0000FF">push_blank ( [$num = 1] )</SPAN>
641 <BR>
642
643 <BR>
644 <SPAN CLASS="font10bold">Description : </SPAN>
645 <!-- ========== Info from phpDoc block ========= -->
646 depricated version of add_blank()
647 <BR>
648
649 <DL>
650 <DT class="font10bold">Function Parameters:</DT>
651
652
653 <DT class="font10bold">Function Info:</DT>
654
655 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_blank() instead</DD>
656
657 </DL>
658
659 </DIV>
660 <BR>
661
662 <DIV CLASS="function">
663 <A NAME='push_heading'><!-- --></A>
664 <SPAN CLASS="font12bold">push_heading</SPAN>
665 <BR>
666 <SPAN CLASS="font10bold">Useage : </SPAN>
667 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
668 <span class="font10bold" style="color: #0000FF">push_heading ( $title )</SPAN>
669 <BR>
670
671 <BR>
672 <SPAN CLASS="font10bold">Description : </SPAN>
673 <!-- ========== Info from phpDoc block ========= -->
674 depricated version of add_heading()
675 <BR>
676
677 <DL>
678 <DT class="font10bold">Function Parameters:</DT>
679
680
681 <DT class="font10bold">Function Info:</DT>
682
683 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_heading() instead</DD>
684
685 </DL>
686
687 </DIV>
688 <BR>
689
690 <DIV CLASS="function">
691 <A NAME='push_text'><!-- --></A>
692 <SPAN CLASS="font12bold">push_text</SPAN>
693 <BR>
694 <SPAN CLASS="font10bold">Useage : </SPAN>
695 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
696 <span class="font10bold" style="color: #0000FF">push_text ( $text )</SPAN>
697 <BR>
698
699 <BR>
700 <SPAN CLASS="font10bold">Description : </SPAN>
701 <!-- ========== Info from phpDoc block ========= -->
702 depricated version of add_text()
703 <BR>
704
705 <DL>
706 <DT class="font10bold">Function Parameters:</DT>
707
708
709 <DT class="font10bold">Function Info:</DT>
710
711 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Deprecated</b> - - use add_text() instead</DD>
712
713 </DL>
714
715 </DIV>
716 <BR>
717
718 <DIV CLASS="function">
719 <A NAME='render'><!-- --></A>
720 <SPAN CLASS="font12bold">render</SPAN>
721 <BR>
722 <SPAN CLASS="font10bold">Useage : </SPAN>
723 <span class="font10bold" style="color: #FF0000">string</SPAN>&nbsp;
724 <span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN>
725 <BR>
726
727 <BR>
728 <SPAN CLASS="font10bold">Description : </SPAN>
729 <!-- ========== Info from phpDoc block ========= -->
730 Render the Navtable and its content.
731 <BR>
732
733 <DL>
734 <DT class="font10bold">Function Parameters:</DT>
735
736 <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
737 the container.</DD>
738
739 <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
740 maintain compatibility w/ the API.</DD>
741
742
743 <DT class="font10bold">Function Info:</DT>
744
745 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - the raw html output.</DD>
746
747 </DL>
748
749 </DIV>
750 <BR>
751
752 <DIV CLASS="function">
753 <A NAME='set_subtitle'><!-- --></A>
754 <SPAN CLASS="font12bold">set_subtitle</SPAN>
755 <BR>
756 <SPAN CLASS="font10bold">Useage : </SPAN>
757 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
758 <span class="font10bold" style="color: #0000FF">set_subtitle ( $subtitle )</SPAN>
759 <BR>
760
761 <BR>
762 <SPAN CLASS="font10bold">Description : </SPAN>
763 <!-- ========== Info from phpDoc block ========= -->
764
765 <BR>
766
767 <DL>
768 <DT class="font10bold">Function Parameters:</DT>
769
770
771 <DT class="font10bold">Function Info:</DT>
772
773 </DL>
774
775 </DIV>
776 <BR>
777
778 <DIV CLASS="function">
779 <A NAME='_build_subtitle'><!-- --></A>
780 <SPAN CLASS="font12bold">_build_subtitle</SPAN>
781 <BR>
782 <SPAN CLASS="font10bold">Useage : </SPAN>
783 <span class="font10bold" style="color: #FF0000"><a href="../phpHtmlLib/TDtag.html">TDtag</a></SPAN>&nbsp;
784 <span class="font10bold" style="color: #0000FF">_build_subtitle ( )</SPAN>
785 <BR>
786
787 <BR>
788 <SPAN CLASS="font10bold">Description : </SPAN>
789 <!-- ========== Info from phpDoc block ========= -->
790 this function builds the subtitle td
791 to hold the...subtitle!
792 <BR>
793
794 <DL>
795 <DT class="font10bold">Function Parameters:</DT>
796
797
798 <DT class="font10bold">Function Info:</DT>
799
800 <DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - object</DD>
801
802 </DL>
803
804 </DIV>
805 <BR>
806
807 <DIV CLASS="function">
808 <A NAME='_render_text'><!-- --></A>
809 <SPAN CLASS="font12bold">_render_text</SPAN>
810 <BR>
811 <SPAN CLASS="font10bold">Useage : </SPAN>
812 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
813 <span class="font10bold" style="color: #0000FF">_render_text ( $val )</SPAN>
814 <BR>
815
816 <BR>
817 <SPAN CLASS="font10bold">Description : </SPAN>
818 <!-- ========== Info from phpDoc block ========= -->
819 render a text row.
820 <BR>
821
822 <DL>
823 <DT class="font10bold">Function Parameters:</DT>
824
825 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array()</SPAN> <span style="color: #0000FF;font-weight:bold">$val</SPAN></SPAN> - the item to render.</DD>
826
827
828 <DT class="font10bold">Function Info:</DT>
829
830 </DL>
831
832 </DIV>
833 <BR>
834
835 <DIV CLASS="function">
836 <A NAME='_render_url'><!-- --></A>
837 <SPAN CLASS="font12bold">_render_url</SPAN>
838 <BR>
839 <SPAN CLASS="font10bold">Useage : </SPAN>
840 <span class="font10bold" style="color: #FF0000">void</SPAN>&nbsp;
841 <span class="font10bold" style="color: #0000FF">_render_url ( $val )</SPAN>
842 <BR>
843
844 <BR>
845 <SPAN CLASS="font10bold">Description : </SPAN>
846 <!-- ========== Info from phpDoc block ========= -->
847 render a url row.
848 <BR>
849
850 <DL>
851 <DT class="font10bold">Function Parameters:</DT>
852
853 <DD CLASS="font10" STYLE="padding-bottom:5px;"><span STYLE="font-style: italic;">- <span style="color: #FF0000;font-weight:bold;">array()</SPAN> <span style="color: #0000FF;font-weight:bold">$val</SPAN></SPAN> - the item to render.</DD>
854
855
856 <DT class="font10bold">Function Info:</DT>
857
858 </DL>
859
860 </DIV>
861 <BR>
862
863
864 <hr>
865 </HTML>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed