Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.4.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.swing
Class JTabbedPane

    java.lang.Object
      |
      +--java.awt.Component
            |
            +--java.awt.Container
                  |
                  +--javax.swing.JComponent
                        |
                        +--javax.swing.JTabbedPane

All Implemented Interfaces:
  Accessible, ImageObserver, MenuContainer, Serializable, 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.

For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the `JTabbedPane` key assignments.

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

See Also:
  `SingleSelectionModel`

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 inherited from class javax.swing.JComponent
``

Nested classes inherited from class java.awt.Container
``

Nested classes inherited from class java.awt.Component
`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 `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.
`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`.
`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 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 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` | `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.

Methods inherited from class javax.swing.JComponent
`addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update`

Methods inherited from class java.awt.Container
`addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree`

Methods inherited from class java.awt.Component
`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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### WRAP_TAB_LAYOUT

    public static final int WRAP_TAB_LAYOUT

  The tab layout policy for wrapping tabs in multiple runs when all tabs will not fit within a single run.

  See Also:
    Constant Field Values

### SCROLL_TAB_LAYOUT

    public static final 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. 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:
    Constant Field Values

### tabPlacement

    protected int tabPlacement

  Where the tabs are placed.

  See Also:
    `setTabPlacement(int)`

### model

    protected SingleSelectionModel model

  The default selection model

### changeListener

    protected ChangeListener changeListener

  The `changeListener` is the listener we add to the model.

### changeEvent

    protected transient ChangeEvent changeEvent

  Only one `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".

Constructor Detail

### JTabbedPane

    public JTabbedPane()

  Creates an empty `TabbedPane` with a default tab placement of `JTabbedPane.TOP`.

See Also:
  `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`

### JTabbedPane

    public JTabbedPane(int tabPlacement)

  Creates an empty `TabbedPane` with the specified tab placement of either: `JTabbedPane.TOP`, `JTabbedPane.BOTTOM`, `JTabbedPane.LEFT`, or `JTabbedPane.RIGHT`.

Parameters:
  `tabPlacement` - the placement for the tabs relative to the content
See Also:
  `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`

### JTabbedPane

    public JTabbedPane(int tabPlacement,
                       int tabLayoutPolicy)

  Creates an empty `TabbedPane` with the specified tab placement and tab layout policy. Tab placement may be either: `JTabbedPane.TOP`, `JTabbedPane.BOTTOM`, `JTabbedPane.LEFT`, or `JTabbedPane.RIGHT`. Tab layout policy may be either: `JTabbedPane.WRAP_TAB_LAYOUT` or `JTabbedPane.SCROLL_TAB_LAYOUT`.

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:
  `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`

Method Detail

### getUI

    public TabbedPaneUI getUI()

  Returns the UI object which implements the L&F for this component.

  Returns:
    a `TabbedPaneUI` object
  See Also:
    `setUI(javax.swing.plaf.TabbedPaneUI)`

### setUI

    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:
    `UIDefaults.getUI(javax.swing.JComponent)`

### updateUI

    public void updateUI()

  Resets the UI property to a value from the current look and feel.

  Overrides:
    `updateUI` in class `JComponent`
  See Also:
    `JComponent.updateUI()`

### getUIClassID

    public String getUIClassID()

  Returns the name of the UI class that implements the L&F for this component.

  Overrides:
    `getUIClassID` in class `JComponent`
  Returns:
    the string "TabbedPaneUI"
  See Also:
    `JComponent.getUIClassID()`, `UIDefaults.getUI(javax.swing.JComponent)`

### createChangeListener

    protected ChangeListener createChangeListener()

  Subclasses that want to handle `ChangeEvents` differently can override this to return a subclass of `ModelListener` or another `ChangeListener` implementation.

  See Also:
    `fireStateChanged()`

### addChangeListener

    public void addChangeListener(ChangeListener l)

  Adds a `ChangeListener` to this tabbedpane.

  Parameters:
    `l` - the `ChangeListener` to add
  See Also:
    `fireStateChanged()`, `removeChangeListener(javax.swing.event.ChangeListener)`

### removeChangeListener

    public void removeChangeListener(ChangeListener l)

  Removes a `ChangeListener` from this tabbedpane.

  Parameters:
    `l` - the `ChangeListener` to remove
  See Also:
    `fireStateChanged()`, `addChangeListener(javax.swing.event.ChangeListener)`

### getChangeListeners

    public ChangeListener[] getChangeListeners()

  Returns an array of all the `ChangeListener`s added to this `JTabbedPane` with `addChangeListener`.

  Returns:
    all of the `ChangeListener`s added or an empty array if no listeners have been added
  Since:
    1.4

### fireStateChanged

    protected void fireStateChanged()

  Sends a `ChangeEvent`, whose source is this tabbedpane, to each listener. This method method is called each time a `ChangeEvent` is received from the model.

  See Also:
    `addChangeListener(javax.swing.event.ChangeListener)`, `EventListenerList`

### getModel

    public SingleSelectionModel getModel()

  Returns the model associated with this tabbedpane.

  See Also:
    `setModel(javax.swing.SingleSelectionModel)`

### setModel

    public void setModel(SingleSelectionModel model)

  Sets the model to be used with this tabbedpane.

  Parameters:
    `model` - the model to be used
  See Also:
    `getModel()`

### getTabPlacement

    public int getTabPlacement()

  Returns the placement of the tabs for this tabbedpane.

  See Also:
    `setTabPlacement(int)`

### setTabPlacement

    public void setTabPlacement(int tabPlacement)

  Sets the tab placement for this tabbedpane. Possible values are:
  - `JTabbedPane.TOP`
  - `JTabbedPane.BOTTOM`
  - `JTabbedPane.LEFT`
  - `JTabbedPane.RIGHT`
  The default value, if not set, is `SwingConstants.TOP`.

  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

### getTabLayoutPolicy

    public int getTabLayoutPolicy()

  Returns the policy used by the tabbedpane to layout the tabs when all the tabs will not fit within a single run.

  Since:
    1.4
  See Also:
    `setTabLayoutPolicy(int)`

### setTabLayoutPolicy

    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`
  The default value, if not set by the UI, is `JTabbedPane.WRAP_TAB_LAYOUT`.

  Some look and feels might only support a subset of the possible layout policies, in which case the value of this property may be ignored.

  Throws:
    `IllegalArgumentException` - if layoutPolicy value isn't one of the above valid values
  Since:
    1.4
  See Also:
    `getTabLayoutPolicy()`

