Class JTabbedPane
- All Implemented Interfaces:
- ImageObserver,- MenuContainer,- 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.
- Since:
- 1.2
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionprotected classThis class implements accessibility support for theJTabbedPaneclass.protected classWe passModelChangedevents along to the listeners with the tabbedpane (instead of the model itself) as the event source.Nested classes/interfaces declared in class javax.swing.JComponentJComponent.AccessibleJComponentNested classes/interfaces declared in class java.awt.ContainerContainer.AccessibleAWTContainerNested classes/interfaces declared in class java.awt.ComponentComponent.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected ChangeEventOnly oneChangeEventis needed perTabPaneinstance since the event's only (read-only) state is the source property.protected ChangeListenerThechangeListeneris the listener we add to the model.protected SingleSelectionModelThe default selection modelstatic final intTab layout policy for providing a subset of available tabs when all the tabs will not fit within a single run.protected intWhere the tabs are placed.static final intThe tab layout policy for wrapping tabs in multiple runs when all tabs will not fit within a single run.Fields declared in class javax.swing.JComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields declared in class java.awt.ComponentaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields declared in interface java.awt.image.ImageObserverABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields declared in interface javax.swing.SwingConstantsBOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an emptyTabbedPanewith a default tab placement ofJTabbedPane.TOP.JTabbedPane(int tabPlacement) Creates an emptyTabbedPanewith the specified tab placement of either:JTabbedPane.TOP,JTabbedPane.BOTTOM,JTabbedPane.LEFT, orJTabbedPane.RIGHT.JTabbedPane(int tabPlacement, int tabLayoutPolicy) Creates an emptyTabbedPanewith the specified tab placement and tab layout policy.
- 
Method SummaryModifier and TypeMethodDescriptionAdds acomponentwith a tab title defaulting to the name of the component which is the result of callingcomponent.getName.Adds acomponentat the specified tab index with a tab title defaulting to the name of the component.voidAdds acomponentto the tabbed pane.voidAdds acomponentat the specified tab index.Adds acomponentwith the specified tab title.voidAdds aChangeListenerto this tabbedpane.voidAdds acomponentrepresented by atitleand no icon.voidAdds acomponentrepresented by atitleand/oricon, either of which can benull.voidAdds acomponentandtiprepresented by atitleand/oricon, either of which can benull.protected ChangeListenerSubclasses that want to handleChangeEventsdifferently can override this to return a subclass ofModelListeneror anotherChangeListenerimplementation.protected voidSends aChangeEvent, with thisJTabbedPaneas the source, to each registered listener.Gets the AccessibleContext associated with this JTabbedPane.getBackgroundAt(int index) Returns the tab background color atindex.getBoundsAt(int index) Returns the tab bounds atindex.Returns an array of all theChangeListeners added to thisJTabbedPanewithaddChangeListener.getComponentAt(int index) Returns the component atindex.getDisabledIconAt(int index) Returns the tab disabled icon atindex.intgetDisplayedMnemonicIndexAt(int tabIndex) Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.getForegroundAt(int index) Returns the tab foreground color atindex.getIconAt(int index) Returns the tab icon atindex.intgetMnemonicAt(int tabIndex) Returns the keyboard mnemonic for accessing the specified tab.getModel()Returns the model associated with this tabbedpane.Returns the currently selected component for this tabbedpane.intReturns the currently selected index for this tabbedpane.getTabComponentAt(int index) Returns the tab component atindex.intReturns the number of tabs in thistabbedpane.intReturns the policy used by the tabbedpane to layout the tabs when all the tabs will not fit within a single run.intReturns the placement of the tabs for this tabbedpane.intReturns the number of tab runs currently used to display the tabs.getTitleAt(int index) Returns the tab title atindex.getToolTipText(MouseEvent event) Returns the tooltip text for the component determined by the mouse event location.getToolTipTextAt(int index) Returns the tab tooltip text atindex.getUI()Returns the UI object which implements the L&F for this component.Returns the name of the UI class that implements the L&F for this component.intindexAtLocation(int x, int y) Returns the tab index corresponding to the tab whose bounds intersect the specified location.intindexOfComponent(Component component) Returns the index of the tab for the specified component.intindexOfTab(String title) Returns the first tab index with a giventitle, or -1 if no tab has this title.intindexOfTab(Icon icon) Returns the first tab index with a givenicon, or -1 if no tab has this icon.intindexOfTabComponent(Component tabComponent) Returns the index of the tab for the specified tab component.voidInserts a new tab for the given component, at the given index, represented by the given title and/or icon, either of which may benull.booleanisEnabledAt(int index) Returns whether or not the tab atindexis currently enabled.protected StringReturns a string representation of thisJTabbedPane.voidremove(int index) Removes the tab and component which corresponds to the specified index.voidRemoves the specifiedComponentfrom theJTabbedPane.voidRemoves all the tabs and their corresponding components from thetabbedpane.voidRemoves aChangeListenerfrom this tabbedpane.voidremoveTabAt(int index) Removes the tab atindex.voidsetBackgroundAt(int index, Color background) Sets the background color atindextobackgroundwhich can benull, in which case the tab's background color will default to the background color of thetabbedpane.voidsetComponentAt(int index, Component component) Sets the component atindextocomponent.voidsetDisabledIconAt(int index, Icon disabledIcon) Sets the disabled icon atindextoiconwhich can benull.voidsetDisplayedMnemonicIndexAt(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.voidsetEnabledAt(int index, boolean enabled) Sets whether or not the tab atindexis enabled.voidsetForegroundAt(int index, Color foreground) Sets the foreground color atindextoforegroundwhich can benull, in which case the tab's foreground color will default to the foreground color of thistabbedpane.voidSets the icon atindextoiconwhich can benull.voidsetMnemonicAt(int tabIndex, int mnemonic) Sets the keyboard mnemonic for accessing the specified tab.voidsetModel(SingleSelectionModel model) Sets the model to be used with this tabbedpane.voidSets the selected component for this tabbedpane.voidsetSelectedIndex(int index) Sets the selected index for this tabbedpane.voidsetTabComponentAt(int index, Component component) Sets the component that is responsible for rendering the title for the specified tab.voidsetTabLayoutPolicy(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.voidsetTabPlacement(int tabPlacement) Sets the tab placement for this tabbedpane.voidsetTitleAt(int index, String title) Sets the title atindextotitlewhich can benull.voidsetToolTipTextAt(int index, String toolTipText) Sets the tooltip text atindextotoolTipTextwhich can benull.voidsetUI(TabbedPaneUI ui) Sets the UI object which implements the L&F for this component.voidupdateUI()Resets the UI property to a value from the current look and feel.Methods declared in class javax.swing.JComponentaddAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, 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, updateMethods declared in class java.awt.ContaineraddContainerListener, 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, validateTreeMethods declared in class java.awt.Componentaction, 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, 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
- 
Field Details- 
WRAP_TAB_LAYOUTpublic static final int WRAP_TAB_LAYOUTThe tab layout policy for wrapping tabs in multiple runs when all tabs will not fit within a single run.- See Also:
 
- 
SCROLL_TAB_LAYOUTpublic static final int SCROLL_TAB_LAYOUTTab 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.- See Also:
 
- 
tabPlacementprotected int tabPlacementWhere the tabs are placed.- See Also:
 
- 
modelThe default selection model
- 
changeListenerThechangeListeneris the listener we add to the model.
- 
changeEventOnly oneChangeEventis needed perTabPaneinstance since the event's only (read-only) state is the source property. The source of events generated here is always "this".
 
- 
- 
Constructor Details- 
JTabbedPanepublic JTabbedPane()Creates an emptyTabbedPanewith a default tab placement ofJTabbedPane.TOP.- See Also:
 
- 
JTabbedPanepublic JTabbedPane(int tabPlacement) Creates an emptyTabbedPanewith the specified tab placement of either:JTabbedPane.TOP,JTabbedPane.BOTTOM,JTabbedPane.LEFT, orJTabbedPane.RIGHT.- Parameters:
- tabPlacement- the placement for the tabs relative to the content
- See Also:
 
- 
JTabbedPanepublic JTabbedPane(int tabPlacement, int tabLayoutPolicy) Creates an emptyTabbedPanewith the specified tab placement and tab layout policy. Tab placement may be either:JTabbedPane.TOP,JTabbedPane.BOTTOM,JTabbedPane.LEFT, orJTabbedPane.RIGHT. Tab layout policy may be either:JTabbedPane.WRAP_TAB_LAYOUTorJTabbedPane.SCROLL_TAB_LAYOUT.- Parameters:
- 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
- Throws:
- IllegalArgumentException- if tab placement or tab layout policy are not one of the above supported values
- Since:
- 1.4
- See Also:
 
 
- 
- 
Method Details- 
getUIReturns the UI object which implements the L&F for this component.- Overrides:
- getUIin class- JComponent
- Returns:
- a TabbedPaneUIobject
- See Also:
 
- 
setUI@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the tabbedpane's LookAndFeel") public void setUI(TabbedPaneUI ui) Sets the UI object which implements the L&F for this component.- Parameters:
- ui- the new UI object
- See Also:
 
- 
updateUIpublic void updateUI()Resets the UI property to a value from the current look and feel.- Overrides:
- updateUIin class- JComponent
- See Also:
 
- 
getUIClassIDReturns the name of the UI class that implements the L&F for this component.- Overrides:
- getUIClassIDin class- JComponent
- Returns:
- the string "TabbedPaneUI"
- See Also:
 
- 
createChangeListenerSubclasses that want to handleChangeEventsdifferently can override this to return a subclass ofModelListeneror anotherChangeListenerimplementation.- Returns:
- a ChangeListener
- See Also:
 
- 
addChangeListenerAdds aChangeListenerto this tabbedpane.- Parameters:
- l- the- ChangeListenerto add
- See Also:
 
- 
removeChangeListenerRemoves aChangeListenerfrom this tabbedpane.- Parameters:
- l- the- ChangeListenerto remove
- See Also:
 
- 
getChangeListenersReturns an array of all theChangeListeners added to thisJTabbedPanewithaddChangeListener.- Returns:
- all of the ChangeListeners added or an empty array if no listeners have been added
- Since:
- 1.4
 
- 
fireStateChangedprotected void fireStateChanged()Sends aChangeEvent, with thisJTabbedPaneas 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 theJTabbedPane. 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.- See Also:
 
- 
getModelReturns the model associated with this tabbedpane.- Returns:
- the SingleSelectionModelassociated with this tabbedpane
- See Also:
 
- 
setModel@BeanProperty(description="The tabbedpane's SingleSelectionModel.") public void setModel(SingleSelectionModel model) Sets the model to be used with this tabbedpane.- Parameters:
- model- the model to be used
- See Also:
 
- 
getTabPlacementpublic int getTabPlacement()Returns the placement of the tabs for this tabbedpane.- Returns:
- an intspecifying the placement for the tabs
- See Also:
 
- 
setTabPlacement@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) Sets the tab placement for this tabbedpane. Possible values are:- JTabbedPane.TOP
- JTabbedPane.BOTTOM
- JTabbedPane.LEFT
- JTabbedPane.RIGHT
 SwingConstants.TOP.- Parameters:
