blob: 3edc960dead8be7f60f112f50a9552b1f674397a [file] [log] [blame]
<html>
<head>
<title>&lt;a2:panel /&gt;</title>
</head>
<body>
<h1>Tag Name: &lt;a2:panel /&gt;</h1>
<h2>Description</h2>
<p>
Render a panel for tabbedPanel
</p>
<p>
<!-- START SNIPPET: javadoc --> Render a panel for tabbedPanel.</p> <!-- END SNIPPET: javadoc --> <p/> <b>Examples</b> See the example in {@link TabbedPanel}. <p/>
</p>
<h2>Attributes</h2>
<p>
<!-- START SNIPPET: tagattributes -->
<table width="100%">
<tr>
<th align="left" valign="top"><h4>Name</h4></th>
<th align="left" valign="top"><h4>Required</h4></th>
<th align="left" valign="top"><h4>Default</h4></th>
<th align="left" valign="top"><h4>Type</h4></th>
<th align="left" valign="top"><h4>Description</h4></th>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tabName</td>
<!-- Required -->
<td align="left" valign="top"><b>true</b></td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The text of the tab to display in the header tab list</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">subscribeTopicName</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set subscribeTopicName attribute</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">remote</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">false</td>
<!-- Type -->
<td align="left" valign="top">Boolean</td>
<!-- Description -->
<td align="left" valign="top">determines whether this is a remote panel (ajax) or a local panel (content loaded into visible/hidden containers)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">updateFreq</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">0</td>
<!-- Type -->
<td align="left" valign="top">Integer</td>
<!-- Description -->
<td align="left" valign="top">How often to re-fetch the content (in milliseconds)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">delay</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">0</td>
<!-- Type -->
<td align="left" valign="top">Integer</td>
<!-- Description -->
<td align="left" valign="top">How long to wait before fetching the content (in milliseconds)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">loadingText</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The text to display to the user while the new content is being fetched (especially good if the content will take awhile)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">listenTopics</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Topic name to listen to (comma delimited), that will cause the DIV's content to be re-fetched</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">theme</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">The theme to use for the element. <b>This tag will usually use the ajax theme.</b></td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">href</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">The URL to call to obtain the content</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">errorText</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">The text to display to the user if the is an error fetching the content</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">showErrorTransportText</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">false</td>
<!-- Type -->
<td align="left" valign="top">Boolean</td>
<!-- Description -->
<td align="left" valign="top">when to show the error message as content when the URL had problems</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">afterLoading</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">Javascript code that will be executed after the content has been fetched</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">openTemplate</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set template to use for opening the rendered html.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">templateDir</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The template directory.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">template</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The template (other than default) to use for rendering the element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">cssClass</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The css class to use for element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">cssStyle</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The css style definitions for element ro use</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">title</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html title attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">disabled</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html disabled attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">label</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Label expression used for rendering a element specific label</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">labelposition</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">define label position of form element (top/left)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">requiredposition</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">define required position of required form element (left|right)</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">name</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">The name to set for element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">required</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">false</td>
<!-- Type -->
<td align="left" valign="top">Boolean</td>
<!-- Description -->
<td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tabindex</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html tabindex attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">value</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Preset the value of input element.</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onclick</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onclick attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">ondblclick</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmousedown</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmouseup</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmouseover</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmousemove</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onmouseout</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onfocus</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onfocus attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onblur</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onblur attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onkeypress</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onkeydown</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onkeyup</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onselect</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onselect attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">onchange</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html onchange attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">accesskey</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">Set the html accesskey attribute on rendered html element</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tooltip</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top"></td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">Set the tooltip of this particular component</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">tooltipConfig</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top"></td>
<!-- Type -->
<td align="left" valign="top">String</td>
<!-- Description -->
<td align="left" valign="top">Set the tooltip configuration</td>
</tr>
<tr>
<!-- Attribute name -->
<td align="left" valign="top">id</td>
<!-- Required -->
<td align="left" valign="top">false</td>
<!-- Default -->
<td align="left" valign="top">&nbsp;</td>
<!-- Type -->
<td align="left" valign="top">Object/String</td>
<!-- Description -->
<td align="left" valign="top">id for referencing element. For UI and form tags it will be used as HTML id attribute</td>
</tr>
</table>
<!-- END SNIPPET: tagattributes -->
</p>
<p>
<center><a href="index.html">Back to Taglib Index</a></center>
</p>
</body>
</html>