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