Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h3>Generated Object</h3>

<p>A JTabbedPane</p>

<h3>Value Argument</h3>

<p>The tabbedPane() node accepts no value argument.</p>

<h3>Attributes</h3>

<p>In addition to <a class="confluence-link" href="/display/GROOVY/SwingBuilder.JComponent" data-linked-resource-id="24576133" data-linked-resource-type="page" data-linked-resource-default-alias="SwingBuilder.JComponent" data-base-url="http://docs.codehaus.org">JComponent</a> attributes, tabbedPane supports these additional attributes:</p>
<ul>
	<li><strong>model</strong> &lt;SingleSelectionModel&gt; The model that tracks the tab selection.  not normally set by the end user.</li>
	<li><strong>tabPlacement</strong> &lt;int&gt; One of JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT, indicates where the tabs should be palced.</li>
	<li><strong>tabLayoutPolicy</strong> &lt;int&gt; One of JTabbedPane.WRAP_TAB_LAYOUT or JTabbedPane.SCROLL_TAB_LAYOUT.  Determines the behavior of the tabs when there are too many for one line.  Either multiple lines, or a single line with scroll controls (respectively)</li>
	<li><strong>selectedIndex</strong> &lt;int&gt; The tab index to be selected initially.  Do not combine with selectedComponent</li>
	<li><strong>selectedComponent</strong> &lt;Component&gt; The tab representing the component to be selected initally.  Do not combine with selectedIndex.</li>
</ul>

<h3>Content</h3>

<p>All immediate children of the JTabbedPane that are Components are added to the tabbed pane as tabs.  In addition, these children also can have the following attributes, which apply to the tab representiong those components</p>
<ul>
	<li><strong>title</strong> &lt;String&gt; The text title on the tab.  If this is missing the name property of the component is used (which defaults to an empty string)</li>
	<li><strong>tabIcon</strong> &lt;Icon&gt; The icon to be used on the tab, usually to the left of the text.</li>
	<li><strong>tabDisabledIcon</strong> &lt;Icon&gt; The icon to be displayed when the tab is disabled.  If tabIcon: is specified but tabDisabledIcon isn't then a disable icon will be automatically generated base on the Look and Feel.</li>
	<li><strong>tabToolTip</strong> &lt;String&gt; The toolTip to be displayed when the mouse is hovering over the tab.  (note that this is different than the component in the tab, use toolTip: for the component itself)</li>
	<li><strong>tabBackground</strong> &lt;Color&gt; The background color of the tab.  If this isn't specified a Look and Feel dependent value will be provided.  The Look and Feel may ignore this (Windows Vista does)</li>
	<li><strong>tabForeground</strong> &lt;Color&gt; The foreground text color of the tab.  If this isn't specified a Look and Feel dependent value will be provided.   The Look and Feel may ignore this (Windows Vista does)</li>
	<li><strong>tabEnabled</strong> &lt;booelan&gt; A flag to indicate whether or not this tab should be considered activated and accessible.</li>
	<li><strong>tabMnemonic</strong> &lt;int or String or char&gt; The mnemonic of the tab to be used for keyboard navigation.  Do not combine with tabDisplayedMnemonicIndex unless the characters match up.  Character must be in title/upper case</li>
	<li><strong>tabDispalyedMnemonicIndex</strong> &lt;int&gt; The character index in the title to use for the mnemonic.  Useful when a more prominent character should be used, like &quot;Stop Operation&quot;, a mnemonic of O would ordinarily underline the 'o' in Stop.</li>
</ul>

<h3>Examples</h3>

<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
tabbedPane(tabPlacement: JTabbedPane.LEFT) {
  label('One', title:'One', tabToolTip:'Uno!')
  label('Green', title:'Green', tabBackground:java.awt.Color.GREEN)
  label('Stop Operation', title:'Stop Operation', tabMnemonic:'O')
  label('Stop Operation', title:'Stop Operation', tabDisplayedMnemonicIndex:5)
}
</pre></td></tr></table>

<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
   tabbedPane() {
      panel(name:'One') {
            label('One')
      }
      panel(name:'Two') {
            label('Two')
      }
    }
</pre></td></tr></table>