Substance API

API method

Description

Unregisters the specified listener on tab-close events on all tabbed panes.

Parameters:

• tabCloseListener - Listener to unregister.

See also

• registerTabCloseChangeListener(BaseTabCloseListener) API.
• registerTabCloseChangeListener(JTabbedPane, BaseTabCloseListener) API.
• unregisterTabCloseChangeListener(JTabbedPane, BaseTabCloseListener) API.

Sample code

The following example registers a global tab close listener that listens on single tab close events. The listener implementation 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.skin.BusinessBlackSteelSkin;
import org.pushingpixels.substance.api.tabbed.TabCloseListener;

/**
 * Test application that shows the use of the
 * {@link SubstanceLookAndFeel#unregisterTabCloseChangeListener(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(org.pushingpixels.substance.tabbed.BaseTabCloseListener)
 */
public class UnregisterTabCloseChangeListener_General extends JFrame {
  /**
   * Listener instance.
   */
  private TabCloseListener listener;

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

    this.setLayout(new BorderLayout());

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

    jtp.putClientProperty(
        SubstanceLookAndFeel.TABBED_PANE_CLOSE_BUTTONS_PROPERTY,
        Boolean.TRUE);

    // register tab close listener on all tabbed panes.
    SubstanceLookAndFeel
        .registerTabCloseChangeListener(listener = new TabCloseListener() {
          public void tabClosing(JTabbedPane tabbedPane,
              Component tabComponent) {
            System.out.println("Tab "
                + tabbedPane.getTitleAt(tabbedPane
                    .indexOfComponent(tabComponent))
                + " 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() {
            unregisterListener.setEnabled(false);
            // unregister listener
            SubstanceLookAndFeel
                .unregisterTabCloseChangeListener(listener);
          }
        });
      }
    });
    controls.add(unregisterListener);
    this.add(controls, BorderLayout.SOUTH);

    this.setSize(400, 200);
    this.setLocationRelativeTo(null);
    this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  }

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

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.