1 |
jonen |
1.4 |
<?xml version="1.0" encoding="iso-8859-1"?>
|
2 |
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
4 |
|
|
<head>
|
5 |
|
|
<!-- template designed by Marco Von Ballmoos -->
|
6 |
|
|
<title>Docs For Class NavTable</title>
|
7 |
|
|
<link rel="stylesheet" href="../media/stylesheet.css" />
|
8 |
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
9 |
|
|
</head>
|
10 |
|
|
<body>
|
11 |
|
|
<div class="page-body">
|
12 |
|
|
<h2 class="class-name">Class NavTable</h2>
|
13 |
|
|
|
14 |
|
|
<a name="sec-description"></a>
|
15 |
|
|
<div class="info-box">
|
16 |
|
|
<div class="info-box-title">Description</div>
|
17 |
|
|
<div class="nav-bar">
|
18 |
|
|
<span class="disabled">Description</span> |
|
19 |
|
|
<a href="#sec-vars">Vars</a>
|
20 |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
21 |
|
|
|
22 |
|
|
</div>
|
23 |
|
|
<div class="info-box-body">
|
24 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
25 |
|
|
<p class="short-description">This builds a navigational table widget that has a title, any # of subtitles and then navigational links.</p>
|
26 |
|
|
<ul class="tags">
|
27 |
|
|
<li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li>
|
28 |
|
|
</ul>
|
29 |
|
|
<p class="notes">
|
30 |
|
|
Located in <a class="field" href="_widgets_NavTable_inc.html">/widgets/NavTable.inc</a> (line <span class="field">25</span>)
|
31 |
|
|
</p>
|
32 |
|
|
|
33 |
|
|
|
34 |
jonen |
1.3 |
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
35 |
jonen |
1.1 |
| |
36 |
|
|
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
37 |
|
|
| |
38 |
jonen |
1.4 |
--NavTable</pre>
|
39 |
|
|
|
40 |
|
|
</div>
|
41 |
|
|
</div>
|
42 |
|
|
|
43 |
|
|
|
44 |
|
|
|
45 |
|
|
|
46 |
|
|
<a name="sec-method-summary"></a>
|
47 |
|
|
<div class="info-box">
|
48 |
|
|
<div class="info-box-title">Method Summary</span></div>
|
49 |
|
|
<div class="nav-bar">
|
50 |
|
|
<a href="#sec-description">Description</a> |
|
51 |
|
|
<a href="#sec-vars">Vars</a>
|
52 |
|
|
|
53 |
|
|
|
|
54 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
55 |
|
|
</div>
|
56 |
|
|
<div class="info-box-body">
|
57 |
|
|
<div class="method-summary">
|
58 |
|
|
|
59 |
|
|
<div class="method-definition">
|
60 |
|
|
<span class="method-result">NavTable</span>
|
61 |
|
|
<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 |
|
|
</div>
|
64 |
|
|
|
65 |
|
|
<div class="method-definition">
|
66 |
|
|
<span class="method-result">void</span>
|
67 |
|
|
<a href="#add" title="details" class="method-name">add</a>
|
68 |
|
|
(<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 |
|
|
</div>
|
70 |
|
|
|
71 |
|
|
<div class="method-definition">
|
72 |
|
|
<span class="method-result">void</span>
|
73 |
|
|
<a href="#add_blank" title="details" class="method-name">add_blank</a>
|
74 |
|
|
([<span class="var-type">int</span> <span class="var-name">$num</span> = <span class="var-default">1</span>])
|
75 |
|
|
</div>
|
76 |
|
|
|
77 |
|
|
<div class="method-definition">
|
78 |
|
|
<span class="method-result">void</span>
|
79 |
|
|
<a href="#add_heading" title="details" class="method-name">add_heading</a>
|
80 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
81 |
|
|
</div>
|
82 |
|
|
|
83 |
|
|
<div class="method-definition">
|
84 |
|
|
<span class="method-result">void</span>
|
85 |
|
|
<a href="#add_text" title="details" class="method-name">add_text</a>
|
86 |
|
|
(<span class="var-type">string</span> <span class="var-name">$text</span>)
|
87 |
|
|
</div>
|
88 |
|
|
|
89 |
|
|
<div class="method-definition">
|
90 |
|
|
<span class="method-result">void</span>
|
91 |
|
|
<a href="#push" title="details" class="method-name">push</a>
|
92 |
|
|
(<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 |
|
|
</div>
|
94 |
|
|
|
95 |
|
|
<div class="method-definition">
|
96 |
|
|
<span class="method-result">void</span>
|
97 |
|
|
<a href="#push_blank" title="details" class="method-name">push_blank</a>
|
98 |
|
|
([<span class="var-type">mixed</span> <span class="var-name">$num</span> = <span class="var-default">1</span>])
|
99 |
|
|
</div>
|
100 |
|
|
|
101 |
|
|
<div class="method-definition">
|
102 |
|
|
<span class="method-result">void</span>
|
103 |
|
|
<a href="#push_heading" title="details" class="method-name">push_heading</a>
|
104 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$title</span>)
|
105 |
|
|
</div>
|
106 |
|
|
|
107 |
|
|
<div class="method-definition">
|
108 |
|
|
<span class="method-result">void</span>
|
109 |
|
|
<a href="#push_text" title="details" class="method-name">push_text</a>
|
110 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$text</span>)
|
111 |
|
|
</div>
|
112 |
|
|
|
113 |
|
|
<div class="method-definition">
|
114 |
|
|
<span class="method-result">string</span>
|
115 |
|
|
<a href="#render" title="details" class="method-name">render</a>
|
116 |
|
|
([<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 |
|
|
</div>
|
118 |
|
|
|
119 |
|
|
<div class="method-definition">
|
120 |
|
|
<span class="method-result">void</span>
|
121 |
|
|
<a href="#set_subtitle" title="details" class="method-name">set_subtitle</a>
|
122 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$subtitle</span>)
|
123 |
|
|
</div>
|
124 |
|
|
|
125 |
|
|
<div class="method-definition">
|
126 |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span>
|
127 |
|
|
<a href="#_build_subtitle" title="details" class="method-name">_build_subtitle</a>
|
128 |
|
|
()
|
129 |
|
|
</div>
|
130 |
|
|
|
131 |
|
|
<div class="method-definition">
|
132 |
|
|
<span class="method-result">void</span>
|
133 |
|
|
<a href="#_render_text" title="details" class="method-name">_render_text</a>
|
134 |
|
|
(<span class="var-type">array()</span> <span class="var-name">$val</span>)
|
135 |
|
|
</div>
|
136 |
|
|
|
137 |
|
|
<div class="method-definition">
|
138 |
|
|
<span class="method-result">void</span>
|
139 |
|
|
<a href="#_render_url" title="details" class="method-name">_render_url</a>
|
140 |
|
|
(<span class="var-type">array()</span> <span class="var-name">$val</span>)
|
141 |
|
|
</div>
|
142 |
|
|
</div>
|
143 |
|
|
</div>
|
144 |
|
|
</div>
|
145 |
|
|
|
146 |
|
|
<a name="sec-vars"></a>
|
147 |
|
|
<div class="info-box">
|
148 |
|
|
<div class="info-box-title">Variables</div>
|
149 |
|
|
<div class="nav-bar">
|
150 |
|
|
<a href="#sec-description">Description</a> |
|
151 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
152 |
|
|
|
153 |
|
|
|
154 |
|
|
|
|
155 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
156 |
|
|
|
157 |
|
|
</div>
|
158 |
|
|
<div class="info-box-body">
|
159 |
|
|
<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 |
|
|
<blockquote>
|
163 |
|
|
<span class="var-title">
|
164 |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
|
165 |
|
|
</span>
|
166 |
|
|
<span class="var-title">
|
167 |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
|
168 |
|
|
</span>
|
169 |
|
|
</blockquote>
|
170 |
|
|
|
171 |
|
|
</div>
|
172 |
|
|
</div>
|
173 |
|
|
|
174 |
|
|
<a name="sec-methods"></a>
|
175 |
|
|
<div class="info-box">
|
176 |
|
|
<div class="info-box-title">Methods</div>
|
177 |
|
|
<div class="nav-bar">
|
178 |
|
|
<a href="#sec-description">Description</a> |
|
179 |
|
|
<a href="#sec-vars">Vars</a>
|
180 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
181 |
|
|
|
182 |
|
|
</div>
|
183 |
|
|
<div class="info-box-body">
|
184 |
|
|
<A NAME='method_detail'></A>
|
185 |
|
|
<a name="methodNavTable" id="NavTable"><!-- --></a>
|
186 |
|
|
<div class="evenrow">
|
187 |
|
|
|
188 |
|
|
<div class="method-header">
|
189 |
|
|
<span class="method-title">Constructor NavTable</span> (line <span class="line-number">60</span>)
|
190 |
|
|
</div>
|
191 |
|
|
|
192 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
193 |
|
|
<p class="short-description">the constructor for this class.</p>
|
194 |
|
|
|
195 |
|
|
<div class="method-signature">
|
196 |
|
|
<span class="method-result">NavTable</span>
|
197 |
|
|
<span class="method-name">
|
198 |
|
|
NavTable
|
199 |
|
|
</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 |
|
|
</div>
|
202 |
|
|
|
203 |
|
|
<ul class="parameters">
|
204 |
|
|
<li>
|
205 |
|
|
<span class="var-type">string</span>
|
206 |
|
|
<span class="var-name">$title</span><span class="var-description">: - the title for the widget.</span> </li>
|
207 |
|
|
<li>
|
208 |
|
|
<span class="var-type">string</span>
|
209 |
|
|
<span class="var-name">$subtitle</span><span class="var-description">: - the subtitle if any.</span> </li>
|
210 |
|
|
<li>
|
211 |
|
|
<span class="var-type">mixed</span>
|
212 |
|
|
<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 |
|
|
|
215 |
|
|
|
216 |
|
|
</div>
|
217 |
|
|
<a name="methodadd" id="add"><!-- --></a>
|
218 |
|
|
<div class="oddrow">
|
219 |
|
|
|
220 |
|
|
<div class="method-header">
|
221 |
|
|
<span class="method-title">add</span> (line <span class="line-number">84</span>)
|
222 |
|
|
</div>
|
223 |
|
|
|
224 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
225 |
|
|
<p class="short-description">this function adds an entry to the navtable.</p>
|
226 |
|
|
<p class="description"><p>It automatically adds the link based on $url, with $text as the viewable text.</p></p>
|
227 |
|
|
|
228 |
|
|
<div class="method-signature">
|
229 |
|
|
<span class="method-result">void</span>
|
230 |
|
|
<span class="method-name">
|
231 |
|
|
add
|
232 |
|
|
</span>
|
233 |
|
|
(<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 |
|
|
</div>
|
235 |
|
|
|
236 |
|
|
<ul class="parameters">
|
237 |
|
|
<li>
|
238 |
|
|
<span class="var-type">string</span>
|
239 |
|
|
<span class="var-name">$url</span><span class="var-description">: - the url for the link</span> </li>
|
240 |
|
|
<li>
|
241 |
|
|
<span class="var-type">string</span>
|
242 |
|
|
<span class="var-name">$text</span><span class="var-description">: - the link text</span> </li>
|
243 |
|
|
<li>
|
244 |
|
|
<span class="var-type">string</span>
|
245 |
|
|
<span class="var-name">$title</span><span class="var-description">: - the link title text</span> </li>
|
246 |
|
|
<li>
|
247 |
|
|
<span class="var-type">string</span>
|
248 |
|
|
<span class="var-name">$target</span><span class="var-description">: - the link target</span> </li>
|
249 |
|
|
</ul>
|
250 |
|
|
|
251 |
|
|
<hr class="separator" />
|
252 |
|
|
<div class="notes">Redefinition of:</div>
|
253 |
|
|
<dl>
|
254 |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
|
255 |
|
|
<dd>add content onto content stack</dd>
|
256 |
|
|
</dl>
|
257 |
|
|
|
258 |
|
|
</div>
|
259 |
|
|
<a name="methodadd_blank" id="add_blank"><!-- --></a>
|
260 |
|
|
<div class="evenrow">
|
261 |
|
|
|
262 |
|
|
<div class="method-header">
|
263 |
|
|
<span class="method-title">add_blank</span> (line <span class="line-number">107</span>)
|
264 |
|
|
</div>
|
265 |
|
|
|
266 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
267 |
|
|
<p class="short-description">This lets you add a blank line between 2 links</p>
|
268 |
|
|
|
269 |
|
|
<div class="method-signature">
|
270 |
|
|
<span class="method-result">void</span>
|
271 |
|
|
<span class="method-name">
|
272 |
|
|
add_blank
|
273 |
|
|
</span>
|
274 |
|
|
([<span class="var-type">int</span> <span class="var-name">$num</span> = <span class="var-default">1</span>])
|
275 |
|
|
</div>
|
276 |
|
|
|
277 |
|
|
<ul class="parameters">
|
278 |
|
|
<li>
|
279 |
|
|
<span class="var-type">int</span>
|
280 |
|
|
<span class="var-name">$num</span><span class="var-description">: - the # of blank lines to insert</span> </li>
|
281 |
|
|
</ul>
|
282 |
|
|
|
283 |
|
|
|
284 |
|
|
</div>
|
285 |
|
|
<a name="methodadd_heading" id="add_heading"><!-- --></a>
|
286 |
|
|
<div class="oddrow">
|
287 |
|
|
|
288 |
|
|
<div class="method-header">
|
289 |
|
|
<span class="method-title">add_heading</span> (line <span class="line-number">145</span>)
|
290 |
|
|
</div>
|
291 |
|
|
|
292 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
293 |
|
|
<p class="short-description">This adds a new heading in the nav.</p>
|
294 |
|
|
<p class="description"><p>It will look just like the sub title area</p></p>
|
295 |
|
|
|
296 |
|
|
<div class="method-signature">
|
297 |
|
|
<span class="method-result">void</span>
|
298 |
|
|
<span class="method-name">
|
299 |
|
|
add_heading
|
300 |
|
|
</span>
|
301 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
302 |
|
|
</div>
|
303 |
|
|
|
304 |
|
|
<ul class="parameters">
|
305 |
|
|
<li>
|
306 |
|
|
<span class="var-type">string</span>
|
307 |
|
|
<span class="var-name">$title</span><span class="var-description">: - the text in the heading</span> </li>
|
308 |
|
|
</ul>
|
309 |
|
|
|
310 |
|
|
|
311 |
|
|
</div>
|
312 |
|
|
<a name="methodadd_text" id="add_text"><!-- --></a>
|
313 |
|
|
<div class="evenrow">
|
314 |
|
|
|
315 |
|
|
<div class="method-header">
|
316 |
|
|
<span class="method-title">add_text</span> (line <span class="line-number">126</span>)
|
317 |
|
|
</div>
|
318 |
|
|
|
319 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
320 |
|
|
<p class="short-description">this adds a text item in the nav</p>
|
321 |
|
|
|
322 |
|
|
<div class="method-signature">
|
323 |
|
|
<span class="method-result">void</span>
|
324 |
|
|
<span class="method-name">
|
325 |
|
|
add_text
|
326 |
|
|
</span>
|
327 |
|
|
(<span class="var-type">string</span> <span class="var-name">$text</span>)
|
328 |
|
|
</div>
|
329 |
|
|
|
330 |
|
|
<ul class="parameters">
|
331 |
|
|
<li>
|
332 |
|
|
<span class="var-type">string</span>
|
333 |
|
|
<span class="var-name">$text</span><span class="var-description">: - the text to display</span> </li>
|
334 |
|
|
</ul>
|
335 |
|
|
|
336 |
|
|
|
337 |
|
|
</div>
|
338 |
|
|
<a name="methodpush" id="push"><!-- --></a>
|
339 |
|
|
<div class="oddrow">
|
340 |
|
|
|
341 |
|
|
<div class="method-header">
|
342 |
|
|
<span class="method-title">push</span> (line <span class="line-number">97</span>)
|
343 |
|
|
</div>
|
344 |
|
|
|
345 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
346 |
|
|
<p class="short-description">depricated version of add()</p>
|
347 |
|
|
<ul class="tags">
|
348 |
|
|
<li><span class="field">deprecated:</span> - use add() instead</li>
|
349 |
|
|
</ul>
|
350 |
|
|
|
351 |
|
|
<div class="method-signature">
|
352 |
|
|
<span class="method-result">void</span>
|
353 |
|
|
<span class="method-name">
|
354 |
|
|
push
|
355 |
|
|
</span>
|
356 |
|
|
(<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 |
|
|
</div>
|
358 |
|
|
|
359 |
|
|
|
360 |
|
|
<hr class="separator" />
|
361 |
|
|
<div class="notes">Redefinition of:</div>
|
362 |
|
|
<dl>
|
363 |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></dt>
|
364 |
|
|
<dd>Same as add().</dd>
|
365 |
|
|
</dl>
|
366 |
|
|
|
367 |
|
|
</div>
|
368 |
|
|
<a name="methodpush_blank" id="push_blank"><!-- --></a>
|
369 |
|
|
<div class="evenrow">
|
370 |
|
|
|
371 |
|
|
<div class="method-header">
|
372 |
|
|
<span class="method-title">push_blank</span> (line <span class="line-number">117</span>)
|
373 |
|
|
</div>
|
374 |
|
|
|
375 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
376 |
|
|
<p class="short-description">depricated version of add_blank()</p>
|
377 |
|
|
<ul class="tags">
|
378 |
|
|
<li><span class="field">deprecated:</span> - use add_blank() instead</li>
|
379 |
|
|
</ul>
|
380 |
|
|
|
381 |
|
|
<div class="method-signature">
|
382 |
|
|
<span class="method-result">void</span>
|
383 |
|
|
<span class="method-name">
|
384 |
|
|
push_blank
|
385 |
|
|
</span>
|
386 |
|
|
([<span class="var-type">mixed</span> <span class="var-name">$num</span> = <span class="var-default">1</span>])
|
387 |
|
|
</div>
|
388 |
|
|
|
389 |
|
|
|
390 |
|
|
|
391 |
|
|
</div>
|
392 |
|
|
<a name="methodpush_heading" id="push_heading"><!-- --></a>
|
393 |
|
|
<div class="oddrow">
|
394 |
|
|
|
395 |
|
|
<div class="method-header">
|
396 |
|
|
<span class="method-title">push_heading</span> (line <span class="line-number">154</span>)
|
397 |
|
|
</div>
|
398 |
|
|
|
399 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
400 |
|
|
<p class="short-description">depricated version of add_heading()</p>
|
401 |
|
|
<ul class="tags">
|
402 |
|
|
<li><span class="field">deprecated:</span> - use add_heading() instead</li>
|
403 |
|
|
</ul>
|
404 |
|
|
|
405 |
|
|
<div class="method-signature">
|
406 |
|
|
<span class="method-result">void</span>
|
407 |
|
|
<span class="method-name">
|
408 |
|
|
push_heading
|
409 |
|
|
</span>
|
410 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$title</span>)
|
411 |
|
|
</div>
|
412 |
|
|
|
413 |
|
|
|
414 |
|
|
|
415 |
|
|
</div>
|
416 |
|
|
<a name="methodpush_text" id="push_text"><!-- --></a>
|
417 |
|
|
<div class="evenrow">
|
418 |
|
|
|
419 |
|
|
<div class="method-header">
|
420 |
|
|
<span class="method-title">push_text</span> (line <span class="line-number">135</span>)
|
421 |
|
|
</div>
|
422 |
|
|
|
423 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
424 |
|
|
<p class="short-description">depricated version of add_text()</p>
|
425 |
|
|
<ul class="tags">
|
426 |
|
|
<li><span class="field">deprecated:</span> - use add_text() instead</li>
|
427 |
|
|
</ul>
|
428 |
|
|
|
429 |
|
|
<div class="method-signature">
|
430 |
|
|
<span class="method-result">void</span>
|
431 |
|
|
<span class="method-name">
|
432 |
|
|
push_text
|
433 |
|
|
</span>
|
434 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$text</span>)
|
435 |
|
|
</div>
|
436 |
|
|
|
437 |
|
|
|
438 |
|
|
|
439 |
|
|
</div>
|
440 |
|
|
<a name="methodrender" id="render"><!-- --></a>
|
441 |
|
|
<div class="oddrow">
|
442 |
|
|
|
443 |
|
|
<div class="method-header">
|
444 |
|
|
<span class="method-title">render</span> (line <span class="line-number">270</span>)
|
445 |
|
|
</div>
|
446 |
|
|
|
447 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
448 |
|
|
<p class="short-description">Render the Navtable and its content.</p>
|
449 |
|
|
<ul class="tags">
|
450 |
|
|
<li><span class="field">return:</span> the raw html output.</li>
|
451 |
|
|
</ul>
|
452 |
|
|
|
453 |
|
|
<div class="method-signature">
|
454 |
|
|
<span class="method-result">string</span>
|
455 |
|
|
<span class="method-name">
|
456 |
|
|
render
|
457 |
|
|
</span>
|
458 |
|
|
([<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 |
|
|
|
461 |
|
|
<ul class="parameters">
|
462 |
|
|
<li>
|
463 |
|
|
<span class="var-type">int</span>
|
464 |
|
|
<span class="var-name">$indent_level</span><span class="var-description">: - the indentation level for the container.</span> </li>
|
465 |
|
|
<li>
|
466 |
|
|
<span class="var-type">int</span>
|
467 |
|
|
<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 |
|
|
|
470 |
|
|
<hr class="separator" />
|
471 |
|
|
<div class="notes">Redefinition of:</div>
|
472 |
|
|
<dl>
|
473 |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
|
474 |
|
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
|
475 |
|
|
</dl>
|
476 |
|
|
|
477 |
|
|
</div>
|
478 |
|
|
<a name="methodset_subtitle" id="set_subtitle"><!-- --></a>
|
479 |
|
|
<div class="evenrow">
|
480 |
|
|
|
481 |
|
|
<div class="method-header">
|
482 |
|
|
<span class="method-title">set_subtitle</span> (line <span class="line-number">68</span>)
|
483 |
|
|
</div>
|
484 |
|
|
|
485 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
486 |
|
|
|
487 |
|
|
<div class="method-signature">
|
488 |
|
|
<span class="method-result">void</span>
|
489 |
|
|
<span class="method-name">
|
490 |
|
|
set_subtitle
|
491 |
|
|
</span>
|
492 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">$subtitle</span>)
|
493 |
|
|
</div>
|
494 |
|
|
|
495 |
|
|
|
496 |
|
|
|
497 |
|
|
</div>
|
498 |
|
|
<a name="method_build_subtitle" id="_build_subtitle"><!-- --></a>
|
499 |
|
|
<div class="oddrow">
|
500 |
|
|
|
501 |
|
|
<div class="method-header">
|
502 |
|
|
<span class="method-title">_build_subtitle</span> (line <span class="line-number">191</span>)
|
503 |
|
|
</div>
|
504 |
|
|
|
505 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
506 |
|
|
<p class="short-description">this function builds the subtitle td to hold the...subtitle!</p>
|
507 |
|
|
<ul class="tags">
|
508 |
|
|
<li><span class="field">return:</span> object</li>
|
509 |
|
|
</ul>
|
510 |
|
|
|
511 |
|
|
<div class="method-signature">
|
512 |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span>
|
513 |
|
|
<span class="method-name">
|
514 |
|
|
_build_subtitle
|
515 |
|
|
</span>
|
516 |
|
|
()
|
517 |
|
|
</div>
|
518 |
|
|
|
519 |
|
|
|
520 |
|
|
|
521 |
|
|
</div>
|
522 |
|
|
<a name="method_render_text" id="_render_text"><!-- --></a>
|
523 |
|
|
<div class="evenrow">
|
524 |
|
|
|
525 |
|
|
<div class="method-header">
|
526 |
|
|
<span class="method-title">_render_text</span> (line <span class="line-number">246</span>)
|
527 |
|
|
</div>
|
528 |
|
|
|
529 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
530 |
|
|
<p class="short-description">render a text row.</p>
|
531 |
|
|
|
532 |
|
|
<div class="method-signature">
|
533 |
|
|
<span class="method-result">void</span>
|
534 |
|
|
<span class="method-name">
|
535 |
|
|
_render_text
|
536 |
|
|
</span>
|
537 |
|
|
(<span class="var-type">array()</span> <span class="var-name">$val</span>)
|
538 |
|
|
</div>
|
539 |
|
|
|
540 |
|
|
<ul class="parameters">
|
541 |
|
|
<li>
|
542 |
|
|
<span class="var-type">array()</span>
|
543 |
|
|
<span class="var-name">$val</span><span class="var-description">: - the item to render.</span> </li>
|
544 |
|
|
</ul>
|
545 |
|
|
|
546 |
|
|
|
547 |
|
|
</div>
|
548 |
|
|
<a name="method_render_url" id="_render_url"><!-- --></a>
|
549 |
|
|
<div class="oddrow">
|
550 |
|
|
|
551 |
|
|
<div class="method-header">
|
552 |
|
|
<span class="method-title">_render_url</span> (line <span class="line-number">219</span>)
|
553 |
|
|
</div>
|
554 |
|
|
|
555 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
556 |
|
|
<p class="short-description">render a url row.</p>
|
557 |
|
|
|
558 |
|
|
<div class="method-signature">
|
559 |
|
|
<span class="method-result">void</span>
|
560 |
|
|
<span class="method-name">
|
561 |
|
|
_render_url
|
562 |
|
|
</span>
|
563 |
|
|
(<span class="var-type">array()</span> <span class="var-name">$val</span>)
|
564 |
|
|
</div>
|
565 |
|
|
|
566 |
|
|
<ul class="parameters">
|
567 |
|
|
<li>
|
568 |
|
|
<span class="var-type">array()</span>
|
569 |
|
|
<span class="var-name">$val</span><span class="var-description">: - the item to render.</span> </li>
|
570 |
|
|
</ul>
|
571 |
|
|
|
572 |
|
|
|
573 |
|
|
</div>
|
574 |
|
|
<h4>Inherited Methods</h4>
|
575 |
|
|
<a name='inherited_methods'><!-- --></a>
|
576 |
|
|
<!-- =========== Summary =========== -->
|
577 |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
|
578 |
|
|
<blockquote>
|
579 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
|
580 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
|
581 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
|
582 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
|
583 |
|
|
<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 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
|
586 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
|
587 |
|
|
</blockquote>
|
588 |
|
|
<!-- =========== Summary =========== -->
|
589 |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
|
590 |
|
|
<blockquote>
|
591 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
|
592 |
|
|
<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 |
|
|
<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 |
|
|
<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 |
|
|
<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 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
|
602 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
|
603 |
|
|
</blockquote>
|
604 |
|
|
|
605 |
|
|
</div>
|
606 |
|
|
</div>
|
607 |
|
|
|
608 |
|
|
|
609 |
|
|
<p class="notes" id="credit">
|
610 |
|
|
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 |
|
|
</p>
|
612 |
|
|
</div></body>
|
613 |
|
|
</html>
|