1 |
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Frameset//EN''http://www.w3.org/TR/REC-html40/frameset.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: 'Mon, 25 Nov 2002 09:21:39 -0800' --> |
<!-- template designed by Marco Von Ballmoos --> |
6 |
<TITLE>Docs For Class VerticalCSSNavTable</TITLE> |
<title>Docs For Class VerticalCSSNavTable</title> |
7 |
<LINK REL ='stylesheet' TYPE='text/css' HREF='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 |
|
<body> |
11 |
|
<div class="page-body"> |
12 |
<!-- Links --> |
<h2 class="class-name">Class VerticalCSSNavTable</h2> |
13 |
<a NAME="top"></A> |
|
14 |
<table WIDTH="100%" class="links"> |
<a name="sec-description"></a> |
15 |
<TR> |
<div class="info-box"> |
16 |
<TD class="font10"> |
<div class="info-box-title">Description</div> |
17 |
Links: |
<div class="nav-bar"> |
18 |
<A HREF="#children_summary" class="links" title="Classes extended from VerticalCSSNavTable">Child Classes</A> |
<span class="disabled">Description</span> | |
19 |
<A HREF="#var_summary" class="links" title="Class Variable Summary">Variables</A> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
20 |
<A HREF="#var_inherited_summary" class="links" title="Inherited Class Variable Summary">Inherited Variables</A> |
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</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> |
</div> |
23 |
<A HREF="#variable_detail" class="links" title="Variable Detail">Variable Detail</A> |
<div class="info-box-body"> |
24 |
<A HREF="#function_detail" class="links" title="Method Detail">Method Detail</A> |
<!-- ========== Info from phpDoc block ========= --> |
25 |
</TD> |
<p class="short-description">This class builds a nice table that conains clickable cells.</p> |
26 |
</TR> |
<p class="description"><p>--------------------- | TITLE | --------------------- | SUBTITLE | --------------------- | link 1 | --------------------- | link 2 | ---------------------</p></p> |
27 |
</TABLE> |
<ul class="tags"> |
28 |
<BR> |
<li><span class="field">author:</span> <p>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>></p></li> |
29 |
|
</ul> |
30 |
<!-- Start of Class Data --> |
<p class="notes"> |
31 |
<H2> |
Located in <a class="field" href="_widgets_VerticalCSSNavTable_inc.html">Program_Root/widgets/VerticalCSSNavTable.inc</a> (line <span class="field">36</span>) |
32 |
Class VerticalCSSNavTable |
</p> |
33 |
</H2> |
|
34 |
|
|
35 |
<pre> |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
|
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
|
36 |
| |
| |
37 |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
38 |
| |
| |
39 |
--VerticalCSSNavTable</pre> |
--VerticalCSSNavTable</pre> |
40 |
</pre> |
|
41 |
|
</div> |
42 |
<A NAME="children_summary"</A> |
</div> |
|
<H3> |
|
|
Classes extended from VerticalCSSNavTable: <A HREF="#top" CLASS="links">^TOP</A> |
|
|
</H3> |
|
|
|
|
|
<p> |
|
|
<b><i>Located in File: Program_Root/widgets/VerticalCSSNavTable.inc</i></b><br> |
|
|
</p> |
|
|
<hr> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This class builds a nice table |
|
|
that conains clickable cells. |
|
|
<BR> |
|
|
--------------------- |
|
|
| TITLE | |
|
|
--------------------- |
|
|
| SUBTITLE | |
|
|
--------------------- |
|
|
| link 1 | |
|
|
--------------------- |
|
|
| link 2 | |
|
|
--------------------- |
|
|
|
|
|
<UL> |
|
|
|
|
|
<LI><b>Package</b> - <CODE>phpHtmlLib</CODE></LI> |
|
|
|
|
|
<LI><b>Author</b> - <CODE>Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">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> |
|
|
|
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#$_subtitle'>$_subtitle</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> the subtitle if any </blockquote> |
|
|
<blockquote> Default Value: <CODE>-><-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#$_table'>$_table</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Holds the outer table object </blockquote> |
|
|
<blockquote> Default Value: <CODE>->NULL<-</CODE> </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- =========== VAR INHERITED SUMMARY =========== --> |
|
|
<A NAME='var_inherited_summary'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR 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#$title'>$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#$width'>$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#$indent_flag'>$indent_flag</A></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
|
|
<td CLASS="font10">Flag for pretty (indented) output</td> |
|
|
</tr> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#$_newline_after_content_flag'>$_newline_after_content_flag</A></td> |
|
|
<td CLASS="font10" STYLE="white-space: nowrap">->TRUE<-</td> |
|
|
<td CLASS="font10">Do we render a newline after the |
|
|
contents has been rendered?</td> |
|
|
</tr> |
|
|
|
|
|
</table> |
|
|
<BR> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- =========== INHERITED METHOD SUMMARY =========== --> |
|
|
<A NAME='functions_inherited'><!-- --></A> |
|
|
<TABLE CELLPADDING='3' CELLSPACING='0' WIDTH='100%' CLASS="border"> |
|
|
<TR 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#get_align'>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#get_css'>get_css ( )</A></td> |
|
|
<td CLASS="font10">This function provides the</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#get_javascript'>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#get_title'>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#get_width'>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#set_align'>set_align ( $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#set_title'>set_title ( [$title = ] )</A></td> |
|
|
<td CLASS="font10">Set the title for the widget.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/BaseWidget.html#set_width'>set_width ( $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#constructor Container'>constructor Container ( )</A></td> |
|
|
<td CLASS="font10">The constructor.</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add'>add ( )</A></td> |
|
|
<td CLASS="font10">add content onto content stack</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#add_reference'>add_reference ( &$content )</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#count_content'>count_content ( )</A></td> |
|
|
<td CLASS="font10">counts the number of content objects</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#get_indent_flag'>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#push'>push ( )</A></td> |
|
|
<td CLASS="font10">Same as add().</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#push_reference'>push_reference ( &$content )</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#render'>render ( [$indent_level = 1], [$output_debug = 0] )</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#reset_content'>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#set_collapse'>set_collapse ( [$collapse = TRUE], [$indent = TRUE] )</A></td> |
|
|
<td CLASS="font10">This function turns on the collapse flag</td> |
|
|
|
|
|
<tr> |
|
|
<td CLASS="font10bold"><A HREF='../phpHtmlLib/Container.html#set_indent_flag'>set_indent_flag ( $flag )</A></td> |
|
|
<td CLASS="font10">function to set the indent flag</td> |
|
|
|
|
|
</table> |
|
|
<br> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
</TABLE> |
|
|
|
|
|
<hr> |
|
|
<!-- should have constructor at some point --> |
|
|
<!-- =========== 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='VerticalCSSNavTable.html#constructor VerticalCSSNavTable'>void constructor VerticalCSSNavTable ( $title, $subtitle, [$width = "100%"] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> Constructor for this class |
|
|
It just sets the width for the |
|
|
widget. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#add'>void add ( $url, $text, $title, $target )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> this function adds a clickable link. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#add_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='VerticalCSSNavTable.html#get_subtitle'>string get_subtitle ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function returns the current |
|
|
subtitle. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#render'>string render ( [$indent_level = 1], [$output_debug = 0] )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> function that will render the widget. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#set_subtitle'>void set_subtitle ( $subtitle )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This sets the subtitle </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#_build_links'>Container _build_links ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function is used to build the links |
|
|
to click on </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#_build_subtitle'>void _build_subtitle ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function builds the subtitle |
|
|
if needed. </blockquote> |
|
|
</TD> |
|
|
</TR> |
|
|
|
|
|
<!-- =========== Summary =========== --> |
|
|
<TR BGCOLOR='white' CLASS='TableRowColor'> |
|
|
<TD> |
|
|
<CODE><B><A HREF='VerticalCSSNavTable.html#_build_title'>void _build_title ( )</A></B></CODE> |
|
|
<BR> |
|
|
<blockquote> This function builds the title tr </blockquote> |
|
|
</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> |
|
|
|
|
|
|
|
|
<A NAME='$_subtitle'><!-- --></A><H3>$_subtitle</H3> |
|
|
<b>Data type:</b> string<br> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
the subtitle if any |
|
|
<BR> |
|
|
|
|
|
|
|
|
<UL> |
|
|
|
|
|
</UL> |
|
|
|
|
|
<HR> |
|
|
|
|
|
<A NAME='$_table'><!-- --></A><H3>$_table</H3> |
|
|
<b>Data type:</b> <a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a><br> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Holds the outer table object |
|
|
<BR> |
|
|
|
|
|
|
|
|
<UL> |
|
|
|
|
|
<LI><b>Var</b> - <CODE>object</CODE></LI> |
|
|
|
|
|
</UL> |
|
|
|
|
|
<HR> |
|
|
|
|
|
|
|
|
<hr> |
|
|
<!-- ============ FUNCTION DETAIL =========== --> |
|
|
|
|
|
<A NAME='function_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='constructor VerticalCSSNavTable'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">constructor VerticalCSSNavTable</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">constructor VerticalCSSNavTable ( $title, $subtitle, [$width = "100%"] )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
Constructor for this class |
|
|
It just sets the width for the |
|
|
widget. |
|
|
<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">$width</SPAN></SPAN> - the width of the widget</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='add'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">add</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">add ( $url, $text, $title, $target )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
this function adds a clickable link. |
|
|
<BR> |
|
|
It automatically adds the link based on $url, |
|
|
with $text as the viewable text. |
|
|
<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 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='add_text'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">add_text</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">add_text ( $text )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
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='get_subtitle'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">get_subtitle</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">get_subtitle ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function returns the current |
|
|
subtitle. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
<DD CLASS="font10" STYLE="padding-bottom:5px;"><b>Return</b> - - the subtitle</DD> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='render'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">render</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">string</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">render ( [$indent_level = 1], [$output_debug = 0] )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
function that will render the widget. |
|
|
<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='set_subtitle'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">set_subtitle</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">set_subtitle ( $subtitle )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This sets the subtitle |
|
|
<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">$subtitle</SPAN></SPAN> - the subtitle</DD> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_build_links'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_links</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">Container</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_links ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function is used to build the links |
|
|
to click on |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_build_subtitle'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_subtitle</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_subtitle ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function builds the subtitle |
|
|
if needed. |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
|
|
|
|
<DIV CLASS="function"> |
|
|
<A NAME='_build_title'><!-- --></A> |
|
|
<SPAN CLASS="font12bold">_build_title</SPAN> |
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Useage : </SPAN> |
|
|
<span class="font10bold" style="color: #FF0000">void</SPAN> |
|
|
<span class="font10bold" style="color: #0000FF">_build_title ( )</SPAN> |
|
|
<BR> |
|
|
|
|
|
<BR> |
|
|
<SPAN CLASS="font10bold">Description : </SPAN> |
|
|
<!-- ========== Info from phpDoc block ========= --> |
|
|
This function builds the title tr |
|
|
<BR> |
|
|
|
|
|
<DL> |
|
|
<DT class="font10bold">Function Parameters:</DT> |
|
|
|
|
|
|
|
|
<DT class="font10bold">Function Info:</DT> |
|
|
|
|
|
</DL> |
|
|
|
|
|
</DIV> |
|
|
<BR> |
|
43 |
|
|
44 |
|
|
45 |
<hr> |
<a name="sec-var-summary"></a> |
46 |
</HTML> |
<div class="info-box"> |
47 |
|
<div class="info-box-title">Variable Summary</span></div> |
48 |
|
<div class="nav-bar"> |
49 |
|
<a href="#sec-description">Description</a> | |
50 |
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
51 |
|
| |
52 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
53 |
|
|
54 |
|
</div> |
55 |
|
<div class="info-box-body"> |
56 |
|
<div class="var-summary"> |
57 |
|
<div class="var-title"> |
58 |
|
<span class="var-type">string</span> |
59 |
|
<a href="#$_subtitle" title="details" class="var-name">$_subtitle</a> |
60 |
|
</div> |
61 |
|
<div class="var-title"> |
62 |
|
<span class="var-type"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
63 |
|
<a href="#$_table" title="details" class="var-name">$_table</a> |
64 |
|
</div> |
65 |
|
</div> |
66 |
|
</div> |
67 |
|
</div> |
68 |
|
|
69 |
|
<a name="sec-method-summary"></a> |
70 |
|
<div class="info-box"> |
71 |
|
<div class="info-box-title">Method Summary</span></div> |
72 |
|
<div class="nav-bar"> |
73 |
|
<a href="#sec-description">Description</a> | |
74 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
75 |
|
|
76 |
|
| |
77 |
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
78 |
|
</div> |
79 |
|
<div class="info-box-body"> |
80 |
|
<div class="method-summary"> |
81 |
|
|
82 |
|
<div class="method-definition"> |
83 |
|
<span class="method-result">void</span> |
84 |
|
<a href="#VerticalCSSNavTable" title="details" class="method-name">VerticalCSSNavTable</a> |
85 |
|
(<span class="var-type">mixed</span> <span class="var-name">$title</span>, [<span class="var-type">mixed</span> <span class="var-name">$subtitle</span> = <span class="var-default">""</span>], [<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>]) |
86 |
|
</div> |
87 |
|
|
88 |
|
<div class="method-definition"> |
89 |
|
<span class="method-result">void</span> |
90 |
|
<a href="#add" title="details" class="method-name">add</a> |
91 |
|
(<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">""</span>], [<span class="var-type">string</span> <span class="var-name">$target</span> = <span class="var-default">""</span>]) |
92 |
|
</div> |
93 |
|
|
94 |
|
<div class="method-definition"> |
95 |
|
<span class="method-result">void</span> |
96 |
|
<a href="#add_text" title="details" class="method-name">add_text</a> |
97 |
|
(<span class="var-type">string</span> <span class="var-name">$text</span>) |
98 |
|
</div> |
99 |
|
|
100 |
|
<div class="method-definition"> |
101 |
|
<span class="method-result">string</span> |
102 |
|
<a href="#get_subtitle" title="details" class="method-name">get_subtitle</a> |
103 |
|
() |
104 |
|
</div> |
105 |
|
|
106 |
|
<div class="method-definition"> |
107 |
|
<span class="method-result">string</span> |
108 |
|
<a href="#render" title="details" class="method-name">render</a> |
109 |
|
([<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>) |
110 |
|
</div> |
111 |
|
|
112 |
|
<div class="method-definition"> |
113 |
|
<span class="method-result">void</span> |
114 |
|
<a href="#set_subtitle" title="details" class="method-name">set_subtitle</a> |
115 |
|
(<span class="var-type">string</span> <span class="var-name">$subtitle</span>) |
116 |
|
</div> |
117 |
|
|
118 |
|
<div class="method-definition"> |
119 |
|
<span class="method-result">Container</span> |
120 |
|
<a href="#_build_links" title="details" class="method-name">_build_links</a> |
121 |
|
() |
122 |
|
</div> |
123 |
|
|
124 |
|
<div class="method-definition"> |
125 |
|
<span class="method-result">void</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="#_build_title" title="details" class="method-name">_build_title</a> |
133 |
|
() |
134 |
|
</div> |
135 |
|
</div> |
136 |
|
</div> |
137 |
|
</div> |
138 |
|
|
139 |
|
<a name="sec-vars"></a> |
140 |
|
<div class="info-box"> |
141 |
|
<div class="info-box-title">Variables</div> |
142 |
|
<div class="nav-bar"> |
143 |
|
<a href="#sec-description">Description</a> | |
144 |
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
145 |
|
|
146 |
|
|
147 |
|
| |
148 |
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
149 |
|
|
150 |
|
</div> |
151 |
|
<div class="info-box-body"> |
152 |
|
<a name="var$_subtitle" id="$_subtitle"><!-- --></A> |
153 |
|
<div class="oddrow"> |
154 |
|
|
155 |
|
<div class="var-header"> |
156 |
|
<span class="var-title"> |
157 |
|
<span class="var-type">string</span> |
158 |
|
<span class="var-name">$_subtitle</span> |
159 |
|
= <span class="var-default"> ""</span> (line <span class="line-number">43</span>) |
160 |
|
</span> |
161 |
|
</div> |
162 |
|
|
163 |
|
<!-- ========== Info from phpDoc block ========= --> |
164 |
|
<p class="short-description">the subtitle if any</p> |
165 |
|
|
166 |
|
|
167 |
|
|
168 |
|
|
169 |
|
|
170 |
|
</div> |
171 |
|
<a name="var$_table" id="$_table"><!-- --></A> |
172 |
|
<div class="evenrow"> |
173 |
|
|
174 |
|
<div class="var-header"> |
175 |
|
<span class="var-title"> |
176 |
|
<span class="var-type"><a href="../phpHtmlLib/TABLEtag.html">TABLEtag</a></span> |
177 |
|
<span class="var-name">$_table</span> |
178 |
|
= <span class="var-default"> NULL</span> (line <span class="line-number">51</span>) |
179 |
|
</span> |
180 |
|
</div> |
181 |
|
|
182 |
|
<!-- ========== Info from phpDoc block ========= --> |
183 |
|
<p class="short-description">Holds the outer table object</p> |
184 |
|
<ul class="tags"> |
185 |
|
<li><span class="field">var:</span> <p>object</p></li> |
186 |
|
</ul> |
187 |
|
|
188 |
|
|
189 |
|
|
190 |
|
|
191 |
|
|
192 |
|
</div> |
193 |
|
<h4>Inherited Variables</h4> |
194 |
|
<A NAME='inherited_vars'><!-- --></A> |
195 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
196 |
|
<blockquote> |
197 |
|
<span class="var-title"> |
198 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
199 |
|
</span> |
200 |
|
<span class="var-title"> |
201 |
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
202 |
|
</span> |
203 |
|
</blockquote> |
204 |
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
205 |
|
<blockquote> |
206 |
|
<span class="var-title"> |
207 |
|
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
208 |
|
</span> |
209 |
|
</blockquote> |
210 |
|
|
211 |
|
</div> |
212 |
|
</div> |
213 |
|
|
214 |
|
<a name="sec-methods"></a> |
215 |
|
<div class="info-box"> |
216 |
|
<div class="info-box-title">Methods</div> |
217 |
|
<div class="nav-bar"> |
218 |
|
<a href="#sec-description">Description</a> | |
219 |
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
220 |
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
221 |
|
|
222 |
|
</div> |
223 |
|
<div class="info-box-body"> |
224 |
|
<A NAME='method_detail'></A> |
225 |
|
<a name="methodVerticalCSSNavTable" id="VerticalCSSNavTable"><!-- --></a> |
226 |
|
<div class="oddrow"> |
227 |
|
|
228 |
|
<div class="method-header"> |
229 |
|
<span class="method-title">Constructor VerticalCSSNavTable</span> (line <span class="line-number">61</span>) |
230 |
|
</div> |
231 |
|
|
232 |
|
<!-- ========== Info from phpDoc block ========= --> |
233 |
|
<p class="short-description">Constructor for this class It just sets the width for the widget.</p> |
234 |
|
|
235 |
|
<div class="method-signature"> |
236 |
|
<span class="method-result">void</span> |
237 |
|
<span class="method-name"> |
238 |
|
VerticalCSSNavTable |
239 |
|
</span> |
240 |
|
(<span class="var-type">mixed</span> <span class="var-name">$title</span>, [<span class="var-type">mixed</span> <span class="var-name">$subtitle</span> = <span class="var-default">""</span>], [<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>]) |
241 |
|
</div> |
242 |
|
|
243 |
|
<ul class="parameters"> |
244 |
|
<li> |
245 |
|
<span class="var-type">int</span> |
246 |
|
<span class="var-name">$width</span><span class="var-description">: <p>- the width of the widget</p></span> </li> |
247 |
|
</ul> |
248 |
|
|
249 |
|
|
250 |
|
</div> |
251 |
|
<a name="methodadd" id="add"><!-- --></a> |
252 |
|
<div class="evenrow"> |
253 |
|
|
254 |
|
<div class="method-header"> |
255 |
|
<span class="method-title">add</span> (line <span class="line-number">122</span>) |
256 |
|
</div> |
257 |
|
|
258 |
|
<!-- ========== Info from phpDoc block ========= --> |
259 |
|
<p class="short-description">this function adds a clickable link.</p> |
260 |
|
<p class="description"><p>It automatically adds the link based on $url, with $text as the viewable text.</p></p> |
261 |
|
|
262 |
|
<div class="method-signature"> |
263 |
|
<span class="method-result">void</span> |
264 |
|
<span class="method-name"> |
265 |
|
add |
266 |
|
</span> |
267 |
|
(<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">""</span>], [<span class="var-type">string</span> <span class="var-name">$target</span> = <span class="var-default">""</span>]) |
268 |
|
</div> |
269 |
|
|
270 |
|
<ul class="parameters"> |
271 |
|
<li> |
272 |
|
<span class="var-type">string</span> |
273 |
|
<span class="var-name">$url</span><span class="var-description">: <p>- the url for the link</p></span> </li> |
274 |
|
<li> |
275 |
|
<span class="var-type">string</span> |
276 |
|
<span class="var-name">$text</span><span class="var-description">: <p>- the link text</p></span> </li> |
277 |
|
<li> |
278 |
|
<span class="var-type">string</span> |
279 |
|
<span class="var-name">$title</span><span class="var-description">: <p>- the title text</p></span> </li> |
280 |
|
<li> |
281 |
|
<span class="var-type">string</span> |
282 |
|
<span class="var-name">$target</span><span class="var-description">: <p>- the link target</p></span> </li> |
283 |
|
</ul> |
284 |
|
|
285 |
|
<hr class="separator" /> |
286 |
|
<div class="notes">Redefinition of:</div> |
287 |
|
<dl> |
288 |
|
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt> |
289 |
|
<dd>add content onto content stack</dd> |
290 |
|
</dl> |
291 |
|
|
292 |
|
</div> |
293 |
|
<a name="methodadd_text" id="add_text"><!-- --></a> |
294 |
|
<div class="oddrow"> |
295 |
|
|
296 |
|
<div class="method-header"> |
297 |
|
<span class="method-title">add_text</span> (line <span class="line-number">133</span>) |
298 |
|
</div> |
299 |
|
|
300 |
|
<!-- ========== Info from phpDoc block ========= --> |
301 |
|
<p class="short-description">this adds a text item in the nav</p> |
302 |
|
|
303 |
|
<div class="method-signature"> |
304 |
|
<span class="method-result">void</span> |
305 |
|
<span class="method-name"> |
306 |
|
add_text |
307 |
|
</span> |
308 |
|
(<span class="var-type">string</span> <span class="var-name">$text</span>) |
309 |
|
</div> |
310 |
|
|
311 |
|
<ul class="parameters"> |
312 |
|
<li> |
313 |
|
<span class="var-type">string</span> |
314 |
|
<span class="var-name">$text</span><span class="var-description">: <p>- the text to display</p></span> </li> |
315 |
|
</ul> |
316 |
|
|
317 |
|
|
318 |
|
</div> |
319 |
|
<a name="methodget_subtitle" id="get_subtitle"><!-- --></a> |
320 |
|
<div class="evenrow"> |
321 |
|
|
322 |
|
<div class="method-header"> |
323 |
|
<span class="method-title">get_subtitle</span> (line <span class="line-number">105</span>) |
324 |
|
</div> |
325 |
|
|
326 |
|
<!-- ========== Info from phpDoc block ========= --> |
327 |
|
<p class="short-description">This function returns the current subtitle.</p> |
328 |
|
<ul class="tags"> |
329 |
|
<li><span class="field">return:</span> <p>- the subtitle</p></li> |
330 |
|
</ul> |
331 |
|
|
332 |
|
<div class="method-signature"> |
333 |
|
<span class="method-result">string</span> |
334 |
|
<span class="method-name"> |
335 |
|
get_subtitle |
336 |
|
</span> |
337 |
|
() |
338 |
|
</div> |
339 |
|
|
340 |
|
|
341 |
|
|
342 |
|
</div> |
343 |
|
<a name="methodrender" id="render"><!-- --></a> |
344 |
|
<div class="oddrow"> |
345 |
|
|
346 |
|
<div class="method-header"> |
347 |
|
<span class="method-title">render</span> (line <span class="line-number">77</span>) |
348 |
|
</div> |
349 |
|
|
350 |
|
<!-- ========== Info from phpDoc block ========= --> |
351 |
|
<p class="short-description">function that will render the widget.</p> |
352 |
|
<ul class="tags"> |
353 |
|
<li><span class="field">return:</span> <p>the raw html output.</p></li> |
354 |
|
</ul> |
355 |
|
|
356 |
|
<div class="method-signature"> |
357 |
|
<span class="method-result">string</span> |
358 |
|
<span class="method-name"> |
359 |
|
render |
360 |
|
</span> |
361 |
|
([<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>) |
362 |
|
</div> |
363 |
|
|
364 |
|
<ul class="parameters"> |
365 |
|
<li> |
366 |
|
<span class="var-type">int</span> |
367 |
|
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for the container.</p></span> </li> |
368 |
|
<li> |
369 |
|
<span class="var-type">int</span> |
370 |
|
<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> |
371 |
|
</ul> |
372 |
|
|
373 |
|
<hr class="separator" /> |
374 |
|
<div class="notes">Redefinition of:</div> |
375 |
|
<dl> |
376 |
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
377 |
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
378 |
|
</dl> |
379 |
|
|
380 |
|
</div> |
381 |
|
<a name="methodset_subtitle" id="set_subtitle"><!-- --></a> |
382 |
|
<div class="evenrow"> |
383 |
|
|
384 |
|
<div class="method-header"> |
385 |
|
<span class="method-title">set_subtitle</span> (line <span class="line-number">95</span>) |
386 |
|
</div> |
387 |
|
|
388 |
|
<!-- ========== Info from phpDoc block ========= --> |
389 |
|
<p class="short-description">This sets the subtitle</p> |
390 |
|
|
391 |
|
<div class="method-signature"> |
392 |
|
<span class="method-result">void</span> |
393 |
|
<span class="method-name"> |
394 |
|
set_subtitle |
395 |
|
</span> |
396 |
|
(<span class="var-type">string</span> <span class="var-name">$subtitle</span>) |
397 |
|
</div> |
398 |
|
|
399 |
|
<ul class="parameters"> |
400 |
|
<li> |
401 |
|
<span class="var-type">string</span> |
402 |
|
<span class="var-name">$subtitle</span><span class="var-description">: <p>- the subtitle</p></span> </li> |
403 |
|
</ul> |
404 |
|
|
405 |
|
|
406 |
|
</div> |
407 |
|
<a name="method_build_links" id="_build_links"><!-- --></a> |
408 |
|
<div class="oddrow"> |
409 |
|
|
410 |
|
<div class="method-header"> |
411 |
|
<span class="method-title">_build_links</span> (line <span class="line-number">171</span>) |
412 |
|
</div> |
413 |
|
|
414 |
|
<!-- ========== Info from phpDoc block ========= --> |
415 |
|
<p class="short-description">This function is used to build the links to click on</p> |
416 |
|
|
417 |
|
<div class="method-signature"> |
418 |
|
<span class="method-result">Container</span> |
419 |
|
<span class="method-name"> |
420 |
|
_build_links |
421 |
|
</span> |
422 |
|
() |
423 |
|
</div> |
424 |
|
|
425 |
|
|
426 |
|
|
427 |
|
</div> |
428 |
|
<a name="method_build_subtitle" id="_build_subtitle"><!-- --></a> |
429 |
|
<div class="evenrow"> |
430 |
|
|
431 |
|
<div class="method-header"> |
432 |
|
<span class="method-title">_build_subtitle</span> (line <span class="line-number">151</span>) |
433 |
|
</div> |
434 |
|
|
435 |
|
<!-- ========== Info from phpDoc block ========= --> |
436 |
|
<p class="short-description">This function builds the subtitle if needed.</p> |
437 |
|
|
438 |
|
<div class="method-signature"> |
439 |
|
<span class="method-result">void</span> |
440 |
|
<span class="method-name"> |
441 |
|
_build_subtitle |
442 |
|
</span> |
443 |
|
() |
444 |
|
</div> |
445 |
|
|
446 |
|
|
447 |
|
|
448 |
|
</div> |
449 |
|
<a name="method_build_title" id="_build_title"><!-- --></a> |
450 |
|
<div class="oddrow"> |
451 |
|
|
452 |
|
<div class="method-header"> |
453 |
|
<span class="method-title">_build_title</span> (line <span class="line-number">142</span>) |
454 |
|
</div> |
455 |
|
|
456 |
|
<!-- ========== Info from phpDoc block ========= --> |
457 |
|
<p class="short-description">This function builds the title tr</p> |
458 |
|
|
459 |
|
<div class="method-signature"> |
460 |
|
<span class="method-result">void</span> |
461 |
|
<span class="method-name"> |
462 |
|
_build_title |
463 |
|
</span> |
464 |
|
() |
465 |
|
</div> |
466 |
|
|
467 |
|
|
468 |
|
|
469 |
|
</div> |
470 |
|
<h4>Inherited Methods</h4> |
471 |
|
<a name='inherited_methods'><!-- --></a> |
472 |
|
<!-- =========== Summary =========== --> |
473 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
474 |
|
<blockquote> |
475 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
476 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
477 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
478 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
479 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
480 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
481 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
482 |
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
483 |
|
</blockquote> |
484 |
|
<!-- =========== Summary =========== --> |
485 |
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
486 |
|
<blockquote> |
487 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
488 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
489 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
490 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
491 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
492 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
493 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
494 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
495 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
496 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
497 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
498 |
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
499 |
|
</blockquote> |
500 |
|
|
501 |
|
</div> |
502 |
|
</div> |
503 |
|
|
504 |
|
<p class="notes" id="credit"> |
505 |
|
Documention generated on Thu, 31 Jul 2003 18:33:52 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
506 |
|
</p> |
507 |
|
</div></body> |
508 |
|
</html> |