- tabPlacement- the placement for the tabs relative to the content
- Throws:
- IllegalArgumentException- if tab placement value isn't one of the above valid values
 
- 
getTabLayoutPolicypublic int getTabLayoutPolicy()Returns the policy used by the tabbedpane to layout the tabs when all the tabs will not fit within a single run.- Returns:
- an intspecifying the policy used to layout the tabs
- Since:
- 1.4
- See Also:
 
- 
setTabLayoutPolicy@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) 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
 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. - Parameters:
- tabLayoutPolicy- the policy used to layout the tabs
- Throws:
- IllegalArgumentException- if layoutPolicy value isn't one of the above valid values
- Since:
- 1.4
- See Also:
 
- 
getSelectedIndexpublic int getSelectedIndex()Returns the currently selected index for this tabbedpane. Returns -1 if there is no currently selected tab.- Returns:
- the index of the selected tab
- See Also:
 
- 
setSelectedIndex@BeanProperty(bound=false, preferred=true, description="The tabbedpane's selected tab index.") public void setSelectedIndex(int 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.- Parameters:
- index- the index to be selected
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < -1 || index >= tab count)
- See Also:
 
- 
getSelectedComponentReturns the currently selected component for this tabbedpane. Returnsnullif there is no currently selected tab.- Returns:
- the component corresponding to the selected tab
- See Also:
 
