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