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 TabWidget</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 TabWidget</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-descendents">Descendents</a>
|
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 the Qualys Tab object.</p>
|
27 |
|
|
<ul class="tags">
|
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">27</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 |
|
|
--TabWidget</pre>
|
40 |
|
|
|
41 |
|
|
</div>
|
42 |
|
|
</div>
|
43 |
|
|
|
44 |
|
|
<a name="sec-descendents"></a>
|
45 |
|
|
<div class="info-box">
|
46 |
|
|
<div class="info-box-title">Direct descendents</div>
|
47 |
|
|
<div class="nav-bar">
|
48 |
|
|
<a href="#sec-description">Description</a> |
|
49 |
|
|
<span class="disabled">Descendents</span>
|
50 |
|
|
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
51 |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
52 |
|
|
|
53 |
|
|
</div>
|
54 |
|
|
<div class="info-box-body">
|
55 |
|
|
<table cellpadding="2" cellspacing="0" class="class-table">
|
56 |
|
|
<tr>
|
57 |
|
|
<th class="class-table-header">Class</th>
|
58 |
|
|
<th class="class-table-header">Description</th>
|
59 |
|
|
</tr>
|
60 |
|
|
<tr>
|
61 |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/widget-examples/FirstTab.html">FirstTab</a></td>
|
62 |
|
|
<td>
|
63 |
|
|
This class implements the Qualys Tab object.
|
64 |
|
|
</td>
|
65 |
|
|
</tr>
|
66 |
|
|
<tr>
|
67 |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/widget-examples/FooTab.html">FooTab</a></td>
|
68 |
|
|
<td>
|
69 |
|
|
This class implements the Qualys Tab object.
|
70 |
|
|
</td>
|
71 |
|
|
</tr>
|
72 |
|
|
<tr>
|
73 |
|
|
<td style="padding-right: 2em"><a href="../phpHtmlLib/widget-examples/test.html">test</a></td>
|
74 |
|
|
<td>
|
75 |
|
|
This class implements the Qualys Tab object.
|
76 |
|
|
</td>
|
77 |
|
|
</tr>
|
78 |
|
|
</table>
|
79 |
|
|
</div>
|
80 |
|
|
</div>
|
81 |
|
|
|
82 |
|
|
|
83 |
|
|
<a name="sec-var-summary"></a>
|
84 |
|
|
<div class="info-box">
|
85 |
|
|
<div class="info-box-title">Variable Summary</span></div>
|
86 |
|
|
<div class="nav-bar">
|
87 |
|
|
<a href="#sec-description">Description</a> |
|
88 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
89 |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
90 |
|
|
|
|
91 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
92 |
|
|
|
93 |
|
|
</div>
|
94 |
|
|
<div class="info-box-body">
|
95 |
|
|
<div class="var-summary">
|
96 |
|
|
<div class="var-title">
|
97 |
|
|
<span class="var-type">mixed</span>
|
98 |
|
|
<a href="#$_number" title="details" class="var-name">$_number</a>
|
99 |
|
|
</div>
|
100 |
|
|
<div class="var-title">
|
101 |
|
|
<span class="var-type">mixed</span>
|
102 |
|
|
<a href="#$_selected" title="details" class="var-name">$_selected</a>
|
103 |
|
|
</div>
|
104 |
|
|
</div>
|
105 |
|
|
</div>
|
106 |
|
|
</div>
|
107 |
|
|
|
108 |
|
|
<a name="sec-method-summary"></a>
|
109 |
|
|
<div class="info-box">
|
110 |
|
|
<div class="info-box-title">Method Summary</span></div>
|
111 |
|
|
<div class="nav-bar">
|
112 |
|
|
<a href="#sec-description">Description</a> |
|
113 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
114 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
115 |
|
|
|
116 |
|
|
|
|
117 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
118 |
|
|
</div>
|
119 |
|
|
<div class="info-box-body">
|
120 |
|
|
<div class="method-summary">
|
121 |
|
|
|
122 |
|
|
<div class="method-definition">
|
123 |
|
|
<span class="method-result">TabWidget</span>
|
124 |
|
|
<a href="#TabWidget" title="details" class="method-name">TabWidget</a>
|
125 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
126 |
|
|
</div>
|
127 |
|
|
|
128 |
|
|
<div class="method-definition">
|
129 |
|
|
<span class="method-result">Container</span>
|
130 |
|
|
<a href="#content" title="details" class="method-name">content</a>
|
131 |
|
|
()
|
132 |
|
|
</div>
|
133 |
|
|
|
134 |
|
|
<div class="method-definition">
|
135 |
|
|
<span class="method-result">string</span>
|
136 |
|
|
<a href="#name" title="details" class="method-name">name</a>
|
137 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
138 |
|
|
</div>
|
139 |
|
|
|
140 |
|
|
<div class="method-definition">
|
141 |
|
|
<span class="method-result">string</span>
|
142 |
|
|
<a href="#queryvar" title="details" class="method-name">queryvar</a>
|
143 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<span class="var-type">boolean</span> <span class="var-name">$subtab_flag</span> = <span class="var-default">false</span>])
|
144 |
|
|
</div>
|
145 |
|
|
</div>
|
146 |
|
|
</div>
|
147 |
|
|
</div>
|
148 |
|
|
|
149 |
|
|
<a name="sec-vars"></a>
|
150 |
|
|
<div class="info-box">
|
151 |
|
|
<div class="info-box-title">Variables</div>
|
152 |
|
|
<div class="nav-bar">
|
153 |
|
|
<a href="#sec-description">Description</a> |
|
154 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
155 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
156 |
|
|
|
157 |
|
|
|
158 |
|
|
|
|
159 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
160 |
|
|
|
161 |
|
|
</div>
|
162 |
|
|
<div class="info-box-body">
|
163 |
|
|
<a name="var$_number" id="$_number"><!-- --></A>
|
164 |
|
|
<div class="evenrow">
|
165 |
|
|
|
166 |
|
|
<div class="var-header">
|
167 |
|
|
<span class="var-title">
|
168 |
|
|
<span class="var-type">mixed</span>
|
169 |
|
|
<span class="var-name">$_number</span>
|
170 |
|
|
= <span class="var-default"> 0</span> (line <span class="line-number">37</span>)
|
171 |
|
|
</span>
|
172 |
|
|
</div>
|
173 |
|
|
|
174 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
175 |
|
|
<p class="short-description">The tab number in the list of tabs.</p>
|
176 |
|
|
|
177 |
|
|
|
178 |
|
|
|
179 |
|
|
|
180 |
|
|
|
181 |
|
|
</div>
|
182 |
|
|
<a name="var$_selected" id="$_selected"><!-- --></A>
|
183 |
|
|
<div class="oddrow">
|
184 |
|
|
|
185 |
|
|
<div class="var-header">
|
186 |
|
|
<span class="var-title">
|
187 |
|
|
<span class="var-type">mixed</span>
|
188 |
|
|
<span class="var-name">$_selected</span>
|
189 |
|
|
= <span class="var-default"> false</span> (line <span class="line-number">32</span>)
|
190 |
|
|
</span>
|
191 |
|
|
</div>
|
192 |
|
|
|
193 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
194 |
|
|
<p class="short-description">Is this tab selected or not?</p>
|
195 |
|
|
|
196 |
|
|
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
|
200 |
|
|
</div>
|
201 |
|
|
<h4>Inherited Variables</h4>
|
202 |
|
|
<A NAME='inherited_vars'><!-- --></A>
|
203 |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
|
204 |
|
|
<blockquote>
|
205 |
|
|
<span class="var-title">
|
206 |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br>
|
207 |
|
|
</span>
|
208 |
|
|
<span class="var-title">
|
209 |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br>
|
210 |
|
|
</span>
|
211 |
|
|
</blockquote>
|
212 |
|
|
|
213 |
|
|
</div>
|
214 |
|
|
</div>
|
215 |
|
|
|
216 |
|
|
<a name="sec-methods"></a>
|
217 |
|
|
<div class="info-box">
|
218 |
|
|
<div class="info-box-title">Methods</div>
|
219 |
|
|
<div class="nav-bar">
|
220 |
|
|
<a href="#sec-description">Description</a> |
|
221 |
|
|
<a href="#sec-descendents">Descendents</a> |
|
222 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
223 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
224 |
|
|
|
225 |
|
|
</div>
|
226 |
|
|
<div class="info-box-body">
|
227 |
|
|
<A NAME='method_detail'></A>
|
228 |
|
|
<a name="methodTabWidget" id="TabWidget"><!-- --></a>
|
229 |
|
|
<div class="evenrow">
|
230 |
|
|
|
231 |
|
|
<div class="method-header">
|
232 |
|
|
<span class="method-title">Constructor TabWidget</span> (line <span class="line-number">46</span>)
|
233 |
|
|
</div>
|
234 |
|
|
|
235 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
236 |
|
|
<p class="short-description">The constructor</p>
|
237 |
|
|
<p class="description"><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/TabWidget.html#methodTabWidget">TabWidget</a><span class="src-sym">(</span><span class="src-var">$title</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
238 |
|
|
<li> <span class="src-var">$this</span><span class="src-sym">-></span><a href="../phpHtmlLib/BaseWidget.html#methodset_title">set_title</a><span class="src-sym">(</span><span class="src-var">$title</span><span class="src-sym">)</span><span class="src-sym">;</span></li> |
239 |
|
|
<li> <span class="src-sym">}</span></li> |
240 |
|
|
</ol></pre></p></p>
|
241 |
|
|
|
242 |
|
|
<div class="method-signature">
|
243 |
|
|
<span class="method-result">TabWidget</span>
|
244 |
|
|
<span class="method-name">
|
245 |
|
|
TabWidget
|
246 |
|
|
</span>
|
247 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
248 |
|
|
</div>
|
249 |
|
|
|
250 |
|
|
<ul class="parameters">
|
251 |
|
|
<li>
|
252 |
|
|
<span class="var-type">string</span>
|
253 |
|
|
<span class="var-name">$title</span><span class="var-description">: the title for the Tab</span> </li>
|
254 |
|
|
</ul>
|
255 |
|
|
|
256 |
|
|
|
257 |
|
|
</div>
|
258 |
|
|
<a name="methodcontent" id="content"><!-- --></a>
|
259 |
|
|
<div class="oddrow">
|
260 |
|
|
|
261 |
|
|
<div class="method-header">
|
262 |
|
|
<span class="method-title">content</span> (line <span class="line-number">60</span>)
|
263 |
|
|
</div>
|
264 |
|
|
|
265 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
266 |
|
|
<p class="short-description">This is the function where you can build the content for the Tab itself.</p>
|
267 |
|
|
<p class="description"><p>The alternative is to use the add() method.</p><p><pre><ol><li><span class="src-key">function </span><a href="../phpHtmlLib/TabWidget.html#methodcontent">content</a><span class="src-sym">(</span><span class="src-sym">) </span><span class="src-sym">{</span></li> |
268 |
|
|
<li> <span class="src-key">return </span><span class="src-id">null</span><span class="src-sym">;</span></li> |
269 |
|
|
<li> <span class="src-sym">}</span></li> |
270 |
|
|
</ol></pre></p></p>
|
271 |
|
|
<ul class="tags">
|
272 |
|
|
<li><span class="field">return:</span> object</li>
|
273 |
|
|
</ul>
|
274 |
|
|
|
275 |
|
|
<div class="method-signature">
|
276 |
|
|
<span class="method-result">Container</span>
|
277 |
|
|
<span class="method-name">
|
278 |
|
|
content
|
279 |
|
|
</span>
|
280 |
|
|
()
|
281 |
|
|
</div>
|
282 |
|
|
|
283 |
|
|
|
284 |
|
|
|
285 |
|
|
<hr class="separator" />
|
286 |
|
|
<div class="notes">Redefined in descendants as:</div>
|
287 |
|
|
<ul class="redefinitions">
|
288 |
|
|
<li>
|
289 |
|
|
<a href="../phpHtmlLib/widget-examples/FirstTab.html#methodcontent">FirstTab::content()</a>
|
290 |
|
|
</li>
|
291 |
|
|
<li>
|
292 |
|
|
<a href="../phpHtmlLib/widget-examples/FooTab.html#methodcontent">FooTab::content()</a>
|
293 |
|
|
</li>
|
294 |
|
|
<li>
|
295 |
|
|
<a href="../phpHtmlLib/widget-examples/test.html#methodcontent">test::content()</a>
|
296 |
|
|
</li>
|
297 |
|
|
</ul>
|
298 |
|
|
</div>
|
299 |
|
|
<a name="methodname" id="name"><!-- --></a>
|
300 |
|
|
<div class="evenrow">
|
301 |
|
|
|
302 |
|
|
<div class="method-header">
|
303 |
|
|
<span class="method-title">name</span> (line <span class="line-number">70</span>)
|
304 |
|
|
</div>
|
305 |
|
|
|
306 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
307 |
|
|
<p class="short-description">This method creates the name of the tab</p>
|
308 |
|
|
<ul class="tags">
|
309 |
|
|
<li><span class="field">return:</span> - the tab name</li>
|
310 |
|
|
</ul>
|
311 |
|
|
|
312 |
|
|
<div class="method-signature">
|
313 |
|
|
<span class="method-result">string</span>
|
314 |
|
|
<span class="method-name">
|
315 |
|
|
name
|
316 |
|
|
</span>
|
317 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>)
|
318 |
|
|
</div>
|
319 |
|
|
|
320 |
|
|
<ul class="parameters">
|
321 |
|
|
<li>
|
322 |
|
|
<span class="var-type">string</span>
|
323 |
|
|
<span class="var-name">$title</span><span class="var-description">: - the tab display string</span> </li>
|
324 |
|
|
</ul>
|
325 |
|
|
|
326 |
|
|
|
327 |
|
|
</div>
|
328 |
|
|
<a name="methodqueryvar" id="queryvar"><!-- --></a>
|
329 |
|
|
<div class="oddrow">
|
330 |
|
|
|
331 |
|
|
<div class="method-header">
|
332 |
|
|
<span class="method-title">queryvar</span> (line <span class="line-number">92</span>)
|
333 |
|
|
</div>
|
334 |
|
|
|
335 |
|
|
<!-- ========== Info from phpDoc block ========= -->
|
336 |
|
|
<p class="short-description">This method builds the query string 'tab_selected=<name>' for you to place in a url</p>
|
337 |
|
|
<ul class="tags">
|
338 |
|
|
<li><span class="field">return:</span> - the query var assigned to tab name</li>
|
339 |
|
|
</ul>
|
340 |
|
|
|
341 |
|
|
<div class="method-signature">
|
342 |
|
|
<span class="method-result">string</span>
|
343 |
|
|
<span class="method-name">
|
344 |
|
|
queryvar
|
345 |
|
|
</span>
|
346 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<span class="var-type">boolean</span> <span class="var-name">$subtab_flag</span> = <span class="var-default">false</span>])
|
347 |
|
|
</div>
|
348 |
|
|
|
349 |
|
|
<ul class="parameters">
|
350 |
|
|
<li>
|
351 |
|
|
<span class="var-type">string</span>
|
352 |
|
|
<span class="var-name">$title</span><span class="var-description">: - the tab title</span> </li>
|
353 |
|
|
<li>
|
354 |
|
|
<span class="var-type">boolean</span>
|
355 |
|
|
<span class="var-name">$subtab_flag</span><span class="var-description">: - is this a subtab?</span> </li>
|
356 |
|
|
</ul>
|
357 |
|
|
|
358 |
|
|
|
359 |
|
|
</div>
|
360 |
|
|
<h4>Inherited Methods</h4>
|
361 |
|
|
<a name='inherited_methods'><!-- --></a>
|
362 |
|
|
<!-- =========== Summary =========== -->
|
363 |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p>
|
364 |
|
|
<blockquote>
|
365 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br>
|
366 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br>
|
367 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br>
|
368 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br>
|
369 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br>
|
370 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br>
|
371 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br>
|
372 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br>
|
373 |
|
|
</blockquote>
|
374 |
|
|
<!-- =========== Summary =========== -->
|
375 |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p>
|
376 |
|
|
<blockquote>
|
377 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br>
|
378 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br>
|
379 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br>
|
380 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br>
|
381 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br>
|
382 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br>
|
383 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br>
|
384 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br>
|
385 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br>
|
386 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br>
|
387 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br>
|
388 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br>
|
389 |
|
|
</blockquote>
|
390 |
|
|
|
391 |
|
|
</div>
|
392 |
|
|
</div>
|
393 |
|
|
|
394 |
|
|
|
395 |
|
|
<p class="notes" id="credit">
|
396 |
|
|
Documentation generated on Thu, 1 Apr 2004 09:40:09 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a>
|
397 |
|
|
</p>
|
398 |
|
|
</div></body>
|
399 |
|
|
</html>
|