- 
setSelectedComponent@BeanProperty(bound=false, preferred=true, description="The tabbedpane's selected component.") public void setSelectedComponent(Component c) Sets the selected component for this tabbedpane. This will automatically set theselectedIndexto the index corresponding to the specified component.- Parameters:
- c- the selected- Componentfor this- TabbedPane
- Throws:
- IllegalArgumentException- if component not found in tabbed pane
- See Also:
 
- 
insertTabInserts a new tab for the given component, at the given index, represented by the given title and/or icon, either of which may benull.- Parameters:
- 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- (index >= 0 && index <= getTabCount())
- Throws:
- IndexOutOfBoundsException- if the index is out of range- (index < 0 || index > getTabCount())
- See Also:
 
- 
addTabAdds acomponentandtiprepresented by atitleand/oricon, either of which can benull. Cover method forinsertTab.- Parameters:
- 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
- See Also:
 
- 
addTabAdds acomponentrepresented by atitleand/oricon, either of which can benull. Cover method forinsertTab.- Parameters:
- 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
- See Also:
 
- 
addTab
- 
addAdds acomponentwith a tab title defaulting to the name of the component which is the result of callingcomponent.getName. Cover method forinsertTab.
- 
addAdds acomponentwith the specified tab title. Cover method forinsertTab.
- 
addAdds acomponentat the specified tab index with a tab title defaulting to the name of the component. Cover method forinsertTab.
- 
addAdds acomponentto the tabbed pane. Ifconstraintsis aStringor anIcon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method forinsertTab.
- 
addAdds acomponentat the specified tab index. Ifconstraintsis aStringor anIcon, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method forinsertTab.
- 
removeTabAtpublic void removeTabAt(int index) Removes the tab atindex. After the component associated withindexis removed, its visibility is reset to true to ensure it will be visible if added to other containers.- Parameters:
- index- the index of the tab to be removed
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
remove
- 
removepublic void remove(int index) Removes the tab and component which corresponds to the specified index.- Overrides:
- removein class- Container
- Parameters:
- index- the index of the component to remove from the- tabbedpane
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
removeAll
- 
getTabCountReturns the number of tabs in thistabbedpane.- Returns:
- an integer specifying the number of tabbed pages
 
