Class BasicJideTabbedPaneUI

Method Details

• createUI

  public static ComponentUI createUI(JComponent c)

• installUI

  public void installUI(JComponent c)

  Overrides:

  installUI in class ComponentUI

• installColorTheme

  public void installColorTheme()

• uninstallUI

  public void uninstallUI(JComponent c)

  Overrides:

  uninstallUI in class ComponentUI

• uninstallColorTheme

  public void uninstallColorTheme()

• createLayoutManager

  protected LayoutManager createLayoutManager()

  Invoked by installUI to create a layout manager object to manage the JTabbedPane.

  Returns:

  a layout manager object

  See Also:

  • BasicJideTabbedPaneUI.TabbedPaneLayout
  • JTabbedPane.getTabLayoutPolicy()

• scrollableTabLayoutEnabled

  protected boolean scrollableTabLayoutEnabled()

• installComponents

  protected void installComponents()

  Creates and installs any required subcomponents for the JTabbedPane. Invoked by installUI.

• uninstallComponents

  protected void uninstallComponents()

  Removes any installed subcomponents from the JTabbedPane. Invoked by uninstallUI.

• installDefaults

  protected void installDefaults()

• uninstallDefaults

  protected void uninstallDefaults()

• installListeners

  protected void installListeners()

• createDropListener

  protected com.jidesoft.plaf.basic.BasicJideTabbedPaneUI.DropListener createDropListener()

• uninstallListeners

  protected void uninstallListeners()

• createChangeListener

  protected ChangeListener createChangeListener()

• createFocusListener

  protected FocusListener createFocusListener()

• createPropertyChangeListener

  protected PropertyChangeListener createPropertyChangeListener()

• installKeyboardActions

  protected void installKeyboardActions()

• uninstallKeyboardActions

  protected void uninstallKeyboardActions()

• updateMnemonics

  protected void updateMnemonics()

  Reloads the mnemonics. This should be invoked when a mnemonic changes, when the title of a mnemonic changes, or when tabs are added/removed.

• getPreferredSize

  public Dimension getPreferredSize(JComponent c)

  Overrides:

  getPreferredSize in class ComponentUI

• getMinimumSize

  public Dimension getMinimumSize(JComponent c)

  Overrides:

  getMinimumSize in class ComponentUI

• getMaximumSize

  public Dimension getMaximumSize(JComponent c)

  Overrides:

  getMaximumSize in class ComponentUI

• paint

  public void paint(Graphics g, JComponent c)

  Overrides:

  paint in class ComponentUI

• paintBackground

  public void paintBackground(Graphics g, Component c)

• paintTabArea

  protected void paintTabArea(Graphics g, int tabPlacement, int selectedIndex, Component c)

  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

  c - the component

• paintTabAreaBackground

  protected void paintTabAreaBackground(Graphics g, Rectangle rect, int tabPlacement)

• paintTab

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

• layoutLabel

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

• paintIcon

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

