| org.netbeans.swing.tabcontrol.plaf.TabCellRenderer
All known Subclasses: org.netbeans.swing.tabcontrol.plaf.AbstractTabCellRenderer,
| TabCellRenderer | | public interface TabCellRenderer (Code) | | 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.
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.
|
| Method Summary | |
| 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. | | public String | getCommandAtPoint(Point p, int tabState, Rectangle bounds, int mouseButton, int eventType, int modifiers)
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
getCommandAtPoint (Point p, int tabState, Rectangle bounds) -
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. | | public Dimension | getPadding()
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. | | public int | getPixelsToAddToSelection()
Returns the number of pixels to be added to the width of a cell if the
cell is the selected index. | | public JComponent | getRendererComponent(TabData data, Rectangle bounds, int state)
| | public Color | getSelectedActivatedBackground()
| | public Color | getSelectedBackground()
| | public Polygon | getTabShape(int tabState, Rectangle bounds)
Get the shape that represents those pixels actually occupied by the tab
on-screen. | | public boolean | isShowCloseButton()
| | public void | setShowCloseButton(boolean val)
|
| getCommandAtPoint | | public String getCommandAtPoint(Point p, int tabState, Rectangle bounds)(Code) | | 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.
Parameters:
p - A point (presumably) within the bounds of the passed rectangle
Parameters:
tabState - The state of the tab, such as selected, clip right, etc.
Parameters:
bounds - The bounds of the tab, defining the coordinate space in whichthe point parameter should be evaluated A command string. TabDisplayer/TabbedContainer define a small number,but other UIs can define whatever private contract they want. If theaction is performed, an action event with this string will be firedfrom the tabbed container, so client code can handle the actual workof the action as needed |
| getCommandAtPoint | | public String getCommandAtPoint(Point p, int tabState, Rectangle bounds, int mouseButton, int eventType, int modifiers)(Code) | | 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
getCommandAtPoint (Point p, int tabState, Rectangle bounds) -
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.
Parameters:
p - A point (presumably) within the bounds of the passed rectangle
Parameters:
tabState - The state of the tab, such as selected, clip right, etc.
Parameters:
bounds - The bounds of the tab, defining the coordinate space in whichthe point parameter should be evaluated
Parameters:
mouseButton - The mouse button used to produce the event, as defined in MouseEvent
Parameters:
eventType - The event type, as defined in MouseEvent
Parameters:
modifiers - The modifiers mask, as defined in MouseEvent A command string or null |
| getPadding | | public Dimension getPadding()(Code) | | 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 once,
during initialization, if this renderer is the default renderer created
by TabsUI.createDefaultRenderer(). 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).
|
| getPixelsToAddToSelection | | public int getPixelsToAddToSelection()(Code) | | 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
|
| getRendererComponent | | public JComponent getRendererComponent(TabData data, Rectangle bounds, int state)(Code) | | Configures and returns a component which can appropriately paint the
passed tab in its current state
|
| getSelectedActivatedBackground | | public Color getSelectedActivatedBackground()(Code) | | |
| getSelectedBackground | | public Color getSelectedBackground()(Code) | | |
| getTabShape | | public Polygon getTabShape(int tabState, Rectangle bounds)(Code) | | 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. A note on painting of tab drag
and drop indication: AbstractTabsUI 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 must be the bottom left corner,
followed by the bottom right corner. 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:
start here --> /---------
|
finish here --> ----------
|
| isShowCloseButton | | public boolean isShowCloseButton()(Code) | | |
| setShowCloseButton | | public void setShowCloseButton(boolean val)(Code) | | |
|
|