Substance look and feel - documentation
Author: substance.dev.java.net
Description: Substance look and feel
Keywords: java, look, feel, skins, plaf, swing, ui, pluggable, substance

# Substance API

View all API methods.

View all client properties.

API method | `public static void unregisterTabCloseChangeListener(JTabbedPane tabbedPane, BaseTabCloseListener tabCloseListener)`
Description | Unregisters the specified listener on tab-close events on the specified tabbed pane. Parameters: `tabbedPane` - Tabbed pane. If `null`, the tab close listener is unregistered globally (for all tabbed panes). `tabCloseListener` - Listener to unregister.
See also | registerTabCloseChangeListener(BaseTabCloseListener) API. registerTabCloseChangeListener(JTabbedPane, BaseTabCloseListener) API. unregisterTabCloseChangeListener(BaseTabCloseListener) API.
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.jvnet.substance.SubstanceLookAndFeel; import org.jvnet.substance.api.tabbed.TabCloseListener; import org.jvnet.substance.skin.BusinessBlackSteelSkin; import test.Check; /** * Test application that shows the use of the * {@link SubstanceLookAndFeel#unregisterTabCloseChangeListener(JTabbedPane, org.jvnet.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.jvnet.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", Check.getIcon("flag_sweden"), new JPanel()); jtp.addTab("tab2", Check.getIcon("flag_mexico"), new JPanel()); jtp.addTab("tab3", Check.getIcon("flag_hong_kong"), new JPanel()); jtp.putClientProperty( SubstanceLookAndFeel.TABBED_PANE_CLOSE_BUTTONS_PROPERTY, Boolean.TRUE); // register tab close listener on the specific tabbed pane. SubstanceLookAndFeel.registerTabCloseChangeListener(jtp, 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( jtp, 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_Specific() .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.