/[cvs]/nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/TabList.html
ViewVC logotype

Contents of /nfo/php/libs/com.newsblob.phphtmllib/doc/phpHtmlLib/TabList.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (show annotations)
Thu May 6 16:57:00 2004 UTC (21 years, 6 months ago) by jonen
Branch: MAIN
CVS Tags: HEAD
File MIME type: text/html 
 updated all to v2.4.1 - Apr 01, 2004
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 TabList</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 TabList</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 implements a set of multiple tabs holding data objects</p>
27 <ul class="tags">
28 <li><span class="field">author:</span> Suren Markossian</li>
29 <li><span class="field">author:</span> Walter A. Boring IV</li>
30 </ul>
31 <p class="notes">
32 Located in <a class="field" href="_widgets_TabWidget_inc.html">/widgets/TabWidget.inc</a> (line <span class="field">111</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 --TabList</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">mixed</span>
61 <a href="#$_save_vars" title="details" class="var-name">$_save_vars</a>
62 </div>
63 <div class="var-title">
64 <span class="var-type">mixed</span>
65 <a href="#$_subtab_flag" title="details" class="var-name">$_subtab_flag</a>
66 </div>
67 <div class="var-title">
68 <span class="var-type">mixed</span>
69 <a href="#$_tabs" title="details" class="var-name">$_tabs</a>
70 </div>
71 <div class="var-title">
72 <span class="var-type">mixed</span>
73 <a href="#$_tab_elected" title="details" class="var-name">$_tab_elected</a>
74 </div>
75 <div class="var-title">
76 <span class="var-type">mixed</span>
77 <a href="#$_tab_num" title="details" class="var-name">$_tab_num</a>
78 </div>
79 <div class="var-title">
80 <span class="var-type">mixed</span>
81 <a href="#$_tab_row" title="details" class="var-name">$_tab_row</a>
82 </div>
83 <div class="var-title">
84 <span class="var-type">mixed</span>
85 <a href="#$_ui_wrapper" title="details" class="var-name">$_ui_wrapper</a>
86 </div>
87 <div class="var-title">
88 <span class="var-type">mixed</span>
89 <a href="#$_valid_tab" title="details" class="var-name">$_valid_tab</a>
90 </div>
91 </div>
92 </div>
93 </div>
94
95 <a name="sec-method-summary"></a>
96 <div class="info-box">
97 <div class="info-box-title">Method Summary</span></div>
98 <div class="nav-bar">
99 <a href="#sec-description">Description</a> |
100 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
101
102 |
103 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
104 </div>
105 <div class="info-box-body">
106 <div class="method-summary">
107
108 <div class="method-definition">
109 <span class="method-result">TabList</span>
110 <a href="#TabList" title="details" class="method-name">TabList</a>
111 (<span class="var-type">the</span>&nbsp;<span class="var-name">$title</span>)
112 </div>
113
114 <div class="method-definition">
115 <span class="method-result">void</span>
116 <a href="#add" title="details" class="method-name">add</a>
117 (<span class="var-type">title</span>&nbsp;<span class="var-name">&$tab_obj</span>, <span class="var-type">data</span>&nbsp;<span class="var-name">1</span>)
118 </div>
119
120 <div class="method-definition">
121 <span class="method-result">void</span>
122 <a href="#get_title" title="details" class="method-name">get_title</a>
123 ()
124 </div>
125
126 <div class="method-definition">
127 <span class="method-result">string</span>
128 <a href="#name" title="details" class="method-name">name</a>
129 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
130 </div>
131
132 <div class="method-definition">
133 <span class="method-result">string</span>
134 <a href="#queryvar" title="details" class="method-name">queryvar</a>
135 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
136 </div>
137
138 <div class="method-definition">
139 <span class="method-result">string</span>
140 <a href="#render" title="details" class="method-name">render</a>
141 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
142 </div>
143
144 <div class="method-definition">
145 <span class="method-result">void</span>
146 <a href="#set_save_vars" title="details" class="method-name">set_save_vars</a>
147 (<span class="var-type">array</span>&nbsp;<span class="var-name">$vars</span>)
148 </div>
149
150 <div class="method-definition">
151 <span class="method-result">void</span>
152 <a href="#_add_tab_spacer" title="details" class="method-name">_add_tab_spacer</a>
153 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$last_spacer</span> = <span class="var-default">false</span>])
154 </div>
155
156 <div class="method-definition">
157 <span class="method-result">string</span>
158 <a href="#_build_save_vars" title="details" class="method-name">_build_save_vars</a>
159 ()
160 </div>
161
162 <div class="method-definition">
163 <span class="method-result">void</span>
164 <a href="#_build_subtab" title="details" class="method-name">_build_subtab</a>
165 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tab_name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$subtab_name</span>)
166 </div>
167
168 <div class="method-definition">
169 <span class="method-result">none</span>
170 <a href="#_build_subtab_ui" title="details" class="method-name">_build_subtab_ui</a>
171 ()
172 </div>
173
174 <div class="method-definition">
175 <span class="method-result">void</span>
176 <a href="#_build_tab" title="details" class="method-name">_build_tab</a>
177 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$tab_name</span>)
178 </div>
179
180 <div class="method-definition">
181 <span class="method-result">none</span>
182 <a href="#_build_top_tab_ui" title="details" class="method-name">_build_top_tab_ui</a>
183 ()
184 </div>
185
186 <div class="method-definition">
187 <span class="method-result">string</span>
188 <a href="#_build_url" title="details" class="method-name">_build_url</a>
189 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tab_name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$subtab_name</span> = <span class="var-default">null</span>])
190 </div>
191
192 <div class="method-definition">
193 <span class="method-result">Container</span>
194 <a href="#_invalid_tab" title="details" class="method-name">_invalid_tab</a>
195 ()
196 </div>
197
198 <div class="method-definition">
199 <span class="method-result">void</span>
200 <a href="#_set_subtab_flag" title="details" class="method-name">_set_subtab_flag</a>
201 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
202 </div>
203 </div>
204 </div>
205 </div>
206
207 <a name="sec-vars"></a>
208 <div class="info-box">
209 <div class="info-box-title">Variables</div>
210 <div class="nav-bar">
211 <a href="#sec-description">Description</a> |
212 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
213
214
215 |
216 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
217
218 </div>
219 <div class="info-box-body">
220 <a name="var$_save_vars" id="$_save_vars"><!-- --></A>
221 <div class="oddrow">
222
223 <div class="var-header">
224 <span class="var-title">
225 <span class="var-type">mixed</span>
226 <span class="var-name">$_save_vars</span>
227 = <span class="var-default">array()</span> (line <span class="line-number">141</span>)
228 </span>
229 </div>
230
231 <!-- ========== Info from phpDoc block ========= -->
232 <p class="short-description">This holds a list of name=&gt;value vars that the caller/child wants to propogate automatically.</p>
233
234
235
236
237
238 </div>
239 <a name="var$_subtab_flag" id="$_subtab_flag"><!-- --></A>
240 <div class="evenrow">
241
242 <div class="var-header">
243 <span class="var-title">
244 <span class="var-type">mixed</span>
245 <span class="var-name">$_subtab_flag</span>
246 = <span class="var-default"> false</span> (line <span class="line-number">147</span>)
247 </span>
248 </div>
249
250 <!-- ========== Info from phpDoc block ========= -->
251 <p class="short-description">Flag to let us know we are a subtab</p>
252 <p class="description"><p>list or not</p></p>
253
254
255
256
257
258 </div>
259 <a name="var$_tabs" id="$_tabs"><!-- --></A>
260 <div class="oddrow">
261
262 <div class="var-header">
263 <span class="var-title">
264 <span class="var-type">mixed</span>
265 <span class="var-name">$_tabs</span>
266 = <span class="var-default">array()</span> (line <span class="line-number">127</span>)
267 </span>
268 </div>
269
270 <!-- ========== Info from phpDoc block ========= -->
271 <p class="short-description">array of tabs that have been added</p>
272
273
274
275
276
277 </div>
278 <a name="var$_tab_elected" id="$_tab_elected"><!-- --></A>
279 <div class="evenrow">
280
281 <div class="var-header">
282 <span class="var-title">
283 <span class="var-type">mixed</span>
284 <span class="var-name">$_tab_elected</span>
285 = <span class="var-default">null</span> (line <span class="line-number">122</span>)
286 </span>
287 </div>
288
289 <!-- ========== Info from phpDoc block ========= -->
290 <p class="short-description">The selected tab</p>
291 <p class="description"><p>from the list</p></p>
292
293
294
295
296
297 </div>
298 <a name="var$_tab_num" id="$_tab_num"><!-- --></A>
299 <div class="oddrow">
300
301 <div class="var-header">
302 <span class="var-title">
303 <span class="var-type">mixed</span>
304 <span class="var-name">$_tab_num</span>
305 (line <span class="line-number">116</span>)
306 </span>
307 </div>
308
309 <!-- ========== Info from phpDoc block ========= -->
310 <p class="short-description">The number of tabs</p>
311
312
313
314
315
316 </div>
317 <a name="var$_tab_row" id="$_tab_row"><!-- --></A>
318 <div class="evenrow">
319
320 <div class="var-header">
321 <span class="var-title">
322 <span class="var-type">mixed</span>
323 <span class="var-name">$_tab_row</span>
324 = <span class="var-default"> null</span> (line <span class="line-number">132</span>)
325 </span>
326 </div>
327
328 <!-- ========== Info from phpDoc block ========= -->
329 <p class="short-description">the TR object for the tabs</p>
330
331
332
333
334
335 </div>
336 <a name="var$_ui_wrapper" id="$_ui_wrapper"><!-- --></A>
337 <div class="oddrow">
338
339 <div class="var-header">
340 <span class="var-title">
341 <span class="var-type">mixed</span>
342 <span class="var-name">$_ui_wrapper</span>
343 = <span class="var-default"> null</span> (line <span class="line-number">155</span>)
344 </span>
345 </div>
346
347 <!-- ========== Info from phpDoc block ========= -->
348 <p class="short-description">The outer wrapper for the ui.</p>
349 <p class="description"><p>So we can build top level and sublevels</p></p>
350
351
352
353
354
355 </div>
356 <a name="var$_valid_tab" id="$_valid_tab"><!-- --></A>
357 <div class="evenrow">
358
359 <div class="var-header">
360 <span class="var-title">
361 <span class="var-type">mixed</span>
362 <span class="var-name">$_valid_tab</span>
363 = <span class="var-default"> false</span> (line <span class="line-number">160</span>)
364 </span>
365 </div>
366
367 <!-- ========== Info from phpDoc block ========= -->
368 <p class="short-description">valid selected tab?</p>
369
370
371
372
373
374 </div>
375
376 <h4>Inherited Variables</h4>
377 <A NAME='inherited_vars'><!-- --></A>
378 <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
379 <blockquote>
380 <span class="var-title">
381 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
382 </span>
383 <span class="var-title">
384 <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
385 </span>
386 </blockquote>
387
388 </div>
389 </div>
390
391 <a name="sec-methods"></a>
392 <div class="info-box">
393 <div class="info-box-title">Methods</div>
394 <div class="nav-bar">
395 <a href="#sec-description">Description</a> |
396 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
397 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
398
399 </div>
400 <div class="info-box-body">
401 <A NAME='method_detail'></A>
402 <a name="methodTabList" id="TabList"><!-- --></a>
403 <div class="oddrow">
404
405 <div class="method-header">
406 <span class="method-title">Constructor TabList</span> (line <span class="line-number">168</span>)
407 </div>
408
409 <!-- ========== Info from phpDoc block ========= -->
410 <p class="short-description">The constructor.</p>
411
412 <div class="method-signature">
413 <span class="method-result">TabList</span>
414 <span class="method-name">
415 TabList
416 </span>
417 (<span class="var-type">the</span>&nbsp;<span class="var-name">$title</span>)
418 </div>
419
420 <ul class="parameters">
421 <li>
422 <span class="var-type">the</span>
423 <span class="var-name">$title</span><span class="var-description">: title of the tablist.</span> </li>
424 </ul>
425
426
427 </div>
428 <a name="methodadd" id="add"><!-- --></a>
429 <div class="evenrow">
430
431 <div class="method-header">
432 <span class="method-title">add</span> (line <span class="line-number">197</span>)
433 </div>
434
435 <!-- ========== Info from phpDoc block ========= -->
436 <p class="short-description">This public method adds a new tab to the table</p>
437
438 <div class="method-signature">
439 <span class="method-result">void</span>
440 <span class="method-name">
441 add
442 </span>
443 (<span class="var-type">title</span>&nbsp;<span class="var-name">&$tab_obj</span>, <span class="var-type">data</span>&nbsp;<span class="var-name">1</span>)
444 </div>
445
446 <ul class="parameters">
447 <li>
448 <span class="var-type">data</span>
449 <span class="var-name">1</span><span class="var-description">: object - data container for this tab</span> </li>
450 <li>
451 <span class="var-type">title</span>
452 <span class="var-name">&$tab_obj</span><span class="var-description">: string - tab title</span> </li>
453 </ul>
454
455 <hr class="separator" />
456 <div class="notes">Redefinition of:</div>
457 <dl>
458 <dt><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></dt>
459 <dd>add content onto content stack</dd>
460 </dl>
461
462 </div>
463 <a name="methodget_title" id="get_title"><!-- --></a>
464 <div class="oddrow">
465
466 <div class="method-header">
467 <span class="method-title">get_title</span> (line <span class="line-number">218</span>)
468 </div>
469
470 <!-- ========== Info from phpDoc block ========= -->
471 <p class="short-description">Return the title</p>
472
473 <div class="method-signature">
474 <span class="method-result">void</span>
475 <span class="method-name">
476 get_title
477 </span>
478 ()
479 </div>
480
481
482 <hr class="separator" />
483 <div class="notes">Redefinition of:</div>
484 <dl>
485 <dt><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></dt>
486 <dd>Function for accessing the title of this widget</dd>
487 </dl>
488
489 </div>
490 <a name="methodname" id="name"><!-- --></a>
491 <div class="evenrow">
492
493 <div class="method-header">
494 <span class="method-title">name</span> (line <span class="line-number">285</span>)
495 </div>
496
497 <!-- ========== Info from phpDoc block ========= -->
498 <p class="short-description">This method creates the name of the tab</p>
499 <ul class="tags">
500 <li><span class="field">return:</span> - the tab name</li>
501 </ul>
502
503 <div class="method-signature">
504 <span class="method-result">string</span>
505 <span class="method-name">
506 name
507 </span>
508 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
509 </div>
510
511 <ul class="parameters">
512 <li>
513 <span class="var-type">string</span>
514 <span class="var-name">$title</span><span class="var-description">: - the tab display string</span> </li>
515 </ul>
516
517
518 </div>
519 <a name="methodqueryvar" id="queryvar"><!-- --></a>
520 <div class="oddrow">
521
522 <div class="method-header">
523 <span class="method-title">queryvar</span> (line <span class="line-number">298</span>)
524 </div>
525
526 <!-- ========== Info from phpDoc block ========= -->
527 <p class="short-description">This method builds the query string 'tab_selected=&lt;name&gt;' for you to place in a url</p>
528 <ul class="tags">
529 <li><span class="field">return:</span> - the query var assigned to tab name</li>
530 </ul>
531
532 <div class="method-signature">
533 <span class="method-result">string</span>
534 <span class="method-name">
535 queryvar
536 </span>
537 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>)
538 </div>
539
540 <ul class="parameters">
541 <li>
542 <span class="var-type">string</span>
543 <span class="var-name">$title</span><span class="var-description">: - the tab title</span> </li>
544 </ul>
545
546
547 </div>
548 <a name="methodrender" id="render"><!-- --></a>
549 <div class="evenrow">
550
551 <div class="method-header">
552 <span class="method-title">render</span> (line <span class="line-number">179</span>)
553 </div>
554
555 <!-- ========== Info from phpDoc block ========= -->
556 <p class="short-description">The render method</p>
557 <ul class="tags">
558 <li><span class="field">return:</span> the output html</li>
559 </ul>
560
561 <div class="method-signature">
562 <span class="method-result">string</span>
563 <span class="method-name">
564 render
565 </span>
566 (<span class="var-type">int</span>&nbsp;<span class="var-name">$indent_level</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$output_debug</span>)
567 </div>
568
569 <ul class="parameters">
570 <li>
571 <span class="var-type">int</span>
572 <span class="var-name">$indent_level</span><span class="var-description">: the html indentation level</span> </li>
573 <li>
574 <span class="var-type">int</span>
575 <span class="var-name">$output_debug</span><span class="var-description">: the html debug level</span> </li>
576 </ul>
577
578 <hr class="separator" />
579 <div class="notes">Redefinition of:</div>
580 <dl>
581 <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
582 <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
583 </dl>
584
585 </div>
586 <a name="methodset_save_vars" id="set_save_vars"><!-- --></a>
587 <div class="oddrow">
588
589 <div class="method-header">
590 <span class="method-title">set_save_vars</span> (line <span class="line-number">230</span>)
591 </div>
592
593 <!-- ========== Info from phpDoc block ========= -->
594 <p class="short-description">This function sets the save variables that the user/child wants to automatically propogate</p>
595
596 <div class="method-signature">
597 <span class="method-result">void</span>
598 <span class="method-name">
599 set_save_vars
600 </span>
601 (<span class="var-type">array</span>&nbsp;<span class="var-name">$vars</span>)
602 </div>
603
604 <ul class="parameters">
605 <li>
606 <span class="var-type">array</span>
607 <span class="var-name">$vars</span><span class="var-description">: - name=&gt;value pairs of the data that they want to propogate</span> </li>
608 </ul>
609
610
611 </div>
612 <a name="method_add_tab_spacer" id="_add_tab_spacer"><!-- --></a>
613 <div class="evenrow">
614
615 <div class="method-header">
616 <span class="method-title">_add_tab_spacer</span> (line <span class="line-number">487</span>)
617 </div>
618
619 <!-- ========== Info from phpDoc block ========= -->
620 <p class="short-description">This method adds a new spacer in between the tabs.</p>
621
622 <div class="method-signature">
623 <span class="method-result">void</span>
624 <span class="method-name">
625 _add_tab_spacer
626 </span>
627 ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$last_spacer</span> = <span class="var-default">false</span>])
628 </div>
629
630 <ul class="parameters">
631 <li>
632 <span class="var-type">boolean</span>
633 <span class="var-name">$last_spacer</span><span class="var-description">: - is this the last spacer?</span> </li>
634 </ul>
635
636
637 </div>
638 <a name="method_build_save_vars" id="_build_save_vars"><!-- --></a>
639 <div class="oddrow">
640
641 <div class="method-header">
642 <span class="method-title">_build_save_vars</span> (line <span class="line-number">241</span>)
643 </div>
644
645 <!-- ========== Info from phpDoc block ========= -->
646 <p class="short-description">this function builds a partial query string with the $this-&gt;_save_vars</p>
647
648 <div class="method-signature">
649 <span class="method-result">string</span>
650 <span class="method-name">
651 _build_save_vars
652 </span>
653 ()
654 </div>
655
656
657
658 </div>
659 <a name="method_build_subtab" id="_build_subtab"><!-- --></a>
660 <div class="evenrow">
661
662 <div class="method-header">
663 <span class="method-title">_build_subtab</span> (line <span class="line-number">455</span>)
664 </div>
665
666 <!-- ========== Info from phpDoc block ========= -->
667 <p class="short-description">This method builds a single subtab</p>
668
669 <div class="method-signature">
670 <span class="method-result">void</span>
671 <span class="method-name">
672 _build_subtab
673 </span>
674 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$tab_name</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$subtab_name</span>)
675 </div>
676
677 <ul class="parameters">
678 <li>
679 <span class="var-type">string</span>
680 <span class="var-name">$title</span><span class="var-description">: the title</span> </li>
681 <li>
682 <span class="var-type">string</span>
683 <span class="var-name">$tab_name</span><span class="var-description">: the tab name</span> </li>
684 </ul>
685
686
687 </div>
688 <a name="method_build_subtab_ui" id="_build_subtab_ui"><!-- --></a>
689 <div class="oddrow">
690
691 <div class="method-header">
692 <span class="method-title">_build_subtab_ui</span> (line <span class="line-number">363</span>)
693 </div>
694
695 <!-- ========== Info from phpDoc block ========= -->
696 <p class="short-description">This method builds the outer wrapper UI for the subtab</p>
697
698 <div class="method-signature">
699 <span class="method-result">none</span>
700 <span class="method-name">
701 _build_subtab_ui
702 </span>
703 ()
704 </div>
705
706
707
708 </div>
709 <a name="method_build_tab" id="_build_tab"><!-- --></a>
710 <div class="evenrow">
711
712 <div class="method-header">
713 <span class="method-title">_build_tab</span> (line <span class="line-number">416</span>)
714 </div>
715
716 <!-- ========== Info from phpDoc block ========= -->
717 <p class="short-description">This method is used to build a top level tab</p>
718
719 <div class="method-signature">
720 <span class="method-result">void</span>
721 <span class="method-name">
722 _build_tab
723 </span>
724 (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$tab_name</span>)
725 </div>
726
727 <ul class="parameters">
728 <li>
729 <span class="var-type">string</span>
730 <span class="var-name">$title</span><span class="var-description">: - the tab title</span> </li>
731 </ul>
732
733
734 </div>
735 <a name="method_build_top_tab_ui" id="_build_top_tab_ui"><!-- --></a>
736 <div class="oddrow">
737
738 <div class="method-header">
739 <span class="method-title">_build_top_tab_ui</span> (line <span class="line-number">309</span>)
740 </div>
741
742 <!-- ========== Info from phpDoc block ========= -->
743 <p class="short-description">This method builds the outer wrapper UI for the top level tab list.</p>
744
745 <div class="method-signature">
746 <span class="method-result">none</span>
747 <span class="method-name">
748 _build_top_tab_ui
749 </span>
750 ()
751 </div>
752
753
754
755 </div>
756 <a name="method_build_url" id="_build_url"><!-- --></a>
757 <div class="evenrow">
758
759 <div class="method-header">
760 <span class="method-title">_build_url</span> (line <span class="line-number">260</span>)
761 </div>
762
763 <!-- ========== Info from phpDoc block ========= -->
764 <p class="short-description">this private function builds the url for the main tab script and adss the needed query string params</p>
765 <ul class="tags">
766 <li><span class="field">return:</span> url</li>
767 </ul>
768
769 <div class="method-signature">
770 <span class="method-result">string</span>
771 <span class="method-name">
772 _build_url
773 </span>
774 (<span class="var-type">string</span>&nbsp;<span class="var-name">$tab_name</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$subtab_name</span> = <span class="var-default">null</span>])
775 </div>
776
777 <ul class="parameters">
778 <li>
779 <span class="var-type">string</span>
780 <span class="var-name">$tab_name</span><span class="var-description">: - the tab name</span> </li>
781 <li>
782 <span class="var-type">string</span>
783 <span class="var-name">$subtab_name</span><span class="var-description">: - the subtab name</span> </li>
784 </ul>
785
786
787 </div>
788 <a name="method_invalid_tab" id="_invalid_tab"><!-- --></a>
789 <div class="oddrow">
790
791 <div class="method-header">
792 <span class="method-title">_invalid_tab</span> (line <span class="line-number">516</span>)
793 </div>
794
795 <!-- ========== Info from phpDoc block ========= -->
796 <p class="short-description">This method builds a message for an invalid selected tab/subtab</p>
797
798 <div class="method-signature">
799 <span class="method-result">Container</span>
800 <span class="method-name">
801 _invalid_tab
802 </span>
803 ()
804 </div>
805
806
807
808 </div>
809 <a name="method_set_subtab_flag" id="_set_subtab_flag"><!-- --></a>
810 <div class="evenrow">
811
812 <div class="method-header">
813 <span class="method-title">_set_subtab_flag</span> (line <span class="line-number">275</span>)
814 </div>
815
816 <!-- ========== Info from phpDoc block ========= -->
817 <p class="short-description">This method is used to set the subtab bit</p>
818
819 <div class="method-signature">
820 <span class="method-result">void</span>
821 <span class="method-name">
822 _set_subtab_flag
823 </span>
824 (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$flag</span>)
825 </div>
826
827 <ul class="parameters">
828 <li>
829 <span class="var-type">boolean</span>
830 <span class="var-name">$flag</span> </li>
831 </ul>
832
833
834 </div>
835 <h4>Inherited Methods</h4>
836 <a name='inherited_methods'><!-- --></a>
837 <!-- =========== Summary =========== -->
838 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
839 <blockquote>
840 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
841 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
842 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
843 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
844 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
845 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
846 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
847 <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
848 </blockquote>
849 <!-- =========== Summary =========== -->
850 <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
851 <blockquote>
852 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
853 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
854 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
855 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
856 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
857 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
858 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
859 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
860 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
861 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
862 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
863 <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
864 </blockquote>
865
866 </div>
867 </div>
868
869
870 <p class="notes" id="credit">
871 Documentation generated on Thu, 1 Apr 2004 09:40:08 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
872 </p>
873 </div></body>
874 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed