blob: 258c7c6efb458adda5b58be0b3f5ef80e7d93c43 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en" xmlns:vdldoc="http://vdldoc.omnifaces.org" xmlns:fo="http://www.w3.org/1999/XSL/Format" xmlns:jakartaee="https://jakarta.ee/xml/ns/jakartaee">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>tabGroup (Tobago Core VDL Documentation)
</title>
<meta name="keywords" content="$title">
<link rel="stylesheet" type="text/css" title="Style" href="../stylesheet.css">
</head>
<body>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="topNav">
<a name="navbar_top"></a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"></a>
<ul class="navList" title="Navigation">
<li>
<a href="../overview-summary.html">Overview</a>
</li>
<li>
<a href="tld-summary.html">Library</a>
</li>
<li class="navBarCell1Rev">Tag</li>
<li>
<a href="../help-doc.html">Help</a>
</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>
<a target="_top" href="../index.html?tc/tabGroup.html">
Frames
</a>
</li>
<li>
<a target="_top" href="tabGroup.html">
No Frames
</a>
</li>
</ul>
<ul class="navList" id="alltags_navbar_top">
<li>
<a href="../alltags-noframe.html">All Tags</a>
</li>
</ul>
<div>
<script type="text/javascript">
document.getElementById("alltags_navbar_top").style.display = (window == top) ? "block" : "none";
</script>
</div>
<a name="skip-navbar_top"></a>
</div>
<div class="header">
<h1 title="Library" class="title">tc</h1>
<h2 class="title">
Tag
tabGroup</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Description:</dt>
<dd>
<div class="block">Renders a tab group which contains tab panels.<p><b>UIComponentClass: </b>org.apache.myfaces.tobago.component.UITabGroup</p><p><b>RendererType: </b><ul><li>TabGroup (default)</li></ul></p><p><b>Supported markups:</b></p><dl><dt><b>spread</b></dt><dd>Use the full height for the HTML content.</dd></dl></div>
</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Component summary table, listing component information">
<caption>
<span>Component Information</span><span class="tabEnd">&nbsp;</span>
</caption>
<thead>
<tr>
<th class="colFirst" scope="col">Info</th><th class="colLast" scope="col">Value</th>
</tr>
</thead>
<tbody>
<tr class="rowColor">
<td class="colFirst">Component Type</td><td class="colLast"><code>org.apache.myfaces.tobago.TabGroup</code></td>
</tr>
<tr class="altColor">
<td class="colFirst">Handler Class</td><td class="colLast"><code>org.apache.myfaces.tobago.facelets.TobagoComponentHandler</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst">Renderer Type</td><td class="colLast"><code>TabGroup</code></td>
</tr>
<tr class="altColor">
<td class="colFirst">Description</td><td class="colLast"><i>None</i></td>
</tr>
</tbody>
</table>
</div>
<div class="summary">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Attribute summary table, listing attribute information">
<caption>
<span>Attributes</span><span class="tabEnd">&nbsp;</span>
</caption>
<thead>
<tr>
<th class="colFirst">Name</th><th class="colOne">Required</th><th class="colOne">Type</th><th class="colLast">Description</th>
</tr>
</thead>
<tbody>
<tr id="action" class="rowColor">
<td class="colFirst"><a href="#action"><code>action</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>java.lang.String</code></td><td class="colLast">Action to invoke when clicked.
This must be a MethodExpression or a String representing the application action to invoke when
this component is activated by the user.
The {@link javax.el.MethodExpression} must evaluate to a public method that takes no parameters,
and returns a {@link String} (the logical outcome) which is passed to the
{@link javax.faces.application.NavigationHandler} for this application.
The string is directly passed to the navigation handler.</td>
</tr>
<tr id="actionListener" class="altColor">
<td class="colFirst"><a href="#actionListener"><code>actionListener</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>java.lang.String</code></td><td class="colLast">MethodExpression representing an action listener method that will be
notified when this component is activated by the user.
The expression must evaluate to a public method that takes an ActionEvent
parameter, with a return type of void.</td>
</tr>
<tr id="autoSpacing" class="rowColor">
<td class="colFirst"><a href="#autoSpacing"><code>autoSpacing</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td class="colLast">Automatically add spacing (margins/paddings) to the component for better positioning.
Default is 'true' except the component is inside a:
- header
- footer
- bar
- sheet
- tree
- link group
- button group
- before facet
- after facet
- label facet
- bar facet<br />Type: <code>java.lang.Boolean</code></td>
</tr>
<tr id="binding" class="altColor">
<td class="colFirst"><a href="#binding"><code>binding</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>javax.faces.component.UIComponent</code>)
</td><td class="colLast">The value binding expression linking this component to a property in a backing bean.
For Facelets, the component is the outer UIPanel, not the input control.<br />Type: <code>javax.faces.component.UIComponent</code></td>
</tr>
<tr id="id" class="rowColor">
<td class="colFirst"><a href="#id"><code>id</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>java.lang.String</code></td><td class="colLast">The component identifier for this component.
This value must be unique within the closest parent component that is a naming container.<br />Type: <code>java.lang.String</code></td>
</tr>
<tr id="immediate" class="altColor">
<td class="colFirst"><a href="#immediate"><code>immediate</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td class="colLast">Flag indicating that, if this component is activated by the user,
notifications should be delivered to interested listeners and actions
immediately (that is, during Apply Request Values phase) rather than
waiting until Invoke Application phase.<br />Type: <code>boolean</code><br />Default: <code>false</code></td>
</tr>
<tr id="markup" class="rowColor">
<td class="colFirst"><a href="#markup"><code>markup</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.context.Markup</code>)
</td><td class="colLast">Indicate markup of this component.
The allowed markups can be defined or overridden in the theme.
The value 'none' should not be used any longer. Just leave the attribute empty, or use a NULL pointer.<br />Type: <code>org.apache.myfaces.tobago.context.Markup</code></td>
</tr>
<tr id="rendered" class="altColor">
<td class="colFirst"><a href="#rendered"><code>rendered</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td class="colLast">Flag indicating whether or not this component should be rendered
(during Render Response Phase), or processed on any subsequent form submit.<br />Type: <code>boolean</code><br />Default: <code>true</code></td>
</tr>
<tr id="selectedIndex" class="rowColor">
<td class="colFirst"><a href="#selectedIndex"><code>selectedIndex</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Integer</code>)
</td><td class="colLast"><strong>ValueBindingExpression</strong> pointing to a Integer to save the
component's selected Tab.<br />Type: <code>java.lang.Integer</code><br />Default: <code>0</code></td>
</tr>
<tr id="showNavigationBar" class="altColor">
<td class="colFirst"><a href="#showNavigationBar"><code>showNavigationBar</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td class="colLast">Flag indicating that the tab navigation bar is rendered.<br />Type: <code>boolean</code><br />Default: <code>true</code></td>
</tr>
<tr id="switchType" class="rowColor">
<td class="colFirst"><a href="#switchType"><code>switchType</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.model.SwitchType</code>)
</td><td class="colLast"><p>
Indicating how tab switching should be done.
</p>
<p>
Possible values are:
</p>
<dl>
<dt>client</dt>
<dd>Tab switching is done on client, no server Request.</dd>
<dt>reloadPage</dt>
<dd>Tab switching is done by server request. Full page is reloaded.</dd>
<dt>reloadTab</dt>
<dd>Tab switching is done by server request. Only the Tab is reloaded.</dd>
</dl><br />Type: <code>org.apache.myfaces.tobago.model.SwitchType</code><br />Default: <code>client</code><br />Allowed Values: <code>[client, reloadPage, reloadTab]</code></td>
</tr>
<tr id="tabChangeListener" class="altColor">
<td class="colFirst"><a href="#tabChangeListener"><code>tabChangeListener</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>java.lang.String</code></td><td class="colLast"><i>No Description</i></td>
</tr>
<tr id="tip" class="rowColor">
<td class="colFirst"><a href="#tip"><code>tip</code></a></td><td class="colOne"><code>false</code></td><td class="colOne"><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td class="colLast">Text value to display as tooltip.<br />Type: <code>java.lang.String</code></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="bottomNav">
<a name="navbar_bottom"></a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"></a>
<ul class="navList" title="Navigation">
<li>
<a href="../overview-summary.html">Overview</a>
</li>
<li>
<a href="tld-summary.html">Library</a>
</li>
<li class="navBarCell1Rev">Tag</li>
<li>
<a href="../help-doc.html">Help</a>
</li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>
<a target="_bottom" href="../index.html?tc/tabGroup.html">
Frames
</a>
</li>
<li>
<a target="_bottom" href="tabGroup.html">
No Frames
</a>
</li>
</ul>
<ul class="navList" id="alltags_navbar_bottom">
<li>
<a href="../alltags-noframe.html">All Tags</a>
</li>
</ul>
<script type="text/javascript">
document.getElementById("alltags_navbar_bottom").style.display = (window == top) ? "block" : "none";
</script><a name="skip-navbar_bottom"></a>
</div>
<p class="about">
Output generated by <a href="http://vdldoc.omnifaces.org" target="_blank">Vdldoc</a> View Declaration Language Documentation Generator.
</p>
</body>
</html>