- 
getTabRunCountReturns the number of tab runs currently used to display the tabs.- Returns:
- an integer giving the number of rows if the
          tabPlacementisTOPorBOTTOMand the number of columns iftabPlacementisLEFTorRIGHT, or 0 if there is no UI set on thistabbedpane
 
- 
getTitleAtReturns the tab title atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- the title at index
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
getIconAtReturns the tab icon atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- the icon at index
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
getDisabledIconAtReturns the tab disabled icon atindex. If the tab disabled icon doesn't exist atindexthis 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.- Parameters:
- index- the index of the item being queried
- Returns:
- the icon at index
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
getToolTipTextAtReturns the tab tooltip text atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- a string containing the tool tip text at index
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- Since:
- 1.3
- See Also:
 
- 
getBackgroundAtReturns the tab background color atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- the Colorof the tab background atindex
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
getForegroundAtReturns the tab foreground color atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- the Colorof the tab foreground atindex
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
isEnabledAtpublic boolean isEnabledAt(int index) Returns whether or not the tab atindexis currently enabled.- Parameters:
- index- the index of the item being queried
- Returns:
- true if the tab at indexis enabled; false otherwise
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
getComponentAtReturns the component atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- the Componentatindex
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
getMnemonicAtpublic int getMnemonicAt(int tabIndex) 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.- Parameters:
- tabIndex- the index of the tab that the mnemonic refers to
- Returns:
- the key code which represents the mnemonic; -1 if a mnemonic is not specified for the tab
- Throws:
- IndexOutOfBoundsException- if index is out of range (- tabIndex< 0 ||- tabIndex>= tab count)
- Since:
- 1.4
- See Also:
 
