ImageObserver
, MenuContainer
, Serializable
, Accessible
, SwingConstants
@JavaBean(defaultProperty="UI", description="A component which provides a tab folder metaphor for displaying one component from a set of components.") public class JTabbedPane extends JComponent implements Serializable, Accessible, SwingConstants
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
.
SingleSelectionModel
Modifier and Type | Class | Description |
---|---|---|
protected class |
JTabbedPane.AccessibleJTabbedPane |
This class implements accessibility support for the
JTabbedPane class. |
protected class |
JTabbedPane.ModelListener |
We pass
ModelChanged events along to the listeners with
the tabbedpane (instead of the model itself) as the event source. |
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Container.AccessibleAWTContainer
JComponent.AccessibleJComponent
Modifier and Type | Field | Description |
---|---|---|
protected ChangeEvent |
changeEvent |
Only one
ChangeEvent is needed per TabPane
instance since the
event's only (read-only) state is the source property. |
protected ChangeListener |
changeListener |
The
changeListener is the listener we add to the
model. |
protected SingleSelectionModel |
model |
The default selection model
|
static int |
SCROLL_TAB_LAYOUT |
Tab layout policy for providing a subset of available tabs when all
the tabs will not fit within a single run.
|
protected int |
tabPlacement |
Where the tabs are placed.
|
static int |
WRAP_TAB_LAYOUT |
The tab layout policy for wrapping tabs in multiple runs when all
tabs will not fit within a single run.
|
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
Constructor | Description |
---|---|
JTabbedPane() |
Creates an empty
TabbedPane with a default
tab placement of JTabbedPane.TOP . |
JTabbedPane(int tabPlacement) |
Creates an empty
TabbedPane with the specified tab placement
of either: JTabbedPane.TOP , JTabbedPane.BOTTOM ,
JTabbedPane.LEFT , or JTabbedPane.RIGHT . |
JTabbedPane(int tabPlacement,
int tabLayoutPolicy) |
Creates an empty
TabbedPane with the specified tab placement
and tab layout policy. |
Modifier and Type | Method | Description |
---|---|---|
Component |
add(Component component) |
Adds a
component with a tab title defaulting to
the name of the component which is the result of calling
component.getName . |
Component |
add(Component component,
int index) |
Adds a
component at the specified tab index with a tab
title defaulting to the name of the component. |
void |
add(Component component,
Object constraints) |
Adds a
component to the tabbed pane. |
void |
add(Component component,
Object constraints,
int index) |
Adds a
component at the specified tab index. |
Component |
add(String title,
Component component) |
Adds a
component with the specified tab title. |
void |
addChangeListener(ChangeListener l) |
Adds a
ChangeListener to this tabbedpane. |
void |
addTab(String title,
Component component) |
Adds a
component represented by a title
and no icon. |
void |
addTab(String title,
Icon icon,
Component component) |
Adds a
component represented by a title
and/or icon , either of which can be null . |
void |
addTab(String title,
Icon icon,
Component component,
String tip) |
Adds a
component and tip
represented by a title and/or icon ,
either of which can be null . |
protected ChangeListener |
createChangeListener() |
Subclasses that want to handle
ChangeEvents differently
can override this to return a subclass of ModelListener or
another ChangeListener implementation. |
protected void |
fireStateChanged() |
Sends a
ChangeEvent , with this JTabbedPane as the source,
to each registered listener. |
AccessibleContext |
getAccessibleContext() |
Gets the AccessibleContext associated with this JTabbedPane.
|
Color |
getBackgroundAt(int index) |
Returns the tab background color at
index . |
Rectangle |
getBoundsAt(int index) |
Returns the tab bounds at
index . |
ChangeListener[] |
getChangeListeners() |
Returns an array of all the
ChangeListener s added
to this JTabbedPane with addChangeListener . |
Component |
getComponentAt(int index) |
Returns the component at
index . |
Icon |
getDisabledIconAt(int index) |
Returns the tab disabled icon at
index . |
int |
getDisplayedMnemonicIndexAt(int tabIndex) |
Returns the character, as an index, that the look and feel should
provide decoration for as representing the mnemonic character.
|
Color |
getForegroundAt(int index) |
Returns the tab foreground color at
index . |
Icon |
getIconAt(int index) |
Returns the tab icon at
index . |
int |
getMnemonicAt(int tabIndex) |
Returns the keyboard mnemonic for accessing the specified tab.
|
SingleSelectionModel |
getModel() |
Returns the model associated with this tabbedpane.
|
Component |
getSelectedComponent() |
Returns the currently selected component for this tabbedpane.
|
int |
getSelectedIndex() |
Returns the currently selected index for this tabbedpane.
|
Component |
getTabComponentAt(int index) |
Returns the tab component at
index . |
int |
getTabCount() |
Returns the number of tabs in this
tabbedpane . |
int |
getTabLayoutPolicy() |
Returns the policy used by the tabbedpane to layout the tabs when all the
tabs will not fit within a single run.
|
int |
getTabPlacement() |
Returns the placement of the tabs for this tabbedpane.
|
int |
getTabRunCount() |
Returns the number of tab runs currently used to display
the tabs.
|
String |
getTitleAt(int index) |
Returns the tab title at
index . |
String |
getToolTipText(MouseEvent event) |
Returns the tooltip text for the component determined by the
mouse event location.
|
String |
getToolTipTextAt(int index) |
Returns the tab tooltip text at
index . |
TabbedPaneUI |
getUI() |
Returns the UI object which implements the L&F for this component.
|
String |
getUIClassID() |
Returns the name of the UI class that implements the
L&F for this component.
|
int |
indexAtLocation(int x,
int y) |
Returns the tab index corresponding to the tab whose bounds
intersect the specified location.
|
int |
indexOfComponent(Component component) |
Returns the index of the tab for the specified component.
|
int |
indexOfTab(String title) |
Returns the first tab index with a given
title , or
-1 if no tab has this title. |
int |
indexOfTab(Icon icon) |
Returns the first tab index with a given
icon ,
or -1 if no tab has this icon. |
int |
indexOfTabComponent(Component tabComponent) |
Returns the index of the tab for the specified tab component.
|
void |
insertTab(String title,
Icon icon,
Component component,
String tip,
int 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 . |
boolean |
isEnabledAt(int index) |
Returns whether or not the tab at
index is
currently enabled. |
protected String |
paramString() |
Returns a string representation of this
JTabbedPane . |
void |
remove(int index) |
Removes the tab and component which corresponds to the specified index.
|
void |
remove(Component component) |
Removes the specified
Component from the
JTabbedPane . |
void |
removeAll() |
Removes all the tabs and their corresponding components
from the
tabbedpane . |
void |
removeChangeListener(ChangeListener l) |
Removes a
ChangeListener from this tabbedpane. |
void |
removeTabAt(int index) |
Removes the tab at
index . |
void |
setBackgroundAt(int index,
Color 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 . |
void |
setComponentAt(int index,
Component component) |
Sets the component at
index to component . |
void |
setDisabledIconAt(int index,
Icon disabledIcon) |
Sets the disabled icon at
index to icon
which can be null . |
void |
setDisplayedMnemonicIndexAt(int tabIndex,
int mnemonicIndex) |
Provides a hint to the look and feel as to which character in the
text should be decorated to represent the mnemonic.
|
void |
setEnabledAt(int index,
boolean enabled) |
Sets whether or not the tab at
index is enabled. |
void |
setForegroundAt(int index,
Color 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 . |
void |
setIconAt(int index,
Icon icon) |
Sets the icon at
index to icon which can be
null . |
void |
setMnemonicAt(int tabIndex,
int mnemonic) |
Sets the keyboard mnemonic for accessing the specified tab.
|
void |
setModel(SingleSelectionModel model) |
Sets the model to be used with this tabbedpane.
|
void |
setSelectedComponent(Component c) |
Sets the selected component for this tabbedpane.
|
void |
setSelectedIndex(int index) |
Sets the selected index for this tabbedpane.
|
void |
setTabComponentAt(int index,
Component component) |
Sets the component that is responsible for rendering the
title for the specified tab.
|
void |
setTabLayoutPolicy(int tabLayoutPolicy) |
Sets the policy which the tabbedpane will use in laying out the tabs
when all the tabs will not fit within a single run.
|
void |
setTabPlacement(int tabPlacement) |
Sets the tab placement for this tabbedpane.
|
void |
setTitleAt(int index,
String title) |
Sets the title at
index to title which
can be null . |
void |
setToolTipTextAt(int index,
String toolTipText) |
Sets the tooltip text at
index to toolTipText
which can be null . |
void |
setUI(TabbedPaneUI ui) |
Sets the UI object which implements the L&F for this component.
|
void |
updateUI() |
Resets the UI property to a value from the current look and feel.
|
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
public static final int WRAP_TAB_LAYOUT
public static final int SCROLL_TAB_LAYOUT
protected int tabPlacement
setTabPlacement(int)
protected SingleSelectionModel model
protected ChangeListener changeListener
changeListener
is the listener we add to the
model.protected transient ChangeEvent changeEvent
ChangeEvent
is needed per TabPane
instance since the
event's only (read-only) state is the source property. The source
of events generated here is always "this".public JTabbedPane()
TabbedPane
with a default
tab placement of JTabbedPane.TOP
.public JTabbedPane(int tabPlacement)
TabbedPane
with the specified tab placement
of either: JTabbedPane.TOP
, JTabbedPane.BOTTOM
,
JTabbedPane.LEFT
, or JTabbedPane.RIGHT
.tabPlacement
- the placement for the tabs relative to the contentaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
public JTabbedPane(int tabPlacement, int tabLayoutPolicy)
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
.tabPlacement
- the placement for the tabs relative to the contenttabLayoutPolicy
- the policy for laying out tabs when all tabs will not fit on one runIllegalArgumentException
- if tab placement or tab layout policy are not
one of the above supported valuesaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
public TabbedPaneUI getUI()
getUI
in class JComponent
TabbedPaneUI
objectsetUI(javax.swing.plaf.TabbedPaneUI)
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the tabbedpane\'s LookAndFeel") public void setUI(TabbedPaneUI ui)
ui
- the new UI objectUIDefaults.getUI(javax.swing.JComponent)
public void updateUI()
updateUI
in class JComponent
JComponent.updateUI()
@BeanProperty(bound=false) public String getUIClassID()
getUIClassID
in class JComponent
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
protected ChangeListener createChangeListener()
ChangeEvents
differently
can override this to return a subclass of ModelListener
or
another ChangeListener
implementation.ChangeListener
fireStateChanged()
public void addChangeListener(ChangeListener l)
ChangeListener
to this tabbedpane.l
- the ChangeListener
to addfireStateChanged()
,
removeChangeListener(javax.swing.event.ChangeListener)
public void removeChangeListener(ChangeListener l)
ChangeListener
from this tabbedpane.l
- the ChangeListener
to removefireStateChanged()
,
addChangeListener(javax.swing.event.ChangeListener)
@BeanProperty(bound=false) public ChangeListener[] getChangeListeners()
ChangeListener
s added
to this JTabbedPane
with addChangeListener
.ChangeListener
s added or an empty
array if no listeners have been addedprotected void fireStateChanged()
ChangeEvent
, with this JTabbedPane
as the source,
to each registered listener. This method is called each time there is
a change to either the selected index or the selected tab in the
JTabbedPane
. Usually, the selected index and selected tab change
together. However, there are some cases, such as tab addition, where the
selected index changes and the same tab remains selected. There are other
cases, such as deleting the selected tab, where the index remains the
same, but a new tab moves to that index. Events are fired for all of
these cases.public SingleSelectionModel getModel()
SingleSelectionModel
associated with this tabbedpanesetModel(javax.swing.SingleSelectionModel)
@BeanProperty(description="The tabbedpane\'s SingleSelectionModel.") public void setModel(SingleSelectionModel model)
model
- the model to be usedgetModel()
public int getTabPlacement()
int
specifying the placement for the tabssetTabPlacement(int)
@BeanProperty(preferred=true, visualUpdate=true, enumerationValues={"JTabbedPane.TOP","JTabbedPane.LEFT","JTabbedPane.BOTTOM","JTabbedPane.RIGHT"}, description="The tabbedpane\'s tab placement.") public void setTabPlacement(int tabPlacement)
JTabbedPane.TOP
JTabbedPane.BOTTOM
JTabbedPane.LEFT
JTabbedPane.RIGHT
SwingConstants.TOP
.tabPlacement
- the placement for the tabs relative to the contentIllegalArgumentException
- if tab placement value isn't one
of the above valid valuespublic int getTabLayoutPolicy()
int
specifying the policy used to layout the tabssetTabLayoutPolicy(int)
@BeanProperty(preferred=true, visualUpdate=true, enumerationValues={"JTabbedPane.WRAP_TAB_LAYOUT","JTabbedPane.SCROLL_TAB_LAYOUT"}, description="The tabbedpane\'s policy for laying out the tabs") public void setTabLayoutPolicy(int tabLayoutPolicy)
JTabbedPane.WRAP_TAB_LAYOUT
JTabbedPane.SCROLL_TAB_LAYOUT
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.
tabLayoutPolicy
- the policy used to layout the tabsIllegalArgumentException
- if layoutPolicy value isn't one
of the above valid valuesgetTabLayoutPolicy()
public int getSelectedIndex()
setSelectedIndex(int)
@BeanProperty(bound=false, preferred=true, description="The tabbedpane\'s selected tab index.") public void setSelectedIndex(int index)
index
- the index to be selectedIndexOutOfBoundsException
- if index is out of range
(index < -1 || index >= tab count)
getSelectedIndex()
,
SingleSelectionModel.setSelectedIndex(int)
public Component getSelectedComponent()
null
if there is no currently selected tab.setSelectedComponent(java.awt.Component)
@BeanProperty(bound=false, preferred=true, description="The tabbedpane\'s selected component.") public void setSelectedComponent(Component c)
selectedIndex
to the index
corresponding to the specified component.c
- the selected Component
for this TabbedPane
IllegalArgumentException
- if component not found in tabbed
panegetSelectedComponent()
public void insertTab(String title, Icon icon, Component component, String tip, int index)
null
.title
- the title to be displayed on the tabicon
- the icon to be displayed on the tabcomponent
- the component to be displayed when this tab is clicked.tip
- the tooltip to be displayed for this tabindex
- the position to insert this new tab
(> 0 and <= getTabCount()
)IndexOutOfBoundsException
- if the index is out of range
(< 0 or > getTabCount()
)addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
removeTabAt(int)
public void addTab(String title, Icon icon, Component component, String tip)
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 tabicon
- the icon to be displayed in this tabcomponent
- the component to be displayed when this tab is clickedtip
- the tooltip to be displayed for this tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void addTab(String title, Icon icon, Component component)
component
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 tabicon
- the icon to be displayed in this tabcomponent
- the component to be displayed when this tab is clickedinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void addTab(String title, Component component)
component
represented by a title
and no icon.
Cover method for insertTab
.title
- the title to be displayed in this tabcomponent
- the component to be displayed when this tab is clickedinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public Component add(Component component)
component
with a tab title defaulting to
the name of the component which is the result of calling
component.getName
.
Cover method for insertTab
.add
in class Container
component
- the component to be displayed when this tab is clickedinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public Component add(String title, Component component)
component
with the specified tab title.
Cover method for insertTab
.add
in class Container
title
- the title to be displayed in this tabcomponent
- the component to be displayed when this tab is clickedinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public Component add(Component component, int index)
component
at the specified tab index with a tab
title defaulting to the name of the component.
Cover method for insertTab
.add
in class Container
component
- the component to be displayed when this tab is clickedindex
- the position to insert this new tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void add(Component component, Object constraints)
component
to the tabbed pane.
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
.add
in class Container
component
- the component to be displayed when this tab is clickedconstraints
- the object to be displayed in the tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void add(Component component, Object constraints, int index)
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
.add
in class Container
component
- the component to be displayed when this tab is clickedconstraints
- the object to be displayed in the tabindex
- the position to insert this new tabinsertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
,
removeTabAt(int)
public void removeTabAt(int index)
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 removedIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
public void remove(Component component)
Component
from the
JTabbedPane
. The method does nothing
if the component
is null.remove
in class Container
component
- the component to remove from the tabbedpaneaddTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
removeTabAt(int)
public void remove(int index)
remove
in class Container
index
- the index of the component to remove from the
tabbedpane
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
removeTabAt(int)
public void removeAll()
tabbedpane
.removeAll
in class Container
addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
,
removeTabAt(int)
@BeanProperty(bound=false) public int getTabCount()
tabbedpane
.@BeanProperty(bound=false) public int getTabRunCount()
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
public String getTitleAt(int index)
index
.index
- the index of the item being queriedindex
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setTitleAt(int, java.lang.String)
public Icon getIconAt(int index)
index
.index
- the index of the item being queriedindex
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setIconAt(int, javax.swing.Icon)
public Icon getDisabledIconAt(int index)
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 queriedindex
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setDisabledIconAt(int, javax.swing.Icon)
public String getToolTipTextAt(int index)
index
.index
- the index of the item being queriedindex
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setToolTipTextAt(int, java.lang.String)
public Color getBackgroundAt(int index)
index
.index
- the index of the item being queriedColor
of the tab background at
index
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setBackgroundAt(int, java.awt.Color)
public Color getForegroundAt(int index)
index
.index
- the index of the item being queriedColor
of the tab foreground at
index
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setForegroundAt(int, java.awt.Color)
public boolean isEnabledAt(int index)
index
is
currently enabled.index
- the index of the item being queriedindex
is enabled;
false otherwiseIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setEnabledAt(int, boolean)
public Component getComponentAt(int index)
index
.index
- the index of the item being queriedComponent
at index
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setComponentAt(int, java.awt.Component)
public int getMnemonicAt(int tabIndex)
tabIndex
- the index of the tab that the mnemonic refers toIndexOutOfBoundsException
- if index is out of range
(tabIndex
< 0 ||
tabIndex
>= tab count)setDisplayedMnemonicIndexAt(int,int)
,
setMnemonicAt(int,int)
public int getDisplayedMnemonicIndexAt(int tabIndex)
tabIndex
- the index of the tab that the mnemonic refers toIndexOutOfBoundsException
- if index is out of range
(tabIndex
< 0 ||
tabIndex
>= tab count)setDisplayedMnemonicIndexAt(int,int)
,
setMnemonicAt(int,int)
public Rectangle getBoundsAt(int index)
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 queriedRectangle
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
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
@BeanProperty(preferred=true, visualUpdate=true, description="The title at the specified tab index.") public void setTitleAt(int index, String title)
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 settitle
- the title to be displayed in the tabIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
getTitleAt(int)
,
setTabComponentAt(int, java.awt.Component)
@BeanProperty(preferred=true, visualUpdate=true, description="The icon at the specified tab index.") public void setIconAt(int index, Icon icon)
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 seticon
- the icon to be displayed in the tabIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setDisabledIconAt(int, javax.swing.Icon)
,
getIconAt(int)
,
getDisabledIconAt(int)
,
setTabComponentAt(int, java.awt.Component)
@BeanProperty(preferred=true, visualUpdate=true, description="The disabled icon at the specified tab index.") public void setDisabledIconAt(int index, Icon disabledIcon)
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 setdisabledIcon
- the icon to be displayed in the tab when disabledIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
getDisabledIconAt(int)
@BeanProperty(preferred=true, description="The tooltip text at the specified tab index.") public void setToolTipTextAt(int index, String toolTipText)
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 settoolTipText
- the tooltip text to be displayed for the tabIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
getToolTipTextAt(int)
@BeanProperty(preferred=true, visualUpdate=true, description="The background color at the specified tab index.") public void setBackgroundAt(int index, Color background)
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 setbackground
- the color to be displayed in the tab's backgroundIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
getBackgroundAt(int)
@BeanProperty(preferred=true, visualUpdate=true, description="The foreground color at the specified tab index.") public void setForegroundAt(int index, Color foreground)
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 setforeground
- the color to be displayed as the tab's foregroundIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
getForegroundAt(int)
public void setEnabledAt(int index, boolean enabled)
index
is enabled.
An internal exception is raised if there is no tab at that index.index
- the tab index which should be enabled/disabledenabled
- whether or not the tab should be enabledIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
isEnabledAt(int)
@BeanProperty(visualUpdate=true, description="The component at the specified tab index.") public void setComponentAt(int index, Component component)
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 placedcomponent
- the component for the tabIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
getComponentAt(int)
@BeanProperty(visualUpdate=true, description="the index into the String to draw the keyboard character mnemonic at") public void setDisplayedMnemonicIndexAt(int tabIndex, int mnemonicIndex)
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.
tabIndex
- the index of the tab that the mnemonic refers tomnemonicIndex
- index into the String
to underlineIndexOutOfBoundsException
- if tabIndex
is
out of range (tabIndex < 0 || tabIndex >= tab
count
)IllegalArgumentException
- will be thrown if
mnemonicIndex
is >= length of the tab
title , or < -1setMnemonicAt(int,int)
,
getDisplayedMnemonicIndexAt(int)
@BeanProperty(visualUpdate=true, description="The keyboard mnenmonic, as a KeyEvent VK constant, for the specified tab") public void setMnemonicAt(int tabIndex, int mnemonic)
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.
tabIndex
- the index of the tab that the mnemonic refers tomnemonic
- the key code which represents the mnemonicIndexOutOfBoundsException
- if tabIndex
is out
of range (tabIndex < 0 || tabIndex >= tab count
)getMnemonicAt(int)
,
setDisplayedMnemonicIndexAt(int,int)
public int indexOfTab(String title)
title
, or
-1 if no tab has this title.title
- the title for the tabtitle
, or
-1 if no tab has this titlepublic int indexOfTab(Icon icon)
icon
,
or -1 if no tab has this icon.icon
- the icon for the tabicon
,
or -1 if no tab has this iconpublic int indexOfComponent(Component component)
component
- the component for the tabpublic int indexAtLocation(int x, int y)
x
- the x location relative to this tabbedpaney
- the y location relative to this tabbedpanepublic String getToolTipText(MouseEvent event)
getToolTipText
in class JComponent
event
- the MouseEvent
that tells where the
cursor is lingeringString
containing the tooltip textprotected String paramString()
JTabbedPane
.
This method
is intended to be used only for debugging purposes, and the
content and format of the returned string may vary between
implementations. The returned string may be empty but may not
be null
.paramString
in class JComponent
@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Component
@BeanProperty(preferred=true, visualUpdate=true, description="The tab component at the specified tab index.") public void setTabComponentAt(int index, Component component)
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 setcomponent
- the component to render the title for the
specified tabIndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
IllegalArgumentException
- if component has already been
added to this JTabbedPane
getTabComponentAt(int)
public Component getTabComponentAt(int index)
index
.index
- the index of the item being queriedindex
IndexOutOfBoundsException
- if index is out of range
(index < 0 || index >= tab count)
setTabComponentAt(int, java.awt.Component)
public int indexOfTabComponent(Component tabComponent)
tabComponent
- the tab component for the tabsetTabComponentAt(int, java.awt.Component)
,
getTabComponentAt(int)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-internal+0-adhoc.mlchung.jdk9-jdeps