- *-scroll-tab-layout
- *-wrap-tab-layout
- ->j-tabbed-pane
- add
- add-change-listener
- add-tab
- enabled-at?
- get-accessible-context
- get-background-at
- get-bounds-at
- get-change-listeners
- get-component-at
- get-disabled-icon-at
- get-displayed-mnemonic-index-at
- get-foreground-at
- get-icon-at
- get-mnemonic-at
- get-model
- get-selected-component
- get-selected-index
- get-tab-component-at
- get-tab-count
- get-tab-layout-policy
- get-tab-placement
- get-tab-run-count
- get-title-at
- get-tool-tip-text
- get-tool-tip-text-at
- get-ui
- get-ui-class-id
- index-at-location
- index-of-component
- index-of-tab
- index-of-tab-component
- insert-tab
- remove
- remove-all
- remove-change-listener
- remove-tab-at
- set-background-at
- set-component-at
- set-disabled-icon-at
- set-displayed-mnemonic-index-at
- set-enabled-at
- set-foreground-at
- set-icon-at
- set-mnemonic-at
- set-model
- set-selected-component
- set-selected-index
- set-tab-component-at
- set-tab-layout-policy
- set-tab-placement
- set-title-at
- set-tool-tip-text-at
- set-ui
- update-ui
javax.swing.JTabbedPane
A component that lets the user switch between a group of components by clicking on a tab with a given title and/or icon. For examples and information on using tabbed panes see How to Use Tabbed Panes, a section in The Java Tutorial.
Tabs/components are added to a TabbedPane object by using the addTab and insertTab methods. A tab is represented by an index corresponding to the position it was added in, where the first tab has an index equal to 0 and the last tab has an index equal to the tab count minus 1.
The TabbedPane uses a SingleSelectionModel to represent the set of tab indices and the currently selected index. If the tab count is greater than 0, then there will always be a selected index, which by default will be initialized to the first tab. If the tab count is 0, then the selected index will be -1.
The tab title can be rendered by a Component. For example, the following produce similar results:
// In this case the look and feel renders the title for the tab. tabbedPane.addTab("Tab", myComponent); // In this case the custom component is responsible for rendering the // title of the tab. tabbedPane.addTab(null, myComponent); tabbedPane.setTabComponentAt(0, new JLabel("Tab")); The latter is typically used when you want a more complex user interaction that requires custom components on the tab. For example, you could provide a custom component that animates or one that has widgets for closing the tab.
If you specify a component for a tab, the JTabbedPane will not render any text or icon you have specified for the tab.
Note: Do not use setVisible directly on a tab component to make it visible, use setSelectedComponent or setSelectedIndex methods instead.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.
A component that lets the user switch between a group of components by
clicking on a tab with a given title and/or icon.
For examples and information on using tabbed panes see
How to Use Tabbed Panes,
a section in The Java Tutorial.
Tabs/components are added to a TabbedPane object by using the
addTab and insertTab methods.
A tab is represented by an index corresponding
to the position it was added in, where the first tab has an index equal to 0
and the last tab has an index equal to the tab count minus 1.
The TabbedPane uses a SingleSelectionModel
to represent the set
of tab indices and the currently selected index. If the tab count
is greater than 0, then there will always be a selected index, which
by default will be initialized to the first tab. If the tab count is
0, then the selected index will be -1.
The tab title can be rendered by a Component.
For example, the following produce similar results:
// In this case the look and feel renders the title for the tab.
tabbedPane.addTab("Tab", myComponent);
// In this case the custom component is responsible for rendering the
// title of the tab.
tabbedPane.addTab(null, myComponent);
tabbedPane.setTabComponentAt(0, new JLabel("Tab"));
The latter is typically used when you want a more complex user interaction
that requires custom components on the tab. For example, you could
provide a custom component that animates or one that has widgets for
closing the tab.
If you specify a component for a tab, the JTabbedPane
will not render any text or icon you have specified for the tab.
Note:
Do not use setVisible directly on a tab component to make it visible,
use setSelectedComponent or setSelectedIndex methods instead.
Warning: Swing is not thread safe. For more
information see Swing's Threading
Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans™
has been added to the java.beans package.
Please see XMLEncoder.*-scroll-tab-layoutclj
Static Constant.
Tab layout policy for providing a subset of available tabs when all the tabs will not fit within a single run. If all the tabs do not fit within a single run the look and feel will provide a way to navigate to hidden tabs.
type: int
Static Constant. Tab layout policy for providing a subset of available tabs when all the tabs will not fit within a single run. If all the tabs do not fit within a single run the look and feel will provide a way to navigate to hidden tabs. type: int
*-wrap-tab-layoutclj
Static Constant.
The tab layout policy for wrapping tabs in multiple runs when all tabs will not fit within a single run.
type: int
Static Constant. The tab layout policy for wrapping tabs in multiple runs when all tabs will not fit within a single run. type: int
->j-tabbed-paneclj
(->j-tabbed-pane)(->j-tabbed-pane tab-placement)(->j-tabbed-pane tab-placement tab-layout-policy)Constructor.
Creates an empty TabbedPane with the specified tab placement and tab layout policy. Tab placement may be either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT. Tab layout policy may be either: JTabbedPane.WRAP_TAB_LAYOUT or JTabbedPane.SCROLL_TAB_LAYOUT.
tab-placement - the placement for the tabs relative to the content - int
tab-layout-policy - the policy for laying out tabs when all tabs will not fit on one run - int
throws: java.lang.IllegalArgumentException - if tab placement or tab layout policy are not one of the above supported values
Constructor. Creates an empty TabbedPane with the specified tab placement and tab layout policy. Tab placement may be either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT. Tab layout policy may be either: JTabbedPane.WRAP_TAB_LAYOUT or JTabbedPane.SCROLL_TAB_LAYOUT. tab-placement - the placement for the tabs relative to the content - `int` tab-layout-policy - the policy for laying out tabs when all tabs will not fit on one run - `int` throws: java.lang.IllegalArgumentException - if tab placement or tab layout policy are not one of the above supported values
addclj
(add this component)(add this title component)(add this component constraints index)Adds a component at the specified tab index. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab.
component - the component to be displayed when this tab is clicked - java.awt.Component
constraints - the object to be displayed in the tab - java.lang.Object
index - the position to insert this new tab - int
Adds a component at the specified tab index. If constraints is a String or an Icon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for insertTab. component - the component to be displayed when this tab is clicked - `java.awt.Component` constraints - the object to be displayed in the tab - `java.lang.Object` index - the position to insert this new tab - `int`
add-change-listenerclj
(add-change-listener this l)Adds a ChangeListener to this tabbedpane.
l - the ChangeListener to add - javax.swing.event.ChangeListener
Adds a ChangeListener to this tabbedpane. l - the ChangeListener to add - `javax.swing.event.ChangeListener`
add-tabclj
(add-tab this title component)(add-tab this title icon component)(add-tab this title icon component tip)Adds a component and tip represented by a title and/or icon, either of which can be null. Cover method for insertTab.
title - the title to be displayed in this tab - java.lang.String
icon - the icon to be displayed in this tab - javax.swing.Icon
component - the component to be displayed when this tab is clicked - java.awt.Component
tip - the tooltip to be displayed for this tab - java.lang.String
Adds a component and tip represented by a title and/or icon, either of which can be null. Cover method for insertTab. title - the title to be displayed in this tab - `java.lang.String` icon - the icon to be displayed in this tab - `javax.swing.Icon` component - the component to be displayed when this tab is clicked - `java.awt.Component` tip - the tooltip to be displayed for this tab - `java.lang.String`
enabled-at?clj
(enabled-at? this index)Returns whether or not the tab at index is currently enabled.
index - the index of the item being queried - int
returns: true if the tab at index is enabled;
false otherwise - boolean
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns whether or not the tab at index is
currently enabled.
index - the index of the item being queried - `int`
returns: true if the tab at index is enabled;
false otherwise - `boolean`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)get-accessible-contextclj
(get-accessible-context this)Gets the AccessibleContext associated with this JTabbedPane. For tabbed panes, the AccessibleContext takes the form of an AccessibleJTabbedPane. A new AccessibleJTabbedPane instance is created if necessary.
returns: an AccessibleJTabbedPane that serves as the
AccessibleContext of this JTabbedPane - javax.accessibility.AccessibleContext
Gets the AccessibleContext associated with this JTabbedPane.
For tabbed panes, the AccessibleContext takes the form of an
AccessibleJTabbedPane.
A new AccessibleJTabbedPane instance is created if necessary.
returns: an AccessibleJTabbedPane that serves as the
AccessibleContext of this JTabbedPane - `javax.accessibility.AccessibleContext`get-background-atclj
(get-background-at this index)Returns the tab background color at index.
index - the index of the item being queried - int
returns: the Color of the tab background at
index - java.awt.Color
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab background color at index.
index - the index of the item being queried - `int`
returns: the Color of the tab background at
index - `java.awt.Color`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)get-bounds-atclj
(get-bounds-at this index)Returns the tab bounds at index. If the tab at this index is not currently visible in the UI, then returns null. If there is no UI set on this tabbedpane, then returns null.
index - the index to be queried - int
returns: a Rectangle containing the tab bounds at
index, or null if tab at
index is not currently visible in the UI,
or if there is no UI set on this tabbedpane - java.awt.Rectangle
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab bounds at index. If the tab at
this index is not currently visible in the UI, then returns
null.
If there is no UI set on this tabbedpane,
then returns null.
index - the index to be queried - `int`
returns: a Rectangle containing the tab bounds at
index, or null if tab at
index is not currently visible in the UI,
or if there is no UI set on this tabbedpane - `java.awt.Rectangle`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)get-change-listenersclj
(get-change-listeners this)Returns an array of all the ChangeListeners added to this JTabbedPane with addChangeListener.
returns: all of the ChangeListeners added or an empty
array if no listeners have been added - javax.swing.event.ChangeListener[]
Returns an array of all the ChangeListeners added
to this JTabbedPane with addChangeListener.
returns: all of the ChangeListeners added or an empty
array if no listeners have been added - `javax.swing.event.ChangeListener[]`get-component-atclj
(get-component-at this index)Returns the component at index.
index - the index of the item being queried - int
returns: the Component at index - java.awt.Component
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the component at index. index - the index of the item being queried - `int` returns: the Component at index - `java.awt.Component` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
get-disabled-icon-atclj
(get-disabled-icon-at this index)Returns the tab disabled icon at index. If the tab disabled icon doesn't exist at index this will forward the call to the look and feel to construct an appropriate disabled Icon from the corresponding enabled Icon. Some look and feels might not render the disabled Icon, in which case it won't be created.
index - the index of the item being queried - int
returns: the icon at index - javax.swing.Icon
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab disabled icon at index. If the tab disabled icon doesn't exist at index this will forward the call to the look and feel to construct an appropriate disabled Icon from the corresponding enabled Icon. Some look and feels might not render the disabled Icon, in which case it won't be created. index - the index of the item being queried - `int` returns: the icon at index - `javax.swing.Icon` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
get-displayed-mnemonic-index-atclj
(get-displayed-mnemonic-index-at this tab-index)Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.
tab-index - the index of the tab that the mnemonic refers to - int
returns: index representing mnemonic character if one exists;
otherwise returns -1 - int
throws: java.lang.IndexOutOfBoundsException - if index is out of range (tabIndex < 0 || tabIndex >= tab count)
Returns the character, as an index, that the look and feel should
provide decoration for as representing the mnemonic character.
tab-index - the index of the tab that the mnemonic refers to - `int`
returns: index representing mnemonic character if one exists;
otherwise returns -1 - `int`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (tabIndex < 0 || tabIndex >= tab count)get-foreground-atclj
(get-foreground-at this index)Returns the tab foreground color at index.
index - the index of the item being queried - int
returns: the Color of the tab foreground at
index - java.awt.Color
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab foreground color at index.
index - the index of the item being queried - `int`
returns: the Color of the tab foreground at
index - `java.awt.Color`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)get-icon-atclj
(get-icon-at this index)Returns the tab icon at index.
index - the index of the item being queried - int
returns: the icon at index - javax.swing.Icon
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab icon at index. index - the index of the item being queried - `int` returns: the icon at index - `javax.swing.Icon` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
get-mnemonic-atclj
(get-mnemonic-at this tab-index)Returns the keyboard mnemonic for accessing the specified tab. The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate the specified tab.
tab-index - the index of the tab that the mnemonic refers to - int
returns: the key code which represents the mnemonic;
-1 if a mnemonic is not specified for the tab - int
throws: java.lang.IndexOutOfBoundsException - if index is out of range (tabIndex < 0 || tabIndex >= tab count)
Returns the keyboard mnemonic for accessing the specified tab.
The mnemonic is the key which when combined with the look and feel's
mouseless modifier (usually Alt) will activate the specified
tab.
tab-index - the index of the tab that the mnemonic refers to - `int`
returns: the key code which represents the mnemonic;
-1 if a mnemonic is not specified for the tab - `int`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (tabIndex < 0 || tabIndex >= tab count)get-modelclj
(get-model this)Returns the model associated with this tabbedpane.
returns: javax.swing.SingleSelectionModel
Returns the model associated with this tabbedpane. returns: `javax.swing.SingleSelectionModel`
get-selected-componentclj
(get-selected-component this)Returns the currently selected component for this tabbedpane. Returns null if there is no currently selected tab.
returns: the component corresponding to the selected tab - java.awt.Component
Returns the currently selected component for this tabbedpane. Returns null if there is no currently selected tab. returns: the component corresponding to the selected tab - `java.awt.Component`
get-selected-indexclj
(get-selected-index this)Returns the currently selected index for this tabbedpane. Returns -1 if there is no currently selected tab.
returns: the index of the selected tab - int
Returns the currently selected index for this tabbedpane. Returns -1 if there is no currently selected tab. returns: the index of the selected tab - `int`
get-tab-component-atclj
(get-tab-component-at this index)Returns the tab component at index.
index - the index of the item being queried - int
returns: the tab component at index - java.awt.Component
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab component at index. index - the index of the item being queried - `int` returns: the tab component at index - `java.awt.Component` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
get-tab-countclj
(get-tab-count this)Returns the number of tabs in this tabbedpane.
returns: an integer specifying the number of tabbed pages - int
Returns the number of tabs in this tabbedpane. returns: an integer specifying the number of tabbed pages - `int`
get-tab-layout-policyclj
(get-tab-layout-policy this)Returns the policy used by the tabbedpane to layout the tabs when all the tabs will not fit within a single run.
returns: int
Returns the policy used by the tabbedpane to layout the tabs when all the tabs will not fit within a single run. returns: `int`
get-tab-placementclj
(get-tab-placement this)Returns the placement of the tabs for this tabbedpane.
returns: int
Returns the placement of the tabs for this tabbedpane. returns: `int`
get-tab-run-countclj
(get-tab-run-count this)Returns the number of tab runs currently used to display the tabs.
returns: an integer giving the number of rows if the
tabPlacement
is TOP or BOTTOM
and the number of columns if
tabPlacement
is LEFT or RIGHT,
or 0 if there is no UI set on this tabbedpane - int
Returns the number of tab runs currently used to display
the tabs.
returns: an integer giving the number of rows if the
tabPlacement
is TOP or BOTTOM
and the number of columns if
tabPlacement
is LEFT or RIGHT,
or 0 if there is no UI set on this tabbedpane - `int`get-title-atclj
(get-title-at this index)Returns the tab title at index.
index - the index of the item being queried - int
returns: the title at index - java.lang.String
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab title at index. index - the index of the item being queried - `int` returns: the title at index - `java.lang.String` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
get-tool-tip-textclj
(get-tool-tip-text this event)Returns the tooltip text for the component determined by the mouse event location.
event - the MouseEvent that tells where the cursor is lingering - java.awt.event.MouseEvent
returns: the String containing the tooltip text - java.lang.String
Returns the tooltip text for the component determined by the mouse event location. event - the MouseEvent that tells where the cursor is lingering - `java.awt.event.MouseEvent` returns: the String containing the tooltip text - `java.lang.String`
get-tool-tip-text-atclj
(get-tool-tip-text-at this index)Returns the tab tooltip text at index.
index - the index of the item being queried - int
returns: a string containing the tool tip text at index - java.lang.String
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Returns the tab tooltip text at index. index - the index of the item being queried - `int` returns: a string containing the tool tip text at index - `java.lang.String` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
get-uiclj
(get-ui this)Returns the UI object which implements the L&F for this component.
returns: a TabbedPaneUI object - javax.swing.plaf.TabbedPaneUI
Returns the UI object which implements the L&F for this component. returns: a TabbedPaneUI object - `javax.swing.plaf.TabbedPaneUI`
get-ui-class-idclj
(get-ui-class-id this)Returns the name of the UI class that implements the L&F for this component.
returns: the string "TabbedPaneUI" - java.lang.String
Returns the name of the UI class that implements the L&F for this component. returns: the string "TabbedPaneUI" - `java.lang.String`
index-at-locationclj
(index-at-location this x y)Returns the tab index corresponding to the tab whose bounds intersect the specified location. Returns -1 if no tab intersects the location.
x - the x location relative to this tabbedpane - int
y - the y location relative to this tabbedpane - int
returns: the tab index which intersects the location, or
-1 if no tab intersects the location - int
Returns the tab index corresponding to the tab whose bounds
intersect the specified location. Returns -1 if no tab
intersects the location.
x - the x location relative to this tabbedpane - `int`
y - the y location relative to this tabbedpane - `int`
returns: the tab index which intersects the location, or
-1 if no tab intersects the location - `int`index-of-componentclj
(index-of-component this component)Returns the index of the tab for the specified component. Returns -1 if there is no tab for this component.
component - the component for the tab - java.awt.Component
returns: the first tab which matches this component, or -1
if there is no tab for this component - int
Returns the index of the tab for the specified component.
Returns -1 if there is no tab for this component.
component - the component for the tab - `java.awt.Component`
returns: the first tab which matches this component, or -1
if there is no tab for this component - `int`index-of-tabclj
(index-of-tab this title)Returns the first tab index with a given title, or -1 if no tab has this title.
title - the title for the tab - java.lang.String
returns: the first tab index which matches title, or
-1 if no tab has this title - int
Returns the first tab index with a given title, or
-1 if no tab has this title.
title - the title for the tab - `java.lang.String`
returns: the first tab index which matches title, or
-1 if no tab has this title - `int`index-of-tab-componentclj
(index-of-tab-component this tab-component)Returns the index of the tab for the specified tab component. Returns -1 if there is no tab for this tab component.
tab-component - the tab component for the tab - java.awt.Component
returns: the first tab which matches this tab component, or -1
if there is no tab for this tab component - int
Returns the index of the tab for the specified tab component.
Returns -1 if there is no tab for this tab component.
tab-component - the tab component for the tab - `java.awt.Component`
returns: the first tab which matches this tab component, or -1
if there is no tab for this tab component - `int`insert-tabclj
(insert-tab this title icon component tip index)Inserts a new tab for the given component, at the given index, represented by the given title and/or icon, either of which may be null.
title - the title to be displayed on the tab - java.lang.String
icon - the icon to be displayed on the tab - javax.swing.Icon
component - the component to be displayed when this tab is clicked. - java.awt.Component
tip - the tooltip to be displayed for this tab - java.lang.String
index - the position to insert this new tab (> 0 and <= getTabCount()) - int
throws: java.lang.IndexOutOfBoundsException - if the index is out of range (< 0 or > getTabCount())
Inserts a new tab for the given component, at the given index, represented by the given title and/or icon, either of which may be null. title - the title to be displayed on the tab - `java.lang.String` icon - the icon to be displayed on the tab - `javax.swing.Icon` component - the component to be displayed when this tab is clicked. - `java.awt.Component` tip - the tooltip to be displayed for this tab - `java.lang.String` index - the position to insert this new tab (> 0 and <= getTabCount()) - `int` throws: java.lang.IndexOutOfBoundsException - if the index is out of range (< 0 or > getTabCount())
removeclj
(remove this component)Removes the specified Component from the JTabbedPane. The method does nothing if the component is null.
component - the component to remove from the tabbedpane - java.awt.Component
Removes the specified Component from the JTabbedPane. The method does nothing if the component is null. component - the component to remove from the tabbedpane - `java.awt.Component`
remove-allclj
(remove-all this)Removes all the tabs and their corresponding components from the tabbedpane.
Removes all the tabs and their corresponding components from the tabbedpane.
remove-change-listenerclj
(remove-change-listener this l)Removes a ChangeListener from this tabbedpane.
l - the ChangeListener to remove - javax.swing.event.ChangeListener
Removes a ChangeListener from this tabbedpane. l - the ChangeListener to remove - `javax.swing.event.ChangeListener`
remove-tab-atclj
(remove-tab-at this index)Removes the tab at index. After the component associated with index is removed, its visibility is reset to true to ensure it will be visible if added to other containers.
index - the index of the tab to be removed - int
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Removes the tab at index. After the component associated with index is removed, its visibility is reset to true to ensure it will be visible if added to other containers. index - the index of the tab to be removed - `int` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-background-atclj
(set-background-at this index background)Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane. An internal exception is raised if there is no tab at that index.
It is up to the look and feel to honor this property, some may choose to ignore it.
index - the tab index where the background should be set - int
background - the color to be displayed in the tab's background - java.awt.Color
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the background color at index to background which can be null, in which case the tab's background color will default to the background color of the tabbedpane. An internal exception is raised if there is no tab at that index. It is up to the look and feel to honor this property, some may choose to ignore it. index - the tab index where the background should be set - `int` background - the color to be displayed in the tab's background - `java.awt.Color` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-component-atclj
(set-component-at this index component)Sets the component at index to component. An internal exception is raised if there is no tab at that index.
index - the tab index where this component is being placed - int
component - the component for the tab - java.awt.Component
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the component at index to component. An internal exception is raised if there is no tab at that index. index - the tab index where this component is being placed - `int` component - the component for the tab - `java.awt.Component` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-disabled-icon-atclj
(set-disabled-icon-at this index disabled-icon)Sets the disabled icon at index to icon which can be null. An internal exception is raised if there is no tab at that index.
index - the tab index where the disabled icon should be set - int
disabled-icon - the icon to be displayed in the tab when disabled - javax.swing.Icon
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the disabled icon at index to icon which can be null. An internal exception is raised if there is no tab at that index. index - the tab index where the disabled icon should be set - `int` disabled-icon - the icon to be displayed in the tab when disabled - `javax.swing.Icon` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-displayed-mnemonic-index-atclj
(set-displayed-mnemonic-index-at this tab-index mnemonic-index)Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic. Not all look and feels may support this. A value of -1 indicates either there is no mnemonic for this tab, or you do not wish the mnemonic to be displayed for this tab.
The value of this is updated as the properties relating to the mnemonic change (such as the mnemonic itself, the text...). You should only ever have to call this if you do not wish the default character to be underlined. For example, if the text at tab index 3 was 'Apple Price', with a mnemonic of 'p', and you wanted the 'P' to be decorated, as 'Apple Price', you would have to invoke setDisplayedMnemonicIndex(3, 6) after invoking setMnemonicAt(3, KeyEvent.VK_P). Note that it is the programmer's responsibility to ensure that each tab has a unique mnemonic or unpredictable results may occur.
tab-index - the index of the tab that the mnemonic refers to - int
mnemonic-index - index into the String to underline - int
throws: java.lang.IndexOutOfBoundsException - if tabIndex is out of range (tabIndex < 0 || tabIndex >= tab count)
Provides a hint to the look and feel as to which character in the text should be decorated to represent the mnemonic. Not all look and feels may support this. A value of -1 indicates either there is no mnemonic for this tab, or you do not wish the mnemonic to be displayed for this tab. The value of this is updated as the properties relating to the mnemonic change (such as the mnemonic itself, the text...). You should only ever have to call this if you do not wish the default character to be underlined. For example, if the text at tab index 3 was 'Apple Price', with a mnemonic of 'p', and you wanted the 'P' to be decorated, as 'Apple Price', you would have to invoke setDisplayedMnemonicIndex(3, 6) after invoking setMnemonicAt(3, KeyEvent.VK_P). Note that it is the programmer's responsibility to ensure that each tab has a unique mnemonic or unpredictable results may occur. tab-index - the index of the tab that the mnemonic refers to - `int` mnemonic-index - index into the String to underline - `int` throws: java.lang.IndexOutOfBoundsException - if tabIndex is out of range (tabIndex < 0 || tabIndex >= tab count)
set-enabled-atclj
(set-enabled-at this index enabled)Sets whether or not the tab at index is enabled. An internal exception is raised if there is no tab at that index.
index - the tab index which should be enabled/disabled - int
enabled - whether or not the tab should be enabled - boolean
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets whether or not the tab at index is enabled. An internal exception is raised if there is no tab at that index. index - the tab index which should be enabled/disabled - `int` enabled - whether or not the tab should be enabled - `boolean` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-foreground-atclj
(set-foreground-at this index foreground)Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane. An internal exception is raised if there is no tab at that index.
It is up to the look and feel to honor this property, some may choose to ignore it.
index - the tab index where the foreground should be set - int
foreground - the color to be displayed as the tab's foreground - java.awt.Color
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the foreground color at index to foreground which can be null, in which case the tab's foreground color will default to the foreground color of this tabbedpane. An internal exception is raised if there is no tab at that index. It is up to the look and feel to honor this property, some may choose to ignore it. index - the tab index where the foreground should be set - `int` foreground - the color to be displayed as the tab's foreground - `java.awt.Color` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-icon-atclj
(set-icon-at this index icon)Sets the icon at index to icon which can be null. This does not set disabled icon at icon. If the new Icon is different than the current Icon and disabled icon is not explicitly set, the LookAndFeel will be asked to generate a disabled Icon. To explicitly set disabled icon, use setDisableIconAt(). The icon is not shown if a tab component for this tab was specified. An internal exception is raised if there is no tab at that index.
index - the tab index where the icon should be set - int
icon - the icon to be displayed in the tab - javax.swing.Icon
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the icon at index to icon which can be null. This does not set disabled icon at icon. If the new Icon is different than the current Icon and disabled icon is not explicitly set, the LookAndFeel will be asked to generate a disabled Icon. To explicitly set disabled icon, use setDisableIconAt(). The icon is not shown if a tab component for this tab was specified. An internal exception is raised if there is no tab at that index. index - the tab index where the icon should be set - `int` icon - the icon to be displayed in the tab - `javax.swing.Icon` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-mnemonic-atclj
(set-mnemonic-at this tab-index mnemonic)Sets the keyboard mnemonic for accessing the specified tab. The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate the specified tab.
A mnemonic must correspond to a single key on the keyboard and should be specified using one of the VK_XXX keycodes defined in java.awt.event.KeyEvent or one of the extended keycodes obtained through java.awt.event.KeyEvent.getExtendedKeyCodeForChar. Mnemonics are case-insensitive, therefore a key event with the corresponding keycode would cause the button to be activated whether or not the Shift modifier was pressed.
This will update the displayed mnemonic property for the specified tab.
tab-index - the index of the tab that the mnemonic refers to - int
mnemonic - the key code which represents the mnemonic - int
throws: java.lang.IndexOutOfBoundsException - if tabIndex is out of range (tabIndex < 0 || tabIndex >= tab count)
Sets the keyboard mnemonic for accessing the specified tab. The mnemonic is the key which when combined with the look and feel's mouseless modifier (usually Alt) will activate the specified tab. A mnemonic must correspond to a single key on the keyboard and should be specified using one of the VK_XXX keycodes defined in java.awt.event.KeyEvent or one of the extended keycodes obtained through java.awt.event.KeyEvent.getExtendedKeyCodeForChar. Mnemonics are case-insensitive, therefore a key event with the corresponding keycode would cause the button to be activated whether or not the Shift modifier was pressed. This will update the displayed mnemonic property for the specified tab. tab-index - the index of the tab that the mnemonic refers to - `int` mnemonic - the key code which represents the mnemonic - `int` throws: java.lang.IndexOutOfBoundsException - if tabIndex is out of range (tabIndex < 0 || tabIndex >= tab count)
set-modelclj
(set-model this model)Sets the model to be used with this tabbedpane.
model - the model to be used - javax.swing.SingleSelectionModel
Sets the model to be used with this tabbedpane. model - the model to be used - `javax.swing.SingleSelectionModel`
set-selected-componentclj
(set-selected-component this c)Sets the selected component for this tabbedpane. This will automatically set the selectedIndex to the index corresponding to the specified component.
c - java.awt.Component
throws: java.lang.IllegalArgumentException - if component not found in tabbed pane
Sets the selected component for this tabbedpane. This will automatically set the selectedIndex to the index corresponding to the specified component. c - `java.awt.Component` throws: java.lang.IllegalArgumentException - if component not found in tabbed pane
set-selected-indexclj
(set-selected-index this index)Sets the selected index for this tabbedpane. The index must be a valid tab index or -1, which indicates that no tab should be selected (can also be used when there are no tabs in the tabbedpane). If a -1 value is specified when the tabbedpane contains one or more tabs, then the results will be implementation defined.
index - the index to be selected - int
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < -1 || index >= tab count)
Sets the selected index for this tabbedpane. The index must be a valid tab index or -1, which indicates that no tab should be selected (can also be used when there are no tabs in the tabbedpane). If a -1 value is specified when the tabbedpane contains one or more tabs, then the results will be implementation defined. index - the index to be selected - `int` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < -1 || index >= tab count)
set-tab-component-atclj
(set-tab-component-at this index component)Sets the component that is responsible for rendering the title for the specified tab. A null value means JTabbedPane will render the title and/or icon for the specified tab. A non-null value means the component will render the title and JTabbedPane will not render the title and/or icon.
Note: The component must not be one that the developer has already added to the tabbed pane.
index - the tab index where the component should be set - int
component - the component to render the title for the specified tab - java.awt.Component
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the component that is responsible for rendering the
title for the specified tab. A null value means
JTabbedPane will render the title and/or icon for
the specified tab. A non-null value means the component will
render the title and JTabbedPane will not render
the title and/or icon.
Note: The component must not be one that the developer has
already added to the tabbed pane.
index - the tab index where the component should be set - `int`
component - the component to render the title for the specified tab - `java.awt.Component`
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)set-tab-layout-policyclj
(set-tab-layout-policy this tab-layout-policy)Sets the policy which the tabbedpane will use in laying out the tabs when all the tabs will not fit within a single run. Possible values are:
JTabbedPane.WRAP_TAB_LAYOUT JTabbedPane.SCROLL_TAB_LAYOUT
The default value, if not set by the UI, is JTabbedPane.WRAP_TAB_LAYOUT.
Some look and feels might only support a subset of the possible layout policies, in which case the value of this property may be ignored.
tab-layout-policy - the policy used to layout the tabs - int
throws: java.lang.IllegalArgumentException - if layoutPolicy value isn't one of the above valid values
Sets the policy which the tabbedpane will use in laying out the tabs when all the tabs will not fit within a single run. Possible values are: JTabbedPane.WRAP_TAB_LAYOUT JTabbedPane.SCROLL_TAB_LAYOUT The default value, if not set by the UI, is JTabbedPane.WRAP_TAB_LAYOUT. Some look and feels might only support a subset of the possible layout policies, in which case the value of this property may be ignored. tab-layout-policy - the policy used to layout the tabs - `int` throws: java.lang.IllegalArgumentException - if layoutPolicy value isn't one of the above valid values
set-tab-placementclj
(set-tab-placement this tab-placement)Sets the tab placement for this tabbedpane. Possible values are: JTabbedPane.TOP JTabbedPane.BOTTOM JTabbedPane.LEFT JTabbedPane.RIGHT
The default value, if not set, is SwingConstants.TOP.
tab-placement - the placement for the tabs relative to the content - int
throws: java.lang.IllegalArgumentException - if tab placement value isn't one of the above valid values
Sets the tab placement for this tabbedpane. Possible values are: JTabbedPane.TOP JTabbedPane.BOTTOM JTabbedPane.LEFT JTabbedPane.RIGHT The default value, if not set, is SwingConstants.TOP. tab-placement - the placement for the tabs relative to the content - `int` throws: java.lang.IllegalArgumentException - if tab placement value isn't one of the above valid values
set-title-atclj
(set-title-at this index title)Sets the title at index to title which can be null. The title is not shown if a tab component for this tab was specified. An internal exception is raised if there is no tab at that index.
index - the tab index where the title should be set - int
title - the title to be displayed in the tab - java.lang.String
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the title at index to title which can be null. The title is not shown if a tab component for this tab was specified. An internal exception is raised if there is no tab at that index. index - the tab index where the title should be set - `int` title - the title to be displayed in the tab - `java.lang.String` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-tool-tip-text-atclj
(set-tool-tip-text-at this index tool-tip-text)Sets the tooltip text at index to toolTipText which can be null. An internal exception is raised if there is no tab at that index.
index - the tab index where the tooltip text should be set - int
tool-tip-text - the tooltip text to be displayed for the tab - java.lang.String
throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
Sets the tooltip text at index to toolTipText which can be null. An internal exception is raised if there is no tab at that index. index - the tab index where the tooltip text should be set - `int` tool-tip-text - the tooltip text to be displayed for the tab - `java.lang.String` throws: java.lang.IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
set-uiclj
(set-ui this ui)Sets the UI object which implements the L&F for this component.
ui - the new UI object - javax.swing.plaf.TabbedPaneUI
Sets the UI object which implements the L&F for this component. ui - the new UI object - `javax.swing.plaf.TabbedPaneUI`
update-uiclj
(update-ui this)Resets the UI property to a value from the current look and feel.
Resets the UI property to a value from the current look and feel.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close