• paintText

  protected void paintText(Graphics g, int tabPlacement, Font font, FontMetrics metrics, int tabIndex, String title, 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

  Parameters:

  g - the Graphics instance

  tabPlacement - the tab placement

  tabIndex - the tab index

  x - x

  y - y

  w - width

  h - height

  isSelected - if the tab is selected

• paintOffice2003TabBorder

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

• paintExcelTabBorder

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

• paintWindowsTabBorder

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

• paintTabBorderMouseOver

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

• paintVsnetTabBorder

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

• paintRoundedVsnetTabBorder

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

• paintFlatTabBorder

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

• paintRoundedFlatTabBorder

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

• paintBoxTabBorder

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

• paintTabBackground

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

• paintOffice2003TabBackground

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

• paintExcelTabBackground

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

• paintDefaultTabBackground

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

• paintTabBackgroundMouseOver

  protected void paintTabBackgroundMouseOver(Graphics g, int tabPlacement, int tabIndex, int x, int y, int w, int h, boolean isSelected, Color backgroundUnselectedColorStart, Color backgroundUnselectedColorEnd)

• paintVsnetTabBackground

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

• paintFlatTabBackground

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

• paintButtonTabBackground

  protected void paintButtonTabBackground(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)

  Paints the border of the conten pane which should reflect the tabs as well.

  Parameters:

  g - the Graphics instance

  tabPlacement - the tab placement

  selectedIndex - the selected tab index

• paintContentBorderLeftEdge

  protected void paintContentBorderLeftEdge(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)

• paintContentBorder

  protected void paintContentBorder(Graphics g, int x, int y, int w, int h)

• getBorderEdgeColor

  protected Color getBorderEdgeColor()

• paintContentBorderTopEdge

  protected void paintContentBorderTopEdge(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)

• ensureCurrentLayout

  protected void ensureCurrentLayout()

• 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

• getTabRunCount

  public int getTabRunCount(JTabbedPane pane)

  Specified by:

  getTabRunCount 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

• getTabAtLocation

  public int getTabAtLocation(int x, int y)

  Returns the tab index which intersects the specified point in the coordinate space of the component where the tabs are actually rendered, which could be the JTabbedPane (for WRAP_TAB_LAYOUT) or a ScrollableTabPanel (SCROLL_TAB_LAYOUT).

  Parameters:

  x - x value of the point

  y - y value of the point

  Returns:

  the tab index in the point (x, y). -1 if no tab could be found.

• isEmptyTabArea

  public boolean isEmptyTabArea(int x, int y)

  Returns if the point resides in the empty tab area, which means it is in the tab area however no real tab contains that point.

  Parameters:

  x - x value of the point

  y - y value of the point

  Returns:

  true if the point is in empty tab area. Otherwise false.

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

• 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

• calculateTabHeight

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

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

• navigateSelectedTab

  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)

• 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

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

• requestFocusForVisibleComponent

  public boolean requestFocusForVisibleComponent()

• createNoFocusButton

  @Deprecated protected BasicJideTabbedPaneUI.TabCloseButton createNoFocusButton(int type)

  Deprecated.

  replaced by JideTabbedPane.createNoFocusButton(int)

  Creates a button.

  Parameters:

  type - the button type

  Returns:

  the button

• stopOrCancelEditing

  protected void stopOrCancelEditing()

• ensureCurrentRects

  protected void ensureCurrentRects(int leftMargin, int tabCount)

• getTabListCellRenderer

  protected ListCellRenderer getTabListCellRenderer()

• updateCloseAction

  protected void updateCloseAction()

• getTabPanel

  public Component getTabPanel()

  Description copied from class: JideTabbedPaneUI

  Gets the tab panel for the JideTabbedPane. The tab panel contains all the tabs and the tabbed pane buttons (close, scroll left/right, list buttons). Sometimes you have to use this tab panel. For example, if you want to add a mouse listener to get double click event on tabs, you must use this tab panel to add mouse listener. In addition, as the tab panel is part of the TabbedPaneUI which is recreated when updateUI is called (which usually happens after switching Linvalid input: '&F'), you should override updateUI method in JideTabbedPane to add mouse listener so that it will get added again after updateUI.

  Specified by:

  getTabPanel in class JideTabbedPaneUI

  Returns:

  the tab panel.

• ensureActiveTabIsVisible

  public void ensureActiveTabIsVisible(boolean scrollLeft)

  Description copied from class: JideTabbedPaneUI

  Scroll the selected tab visible in case the tab is outside of the viewport. This method is called by JideTabbedPane.scrollSelectedTabToVisible(boolean) method.

  Specified by:

  ensureActiveTabIsVisible in class JideTabbedPaneUI

  Parameters:

  scrollLeft - true to scroll the first tab visible first then scroll left to make the selected tab visible. This will get a more consistent result. If false, it will simple scroll the selected tab visible. Sometimes the tab will appear as the first visible tab or the last visible tab depending on the previous viewport position.