### getSelectedIndex

    public 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(int)`

### setSelectedIndex

    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:
    `getSelectedIndex()`, `SingleSelectionModel.setSelectedIndex(int)`

### getSelectedComponent

    public Component getSelectedComponent()

  Returns the currently selected component for this tabbedpane. Returns `null` if there is no currently selected tab.

  Returns:
    the component corresponding to the selected tab
  See Also:
    `setSelectedComponent(java.awt.Component)`

### setSelectedComponent

    public void setSelectedComponent(Component c)

  Sets the selected component for this tabbedpane. This will automatically set the `selectedIndex` to the index corresponding to the specified component.

  Throws:
    `IllegalArgumentException` - if component not found in tabbed pane
  See Also:
    `getSelectedComponent()`

### insertTab

    public 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`. If `icon` is non-`null` and it implements `ImageIcon` a corresponding disabled icon will automatically be created and set on the tabbedpane. Uses java.util.Vector internally, see `insertElementAt` for details of insertion conventions.

  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
    `index` - the position to insert this new tab
  See Also:
    `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`, `removeTabAt(int)`

### addTab

    public 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`. If `icon` is non-`null` and it implements `ImageIcon` a corresponding disabled icon will automatically be created and set on the tabbedpane. Cover method for `insertTab`.

  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:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### addTab

    public void addTab(String title,
                       Icon icon,
                       Component component)

  Adds a `component` represented by a `title` and/or `icon`, either of which can be `null`. If `icon` is non-`null` and it implements `ImageIcon` a corresponding disabled icon will automatically be created and set on the tabbedpane. Cover method for `insertTab`.

  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:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### addTab

    public void addTab(String title,
                       Component component)

  Adds a `component` represented by a `title` and no icon. Cover method for `insertTab`.

  Parameters:
    `title` - the title to be displayed in this tab
    `component` - the component to be displayed when this tab is clicked
  See Also:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### add

    public 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`. Cover method for `insertTab`.

  Overrides:
    `add` in class `Container`
  Parameters:
    `component` - the component to be displayed when this tab is clicked
  Returns:
    the component
  See Also:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### add

    public Component add(String title,
                         Component component)

  Adds a `component` with the specified tab title. Cover method for `insertTab`.

  Overrides:
    `add` in class `Container`
  Parameters:
    `title` - the title to be displayed in this tab
    `component` - the component to be displayed when this tab is clicked
  Returns:
    the component
  See Also:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### add

    public 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. Cover method for `insertTab`.

  Overrides:
    `add` in class `Container`
  Parameters:
    `component` - the component to be displayed when this tab is clicked
    `index` - the position to insert this new tab
  Returns:
    the component
  See Also:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### add

    public void add(Component component,
                    Object constraints)

  Adds a `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`.

  Overrides:
    `add` in class `Container`
  Parameters:
    `component` - the component to be displayed when this tab is clicked
    `constraints` - the object to be displayed in the tab
  See Also:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### add

    public void add(Component component,
                    Object constraints,
                    int index)

  Adds a `component` at the specified tab index. If `constraints` is a `String` or an `Icon`, it will be used for the tab title, otherwise the component's name will be used as the tab title. Cover method for `insertTab`.

  Overrides:
    `add` in class `Container`
  Parameters:
    `component` - the component to be displayed when this tab is clicked
    `index` - the position to insert this new tab
    `constraints` - an object expressing layout contraints for this
  See Also:
    `insertTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String, int)`, `removeTabAt(int)`

