1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* http://www.netbeans.org/cddl-gplv2.html
* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at
* nbbuild/licenses/CDDL-GPL-2-CP. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the
* License Header, with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Contributor(s):
*
* The Original Software is NetBeans. The Initial Developer of the Original
* Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
* Microsystems, Inc. All Rights Reserved.
*
* If you wish your version of this file to be governed by only the CDDL
* or only the GPL Version 2, indicate your decision by adding
* "[Contributor] elects to include this software in this distribution
* under the [CDDL or GPL Version 2] license." If you do not indicate a
* single choice of license, a recipient has the option to distribute
* your version of this file under either the CDDL, the GPL Version 2 or
* to extend the choice of license to its licensees as provided above.
* However, if you add GPL Version 2 code and therefore, elected the GPL
* Version 2 license, then the option applies only if the new code is
* made subject to such option by the copyright holder.
*/
/*
* TabCellRenderer.java
*
* Created on December 2, 2003, 6:25 PM
*/
package org.netbeans.swing.tabcontrol.plaf;
import org.netbeans.swing.tabcontrol.TabData;
import javax.swing.*;
import java.awt.*;
/**
* Interface for a component that can render a tab and handle other aspects of
* its functionality. Implementing this interface is the main aspect of implementing
* an additional look and feel.
* <p>
* Note: The component returned by getRendererComponent() should be capable of
* painting itself properly without needing to be added into the AWT hierarchy - it
* will be painted directly with a call to its paint() method, not by using
* SwingUtilities.paintComponent(), for performance reasons.
*/
public interface TabCellRenderer {
/**
* Configures and returns a component which can appropriately paint the
* passed tab in its current state
*/
public JComponent getRendererComponent(TabData data, Rectangle bounds,
int state);
/**
* Get a command string which is identified with a region of the tab cell
* renderer, such as TabbedContainer.COMMAND_CLOSE if the point is inside the
* close button, or TabbedContainer.COMMAND_SELECT if the point is over the
* tab title. The command returned should be the one that would be executed
* were the default mouse button to be pressed. Primarily this method is used
* to determine what, if any, visual feedback to show to the user as the mouse
* is moved over tabs.
*
* @param p A point (presumably) within the bounds of the passed rectangle
* @param tabState The state of the tab, such as selected, clip right, etc.
* @param bounds The bounds of the tab, defining the coordinate space in which
* the point parameter should be evaluated
* @return A command string. TabDisplayer/TabbedContainer define a small number,
* but other UIs can define whatever private contract they want. If the
* action is performed, an action event with this string will be fired
* from the tabbed container, so client code can handle the actual work
* of the action as needed
*/
public String getCommandAtPoint (Point p, int tabState, Rectangle bounds);
/**
* Get a command string which is identified with a region of the tab cell
* renderer, such as TabbedContainer.COMMAND_CLOSE if the point is inside the
* close button, or TabbedContainer.COMMAND_SELECT if the point is over the
* tab title.
*
* Note that this method may return a different result than
* <code>getCommandAtPoint (Point p, int tabState, Rectangle bounds)</code> -
* that method is primarily used for painting logic (such as whether to
* draw a rectangle around a close button); this one is to determine the
* actual action, if any to perform. So it is free to return null, some
* other action, etc.
*
* @param p A point (presumably) within the bounds of the passed rectangle
* @param tabState The state of the tab, such as selected, clip right, etc.
* @param bounds The bounds of the tab, defining the coordinate space in which
* the point parameter should be evaluated
* @param mouseButton The mouse button used to produce the event, as defined in MouseEvent
* @param eventType The event type, as defined in MouseEvent
* @param modifiers The modifiers mask, as defined in MouseEvent
*
* @return A command string or null
*/
public String getCommandAtPoint (Point p, int tabState, Rectangle bounds, int mouseButton,
int eventType, int modifiers);
/**
* Get the shape that represents those pixels actually occupied by the tab
* on-screen. This is used for determining whether a mouse event really
* occured on a tab, and for painting.<p> <b>A note on painting of tab drag
* and drop indication: <code>AbstractTabsUI</code> contains generic
* support for drawing drag and drop target indications. If want to use it
* rather than write your own, you need to specify the polygon returned by
* this method with the following point order: The last two points in the
* point array of the polygon <strong>must be the bottom left corner,
* followed by the bottom right corner</strong>. In other words, start at
* the upper left corner when constructing the polygon, and end at the
* bottom right corner, using no more than one point for the bottom left and
* right corners:
* <pre>
* start here --> /---------
* |
* finish here --> ----------
* </pre>
*/
public Polygon getTabShape(int tabState, Rectangle bounds);
/**
* Returns the number of pixels this renderer wants added to the base width
* and height of the icon and text to fit decorations such as close butons,
* drag indicators, etc. This method is called only <strong>once</strong>,
* during initialization, if this renderer is the default renderer created
* by <code>TabsUI.createDefaultRenderer()</code>. The values it returns
* cannot be changed dynamically. The result will be passed as padX/padY
* arguments to the constructor of DefaultTabLayoutModel (unless
* createLayoutModel is overridden with some custom model - then all bets
* are off).
*/
public Dimension getPadding();
/**
* Returns the number of pixels to be added to the width of a cell if the
* cell is the selected index. This method is also called only once, on
* initialization, for the default renderer
*/
public int getPixelsToAddToSelection();
public Color getSelectedBackground(); //XXX delete me
public Color getSelectedActivatedBackground(); //XXX delete me
public boolean isShowCloseButton();
public void setShowCloseButton(boolean val);
}
|