• isShowCloseButtonOnTab

  protected boolean isShowCloseButtonOnTab()

• isShowCloseButton

  protected boolean isShowCloseButton()

• ensureCloseButtonCreated

  public void ensureCloseButtonCreated()

• isShowTabButtons

  protected boolean isShowTabButtons()

• isShrinkTabs

  protected boolean isShrinkTabs()

• isTabEditing

  public boolean isTabEditing()

  Description copied from class: JideTabbedPaneUI

  Checks if the tab is being edited.

  Specified by:

  isTabEditing in class JideTabbedPaneUI

  Returns:

  true or false.

• createDefaultTabEditor

  protected BasicJideTabbedPaneUI.TabEditor createDefaultTabEditor()

• stopTabEditing

  public void stopTabEditing()

  Description copied from class: JideTabbedPaneUI

  Stops the editing and commits the change.

  Specified by:

  stopTabEditing in class JideTabbedPaneUI

• cancelTabEditing

  public void cancelTabEditing()

  Description copied from class: JideTabbedPaneUI

  Cancels the editing and discards the change.

  Specified by:

  cancelTabEditing in class JideTabbedPaneUI

• editTabAt

  public boolean editTabAt(int tabIndex)

  Description copied from class: JideTabbedPaneUI

  Edits the tab at the index.

  Specified by:

  editTabAt in class JideTabbedPaneUI

  Parameters:

  tabIndex - the tab index.

  Returns:

  true if editing started. Otherwise false if the tab is already in editing mode when this method is called.

• getEditingTabIndex

  public int getEditingTabIndex()

  Description copied from class: JideTabbedPaneUI

  Gets the tab index that is editing, if any. -1 if no tab is being edited.

  Specified by:

  getEditingTabIndex in class JideTabbedPaneUI

  Returns:

  the tab index or -1.

• prepareEditor

  protected void prepareEditor(BasicJideTabbedPaneUI.TabEditor e, int tabIndex)

• getTabsTextBoundsAt

  protected Rectangle getTabsTextBoundsAt(int tabIndex)

• insertUpdate

  public void insertUpdate(DocumentEvent e)

  Specified by:

  insertUpdate in interface DocumentListener

• removeUpdate

  public void removeUpdate(DocumentEvent e)

  Specified by:

  removeUpdate in interface DocumentListener

• changedUpdate

  public void changedUpdate(DocumentEvent e)

  Specified by:

  changedUpdate in interface DocumentListener

• resizeEditor

  protected void resizeEditor(int tabIndex)

• getCurrentDisplayTitleAt

  protected String getCurrentDisplayTitleAt(JideTabbedPane tp, int index)

• startEditing

  public void startEditing(MouseEvent e)

• getPainter

  public ThemePainter getPainter()

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

• isRoundedCorner

  protected boolean isRoundedCorner()

• getTabShape

  protected int getTabShape()

• getTabResizeMode

  protected int getTabResizeMode()

• getColorTheme

  protected int getColorTheme()

• getLeftMargin

  protected int getLeftMargin()

• getTabGap

  protected int getTabGap()

• getLayoutSize

  protected int getLayoutSize()

• getTabRightPadding

  protected int getTabRightPadding()

• createMouseListener

  protected MouseListener createMouseListener()

• createMouseWheelListener

  protected MouseWheelListener createMouseWheelListener()

• createMouseMotionListener

  protected MouseMotionListener createMouseMotionListener()

• isTabLeadingComponentVisible

  protected boolean isTabLeadingComponentVisible()

• isTabTrailingComponentVisible

  protected boolean isTabTrailingComponentVisible()

• isTabTopVisible

  protected boolean isTabTopVisible(int tabPlacement)

• showFocusIndicator

  protected boolean showFocusIndicator()

• getResourceString

  protected String getResourceString(String key)

  Gets the resource string used in JideTabbedPane. Subclass can override it to provide their own strings.

  Parameters:

  key - the resource key

  Returns:

  the localized string.