01: /*
02: * Copyright (c) 2005-2008 Substance Kirill Grouchnikov. All Rights Reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * o Redistributions of source code must retain the above copyright notice,
08: * this list of conditions and the following disclaimer.
09: *
10: * o Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * o Neither the name of Substance Kirill Grouchnikov nor the names of
15: * its contributors may be used to endorse or promote products derived
16: * from this software without specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20: * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
22: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25: * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26: * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
27: * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
28: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29: */
30: package org.jvnet.substance.tabbed;
31:
32: import java.awt.event.MouseEvent;
33:
34: import javax.swing.JTabbedPane;
35:
36: import org.jvnet.substance.utils.SubstanceConstants.TabCloseKind;
37:
38: /**
39: * Callback for registering app-specific behaviour on tab close buttons. This
40: * class is part of officially supported API.
41: *
42: * @author Kirill Grouchnikov
43: */
44: public interface TabCloseCallback {
45: /**
46: * Invoked when the tab area (not close button) is clicked.
47: *
48: * @param tabbedPane
49: * Tabbed pane.
50: * @param tabIndex
51: * Index of the tab under the click.
52: * @param mouseEvent
53: * Mouse event.
54: * @return Tab close kind.
55: */
56: public TabCloseKind onAreaClick(JTabbedPane tabbedPane,
57: int tabIndex, MouseEvent mouseEvent);
58:
59: /**
60: * Invoked when the tab close button is clicked.
61: *
62: * @param tabbedPane
63: * Tabbed pane.
64: * @param tabIndex
65: * Index of the tab under the click.
66: * @param mouseEvent
67: * Mouse event.
68: * @return Tab close kind.
69: */
70: public TabCloseKind onCloseButtonClick(JTabbedPane tabbedPane,
71: int tabIndex, MouseEvent mouseEvent);
72:
73: /**
74: * Returns the tooltip for the tab area (not close button).
75: *
76: * @param tabbedPane
77: * Tabbed pane.
78: * @param tabIndex
79: * Index of the tab under the mouse.
80: * @return Tooltip for the tab area.
81: */
82: public String getAreaTooltip(JTabbedPane tabbedPane, int tabIndex);
83:
84: /**
85: * Returns the tooltip for the tab close button.
86: *
87: * @param tabbedPane
88: * Tabbed pane.
89: * @param tabIndex
90: * Index of the tab under the mouse.
91: * @return Tooltip for the tab close button.
92: */
93: public String getCloseButtonTooltip(JTabbedPane tabbedPane,
94: int tabIndex);
95: }
|