Module java.desktop
Package javax.swing

Class JTabbedPane

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

    @JavaBean(defaultProperty="UI",
          description="A component which provides a tab folder metaphor for displaying one component from a set of components.")
public class JTabbedPane
extends JComponent
implements Serializable, Accessible, SwingConstants
    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.

    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:
    SingleSelectionModel, Serialized Form

    • 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)

      • 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​(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

      • createChangeListener

        protected ChangeListener createChangeListener​()
        Subclasses that want to handle ChangeEvents differently can override this to return a subclass of ModelListener or another ChangeListener implementation.
        Returns:
        a ChangeListener
        See Also:
        fireStateChanged()

      • getChangeListeners

        @BeanProperty(bound=false)
public ChangeListener[] getChangeListeners​()
        Returns an array of all the ChangeListeners added to this JTabbedPane with addChangeListener.
        Returns:
        all of the ChangeListeners added or an empty array if no listeners have been added
        Since:
        1.4

      • fireStateChanged

        protected void fireStateChanged​()
        Sends a ChangeEvent, with this JTabbedPane as the source, to each registered listener. This method is called each time there is a change to either the selected index or the selected tab in the JTabbedPane. Usually, the selected index and selected tab change together. However, there are some cases, such as tab addition, where the selected index changes and the same tab remains selected. There are other cases, such as deleting the selected tab, where the index remains the same, but a new tab moves to that index. Events are fired for all of these cases.
        See Also:
        addChangeListener(javax.swing.event.ChangeListener), EventListenerList

      • getTabPlacement

        public int getTabPlacement​()
        Returns the placement of the tabs for this tabbedpane.
        Returns:
        an int specifying the placement for the tabs
        See Also:
        setTabPlacement(int)

      • 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
        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.
        Returns:
        an int specifying the policy used to layout the tabs
        Since:
        1.4
        See Also:
        setTabLayoutPolicy(int)

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

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

        @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:
        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

        @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 the selectedIndex to the index corresponding to the specified component.
        Parameters:
        c - the selected Component for this TabbedPane
        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 new tab for the given component, at the given index, represented by the given title and/or icon, either of which may be null.
        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 (> 0 and <= getTabCount())
        Throws:
        IndexOutOfBoundsException - if the index is out of range (< 0 or > getTabCount())
        See Also:
        addTab(java.lang.String, javax.swing.Icon, java.awt.Component, java.lang.String), removeTabAt(int)

      • getTabCount

        @BeanProperty(bound=false)
public int getTabCount​()
        Returns the number of tabs in this tabbedpane.
        Returns:
        an integer specifying the number of tabbed pages

      • getTabRunCount

        @BeanProperty(bound=false)
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

      • getDisabledIconAt

        public Icon getDisabledIconAt​(int index)
        Returns the tab disabled icon at index. If the tab disabled icon doesn't exist at index this will forward the call to the look and feel to construct an appropriate disabled Icon from the corresponding enabled Icon. Some look and feels might not render the disabled Icon, in which case it won't be created.
        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)
        Since:
        1.3
        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)

      • 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)

      • 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 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
        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:
        getDisabledIconAt(int)

      • setToolTipTextAt

        @BeanProperty(preferred=true,
              description="The tooltip text at the specified tab index.")
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)
        Since:
        1.3
        See Also:
        getToolTipTextAt(int)

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

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

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

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

        @BeanProperty(visualUpdate=true,
              description="The component at the specified tab index.")
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

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

        @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_XXX keycodes defined in java.awt.event.KeyEvent or one of the extended keycodes obtained through java.awt.event.KeyEvent.getExtendedKeyCodeForChar. Mnemonics are case-insensitive, therefore a key event with the corresponding keycode would cause the button to be activated whether or not the Shift modifier was pressed.

        This will update the displayed mnemonic property for the specified tab.

        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

        @BeanProperty(bound=false)
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 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 means JTabbedPane will render the title and/or icon for the specified tab. A non-null value means the component will render the title and JTabbedPane will not render the title and/or icon.

        Note: The component must not be one that the developer has already added to the tabbed pane.

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

      • indexOfTabComponent

        public int indexOfTabComponent​(Component tabComponent)
        Returns 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:
        setTabComponentAt(int, java.awt.Component), getTabComponentAt(int)