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