001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: /*
042: * TabCellRenderer.java
043: *
044: * Created on December 2, 2003, 6:25 PM
045: */
046:
047: package org.netbeans.swing.tabcontrol.plaf;
048:
049: import org.netbeans.swing.tabcontrol.TabData;
050:
051: import javax.swing.*;
052: import java.awt.*;
053:
054: /**
055: * Interface for a component that can render a tab and handle other aspects of
056: * its functionality. Implementing this interface is the main aspect of implementing
057: * an additional look and feel.
058: * <p>
059: * Note: The component returned by getRendererComponent() should be capable of
060: * painting itself properly without needing to be added into the AWT hierarchy - it
061: * will be painted directly with a call to its paint() method, not by using
062: * SwingUtilities.paintComponent(), for performance reasons.
063: */
064: public interface TabCellRenderer {
065: /**
066: * Configures and returns a component which can appropriately paint the
067: * passed tab in its current state
068: */
069: public JComponent getRendererComponent(TabData data,
070: Rectangle bounds, int state);
071:
072: /**
073: * Get a command string which is identified with a region of the tab cell
074: * renderer, such as TabbedContainer.COMMAND_CLOSE if the point is inside the
075: * close button, or TabbedContainer.COMMAND_SELECT if the point is over the
076: * tab title. The command returned should be the one that would be executed
077: * were the default mouse button to be pressed. Primarily this method is used
078: * to determine what, if any, visual feedback to show to the user as the mouse
079: * is moved over tabs.
080: *
081: * @param p A point (presumably) within the bounds of the passed rectangle
082: * @param tabState The state of the tab, such as selected, clip right, etc.
083: * @param bounds The bounds of the tab, defining the coordinate space in which
084: * the point parameter should be evaluated
085: * @return A command string. TabDisplayer/TabbedContainer define a small number,
086: * but other UIs can define whatever private contract they want. If the
087: * action is performed, an action event with this string will be fired
088: * from the tabbed container, so client code can handle the actual work
089: * of the action as needed
090: */
091: public String getCommandAtPoint(Point p, int tabState,
092: Rectangle bounds);
093:
094: /**
095: * Get a command string which is identified with a region of the tab cell
096: * renderer, such as TabbedContainer.COMMAND_CLOSE if the point is inside the
097: * close button, or TabbedContainer.COMMAND_SELECT if the point is over the
098: * tab title.
099: *
100: * Note that this method may return a different result than
101: * <code>getCommandAtPoint (Point p, int tabState, Rectangle bounds)</code> -
102: * that method is primarily used for painting logic (such as whether to
103: * draw a rectangle around a close button); this one is to determine the
104: * actual action, if any to perform. So it is free to return null, some
105: * other action, etc.
106: *
107: * @param p A point (presumably) within the bounds of the passed rectangle
108: * @param tabState The state of the tab, such as selected, clip right, etc.
109: * @param bounds The bounds of the tab, defining the coordinate space in which
110: * the point parameter should be evaluated
111: * @param mouseButton The mouse button used to produce the event, as defined in MouseEvent
112: * @param eventType The event type, as defined in MouseEvent
113: * @param modifiers The modifiers mask, as defined in MouseEvent
114: *
115: * @return A command string or null
116: */
117: public String getCommandAtPoint(Point p, int tabState,
118: Rectangle bounds, int mouseButton, int eventType,
119: int modifiers);
120:
121: /**
122: * Get the shape that represents those pixels actually occupied by the tab
123: * on-screen. This is used for determining whether a mouse event really
124: * occured on a tab, and for painting.<p> <b>A note on painting of tab drag
125: * and drop indication: <code>AbstractTabsUI</code> contains generic
126: * support for drawing drag and drop target indications. If want to use it
127: * rather than write your own, you need to specify the polygon returned by
128: * this method with the following point order: The last two points in the
129: * point array of the polygon <strong>must be the bottom left corner,
130: * followed by the bottom right corner</strong>. In other words, start at
131: * the upper left corner when constructing the polygon, and end at the
132: * bottom right corner, using no more than one point for the bottom left and
133: * right corners:
134: * <pre>
135: * start here --> /---------
136: * |
137: * finish here --> ----------
138: * </pre>
139: */
140: public Polygon getTabShape(int tabState, Rectangle bounds);
141:
142: /**
143: * Returns the number of pixels this renderer wants added to the base width
144: * and height of the icon and text to fit decorations such as close butons,
145: * drag indicators, etc. This method is called only <strong>once</strong>,
146: * during initialization, if this renderer is the default renderer created
147: * by <code>TabsUI.createDefaultRenderer()</code>. The values it returns
148: * cannot be changed dynamically. The result will be passed as padX/padY
149: * arguments to the constructor of DefaultTabLayoutModel (unless
150: * createLayoutModel is overridden with some custom model - then all bets
151: * are off).
152: */
153: public Dimension getPadding();
154:
155: /**
156: * Returns the number of pixels to be added to the width of a cell if the
157: * cell is the selected index. This method is also called only once, on
158: * initialization, for the default renderer
159: */
160: public int getPixelsToAddToSelection();
161:
162: public Color getSelectedBackground(); //XXX delete me
163:
164: public Color getSelectedActivatedBackground(); //XXX delete me
165:
166: public boolean isShowCloseButton();
167:
168: public void setShowCloseButton(boolean val);
169: }
|