Package org.pushingpixels.substance.api.tabbed

Interface TabCloseCallback


  • public interface TabCloseCallback
    Callback for registering app-specific behaviour on tab close buttons. This class is part of officially supported API.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getAreaTooltip​(javax.swing.JTabbedPane tabbedPane, int tabIndex)
      Returns the tooltip for the tab area (not close button).
      java.lang.String getCloseButtonTooltip​(javax.swing.JTabbedPane tabbedPane, int tabIndex)
      Returns the tooltip for the tab close button.
      SubstanceSlices.TabCloseKind onAreaClick​(javax.swing.JTabbedPane tabbedPane, int tabIndex, java.awt.event.MouseEvent mouseEvent)
      Invoked when the tab area (not close button) is clicked.
      SubstanceSlices.TabCloseKind onCloseButtonClick​(javax.swing.JTabbedPane tabbedPane, int tabIndex, java.awt.event.MouseEvent mouseEvent)
      Invoked when the tab close button is clicked.

    • Method Detail

      • onAreaClick

        SubstanceSlices.TabCloseKind onAreaClick​(javax.swing.JTabbedPane tabbedPane,
                                         int tabIndex,
                                         java.awt.event.MouseEvent mouseEvent)
        Invoked when the tab area (not close button) is clicked.
        Parameters:
        tabbedPane - Tabbed pane.
        tabIndex - Index of the tab under the click.
        mouseEvent - Mouse event.
        Returns:
        Tab close kind.

      • onCloseButtonClick

        SubstanceSlices.TabCloseKind onCloseButtonClick​(javax.swing.JTabbedPane tabbedPane,
                                                int tabIndex,
                                                java.awt.event.MouseEvent mouseEvent)
        Invoked when the tab close button is clicked.
        Parameters:
        tabbedPane - Tabbed pane.
        tabIndex - Index of the tab under the click.
        mouseEvent - Mouse event.
        Returns:
        Tab close kind.

      • getAreaTooltip

        java.lang.String getAreaTooltip​(javax.swing.JTabbedPane tabbedPane,
                                int tabIndex)
        Returns the tooltip for the tab area (not close button).
        Parameters:
        tabbedPane - Tabbed pane.
        tabIndex - Index of the tab under the mouse.
        Returns:
        Tooltip for the tab area.

      • getCloseButtonTooltip

        java.lang.String getCloseButtonTooltip​(javax.swing.JTabbedPane tabbedPane,
                                       int tabIndex)
        Returns the tooltip for the tab close button.
        Parameters:
        tabbedPane - Tabbed pane.
        tabIndex - Index of the tab under the mouse.
        Returns:
        Tooltip for the tab close button.