Location: PHPKode > projects > Aukyla Document Management System > doc/html/a00158.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <title>Aukyla PHP Framework</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <link rel="StyleSheet" href="auton.css" type="text/css" media="screen">
  </head>

  <body>
    <div id="mainmenu">
      <a href="http://www.auton.nl/" class="home">Home</a>
    </div>
    <div id="submenu">
      <a class="logo" href="http://www.auton.nl/"></a>

      <div class="head">Ads</div>
      <a href="http://sourceforge.net/"><img src="http://sourceforge.net/sflogo.php?group_id=116358&amp;type=1" alt="SourceForge.net Logo" style="padding: 2px 4px; width: 88px; height: 31px; border: 0px"></a>
      <a href="http://getfirefox.com/" title="Get Firefox - The Browser, Reloaded."><img src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox" style="width: 110px; height: 32px; border: 0px"></a>
    </div>
    <div id="main">
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>TabWidget Class Reference</h1><p>Inheritance diagram for TabWidget:
<p><center><img src="a00158.png" usemap="#TabWidget_map" border="0" alt=""></center>
<map name="TabWidget_map">
<area href="a00166.html" alt="Widget" shape="rect" coords="0,0,71,24">
</map>
<a href="a00055.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
A widget containing tab panels. 
<p>
A tab widget is a widget which contains tab panels. Every tab panel is a container which can be accessed using the <a class="el" href="a00158.html#a2">tab()</a> function. You can add new tabs using the <a class="el" href="a00158.html#a1">addTab()</a> function.<p>
When you compose a tab widget, you should provide the contents for all tabs, the widget will take care of which tab to show. This is unlike HTML where you would have to compose every panel yourself at different times. 
<p>

<p>
Definition at line <a class="el" href="a00226.html#l00057">57</a> of file <a class="el" href="a00226.html">Navigation.php</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a0">__construct</a> (<a class="el" href="a00096.html">Container</a> $parent, $id)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a1">addTab</a> ($id, $label)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a2">tab</a> ($id)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a3">setTabContainer</a> ($id, <a class="el" href="a00096.html">Container</a> $container)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a4">setCurrentTab</a> ($id)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a5">currentTab</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a6">setParameters</a> ($parameters)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00158.html#a7">show</a> ()</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="TabWidget::__construct"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::__construct           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a00096.html">Container</a> $&nbsp;</td>
          <td class="mdname" nowrap> <em>parent</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>id</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor.<p>
Creates a new tab widget.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>Parent container this widget should be added to. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The ID of this widget.</td></tr>
  </table>
</dl>

<p>
Reimplemented from <a class="el" href="a00166.html#a0">Widget</a>.
<p>
Definition at line <a class="el" href="a00226.html#l00067">67</a> of file <a class="el" href="a00226.html">Navigation.php</a>.
<p>
References <a class="el" href="a00226.html#l00158">currentTab()</a>, <a class="el" href="a00207.html#l00243">Config::request()</a>, <a class="el" href="a00220.html#l00334">Login::sessionVariable()</a>, and <a class="el" href="a00220.html#l00309">Login::setSessionVariable()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1" doxytag="TabWidget::addTab"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::addTab           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>$&nbsp;</td>
          <td class="mdname" nowrap> <em>label</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Adds a new tab to the widget.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>The ID of the tab panel. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>The label to show on the tab.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A container widget representing the tab to which you can add contents.</dd></dl>

<p>
Definition at line <a class="el" href="a00226.html#l00094">94</a> of file <a class="el" href="a00226.html">Navigation.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a5" doxytag="TabWidget::currentTab"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::currentTab           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the currently opened tab.<p>
<dl compact><dt><b>Returns:</b></dt><dd>ID of the currently opened tab.</dd></dl>
<dl compact><dt><b>Since:</b></dt><dd>1.1</dd></dl>

<p>
Definition at line <a class="el" href="a00226.html#l00158">158</a> of file <a class="el" href="a00226.html">Navigation.php</a>.
<p>
Referenced by <a class="el" href="a00226.html#l00067">__construct()</a>, <a class="el" href="a00226.html#l00146">setCurrentTab()</a>, and <a class="el" href="a00226.html#l00173">show()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4" doxytag="TabWidget::setCurrentTab"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::setCurrentTab           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>id</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Sets the tab with the given <code>id</code> to be the currently opened tab. As the tab widget will normally remember which tab was opened last, you should only call this function if you really want to force a certain tab to be opened.
<p>
Definition at line <a class="el" href="a00226.html#l00146">146</a> of file <a class="el" href="a00226.html">Navigation.php</a>.
<p>
References <a class="el" href="a00226.html#l00158">currentTab()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a6" doxytag="TabWidget::setParameters"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::setParameters           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>parameters</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Use this function to set any <code>parameters</code> on the "tab links" which show when the TabWidget is shown with <a class="el" href="a00169.html">XHTML</a> output. These parameters can be used to make sure the correct page is served when the user switches tabs.
<p>
Definition at line <a class="el" href="a00226.html#l00168">168</a> of file <a class="el" href="a00226.html">Navigation.php</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a3" doxytag="TabWidget::setTabContainer"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::setTabContainer           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname" nowrap> <em>id</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="a00096.html">Container</a> $&nbsp;</td>
          <td class="mdname" nowrap> <em>container</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This is an advanced function which sets the internal container of a tab panel to the specified <code>container</code>. By doing this, you can create your own container and insert it into the tab widget afterwards.
<p>
Definition at line <a class="el" href="a00226.html#l00128">128</a> of file <a class="el" href="a00226.html">Navigation.php</a>.
<p>
References <a class="el" href="a00226.html#l00110">tab()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a7" doxytag="TabWidget::show"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::show           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Show the widget.
<p>
Reimplemented from <a class="el" href="a00166.html#a10">Widget</a>.
<p>
Definition at line <a class="el" href="a00226.html#l00173">173</a> of file <a class="el" href="a00226.html">Navigation.php</a>.
<p>
References <a class="el" href="a00226.html#l00158">currentTab()</a>, <a class="el" href="a00226.html#l00110">tab()</a>, and <a class="el" href="a00229.html#l00168">Output::write()</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2" doxytag="TabWidget::tab"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">TabWidget::tab           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">$&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>id</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the container of the given tab. Use this container to add contents to the tab.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>id</em>&nbsp;</td><td>ID of the tab panel whose container will be returned.</td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A container widget to which you can add contents. Returns <code>null</code> if the given <code>id</code> is not found.</dd></dl>

<p>
Definition at line <a class="el" href="a00226.html#l00110">110</a> of file <a class="el" href="a00226.html">Navigation.php</a>.
<p>
References <a class="el" href="a00226.html#l00110">tab()</a>.
<p>
Referenced by <a class="el" href="a00226.html#l00128">setTabContainer()</a>, <a class="el" href="a00226.html#l00173">show()</a>, and <a class="el" href="a00226.html#l00110">tab()</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00226.html">Navigation.php</a></ul>
    </div>
  </body>
</html>
Return current item: Aukyla Document Management System