### removeTabAt

    public void removeTabAt(int index)

  Removes the tab at `index`. After the component associated with `index` is removed, its visibility is reset to true to ensure it will be visible if added to other containers.

  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:
    `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)`

### remove

    public void remove(Component component)

  Removes the specified `Component` from the `JTabbedPane`.

  Overrides:
    `remove` in class `Container`
  Parameters:
    `component` - the component to remove from the tabbedpane
  Throws:
    `NullPointerException` - if `component` is null.
  See Also:
    `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`, `removeTabAt(int)`

### remove

    public void remove(int index)

  Removes the tab and component which corresponds to the specified index.

  Overrides:
    `remove` in 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:
    `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`, `removeTabAt(int)`

### removeAll

    public void removeAll()

  Removes all the tabs and their corresponding components from the `tabbedpane`.

  Overrides:
    `removeAll` in class `Container`
  See Also:
    `addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String)`, `removeTabAt(int)`

### getTabCount

    public int getTabCount()

  Returns the number of tabs in this `tabbedpane`.

  Returns:
    an integer specifying the number of tabbed pages

### getTabRunCount

    public int getTabRunCount()

  Returns the number of tab runs currently used to display the tabs.

  Returns:
    an integer giving the number of rows if the `tabPlacement` is `TOP` or `BOTTOM` and the number of columns if `tabPlacement` is `LEFT` or `RIGHT`, or 0 if there is no UI set on this `tabbedpane`

### getTitleAt

    public String getTitleAt(int index)

  Returns the tab title at `index`.

  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:
    `setTitleAt(int, java.lang.String)`

### getIconAt

    public Icon getIconAt(int index)

  Returns the tab icon at `index`.

  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:
    `* If `icon` is non-null and it implements `ImageIcon` a corresponding disabled icon will automatically be created and set on the tabbedpane.`

### getDisabledIconAt

    public Icon getDisabledIconAt(int index)

  Returns the tab disabled icon at `index`.

  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:
    `setDisabledIconAt(int, javax.swing.Icon)`

### getToolTipTextAt

    public String getToolTipTextAt(int index)

  Returns the tab tooltip text at `index`.

  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)
  See Also:
    `setToolTipTextAt(int, java.lang.String)`

### getBackgroundAt

    public Color getBackgroundAt(int index)

  Returns the tab background color at `index`.

  Parameters:
    `index` - the index of the item being queried
  Returns:
    the `Color` of the tab background at `index`
  Throws:
    `IndexOutOfBoundsException` - if index is out of range (index < 0 || index >= tab count)
  See Also:
    `setBackgroundAt(int, java.awt.Color)`

### getForegroundAt

    public Color getForegroundAt(int index)

  Returns the tab foreground color at `index`.

  Parameters:
    `index` - the index of the item being queried
  Returns:
    the `Color` of the tab foreground at `index`
  Throws:
    `IndexOutOfBoundsException` - if index is out of range (index < 0 || index >= tab count)
  See Also:
    `setForegroundAt(int, java.awt.Color)`

### isEnabledAt

    public boolean isEnabledAt(int index)

  Returns whether or not the tab at `index` is currently enabled.

  Parameters:
    `index` - the index of the item being queried
  Returns:
    true if the tab at `index` is enabled; false otherwise
  Throws:
    `IndexOutOfBoundsException` - if index is out of range (index < 0 || index >= tab count)
  See Also:
    `setEnabledAt(int, boolean)`

### getComponentAt

    public Component getComponentAt(int index)

  Returns the component at `index`.

  Parameters:
    `index` - the index of the item being queried
  Returns:
    the `Component` at `index`
  Throws:
    `IndexOutOfBoundsException` - if index is out of range (index < 0 || index >= tab count)
  See Also:
    `setComponentAt(int, java.awt.Component)`

### getMnemonicAt

    public 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:
    `setDisplayedMnemonicIndexAt(int,int)`, `setMnemonicAt(int,int)`

