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

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

Parent Directory Parent Directory | Revision Log Revision Log

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