public class JTabbedPane extends JComponentimplements 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 and Description |
|---|---|
protected class |
JTabbedPane
This class implements accessibility support for the
JTabbedPane class.
|
protected class |
JTabbedPane
We pass
ModelChanged events along to the listeners with the tabbedpane (instead of the model itself) as the event source.
|
JComponent.AccessibleJComponent Container.AccessibleAWTContainer Component.AccessibleAWTComponent , Component.BaselineResizeBehavior , Component.BltBufferStrategy , Component.FlipBufferStrategy | Modifier and Type | Field and 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.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTBOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WESTABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH| Constructor and 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 and Description |
|---|---|
Component |
add(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
Adds a
component at the specified tab index with a tab title defaulting to the name of the component.
|
void |
add(Component
Adds a
component to the tabbed pane.
|
void |
add(Component
Adds a
component at the specified tab index.
|
Component |
add(String
Adds a
component with the specified tab title.
|
void |
addChangeListener(ChangeListener
Adds a
ChangeListener to this tabbedpane.
|
void |
addTab(String
Adds a
component represented by a
title and no icon.
|
void |
addTab(String
Adds a
component represented by a
title and/or
icon, either of which can be
null.
|
void |
addTab(String
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
ChangeListeners 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
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
Returns the index of the tab for the specified component.
|
int |
indexOfTab(Icon
Returns the first tab index with a given
icon, or -1 if no tab has this icon.
|
int |
indexOfTab(String
Returns the first tab index with a given
title, or -1 if no tab has this title.
|
int |
indexOfTabComponent(Component
Returns the index of the tab for the specified tab component.
|
void |
insertTab(String
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(Component
Removes the specified
Component from the
JTabbedPane.
|
void |
remove(int index)
Removes the tab and component which corresponds to the specified index.
|
void |
removeAll()
Removes all the tabs and their corresponding components from the
tabbedpane.
|
void |
removeChangeListener(ChangeListener
Removes a
ChangeListener from this tabbedpane.
|
void |
removeTabAt(int index)
Removes the tab at
index.
|
void |
setBackgroundAt(int index, Color
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
Sets the component at
index to
component.
|
void |
setDisabledIconAt(int index, Icon
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
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
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
Sets the model to be used with this tabbedpane.
|
void |
setSelectedComponent(Component
Sets the selected component for this tabbedpane.
|
void |
setSelectedIndex(int index)
Sets the selected index for this tabbedpane.
|
void |
setTabComponentAt(int index, 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
Sets the title at
index to
title which can be
null.
|
void |
setToolTipTextAt(int index, String
Sets the tooltip text at
index to
toolTipText which can be
null.
|
void |
setUI(TabbedPaneUI
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.
|
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, updateaddContainerListener, 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, validateTreeaction, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCyclepublic static final int WRAP_TAB_LAYOUT
public static final int SCROLL_TAB_LAYOUT
protected int tabPlacement
setTabPlacement(int)
protected SingleSelectionModelmodel
protected ChangeListenerchangeListener
changeListener is the listener we add to the model.
protected transient ChangeEventchangeEvent
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 content
addTab(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 content
tabLayoutPolicy - the policy for laying out tabs when all tabs will not fit on one run
IllegalArgumentException - if tab placement or tab layout policy are not one of the above supported values
addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)
public TabbedPaneUIgetUI()
TabbedPaneUI object
setUI(javax.swing.plaf.TabbedPaneUI)
public void setUI(TabbedPaneUIui)
ui - the new UI object
UIDefaults.getUI(javax.swing.JComponent)
public void updateUI()
updateUI in class
JComponent
JComponent.updateUI()
public StringgetUIClassID()
getUIClassID in class
JComponent
JComponent.getUIClassID() ,
UIDefaults.getUI(javax.swing.JComponent)
protected ChangeListenercreateChangeListener()
ChangeEvents differently can override this to return a subclass of
ModelListener or another
ChangeListener implementation.
fireStateChanged()
public void addChangeListener(ChangeListenerl)
ChangeListener to this tabbedpane.
l - the
ChangeListener to add
fireStateChanged(),
removeChangeListener(javax.swing.event.ChangeListener)
public void removeChangeListener(ChangeListenerl)
ChangeListener from this tabbedpane.
l - the
ChangeListener to remove
fireStateChanged(),
addChangeListener(javax.swing.event.ChangeListener)
public ChangeListener[] getChangeListeners()
ChangeListeners added to this
JTabbedPane with
addChangeListener.
ChangeListeners added or an empty array if no listeners have been added
protected 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 SingleSelectionModelgetModel()
public void setModel(SingleSelectionModelmodel)
model - the model to be used
getModel()
public int getTabPlacement()
setTabPlacement(int)
public void setTabPlacement(int tabPlacement)
JTabbedPane.TOP JTabbedPane.BOTTOM JTabbedPane.LEFT JTabbedPane.RIGHT SwingConstants.TOP.
tabPlacement - the placement for the tabs relative to the content
IllegalArgumentException - if tab placement value isn't one of the above valid values
public int getTabLayoutPolicy()
setTabLayoutPolicy(int)
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 tabs
IllegalArgumentException - if layoutPolicy value isn't one of the above valid values
getTabLayoutPolicy()
public int getSelectedIndex()
setSelectedIndex(int)
public void setSelectedIndex(int index)
index - the index to be selected
IndexOutOfBoundsException - if index is out of range
(index < -1 || index >= tab count)
getSelectedIndex(),
SingleSelectionModel.setSelectedIndex(int)
public ComponentgetSelectedComponent()
null if there is no currently selected tab.
setSelectedComponent(java.awt.Component)
public void setSelectedComponent(Componentc)
selectedIndex to the index corresponding to the specified component.
IllegalArgumentException - if component not found in tabbed pane
getSelectedComponent()
public void insertTab(Stringtitle, Icon icon, Component component, String tip, int index)
null.
title - the title to be displayed on the tab
icon - the icon to be displayed on the tab
component - the component to be displayed when this tab is clicked.
tip - the tooltip to be displayed for this tab
index - 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(Stringtitle, 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 tab
icon - the icon to be displayed in this tab
component - the component to be displayed when this tab is clicked
tip - the tooltip to be displayed for this tab
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public void addTab(Stringtitle, 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 tab
icon - the icon to be displayed in this tab
component - the component to be displayed when this tab is clicked
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public void addTab(Stringtitle, Component component)
component represented by a
title and no icon. Cover method for
insertTab.
title - the title to be displayed in this tab
component - the component to be displayed when this tab is clicked
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public Componentadd(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 clicked
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public Componentadd(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 tab
component - the component to be displayed when this tab is clicked
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public Componentadd(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 clicked
index - the position to insert this new tab
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public void add(Componentcomponent, 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 clicked
constraints - the object to be displayed in the tab
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int),
removeTabAt(int)
public void add(Componentcomponent, 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 clicked
constraints - the object to be displayed in the tab
index - the position to insert this new tab
insertTab(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 removed
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),
insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)
public void remove(Componentcomponent)
Component from the
JTabbedPane. The method does nothing if the
component is null.
remove in class
Container
component - the component to remove from the tabbedpane
addTab(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)
public int getTabCount()
tabbedpane.
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 StringgetTitleAt(int index)
index.
index - the index of the item being queried
index
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setTitleAt(int, java.lang.String)
public IcongetIconAt(int index)
index.
index - the index of the item being queried
index
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setIconAt(int, javax.swing.Icon)
public IcongetDisabledIconAt(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 queried
index
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setDisabledIconAt(int, javax.swing.Icon)
public StringgetToolTipTextAt(int index)
index.
index - the index of the item being queried
index
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setToolTipTextAt(int, java.lang.String)
public ColorgetBackgroundAt(int index)
index.
index - the index of the item being queried
Color of the tab background at
index
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setBackgroundAt(int, java.awt.Color)
public ColorgetForegroundAt(int index)
index.
index - the index of the item being queried
Color 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 queried
index is enabled; false otherwise
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setEnabledAt(int, boolean)
public ComponentgetComponentAt(int index)
index.
index - the index of the item being queried
Component 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 to
IndexOutOfBoundsException - 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 to
IndexOutOfBoundsException - if index is out of range (
tabIndex < 0 ||
tabIndex >= tab count)
setDisplayedMnemonicIndexAt(int,int),
setMnemonicAt(int,int)
public RectanglegetBoundsAt(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 queried
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
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
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 set
title - the title to be displayed in the tab
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
getTitleAt(int),
setTabComponentAt(int, java.awt.Component)
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 set
icon - the icon to be displayed in the tab
IndexOutOfBoundsException - 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)
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 set
disabledIcon - the icon to be displayed in the tab when disabled
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
getDisabledIconAt(int)
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 set
toolTipText - the tooltip text to be displayed for the tab
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
getToolTipTextAt(int)
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 set
background - the color to be displayed in the tab's background
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
getBackgroundAt(int)
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 set
foreground - the color to be displayed as the tab's foreground
IndexOutOfBoundsException - 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/disabled
enabled - whether or not the tab should be enabled
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
isEnabledAt(int)
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 placed
component - the component for the tab
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
getComponentAt(int)
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 to
mnemonicIndex - index into the
String to underline
IndexOutOfBoundsException - if
tabIndex is out of range (
tabIndex < 0 || tabIndex >= tab count)
IllegalArgumentException - will be thrown if
mnemonicIndex is >= length of the tab title , or < -1
setMnemonicAt(int,int),
getDisplayedMnemonicIndexAt(int)
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 to
mnemonic - the key code which represents the mnemonic
IndexOutOfBoundsException - if
tabIndex is out of range (
tabIndex < 0 || tabIndex >= tab count)
getMnemonicAt(int),
setDisplayedMnemonicIndexAt(int,int)
public int indexOfTab(Stringtitle)
title, or -1 if no tab has this title.
title - the title for the tab
title, or -1 if no tab has this title
public int indexOfTab(Iconicon)
icon, or -1 if no tab has this icon.
icon - the icon for the tab
icon, or -1 if no tab has this icon
public int indexOfComponent(Componentcomponent)
component - the component for the tab
public int indexAtLocation(int x,
int y)
x - the x location relative to this tabbedpane
y - the y location relative to this tabbedpane
public StringgetToolTipText(MouseEvent event)
getToolTipText in class
JComponent
event - the
MouseEvent that tells where the cursor is lingering
String containing the tooltip text
protected StringparamString()
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
public AccessibleContextgetAccessibleContext()
getAccessibleContext in interface
Accessible
getAccessibleContext in class
Component
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 set
component - the component to render the title for the specified tab
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
IllegalArgumentException - if component has already been added to this
JTabbedPane
getTabComponentAt(int)
public ComponentgetTabComponentAt(int index)
index.
index - the index of the item being queried
index
IndexOutOfBoundsException - if index is out of range
(index < 0 || index >= tab count)
setTabComponentAt(int, java.awt.Component)
public int indexOfTabComponent(ComponenttabComponent)
tabComponent - the tab component for the tab
setTabComponentAt(int, java.awt.Component),
getTabComponentAt(int)