### getDisplayedMnemonicIndexAt

    public 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:
    `setDisplayedMnemonicIndexAt(int,int)`, `setMnemonicAt(int,int)`

### getBoundsAt

    public Rectangle getBoundsAt(int index)

  Returns the tab bounds at `index`. If the tab at this index is not currently visible in the UI, then returns `null`. If there is no UI set on this `tabbedpane`, then returns `null`.

  Parameters:
    `index` - the index to be queried
  Returns:
    a `Rectangle` containing the tab bounds at `index`, or `null` if tab at `index` is not currently visible in the UI, or if there is no UI set on this `tabbedpane`
  Throws:
    `IndexOutOfBoundsException` - if index is out of range (index < 0 || index >= tab count)

### setTitleAt

    public void setTitleAt(int index,
                           String title)

  Sets the title at `index` to `title` which can be `null`. 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:
    `getTitleAt(int)`

### setIconAt

    public void setIconAt(int index,
                          Icon icon)

  Sets the icon at `index` to `icon` which can be `null`. Does not set disabled icon at `icon` To set disabled icon, use `setDisableIconAt()`. 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(int, javax.swing.Icon)`, `getIconAt(int)`

### setDisabledIconAt

    public void setDisabledIconAt(int index,
                                  Icon disabledIcon)

  Sets the disabled icon at `index` to `icon` which can be `null`. An internal exception is raised if there is no tab at that index.

  Parameters:
    `index` - the tab index where the disabled icon should be set
  Throws:
    `IndexOutOfBoundsException` - if index is out of range (index < 0 || index >= tab count)
  See Also:
    `getDisabledIconAt(int)`

### setToolTipTextAt

    public void setToolTipTextAt(int index,
                                 String toolTipText)

  Sets the tooltip text at `index` to `toolTipText` which can be `null`. An internal exception is raised if there is no tab at that index.

  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)
  See Also:
    `getToolTipTextAt(int)`

### setBackgroundAt

    public 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`. An internal exception is raised if there is no tab at that index.

  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:
    `getBackgroundAt(int)`

### setForegroundAt

    public 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`. An internal exception is raised if there is no tab at that index.

  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:
    `getForegroundAt(int)`

### setEnabledAt

    public void setEnabledAt(int index,
                             boolean enabled)

  Sets whether or not the tab at `index` is 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:
    `isEnabledAt(int)`

### setComponentAt

    public void setComponentAt(int index,
                               Component component)

  Sets the component at `index` to `component`. 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:
    `getComponentAt(int)`

### setDisplayedMnemonicIndexAt

    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 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.

  Parameters:
    `tabIndex` - the index of the tab that the mnemonic refers to
    `mnemonicIndex` - index into the `String` to underline
  Throws:
    `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
  Since:
    1.4
  See Also:
    `setMnemonicAt(int,int)`, `getDisplayedMnemonicIndexAt(int)`

### setMnemonicAt

    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_XXX` keycodes defined in `java.awt.event.KeyEvent`. 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 `tabIndex` is out of range (`tabIndex < 0 || tabIndex >= tab count`)
  Since:
    1.4
  See Also:
    `getMnemonicAt(int)`, `setDisplayedMnemonicIndexAt(int,int)`

### indexOfTab

    public int indexOfTab(String title)

  Returns the first tab index with a given `title`, 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

### indexOfTab

    public int indexOfTab(Icon icon)

  Returns the first tab index with a given `icon`, 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

### indexOfComponent

    public int indexOfComponent(Component component)

  Returns 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

### indexAtLocation

    public 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

### getToolTipText

    public String getToolTipText(MouseEvent event)

  Returns the tooltip text for the component determined by the mouse event location.

  Overrides:
    `getToolTipText` in class `JComponent`
  Parameters:
    `event` - the `MouseEvent` that tells where the cursor is lingering
  Returns:
    the `String` containing the tooltip text

### paramString

    protected String paramString()

  Returns a string representation of this `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`.

  Overrides:
    `paramString` in class `JComponent`
  Returns:
    a string representation of this JTabbedPane.

### getAccessibleContext

    public AccessibleContext getAccessibleContext()

  Gets the AccessibleContext associated with this JTabbedPane. For tabbed panes, the AccessibleContext takes the form of an AccessibleJTabbedPane. A new AccessibleJTabbedPane instance is created if necessary.

  Specified by:
    `getAccessibleContext` in interface `Accessible`
  Overrides:
    `getAccessibleContext` in class `JComponent`
  Returns:
    an AccessibleJTabbedPane that serves as the AccessibleContext of this JTabbedPane

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.4.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.