javax.swing
Class JTabbedPane

java.lang.Object   
  java.awt.Component   
      java.awt.Container   
          javax.swing.JComponent   
              javax.swing.JTabbedPane

All Implemented Interfaces:

ImageObserver , MenuContainer , Serializable , Accessible , SwingConstants

public class JTabbedPane
extends JComponent   
implements Serializable   , Accessible   , SwingConstants   

A component that lets the user switch between a group of components by clicking on a tab with a given title and/or icon. For examples and information on using tabbed panes see How to Use Tabbed Panes, a section in The Java Tutorial.

Tabs/components are added to a TabbedPane object by using the addTab and insertTab methods. A tab is represented by an index corresponding to the position it was added in, where the first tab has an index equal to 0 and the last tab has an index equal to the tab count minus 1.

The TabbedPane uses a SingleSelectionModel to represent the set of tab indices and the currently selected index. If the tab count is greater than 0, then there will always be a selected index, which by default will be initialized to the first tab. If the tab count is 0, then the selected index will be -1.

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^TM has been added to the java.beans package. Please see XMLEncoder .

See Also:

SingleSelectionModel , Serialized Form

Nested Class Summary

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.

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent , Component.BltBufferStrategy , Component.FlipBufferStrategy

Field Summary

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.

Fields inherited from class javax.swing.JComponent

accessibleContext , listenerList , TOOL_TIP_TEXT_KEY , ui , UNDEFINED_CONDITION , WHEN_ANCESTOR_OF_FOCUSED_COMPONENT , WHEN_FOCUSED , WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT , CENTER_ALIGNMENT , LEFT_ALIGNMENT , RIGHT_ALIGNMENT , TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM , CENTER , EAST , HORIZONTAL , LEADING , LEFT , NEXT , NORTH , NORTH_EAST , NORTH_WEST , PREVIOUS , RIGHT , SOUTH , SOUTH_EAST , SOUTH_WEST , TOP , TRAILING , VERTICAL , WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT , ALLBITS , ERROR , FRAMEBITS , HEIGHT , PROPERTIES , SOMEBITS , WIDTH

Constructor Summary

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.

Method Summary

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, whose source is this tabbedpane, to each 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.
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 (Icon icon) Returns the first tab index with a given icon, or -1 if no tab has this icon.
int	indexOfTab (String title) Returns the first tab index with a given title, or -1 if no tab has this title.
void	insertTab (String title, Icon icon, Component component, String tip, int index) Inserts a component, at index, represented by a title and/or icon, either of which may be null.