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