blob: 5e170f4b3351ecb08fab5f491630d8e661a8f381 [file] [log] [blame]
<html xmlns:javaee="http://java.sun.com/xml/ns/javaee" xmlns:fo="http://www.w3.org/1999/XSL/Format">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>tabGroup
(Tobago Core Tag library documentation)
</title>
<meta name="keywords" content="$title">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
</head>
<script>
function asd()
{
parent.document.title="tabGroup (Tobago Core Tag library documentation)";
}
</script>
<body bgcolor="white" onload="asd();">
<a name="navbar_top"></a>
<table border="0" width="100%" cellpadding="1" cellspacing="0">
<tr>
<td COLSPAN="3" BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><a NAME="navbar_top_firstrow"></a>
<table BORDER="0" CELLPADDING="0" CELLSPACING="3">
<tr ALIGN="center" VALIGN="top">
<td BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> &nbsp;<a href="../overview-summary.html"><font CLASS="NavBarFont1"><b>Overview</b></font></a>&nbsp;</td><td BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> &nbsp;<a href="tld-summary.html"><font CLASS="NavBarFont1"><b>Library</b></font></a>&nbsp;</td><td BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<font CLASS="NavBarFont1Rev">&nbsp;Tag&nbsp;</font>&nbsp;</td><td BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> &nbsp;<a HREF="../help-doc.html"><font CLASS="NavBarFont1"><b>Help</b></font></a>&nbsp;</td>
</tr>
</table>
</td><td ALIGN="right" VALIGN="top" ROWSPAN="3"><em></em></td>
</tr>
<tr>
<td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2"></font></td><td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2">
&nbsp;<a HREF="../index.html" TARGET="_top"><b>FRAMES</b></a>&nbsp;
&nbsp;<a href="tabGroup.html" target="_top"><b>NO FRAMES</b></a>&nbsp;
<script></script>
<noscript>
<a HREF="../alltags-noframe.html" TARGET=""><b>All Tags</b></a>
</noscript>
</font></td>
</tr>
</table>
<hr>
<h2>
<font size="-1">tc</font>
<br>
Tag tabGroup
</h2>
<hr>
Renders a tab group which contains tab panels.<p><b>UIComponentClass: </b>org.apache.myfaces.tobago.component.UITabGroup</p><p><b>RendererType: </b>TabGroup</p>
<br>
<p></p>
<hr>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan="2"><font size="+2"><b>Tag Information</b></font></td>
</tr>
<tr>
<td>Tag Class</td><td>org.apache.myfaces.tobago.internal.taglib.TabGroupTag</td>
</tr>
<tr>
<td>TagExtraInfo Class</td><td><i>None</i></td>
</tr>
<tr>
<td>Body Content</td><td>JSP</td>
</tr>
<tr>
<td>Display Name</td><td><i>None</i></td>
</tr>
</table>
<br>
<p></p>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan="5"><font size="+2"><b>Attributes</b></font></td>
</tr>
<tr>
<td><b>Name</b></td><td><b>Required</b></td><td><b>Request-time</b></td><td><b>Type</b></td><td><b>Description</b></td>
</tr>
<tr valign="top">
<td>action</td><td>false</td><td>false</td><td><code>javax.el.MethodExpression</code>
<br>
(<i>signature must match </i><code>java.lang.Object action()</code>)
</td><td>Action to invoke when clicked. This must be a MethodBinding or a String representing the application action to
invoke when this component is activated by the user. The MethodBinding must evaluate to a public method that takes
no parameters, and returns a String (the logical outcome) which is passed to the NavigationHandler for this
application. The string is directly passed to the navigation handler.</td>
</tr>
<tr valign="top">
<td>actionListener</td><td>false</td><td>false</td><td><code>javax.el.MethodExpression</code>
<br>
(<i>signature must match </i><code>void actionListener(javax.faces.event.ActionEvent)</code>)
</td><td>MethodBinding 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 valign="top">
<td>binding</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>javax.faces.component.UIComponent</code>)
</td><td>The value binding expression linking this component to a property in a backing bean.
<p/>
Warning: For the tobago extension library <b>tx</b> the binding differs from JSP and Facelets:
<ul>
<li>JSP: The component is the inner main control (e. g. UIInput).</li>
<li>Facelets: The component is the outer UIPanel.</li>
</ul><br />Type: <code>javax.faces.component.UIComponent</code></td>
</tr>
<tr valign="top">
<td>id</td><td>false</td><td>true</td><td><code>java.lang.String</code></td><td>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 valign="top">
<td>immediate</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td>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 valign="top">
<td>markup</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>org.apache.myfaces.tobago.context.Markup</code>)
</td><td>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 valign="top">
<td>rendered</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td>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 valign="top">
<td>renderedPartially</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String[]</code>)
</td><td><p>
Indicate the partially rendered components in a case of a submit.
</p>
<p>
The search depends on the number of prefixed colons in the relativeId:
<dl>
<dd>number of prefixed colons == 0</dd>
<dt>fully relative</dt>
<dd>number of prefixed colons == 1</dd>
<dt>absolute (still normal findComponent syntax)</dt>
<dd>number of prefixed colons == 2</dd>
<dt>search in the current naming container (same as 0 colons)</dt>
<dd>number of prefixed colons == 3</dd>
<dt>search in the parent naming container of the current naming container</dt>
<dd>number of prefixed colons > 3</dd>
<dt>go to the next parent naming container for each additional colon</dt>
</dl>
</p>
<p>
If a literal is specified: to use more than one identifier the identifiers must be space delimited.
</p>
<p>
Using this in a UISheet or UITabGroup component this list indicates components to update when calling
internal AJAX requests like sort or paging commands.
Don't forget to add the sheet-id or tagGroup-id in that case, if needed.
</p>
<p>
You can also use<br />Type: <code>java.lang.String[]</code></td>
</tr>
<tr valign="top">
<td>selectedIndex</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Integer</code>)
</td><td><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 valign="top">
<td>showNavigationBar</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.Boolean</code>)
</td><td>Flag indicating that the tab navigation bar is rendered.<br />Type: <code>boolean</code><br />Default: <code>true</code></td>
</tr>
<tr valign="top">
<td>switchType</td><td>false</td><td>false</td><td><code>javax.el.ValueExpression</code>
<br>
(<i>must evaluate to </i><code>java.lang.String</code>)
</td><td>Indicating how tab switching should be done.
<p/>
Possible values are:
<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>java.lang.String</code><br />Default: <code>client</code><br />Allowed Values: <code>[client, reloadPage, reloadTab]</code></td>
</tr>
<tr valign="top">
<td>tabChangeListener</td><td>false</td><td>false</td><td><code>javax.el.MethodExpression</code>
<br>
(<i>signature must match </i><code>void tabChangeListener(org.apache.myfaces.tobago.event.TabChangeEvent)</code>)
</td><td><i>No Description</i></td>
</tr>
</table>
<br>
<p></p>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<td colspan="5"><font size="+2"><b>Variables</b></font></td>
</tr>
<td colspan="2"><i>No Variables Defined.</i></td>
</table>
<br>
<p></p>
<a name="navbar_bottom"></a>
<table border="0" width="100%" cellpadding="1" cellspacing="0">
<tr>
<td COLSPAN="3" BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><a NAME="navbar_bottom_firstrow"></a>
<table BORDER="0" CELLPADDING="0" CELLSPACING="3">
<tr ALIGN="center" VALIGN="top">
<td BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> &nbsp;<a href="../overview-summary.html"><font CLASS="NavBarFont1"><b>Overview</b></font></a>&nbsp;</td><td BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> &nbsp;<a href="tld-summary.html"><font CLASS="NavBarFont1"><b>Library</b></font></a>&nbsp;</td><td BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<font CLASS="NavBarFont1Rev">&nbsp;Tag&nbsp;</font>&nbsp;</td><td BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> &nbsp;<a HREF="../help-doc.html"><font CLASS="NavBarFont1"><b>Help</b></font></a>&nbsp;</td>
</tr>
</table>
</td><td ALIGN="right" VALIGN="top" ROWSPAN="3"><em></em></td>
</tr>
<tr>
<td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2"></font></td><td BGCOLOR="white" CLASS="NavBarCell2"><font SIZE="-2">
&nbsp;<a HREF="../index.html" TARGET="_top"><b>FRAMES</b></a>&nbsp;
&nbsp;<a href="tabGroup.html" target="_top"><b>NO FRAMES</b></a>&nbsp;
<script></script>
<noscript>
<a HREF="../alltags-noframe.html" TARGET=""><b>All Tags</b></a>
</noscript>
</font></td>
</tr>
</table>
<hr>
<small><i>
Output Generated by
<a href="http://taglibrarydoc.dev.java.net/" target="_blank">Tag Library Documentation Generator</a>.
Java, JSP, and JavaServer Pages are trademarks or
registered trademarks of Sun Microsystems, Inc. in the US and other
countries. Copyright 2002-4 Sun Microsystems, Inc.
4150 Network Circle
Santa Clara, CA 95054, U.S.A.
All Rights Reserved.
</i></small>
</body>
</html>