javax.swing.plaf.basic

Class BasicTabbedPaneUI

    • Field Detail

      • highlight

        protected Color highlight
      • lightHighlight

        protected Color lightHighlight
      • shadow

        protected Color shadow
      • darkShadow

        protected Color darkShadow
      • focus

        protected Color focus
      • textIconGap

        protected int textIconGap
      • tabRunOverlay

        protected int tabRunOverlay
      • tabInsets

        protected Insets tabInsets
      • selectedTabPadInsets

        protected Insets selectedTabPadInsets
      • tabAreaInsets

        protected Insets tabAreaInsets
      • contentBorderInsets

        protected Insets contentBorderInsets
      • upKey

        @Deprecated
        protected KeyStroke upKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
      • downKey

        @Deprecated
        protected KeyStroke downKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
      • leftKey

        @Deprecated
        protected KeyStroke leftKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
      • rightKey

        @Deprecated
        protected KeyStroke rightKey
        Deprecated. As of Java 2 platform v1.3.
        As of Java 2 platform v1.3 this previously undocumented field is no longer used. Key bindings are now defined by the LookAndFeel, please refer to the key bindings specification for further details.
      • tabRuns

        protected int[] tabRuns
      • runCount

        protected int runCount
      • selectedRun

        protected int selectedRun
      • maxTabHeight

        protected int maxTabHeight
      • maxTabWidth

        protected int maxTabWidth
      • calcRect

        protected transient Rectangle calcRect
        A rectangle used for general layout calculations in order to avoid constructing many new Rectangles on the fly.
    • Constructor Detail

      • BasicTabbedPaneUI

        public BasicTabbedPaneUI()
    • Method Detail

      • installUI

        public void installUI(JComponent c)
        Description copied from class: ComponentUI
        Configures the specified component appropriately for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:
        1. Install default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
        2. Install a LayoutManager on the component if necessary.
        3. Create/add any required sub-components to the component.
        4. Create/install event listeners on the component.
        5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
        6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
        7. Initialize any appropriate instance data.
        Overrides:
        installUI in class ComponentUI
        Parameters:
        c - the component where this UI delegate is being installed
        See Also:
        ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()
      • uninstallUI

        public void uninstallUI(JComponent c)
        Description copied from class: ComponentUI
        Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:
        1. Remove any UI-set borders from the component.
        2. Remove any UI-set layout managers on the component.
        3. Remove any UI-added sub-components from the component.
        4. Remove any UI-added event/property listeners from the component.
        5. Remove any UI-installed keyboard UI from the component.
        6. Nullify any allocated instance data objects to allow for GC.
        Overrides:
        uninstallUI in class ComponentUI
        Parameters:
        c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
        See Also:
        ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()
      • installComponents

        protected void installComponents()
        Creates and installs any required subcomponents for the JTabbedPane. Invoked by installUI.
        Since:
        1.4
      • createScrollButton

        protected JButton createScrollButton(int direction)
        Creates and returns a JButton that will provide the user with a way to scroll the tabs in a particular direction. The returned JButton must be instance of UIResource.
        Parameters:
        direction - One of the SwingConstants constants: SOUTH, NORTH, EAST or WEST
        Returns:
        Widget for user to
        Throws:
        IllegalArgumentException - if direction is not one of NORTH, SOUTH, EAST or WEST
        Since:
        1.5
        See Also:
        JTabbedPane.setTabPlacement(int), SwingConstants
      • uninstallComponents

        protected void uninstallComponents()
        Removes any installed subcomponents from the JTabbedPane. Invoked by uninstallUI.
        Since:
        1.4
      • installDefaults

        protected void installDefaults()
      • uninstallDefaults

        protected void uninstallDefaults()
      • installListeners

        protected void installListeners()
      • uninstallListeners

        protected void uninstallListeners()
      • createMouseListener

        protected MouseListener createMouseListener()
      • createFocusListener

        protected FocusListener createFocusListener()
      • createChangeListener

        protected ChangeListener createChangeListener()
      • installKeyboardActions

        protected void installKeyboardActions()
      • uninstallKeyboardActions

        protected void uninstallKeyboardActions()
      • setRolloverTab

        protected void setRolloverTab(int index)
        Sets the tab the mouse is currently over to index. index will be -1 if the mouse is no longer over any tab. No checking is done to ensure the passed in index identifies a valid tab.
        Parameters:
        index - Index of the tab the mouse is over.
        Since:
        1.5
      • getRolloverTab

        protected int getRolloverTab()
        Returns the tab the mouse is currently over, or -1 if the mouse is no longer over any tab.
        Returns:
        the tab the mouse is currently over, or -1 if the mouse is no longer over any tab
        Since:
        1.5
      • getMaximumSize

        public Dimension getMaximumSize(JComponent c)
        Description copied from class: ComponentUI
        Returns the specified component's maximum size appropriate for the look and feel. If null is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.
        Overrides:
        getMaximumSize in class ComponentUI
        Parameters:
        c - the component whose maximum size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
        Returns:
        a Dimension object or null
        See Also:
        JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)
      • getBaseline

        protected int getBaseline(int tab)
        Returns the baseline for the specified tab.
        Parameters:
        tab - index of tab to get baseline for
        Returns:
        baseline or a value < 0 indicating there is no reasonable baseline
        Throws:
        IndexOutOfBoundsException - if index is out of range (index < 0 || index >= tab count)
        Since:
        1.6
      • getBaselineOffset

        protected int getBaselineOffset()
        Returns the amount the baseline is offset by. This is typically the same as getTabLabelShiftY.
        Returns:
        amount to offset the baseline by
        Since:
        1.6
      • paint

        public void paint(Graphics g,
                 JComponent c)
        Description copied from class: ComponentUI
        Paints the specified component appropriately for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.
        Overrides:
        paint in class ComponentUI
        Parameters:
        g - the Graphics context in which to paint
        c - the component being painted; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components
        See Also:
        ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)
      • paintTabArea

        protected void paintTabArea(Graphics g,
                        int tabPlacement,
                        int selectedIndex)
        Paints the tabs in the tab area. Invoked by paint(). The graphics parameter must be a valid Graphics object. Tab placement may be either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT. The selected index must be a valid tabbed pane tab index (0 to tab count - 1, inclusive) or -1 if no tab is currently selected. The handling of invalid parameters is unspecified.
        Parameters:
        g - the graphics object to use for rendering
        tabPlacement - the placement for the tabs within the JTabbedPane
        selectedIndex - the tab index of the selected component
        Since:
        1.4
      • paintIcon

        protected void paintIcon(Graphics g,
                     int tabPlacement,
                     int tabIndex,
                     Icon icon,
                     Rectangle iconRect,
                     boolean isSelected)
      • getTabLabelShiftX

        protected int getTabLabelShiftX(int tabPlacement,
                            int tabIndex,
                            boolean isSelected)
      • getTabLabelShiftY

        protected int getTabLabelShiftY(int tabPlacement,
                            int tabIndex,
                            boolean isSelected)
      • paintFocusIndicator

        protected void paintFocusIndicator(Graphics g,
                               int tabPlacement,
                               Rectangle[] rects,
                               int tabIndex,
                               Rectangle iconRect,
                               Rectangle textRect,
                               boolean isSelected)
      • paintTabBorder

        protected void paintTabBorder(Graphics g,
                          int tabPlacement,
                          int tabIndex,
                          int x,
                          int y,
                          int w,
                          int h,
                          boolean isSelected)
        this function draws the border around each tab note that this function does now draw the background of the tab. that is done elsewhere
      • paintTabBackground

        protected void paintTabBackground(Graphics g,
                              int tabPlacement,
                              int tabIndex,
                              int x,
                              int y,
                              int w,
                              int h,
                              boolean isSelected)
      • paintContentBorder

        protected void paintContentBorder(Graphics g,
                              int tabPlacement,
                              int selectedIndex)
      • paintContentBorderTopEdge

        protected void paintContentBorderTopEdge(Graphics g,
                                     int tabPlacement,
                                     int selectedIndex,
                                     int x,
                                     int y,
                                     int w,
                                     int h)
      • paintContentBorderLeftEdge

        protected void paintContentBorderLeftEdge(Graphics g,
                                      int tabPlacement,
                                      int selectedIndex,
                                      int x,
                                      int y,
                                      int w,
                                      int h)
      • paintContentBorderBottomEdge

        protected void paintContentBorderBottomEdge(Graphics g,
                                        int tabPlacement,
                                        int selectedIndex,
                                        int x,
                                        int y,
                                        int w,
                                        int h)
      • paintContentBorderRightEdge

        protected void paintContentBorderRightEdge(Graphics g,
                                       int tabPlacement,
                                       int selectedIndex,
                                       int x,
                                       int y,
                                       int w,
                                       int h)
      • getTabBounds

        public Rectangle getTabBounds(JTabbedPane pane,
                             int i)
        Returns the bounds of the specified tab index. The bounds are with respect to the JTabbedPane's coordinate space.
        Specified by:
        getTabBounds in class TabbedPaneUI
      • tabForCoordinate

        public int tabForCoordinate(JTabbedPane pane,
                           int x,
                           int y)
        Returns the tab index which intersects the specified point in the JTabbedPane's coordinate space.
        Specified by:
        tabForCoordinate in class TabbedPaneUI
      • getTabBounds

        protected Rectangle getTabBounds(int tabIndex,
                             Rectangle dest)
        Returns the bounds of the specified tab in the coordinate space of the JTabbedPane component. This is required because the tab rects are by default defined in the coordinate space of the component where they are rendered, which could be the JTabbedPane (for WRAP_TAB_LAYOUT) or a ScrollableTabPanel (SCROLL_TAB_LAYOUT). This method should be used whenever the tab rectangle must be relative to the JTabbedPane itself and the result should be placed in a designated Rectangle object (rather than instantiating and returning a new Rectangle each time). The tab index parameter must be a valid tabbed pane tab index (0 to tab count - 1, inclusive). The destination rectangle parameter must be a valid Rectangle instance. The handling of invalid parameters is unspecified.
        Parameters:
        tabIndex - the index of the tab
        dest - the rectangle where the result should be placed
        Returns:
        the resulting rectangle
        Since:
        1.4
      • getVisibleComponent

        protected Component getVisibleComponent()
      • setVisibleComponent

        protected void setVisibleComponent(Component component)
      • assureRectsCreated

        protected void assureRectsCreated(int tabCount)
      • expandTabRunsArray

        protected void expandTabRunsArray()
      • getRunForTab

        protected int getRunForTab(int tabCount,
                       int tabIndex)
      • lastTabInRun

        protected int lastTabInRun(int tabCount,
                       int run)
      • getTabRunOverlay

        protected int getTabRunOverlay(int tabPlacement)
      • getTabRunIndent

        protected int getTabRunIndent(int tabPlacement,
                          int run)
      • shouldPadTabRun

        protected boolean shouldPadTabRun(int tabPlacement,
                              int run)
      • shouldRotateTabRuns

        protected boolean shouldRotateTabRuns(int tabPlacement)
      • getIconForTab

        protected Icon getIconForTab(int tabIndex)
      • getTextViewForTab

        protected View getTextViewForTab(int tabIndex)
        Returns the text View object required to render stylized text (HTML) for the specified tab or null if no specialized text rendering is needed for this tab. This is provided to support html rendering inside tabs.
        Parameters:
        tabIndex - the index of the tab
        Returns:
        the text view to render the tab's text or null if no specialized rendering is required
        Since:
        1.4
      • calculateTabHeight

        protected int calculateTabHeight(int tabPlacement,
                             int tabIndex,
                             int fontHeight)
      • calculateMaxTabHeight

        protected int calculateMaxTabHeight(int tabPlacement)
      • calculateTabWidth

        protected int calculateTabWidth(int tabPlacement,
                            int tabIndex,
                            FontMetrics metrics)
      • calculateMaxTabWidth

        protected int calculateMaxTabWidth(int tabPlacement)
      • calculateTabAreaHeight

        protected int calculateTabAreaHeight(int tabPlacement,
                                 int horizRunCount,
                                 int maxTabHeight)
      • calculateTabAreaWidth

        protected int calculateTabAreaWidth(int tabPlacement,
                                int vertRunCount,
                                int maxTabWidth)
      • getTabInsets

        protected Insets getTabInsets(int tabPlacement,
                          int tabIndex)
      • getSelectedTabPadInsets

        protected Insets getSelectedTabPadInsets(int tabPlacement)
      • getTabAreaInsets

        protected Insets getTabAreaInsets(int tabPlacement)
      • getContentBorderInsets

        protected Insets getContentBorderInsets(int tabPlacement)
      • getFontMetrics

        protected FontMetrics getFontMetrics()
      • protected void navigateSelectedTab(int direction)
      • selectNextTabInRun

        protected void selectNextTabInRun(int current)
      • selectPreviousTabInRun

        protected void selectPreviousTabInRun(int current)
      • selectNextTab

        protected void selectNextTab(int current)
      • selectPreviousTab

        protected void selectPreviousTab(int current)
      • selectAdjacentRunTab

        protected void selectAdjacentRunTab(int tabPlacement,
                                int tabIndex,
                                int offset)
      • getFocusIndex

        protected int getFocusIndex()
        Returns the index of the tab that has focus.
        Returns:
        index of tab that has focus
        Since:
        1.5
      • getTabRunOffset

        protected int getTabRunOffset(int tabPlacement,
                          int tabCount,
                          int tabIndex,
                          boolean forward)
      • getPreviousTabIndex

        protected int getPreviousTabIndex(int base)
      • getNextTabIndex

        protected int getNextTabIndex(int base)
      • getNextTabIndexInRun

        protected int getNextTabIndexInRun(int tabCount,
                               int base)
      • getPreviousTabIndexInRun

        protected int getPreviousTabIndexInRun(int tabCount,
                                   int base)
      • getPreviousTabRun

        protected int getPreviousTabRun(int baseRun)
      • getNextTabRun

        protected int getNextTabRun(int baseRun)
      • rotateInsets

        protected static void rotateInsets(Insets topInsets,
                        Insets targetInsets,
                        int targetPlacement)

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/plaf/basic/basictabbedpaneui.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut