BasicTabbedPaneUI (Java Platform SE 8 ) (original) (raw)

protected JTabbedPane tabPane

protected Color highlight

protected Color lightHighlight

protected Color shadow

protected Color darkShadow

protected Color focus

protected int textIconGap

protected int tabRunOverlay

protected Insets tabInsets

protected Insets selectedTabPadInsets

protected Insets tabAreaInsets

protected Insets contentBorderInsets

@Deprecated
protected KeyStroke upKey
Deprecated.
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.

@Deprecated
protected KeyStroke downKey
Deprecated.
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.

@Deprecated
protected KeyStroke leftKey
Deprecated.
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.

@Deprecated
protected KeyStroke rightKey
Deprecated.
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.

protected int[] tabRuns

protected int runCount

protected int selectedRun

protected Rectangle[] rects

protected int maxTabHeight

protected int maxTabWidth

protected ChangeListener tabChangeListener

protected PropertyChangeListener propertyChangeListener

protected MouseListener mouseListener

protected FocusListener focusListener

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

public static ComponentUI createUI(JComponent c)

public void installUI(JComponent c)
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](../../../../javax/swing/plaf/ComponentUI.html#installUI-javax.swing.JComponent-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
    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()

public void uninstallUI(JComponent c)
Reverses configuration which was done on the specified component duringinstallUI. This method is invoked when thisUIComponent 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](../../../../javax/swing/plaf/ComponentUI.html#uninstallUI-javax.swing.JComponent-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
    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()

protected LayoutManager createLayoutManager()
Invoked by installUI to create a layout manager object to manage the JTabbedPane.
Returns:
a layout manager object
See Also:
BasicTabbedPaneUI.TabbedPaneLayout, JTabbedPane.getTabLayoutPolicy()

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

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](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - if direction is not one of NORTH, SOUTH, EAST or WEST
Since:
1.5
See Also:
JTabbedPane.setTabPlacement(int), SwingConstants

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

protected void installDefaults()

protected void uninstallDefaults()

protected void installListeners()

protected void uninstallListeners()

protected MouseListener createMouseListener()

protected FocusListener createFocusListener()

protected ChangeListener createChangeListener()

protected PropertyChangeListener createPropertyChangeListener()

protected void installKeyboardActions()

protected void uninstallKeyboardActions()

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

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

public Dimension getMinimumSize(JComponent c)
Returns the specified component's minimum size appropriate for the look and feel. If null is returned, the minimum 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:
[getMinimumSize](../../../../javax/swing/plaf/ComponentUI.html#getMinimumSize-javax.swing.JComponent-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
Parameters:
c - the component whose minimum 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.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), ComponentUI.getPreferredSize(javax.swing.JComponent)

public Dimension getMaximumSize(JComponent c)
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](../../../../javax/swing/plaf/ComponentUI.html#getMaximumSize-javax.swing.JComponent-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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)

public int getBaseline(JComponent c,
int width,
int height)
Returns the baseline.
Overrides:
[getBaseline](../../../../javax/swing/plaf/ComponentUI.html#getBaseline-javax.swing.JComponent-int-int-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
Parameters:
c - JComponent baseline is being requested for
width - the width to get the baseline for
height - the height to get the baseline for
Returns:
baseline or a value < 0 indicating there is no reasonable baseline
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if c is null
[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang") - if width or height is < 0
Since:
1.6
See Also:
JComponent.getBaseline(int, int)

public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)
Returns an enum indicating how the baseline of the component changes as the size changes.
Overrides:
[getBaselineResizeBehavior](../../../../javax/swing/plaf/ComponentUI.html#getBaselineResizeBehavior-javax.swing.JComponent-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
Parameters:
c - JComponent to return baseline resize behavior for
Returns:
an enum indicating how the baseline changes as the component size changes
Throws:
[NullPointerException](../../../../java/lang/NullPointerException.html "class in java.lang") - if c is null
Since:
1.6
See Also:
JComponent.getBaseline(int, int)

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](../../../../java/lang/IndexOutOfBoundsException.html "class in java.lang") - if index is out of range (index < 0 || index >= tab count)
Since:
1.6

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

public void paint(Graphics g,
JComponent c)
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](../../../../javax/swing/plaf/ComponentUI.html#paint-java.awt.Graphics-javax.swing.JComponent-) in class [ComponentUI](../../../../javax/swing/plaf/ComponentUI.html "class in javax.swing.plaf")
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)

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

protected void paintTab(Graphics g,
int tabPlacement,
Rectangle[] rects,
int tabIndex,
Rectangle iconRect,
Rectangle textRect)

protected void layoutLabel(int tabPlacement,
FontMetrics metrics,
int tabIndex,
String title,
Icon icon,
Rectangle tabRect,
Rectangle iconRect,
Rectangle textRect,
boolean isSelected)

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

protected void paintText(Graphics g,
int tabPlacement,
Font font,
FontMetrics metrics,
int tabIndex,
String title,
Rectangle textRect,
boolean isSelected)

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

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

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

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

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

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

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

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

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

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

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](../../../../javax/swing/plaf/TabbedPaneUI.html#getTabBounds-javax.swing.JTabbedPane-int-) in class [TabbedPaneUI](../../../../javax/swing/plaf/TabbedPaneUI.html "class in javax.swing.plaf")

public int getTabRunCount(JTabbedPane pane)
Specified by:
[getTabRunCount](../../../../javax/swing/plaf/TabbedPaneUI.html#getTabRunCount-javax.swing.JTabbedPane-) in class [TabbedPaneUI](../../../../javax/swing/plaf/TabbedPaneUI.html "class in javax.swing.plaf")

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](../../../../javax/swing/plaf/TabbedPaneUI.html#tabForCoordinate-javax.swing.JTabbedPane-int-int-) in class [TabbedPaneUI](../../../../javax/swing/plaf/TabbedPaneUI.html "class in javax.swing.plaf")

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

protected Component getVisibleComponent()

protected void setVisibleComponent(Component component)

protected void assureRectsCreated(int tabCount)

protected void expandTabRunsArray()

protected int getRunForTab(int tabCount,
int tabIndex)

protected int lastTabInRun(int tabCount,
int run)

protected int getTabRunOverlay(int tabPlacement)

protected int getTabRunIndent(int tabPlacement,
int run)

protected boolean shouldPadTabRun(int tabPlacement,
int run)

protected boolean shouldRotateTabRuns(int tabPlacement)

protected Icon getIconForTab(int tabIndex)

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

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

protected int calculateMaxTabHeight(int tabPlacement)

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

protected int calculateMaxTabWidth(int tabPlacement)

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

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

protected Insets getTabInsets(int tabPlacement,
int tabIndex)

protected Insets getSelectedTabPadInsets(int tabPlacement)

protected Insets getTabAreaInsets(int tabPlacement)

protected Insets getContentBorderInsets(int tabPlacement)

protected FontMetrics getFontMetrics()

protected void navigateSelectedTab(int direction)

protected void selectNextTabInRun(int current)

protected void selectPreviousTabInRun(int current)

protected void selectNextTab(int current)

protected void selectPreviousTab(int current)

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

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

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

protected int getPreviousTabIndex(int base)

protected int getNextTabIndex(int base)

protected int getNextTabIndexInRun(int tabCount,
int base)

protected int getPreviousTabIndexInRun(int tabCount,
int base)

protected int getPreviousTabRun(int baseRun)

protected int getNextTabRun(int baseRun)

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