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