# Substance client properties

View all API methods.

View all client properties.

Client property name | SubstanceLookAndFeel.TABBED_PANE_CLOSE_CALLBACK

Description | Client property name for specifying the callback for deciding on the tab close type. This property can be specified on a single tab component, on a `JTabbedPane` itself (will hold for all tab components that don't define this property) or on `UIManager`. The value should be an instance of `TabCloseCallback`. Note that this setting is only relevant for tabs marked with `SubstanceLookAndFeel.TABBED_PANE_CLOSE_BUTTONS_PROPERTY` property.

See also |

- TABBED_PANE_CLOSE_BUTTONS_PROPERTY client property.

Sample code | `import java.awt.BorderLayout; import java.awt.event.MouseEvent; import javax.swing.*; import org.jvnet.substance.SubstanceLookAndFeel; import org.jvnet.substance.api.SubstanceConstants.TabCloseKind;
import org.jvnet.substance.api.tabbed.TabCloseCallback;
import org.jvnet.substance.skin.SubstanceBusinessBlackSteelLookAndFeel;
/**
* Test application that shows the use of the {@link
* SubstanceLookAndFeel#TABBED_PANE_CLOSE_CALLBACK} client property.
*
* @author Kirill Grouchnikov
* @see SubstanceLookAndFeel#TABBED_PANE_CLOSE_CALLBACK
*/
public class TabbedPaneCloseCallback extends JFrame {
/**
* Creates the main frame for <code>this</code> sample.
*/
public TabbedPaneCloseCallback() {
super("Tabbed pane close callback");
this.setLayout(new BorderLayout());
// create tabbed pane with a few tabs
final JTabbedPane jtp = new JTabbedPane();
String packageName = MenuGutterFillKindProperty.class.getPackage()
.getName();
jtp.addTab("First", new ImageIcon(MenuGutterFillKindProperty.class
.getClassLoader().getResource(
packageName.replace('.', '/') + "/flag_mexico.png")),
new JPanel());
jtp.addTab("Second", new ImageIcon(MenuGutterFillKindProperty.class
.getClassLoader().getResource(
packageName.replace('.', '/') + "/flag_sweden.png")),
new JPanel());
jtp.addTab("Third", new ImageIcon(MenuGutterFillKindProperty.class
.getClassLoader().getResource(
packageName.replace('.', '/') + "/flag_hong_kong.png")),
new JPanel());
// mark it to have close buttons on all the tabs
jtp.putClientProperty(
SubstanceLookAndFeel.TABBED_PANE_CLOSE_BUTTONS_PROPERTY,
Boolean.TRUE);
this.add(jtp, BorderLayout.CENTER);
// create a custom implementation of TabCloseCallback interface.
TabCloseCallback closeCallback = new TabCloseCallback() {
public TabCloseKind onAreaClick(JTabbedPane tabbedPane,
int tabIndex, MouseEvent mouseEvent) {
if (mouseEvent.getButton() != MouseEvent.BUTTON3)
return TabCloseKind.NONE;
if (mouseEvent.isShiftDown()) {
return TabCloseKind.ALL;
}
return TabCloseKind.THIS;
}
public TabCloseKind onCloseButtonClick(JTabbedPane tabbedPane,
int tabIndex, MouseEvent mouseEvent) {
if (mouseEvent.isAltDown()) {
return TabCloseKind.ALL_BUT_THIS;
}
if (mouseEvent.isShiftDown()) {
return TabCloseKind.ALL;
}
return TabCloseKind.THIS;
}
public String getAreaTooltip(JTabbedPane tabbedPane, int tabIndex) {
return null;
}
public String getCloseButtonTooltip(JTabbedPane tabbedPane,
int tabIndex) {
StringBuffer result = new StringBuffer();
result.append("<html><body>");
result.append("Mouse click closes <b>"
+ tabbedPane.getTitleAt(tabIndex) + "</b> tab");
result
.append("<br><b>Alt</b>-Mouse click closes all tabs but <b>"
+ tabbedPane.getTitleAt(tabIndex) + "</b> tab");
result.append("<br><b>Shift</b>-Mouse click closes all tabs");
result.append("</body></html>");
return result.toString();
}
};
// register the callback on the tabbed pane
jtp.putClientProperty(SubstanceLookAndFeel.TABBED_PANE_CLOSE_CALLBACK,
closeCallback);
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.
* @throws Exception
* If some exception occured. Note that there is no special treatment
* of exception conditions in <code>this</code> sample code.
*/
public static void main(String[] args) throws Exception {
UIManager.setLookAndFeel(new SubstanceBusinessBlackSteelLookAndFeel());
JFrame.setDefaultLookAndFeelDecorated(true);
SwingUtilities.invokeLater(new Runnable() {
public void run() {
new TabbedPaneCloseCallback().setVisible(true);
}
});
}
}`

The screenshot below shows tabbed pane with custom close callback installed. The mouse hovers over the close button of the first tab.