- 
getDisplayedMnemonicIndexAtpublic int getDisplayedMnemonicIndexAt(int tabIndex) Returns the character, as an index, that the look and feel should provide decoration for as representing the mnemonic character.- Parameters:
- tabIndex- the index of the tab that the mnemonic refers to
- Returns:
- index representing mnemonic character if one exists; otherwise returns -1
- Throws:
- IndexOutOfBoundsException- if index is out of range (- tabIndex< 0 ||- tabIndex>= tab count)
- Since:
- 1.4
- See Also:
 
- 
getBoundsAtReturns the tab bounds atindex. If the tab at this index is not currently visible in the UI, then returnsnull. If there is no UI set on thistabbedpane, then returnsnull.- Parameters:
- index- the index to be queried
- Returns:
- a Rectanglecontaining the tab bounds atindex, ornullif tab atindexis not currently visible in the UI, or if there is no UI set on thistabbedpane
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
 
- 
setTitleAt@BeanProperty(preferred=true, visualUpdate=true, description="The title at the specified tab index.") public void setTitleAt(int index, String title) Sets the title atindextotitlewhich can benull. 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.- Parameters:
- index- the tab index where the title should be set
- title- the title to be displayed in the tab
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setIconAt@BeanProperty(preferred=true, visualUpdate=true, description="The icon at the specified tab index.") public void setIconAt(int index, Icon icon) Sets the icon atindextoiconwhich can benull. This does not set disabled icon aticon. 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, usesetDisableIconAt(). 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.- Parameters:
- index- the tab index where the icon should be set
- icon- the icon to be displayed in the tab
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setDisabledIconAt@BeanProperty(preferred=true, visualUpdate=true, description="The disabled icon at the specified tab index.") public void setDisabledIconAt(int index, Icon disabledIcon) Sets the disabled icon atindextoiconwhich can benull. An internal exception is raised if there is no tab at that index.- Parameters:
- index- the tab index where the disabled icon should be set
- disabledIcon- the icon to be displayed in the tab when disabled
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setToolTipTextAt@BeanProperty(preferred=true, description="The tooltip text at the specified tab index.") public void setToolTipTextAt(int index, String toolTipText) Sets the tooltip text atindextotoolTipTextwhich can benull. An internal exception is raised if there is no tab at that index.- Parameters:
- index- the tab index where the tooltip text should be set
- toolTipText- the tooltip text to be displayed for the tab
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- Since:
- 1.3
- See Also:
 
- 
setBackgroundAt@BeanProperty(preferred=true, visualUpdate=true, description="The background color at the specified tab index.") public void setBackgroundAt(int index, Color background) Sets the background color atindextobackgroundwhich can benull, in which case the tab's background color will default to the background color of thetabbedpane. 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. - Parameters:
- index- the tab index where the background should be set
- background- the color to be displayed in the tab's background
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setForegroundAt@BeanProperty(preferred=true, visualUpdate=true, description="The foreground color at the specified tab index.") public void setForegroundAt(int index, Color foreground) Sets the foreground color atindextoforegroundwhich can benull, in which case the tab's foreground color will default to the foreground color of thistabbedpane. 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. - Parameters:
- index- the tab index where the foreground should be set
- foreground- the color to be displayed as the tab's foreground
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setEnabledAtpublic void setEnabledAt(int index, boolean enabled) Sets whether or not the tab atindexis enabled. An internal exception is raised if there is no tab at that index.- Parameters:
- index- the tab index which should be enabled/disabled
- enabled- whether or not the tab should be enabled
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setComponentAt@BeanProperty(visualUpdate=true, description="The component at the specified tab index.") public void setComponentAt(int index, Component component) Sets the component atindextocomponent. An internal exception is raised if there is no tab at that index.- Parameters:
- index- the tab index where this component is being placed
- component- the component for the tab
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- See Also:
 
