Substance API

View all API methods.

View all client properties.

API method

public static void unregisterTabCloseChangeListener(JTabbedPane tabbedPane,
      BaseTabCloseListener tabCloseListener)


Unregisters the specified listener on tab-close events on the specified tabbed pane.


  • tabbedPane - Tabbed pane. If null, the tab close listener is unregistered globally (for all tabbed panes).
  • tabCloseListener - Listener to unregister.

See also

Sample code

The following example registers a tab close listener on the specified tabbed pane. The listener listens on single tab close events and prints out trace messages. After unregistering this listener, closing a tab doesn't produce any trace messages.

import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.*;

import org.pushingpixels.substance.api.SubstanceLookAndFeel;
import org.pushingpixels.substance.api.tabbed.TabCloseListener;

 * Test application that shows the use of the
 {@link SubstanceLookAndFeel#unregisterTabCloseChangeListener(JTabbedPane, org.pushingpixels.substance.tabbed.BaseTabCloseListener)}
 * API with registering a tab close listener that listens on single tab closing
 * on a specific tabbed pane.
 @author Kirill Grouchnikov
 @see SubstanceLookAndFeel#unregisterTabCloseChangeListener(JTabbedPane,
 *      org.pushingpixels.substance.tabbed.BaseTabCloseListener)
public class UnregisterTabCloseChangeListener_Specific extends JFrame {
   * Listener instance.
  private TabCloseListener listener;

   * Creates the main frame for <code>this</code> sample.
  public UnregisterTabCloseChangeListener_Specific() {
    super("Unregister tab close listener");

    this.setLayout(new BorderLayout());

    final JTabbedPane jtp = new JTabbedPane();
    jtp.addTab("tab1"new JPanel());
    jtp.addTab("tab2"new JPanel());
    jtp.addTab("tab3"new JPanel());


    // register tab close listener on the specific tabbed pane.
        listener = new TabCloseListener() {
          public void tabClosing(JTabbedPane tabbedPane,
              Component tabComponent) {
            System.out.println("Tab "
                + tabbedPane.getTitleAt(tabbedPane
                " closing");

          public void tabClosed(JTabbedPane tabbedPane,
              Component tabComponent) {
            System.out.println("Tab closed");

    this.add(jtp, BorderLayout.CENTER);

    JPanel controls = new JPanel(new FlowLayout(FlowLayout.RIGHT));
    final JButton unregisterListener = new JButton("Unregister listener");
    unregisterListener.addActionListener(new ActionListener() {
      public void actionPerformed(ActionEvent e) {
        SwingUtilities.invokeLater(new Runnable() {
          public void run() {
            // unregister listener
                jtp, listener);
    this.add(controls, BorderLayout.SOUTH);


   * The main method for <code>this</code> sample. The arguments are ignored.
   @param args
   *            Ignored.
  public static void main(String[] args) {
    SwingUtilities.invokeLater(new Runnable() {
      public void run() {
        SubstanceLookAndFeel.setSkin(new BusinessBlackSteelSkin());
        new UnregisterTabCloseChangeListener_Specific()

Running the example above and clicking the close button of the third tab produce the following output:

Tab tab3 closing
Tab closed

Clicking the "Unregister" button and clicking the close button of the second tab just closes that tab and doesn't produce any additional output.