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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (hide annotations)
Sat Sep 20 00:23:53 2003 UTC (22 years, 1 month ago) by jonen
Branch: MAIN
Changes since 1.2: +578 -670 lines
File MIME type: text/html 
+ updated whole phphtmllib to v2.3.0
1 jonen 1.3 <?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 ActiveTab</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 ActiveTab</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 is used for creating a tab panel of content where the tabs can be switched on the fly w/ JS, thereby eliminating a page turn to see the other tab's content.</p>
26     <ul class="tags">
27     <li><span class="field">author:</span> <p>Walter A. Boring IV &lt;<a href="mailto:waboring@buildabetterweb.com">mailto:waboring@buildabetterweb.com</a>&gt;</p></li>
28     </ul>
29     <p class="notes">
30     Located in <a class="field" href="_widgets_ActiveTab_inc.html">Program_Root/widgets/ActiveTab.inc</a> (line <span class="field">20</span>)
31     </p>
32    
33    
34     <pre><a href="../phpHtmlLib/Container.html">Container</a>
35 jonen 1.1 |
36     --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a>
37     |
38     --ActiveTab</pre>
39 jonen 1.3
40     </div>
41     </div>
42    
43    
44     <a name="sec-var-summary"></a>
45     <div class="info-box">
46     <div class="info-box-title">Variable Summary</span></div>
47     <div class="nav-bar">
48     <a href="#sec-description">Description</a> |
49     <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
50     |
51     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
52    
53     </div>
54     <div class="info-box-body">
55     <div class="var-summary">
56     <div class="var-title">
57     <span class="var-type">mixed</span>
58     <a href="#$_hidden_background" title="details" class="var-name">$_hidden_background</a>
59     </div>
60     <div class="var-title">
61     <span class="var-type">mixed</span>
62     <a href="#$_selected_background" title="details" class="var-name">$_selected_background</a>
63     </div>
64     <div class="var-title">
65     <span class="var-type">mixed</span>
66     <a href="#$_selected_tab" title="details" class="var-name">$_selected_tab</a>
67     </div>
68     </div>
69     </div>
70     </div>
71    
72     <a name="sec-method-summary"></a>
73     <div class="info-box">
74     <div class="info-box-title">Method Summary</span></div>
75     <div class="nav-bar">
76     <a href="#sec-description">Description</a> |
77     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
78    
79     |
80     <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
81     </div>
82     <div class="info-box-body">
83     <div class="method-summary">
84    
85     <div class="method-definition">
86     <span class="method-result">void</span>
87     <a href="#ActiveTab" title="details" class="method-name">ActiveTab</a>
88     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">"300px"</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$selected_tab</span>)
89     </div>
90    
91     <div class="method-definition">
92     <span class="method-result">void</span>
93     <a href="#add_tab" title="details" class="method-name">add_tab</a>
94     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">FALSE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>])
95     </div>
96    
97     <div class="method-definition">
98     <span class="method-result">void</span>
99     <a href="#build_content" title="details" class="method-name">build_content</a>
100     ()
101     </div>
102    
103     <div class="method-definition">
104     <span class="method-result">void</span>
105     <a href="#build_tabs" title="details" class="method-name">build_tabs</a>
106     ()
107     </div>
108    
109     <div class="method-definition">
110     <span class="method-result">string</span>
111     <a href="#get_javascript" title="details" class="method-name">get_javascript</a>
112     ()
113     </div>
114    
115     <div class="method-definition">
116     <span class="method-result">void</span>
117     <a href="#hidden_background" title="details" class="method-name">hidden_background</a>
118     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$color</span>)
119     </div>
120    
121     <div class="method-definition">
122     <span class="method-result">void</span>
123     <a href="#render" title="details" class="method-name">render</a>
124     ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
125     </div>
126    
127     <div class="method-definition">
128     <span class="method-result">void</span>
129     <a href="#selected_background" title="details" class="method-name">selected_background</a>
130     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$color</span>)
131     </div>
132    
133     <div class="method-definition">
134     <span class="method-result">void</span>
135     <a href="#_build_tab_td" title="details" class="method-name">_build_tab_td</a>
136     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span>)
137     </div>
138    
139     <div class="method-definition">
140     <span class="method-result">void</span>
141     <a href="#_end_td" title="details" class="method-name">_end_td</a>
142     ()
143     </div>
144    
145     <div class="method-definition">
146     <span class="method-result">void</span>
147     <a href="#_spacer_td" title="details" class="method-name">_spacer_td</a>
148     ()
149     </div>
150    
151     <div class="method-definition">
152     <span class="method-result">void</span>
153     <a href="#_tab_name" title="details" class="method-name">_tab_name</a>
154     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>)
155     </div>
156     </div>
157     </div>
158     </div>
159    
160     <a name="sec-vars"></a>
161     <div class="info-box">
162     <div class="info-box-title">Variables</div>
163     <div class="nav-bar">
164     <a href="#sec-description">Description</a> |
165     <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
166    
167    
168     |
169     <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
170    
171     </div>
172     <div class="info-box-body">
173     <a name="var$_hidden_background" id="$_hidden_background"><!-- --></A>
174     <div class="evenrow">
175    
176     <div class="var-header">
177     <span class="var-title">
178     <span class="var-type">mixed</span>
179     <span class="var-name">$_hidden_background</span>
180     = <span class="var-default"> &quot;#e0e0e0&quot;</span> (line <span class="line-number">40</span>)
181     </span>
182     </div>
183    
184     <!-- ========== Info from phpDoc block ========= -->
185     <p class="short-description">The hidden tab's background color</p>
186    
187    
188    
189    
190    
191     </div>
192     <a name="var$_selected_background" id="$_selected_background"><!-- --></A>
193     <div class="oddrow">
194    
195     <div class="var-header">
196     <span class="var-title">
197     <span class="var-type">mixed</span>
198     <span class="var-name">$_selected_background</span>
199     = <span class="var-default"> &quot;#eeeeee&quot;</span> (line <span class="line-number">35</span>)
200     </span>
201     </div>
202    
203     <!-- ========== Info from phpDoc block ========= -->
204     <p class="short-description">The active tab's background color</p>
205    
206    
207    
208    
209    
210     </div>
211     <a name="var$_selected_tab" id="$_selected_tab"><!-- --></A>
212     <div class="evenrow">
213    
214     <div class="var-header">
215     <span class="var-title">
216     <span class="var-type">mixed</span>
217     <span class="var-name">$_selected_tab</span>
218     = <span class="var-default"> 0</span> (line <span class="line-number">45</span>)
219     </span>
220     </div>
221    
222     <!-- ========== Info from phpDoc block ========= -->
223     <p class="short-description">The default selected tab</p>
224    
225    
226    
227    
228    
229     </div>
230     <h4>Inherited Variables</h4>
231     <A NAME='inherited_vars'><!-- --></A>
232     <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
233     <blockquote>
234     <span class="var-title">
235     <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
236     </span>
237     <span class="var-title">
238     <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
239     </span>
240     </blockquote>
241     <p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
242     <blockquote>
243     <span class="var-title">
244     <span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br>
245     </span>
246     </blockquote>
247    
248     </div>
249     </div>
250    
251     <a name="sec-methods"></a>
252     <div class="info-box">
253     <div class="info-box-title">Methods</div>
254     <div class="nav-bar">
255     <a href="#sec-description">Description</a> |
256     <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
257     <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
258    
259     </div>
260     <div class="info-box-body">
261     <A NAME='method_detail'></A>
262     <a name="methodActiveTab" id="ActiveTab"><!-- --></a>
263     <div class="oddrow">
264    
265     <div class="method-header">
266     <span class="method-title">Constructor ActiveTab</span> (line <span class="line-number">56</span>)
267     </div>
268    
269     <!-- ========== Info from phpDoc block ========= -->
270     <p class="short-description">This is the constructor for the ActiveTab object.</p>
271    
272     <div class="method-signature">
273     <span class="method-result">void</span>
274     <span class="method-name">
275     ActiveTab
276     </span>
277     ([<span class="var-type">string</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">"300px"</span>], <span class="var-type">int</span>&nbsp;<span class="var-name">$selected_tab</span>)
278     </div>
279    
280     <ul class="parameters">
281     <li>
282     <span class="var-type">string</span>
283     <span class="var-name">$width</span><span class="var-description">: <p>- the width table</p></span> </li>
284     <li>
285     <span class="var-type">string</span>
286     <span class="var-name">$height</span><span class="var-description">: <p>- the height of the tab's contents</p></span> </li>
287     <li>
288     <span class="var-type">int</span>
289     <span class="var-name">$selected_tab</span><span class="var-description">: <p>- the selected tab.</p></span> </li>
290     </ul>
291    
292    
293 jonen 1.2 </div>
294 jonen 1.3 <a name="methodadd_tab" id="add_tab"><!-- --></a>
295     <div class="evenrow">
296    
297     <div class="method-header">
298     <span class="method-title">add_tab</span> (line <span class="line-number">124</span>)
299     </div>
300    
301     <!-- ========== Info from phpDoc block ========= -->
302     <p class="short-description">Add a tab</p>
303    
304     <div class="method-signature">
305     <span class="method-result">void</span>
306     <span class="method-name">
307     add_tab
308     </span>
309     (<span class="var-type">string</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$content</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$selected</span> = <span class="var-default">FALSE</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">NULL</span>])
310     </div>
311    
312     <ul class="parameters">
313     <li>
314     <span class="var-type">string</span>
315     <span class="var-name">$title</span><span class="var-description">: <p>- the title of the tab</p></span> </li>
316     <li>
317     <span class="var-type">mixed</span>
318     <span class="var-name">$content</span><span class="var-description">: <p>- the conetnts for the tab</p></span> </li>
319     <li>
320     <span class="var-type">boolean</span>
321     <span class="var-name">$selected</span><span class="var-description">: <p>- should this tab be the default selected tab?</p></span> </li>
322     <li>
323     <span class="var-type">int</span>
324     <span class="var-name">$width</span><span class="var-description">: <p>- the width of the tab in pixels defaults to 60</p></span> </li>
325     </ul>
326    
327    
328     </div>
329     <a name="methodbuild_content" id="build_content"><!-- --></a>
330     <div class="oddrow">
331    
332     <div class="method-header">
333     <span class="method-title">build_content</span> (line <span class="line-number">163</span>)
334     </div>
335    
336     <!-- ========== Info from phpDoc block ========= -->
337    
338     <div class="method-signature">
339     <span class="method-result">void</span>
340     <span class="method-name">
341     build_content
342     </span>
343     ()
344     </div>
345    
346    
347    
348     </div>
349     <a name="methodbuild_tabs" id="build_tabs"><!-- --></a>
350     <div class="evenrow">
351    
352     <div class="method-header">
353     <span class="method-title">build_tabs</span> (line <span class="line-number">134</span>)
354     </div>
355    
356     <!-- ========== Info from phpDoc block ========= -->
357    
358     <div class="method-signature">
359     <span class="method-result">void</span>
360     <span class="method-name">
361     build_tabs
362     </span>
363     ()
364     </div>
365    
366    
367    
368     </div>
369     <a name="methodget_javascript" id="get_javascript"><!-- --></a>
370     <div class="oddrow">
371    
372     <div class="method-header">
373     <span class="method-title">get_javascript</span> (line <span class="line-number">81</span>)
374     </div>
375    
376     <!-- ========== Info from phpDoc block ========= -->
377     <p class="short-description">This function MUST be called AFTER ALL content has been added, in order for the js to work properly</p>
378    
379     <div class="method-signature">
380     <span class="method-result">string</span>
381     <span class="method-name">
382     get_javascript
383     </span>
384     ()
385     </div>
386    
387    
388     <hr class="separator" />
389     <div class="notes">Redefinition of:</div>
390     <dl>
391     <dt><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></dt>
392     <dd>Function for returning the raw javascript that is required for this widget.</dd>
393     </dl>
394    
395     </div>
396     <a name="methodhidden_background" id="hidden_background"><!-- --></a>
397     <div class="evenrow">
398    
399     <div class="method-header">
400     <span class="method-title">hidden_background</span> (line <span class="line-number">236</span>)
401     </div>
402    
403     <!-- ========== Info from phpDoc block ========= -->
404     <p class="short-description">Thie method is used to change the hidden tab's</p>
405     <p class="description"><p>background color</p></p>
406    
407     <div class="method-signature">
408     <span class="method-result">void</span>
409     <span class="method-name">
410     hidden_background
411     </span>
412     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$color</span>)
413     </div>
414    
415    
416    
417     </div>
418     <a name="methodrender" id="render"><!-- --></a>
419     <div class="oddrow">
420    
421     <div class="method-header">
422     <span class="method-title">render</span> (line <span class="line-number">63</span>)
423     </div>
424    
425     <!-- ========== Info from phpDoc block ========= -->
426    
427     <div class="method-signature">
428     <span class="method-result">void</span>
429     <span class="method-name">
430     render
431     </span>
432     ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">mixed</span>&nbsp;<span class="var-name">$output_debug</span>)
433     </div>
434    
435    
436     <hr class="separator" />
437     <div class="notes">Redefinition of:</div>
438     <dl>
439     <dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt>
440     <dd>This function is compatible with the rest of the phpHtmllib API spec.</dd>
441     </dl>
442    
443     </div>
444     <a name="methodselected_background" id="selected_background"><!-- --></a>
445     <div class="evenrow">
446    
447     <div class="method-header">
448     <span class="method-title">selected_background</span> (line <span class="line-number">228</span>)
449     </div>
450    
451     <!-- ========== Info from phpDoc block ========= -->
452     <p class="short-description">Thie method is used to change the selected tab's</p>
453     <p class="description"><p>background color</p></p>
454    
455     <div class="method-signature">
456     <span class="method-result">void</span>
457     <span class="method-name">
458     selected_background
459     </span>
460     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$color</span>)
461     </div>
462    
463    
464    
465     </div>
466     <a name="method_build_tab_td" id="_build_tab_td"><!-- --></a>
467     <div class="oddrow">
468    
469     <div class="method-header">
470     <span class="method-title">_build_tab_td</span> (line <span class="line-number">192</span>)
471     </div>
472    
473     <!-- ========== Info from phpDoc block ========= -->
474    
475     <div class="method-signature">
476     <span class="method-result">void</span>
477     <span class="method-name">
478     _build_tab_td
479     </span>
480     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$selected</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$width</span>)
481     </div>
482    
483    
484    
485     </div>
486     <a name="method_end_td" id="_end_td"><!-- --></a>
487     <div class="evenrow">
488    
489     <div class="method-header">
490     <span class="method-title">_end_td</span> (line <span class="line-number">187</span>)
491     </div>
492    
493     <!-- ========== Info from phpDoc block ========= -->
494    
495     <div class="method-signature">
496     <span class="method-result">void</span>
497     <span class="method-name">
498     _end_td
499     </span>
500     ()
501     </div>
502    
503    
504    
505     </div>
506     <a name="method_spacer_td" id="_spacer_td"><!-- --></a>
507     <div class="oddrow">
508    
509     <div class="method-header">
510     <span class="method-title">_spacer_td</span> (line <span class="line-number">183</span>)
511     </div>
512    
513     <!-- ========== Info from phpDoc block ========= -->
514    
515     <div class="method-signature">
516     <span class="method-result">void</span>
517     <span class="method-name">
518     _spacer_td
519     </span>
520     ()
521     </div>
522    
523    
524    
525     </div>
526     <a name="method_tab_name" id="_tab_name"><!-- --></a>
527     <div class="evenrow">
528    
529     <div class="method-header">
530     <span class="method-title">_tab_name</span> (line <span class="line-number">241</span>)
531     </div>
532    
533     <!-- ========== Info from phpDoc block ========= -->
534    
535     <div class="method-signature">
536     <span class="method-result">void</span>
537     <span class="method-name">
538     _tab_name
539     </span>
540     (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$title</span>)
541     </div>
542    
543    
544    
545     </div>
546     <h4>Inherited Methods</h4>
547     <a name='inherited_methods'><!-- --></a>
548     <!-- =========== Summary =========== -->
549     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
550     <blockquote>
551     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
552     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
553     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
554     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
555     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
556     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
557     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
558     <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
559     </blockquote>
560     <!-- =========== Summary =========== -->
561     <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
562     <blockquote>
563     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
564     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
565     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
566     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
567     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
568     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
569     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
570     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
571     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
572     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
573     <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
574     <span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br>
575     </blockquote>
576    
577     </div>
578     </div>
579    
580     <p class="notes" id="credit">
581     Documention generated on Thu, 31 Jul 2003 18:31:29 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a>
582     </p>
583     </div></body>
584 jonen 1.2 </html>
MailToCvsAdmin">MailToCvsAdmin
 ViewVC Help
Powered by ViewVC 1.1.26 RSS 2.0 feed