- 
setDisplayedMnemonicIndexAt@BeanProperty(visualUpdate=true, description="the index into the String to draw the keyboard character mnemonic at") public 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. 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 invokingsetMnemonicAt(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. - Parameters:
- tabIndex- the index of the tab that the mnemonic refers to
- mnemonicIndex- index into the- Stringto underline
- Throws:
- IndexOutOfBoundsException- if- tabIndexis out of range (- tabIndex < 0 || tabIndex >= tab count)
- IllegalArgumentException- will be thrown if- mnemonicIndexis >= length of the tab title , or < -1
- Since:
- 1.4
- See Also:
 
- 
setMnemonicAt@BeanProperty(visualUpdate=true, description="The keyboard mnenmonic, as a KeyEvent VK constant, for the specified tab") public void setMnemonicAt(int tabIndex, int 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_XXXkeycodes defined injava.awt.event.KeyEventor one of the extended keycodes obtained throughjava.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. - Parameters:
- tabIndex- the index of the tab that the mnemonic refers to
- mnemonic- the key code which represents the mnemonic
- Throws:
- IndexOutOfBoundsException- if- tabIndexis out of range (- tabIndex < 0 || tabIndex >= tab count)
- Since:
- 1.4
- See Also:
 
- 
indexOfTabReturns the first tab index with a giventitle, or -1 if no tab has this title.- Parameters:
- title- the title for the tab
- Returns:
- the first tab index which matches title, or -1 if no tab has this title
 
- 
indexOfTabReturns the first tab index with a givenicon, or -1 if no tab has this icon.- Parameters:
- icon- the icon for the tab
- Returns:
- the first tab index which matches icon, or -1 if no tab has this icon
 
- 
indexOfComponentReturns the index of the tab for the specified component. Returns -1 if there is no tab for this component.- Parameters:
- component- the component for the tab
- Returns:
- the first tab which matches this component, or -1 if there is no tab for this component
 
- 
indexAtLocationpublic int indexAtLocation(int x, int y) Returns the tab index corresponding to the tab whose bounds intersect the specified location. Returns -1 if no tab intersects the location.- Parameters:
- x- the x location relative to this tabbedpane
- y- the y location relative to this tabbedpane
- Returns:
- the tab index which intersects the location, or -1 if no tab intersects the location
- Since:
- 1.4
 
- 
getToolTipTextReturns the tooltip text for the component determined by the mouse event location.- Overrides:
- getToolTipTextin class- JComponent
- Parameters:
- event- the- MouseEventthat tells where the cursor is lingering
- Returns:
- the Stringcontaining the tooltip text
 
- 
paramStringReturns a string representation of thisJTabbedPane. 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 benull.- Overrides:
- paramStringin class- JComponent
- Returns:
- a string representation of this JTabbedPane.
 
- 
getAccessibleContextGets 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.- Specified by:
- getAccessibleContextin interface- Accessible
- Overrides:
- getAccessibleContextin class- Component
- Returns:
- an AccessibleJTabbedPane that serves as the AccessibleContext of this JTabbedPane
 
- 
setTabComponentAt@BeanProperty(preferred=true, visualUpdate=true, description="The tab component at the specified tab index.") public void setTabComponentAt(int index, Component component) Sets the component that is responsible for rendering the title for the specified tab. A null value meansJTabbedPanewill render the title and/or icon for the specified tab. A non-null value means the component will render the title andJTabbedPanewill not render the title and/or icon.Note: The component must not be one that the developer has already added to the tabbed pane. - Parameters:
- index- the tab index where the component should be set
- component- the component to render the title for the specified tab
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- IllegalArgumentException- if component has already been added to this- JTabbedPane
- Since:
- 1.6
- See Also:
 
- 
getTabComponentAtReturns the tab component atindex.- Parameters:
- index- the index of the item being queried
- Returns:
- the tab component at index
- Throws:
- IndexOutOfBoundsException- if index is out of range- (index < 0 || index >= tab count)
- Since:
- 1.6
- See Also:
 
- 
indexOfTabComponentReturns the index of the tab for the specified tab component. Returns -1 if there is no tab for this tab component.- Parameters:
- tabComponent- the tab component for the tab
- Returns:
- the first tab which matches this tab component, or -1 if there is no tab for this tab component
- Since:
- 1.6
- See Also:
 
 
-