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