com.alee.laf.tabbedpane

Class TabbedPanePainter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

java.lang.Object

com.alee.painter.AbstractPainter<E,U>

com.alee.laf.tabbedpane.TabbedPanePainter<E,U>

Type Parameters:

E - component type

U - component UI type

All Implemented Interfaces:

ITabbedPanePainter<E,U>, Painter<E,U>, SpecificPainter<E,U>, BorderMethods, com.alee.utils.swing.SwingMethods

public class TabbedPanePainter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>
extends AbstractPainter<E,U>
implements ITabbedPanePainter<E,U>

Basic painter for JTabbedPane component. It is used as WebTabbedPaneUI default painter.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Color	backgroundColor
protected java.awt.Color	bottomBg
protected java.awt.Color	contentBorderColor
protected java.awt.event.FocusAdapter	focusAdapter Listeners.
protected boolean	forceUseSelectedTabBgColors
protected java.util.Vector	htmlViews
protected int	maxTabHeight
protected int	maxTabWidth
protected boolean	paintBorderOnlyOnSelectedTab
protected boolean	paintOnlyTopBorder
protected java.awt.Rectangle[]	rects
protected int	round Style settings.
protected int	runCount
protected boolean	scrollableTabLayoutEnabled
protected java.awt.Color	selectedBottomBg
protected java.awt.Color	selectedTopBg
protected int	shadeWidth
protected java.awt.Color	tabBorderColor
protected int[]	tabRuns
protected boolean	tabsOpaque
protected boolean	tabsOverlapBorder Painting variables.
protected int	textIconGap
protected java.awt.Color	topBg

Fields inherited from class com.alee.painter.AbstractPainter

component, listeners, ltr, propertyChangeListener, ui

Constructor Summary

Constructors

Constructor and Description
TabbedPanePainter()

Method Summary

Modifier and Type	Method and Description
protected int	calculateTabAreaHeight(int tabPlacement, int horizRunCount, int maxTabHeight)
protected int	calculateTabAreaWidth(int tabPlacement, int vertRunCount, int maxTabWidth)
protected java.awt.Shape	createBackgroundShape(int tabPlacement, int tabAreaSize, java.awt.Insets bi, java.awt.Rectangle selected)
protected java.awt.geom.GeneralPath	createTabShape(TabShapeType tabShapeType, int tabPlacement, int x, int y, int w, int h, boolean isSelected)
protected void	ensureCurrentLayout()
java.awt.Color	getBackgroundColor()
java.awt.Color	getBottomBg()
protected java.awt.Point	getBottomTabBgPoint(int tabPlacement, int x, int y, int w, int h)
protected int	getChange(TabShapeType tabShapeType)
java.awt.Color	getContentBorderColor()
protected javax.swing.Icon	getIconForTab(int tabIndex)
int	getRound()
java.awt.Color	getSelectedBottomBg()
java.awt.Color	getSelectedTopBg()
int	getShadeWidth()
protected int	getTabAreaLength(int tabPlacement)
java.awt.Color	getTabBorderColor()
protected int	getTabLabelShiftX(int tabPlacement, int tabIndex, boolean isSelected)
protected int	getTabLabelShiftY(int tabPlacement, int tabIndex, boolean isSelected)
protected javax.swing.text.View	getTextViewForTab(int tabIndex) Returns the text View object required to render stylized text (HTML) for the specified tab or null if no specialized text rendering is needed for this tab.
java.awt.Color	getTopBg()
protected java.awt.Point	getTopTabBgPoint(int tabPlacement, int x, int y, int w, int h)
void	install(E c, U ui) Called when painter is installed onto some component.
boolean	isForceUseSelectedTabBgColors()
protected boolean	isHorizontalTabPlacement()
boolean	isPaintBorderOnlyOnSelectedTab()
boolean	isPaintOnlyTopBorder()
protected void	layoutLabel(int tabPlacement, java.awt.FontMetrics metrics, int tabIndex, java.lang.String title, javax.swing.Icon icon, java.awt.Rectangle tabRect, java.awt.Rectangle iconRect, java.awt.Rectangle textRect, boolean isSelected)
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, U ui) Paints visual data using component graphics context.
protected void	paintContentBorder(java.awt.Graphics2D g2d, int tabPlacement, int selectedIndex)
protected void	paintIcon(java.awt.Graphics g, int tabPlacement, int tabIndex, javax.swing.Icon icon, java.awt.Rectangle iconRect, boolean isSelected)
protected void	paintTab(java.awt.Graphics g, int tabPlacement, java.awt.Rectangle[] rects, int tabIndex, java.awt.Rectangle iconRect, java.awt.Rectangle textRect)
protected void	paintTabArea(java.awt.Graphics g, int tabPlacement, int selectedIndex) Paints the tabs in the tab area.
protected void	paintTabBackground(java.awt.Graphics g, int tabPlacement, int tabIndex, int x, int y, int w, int h, boolean isSelected)
protected void	paintText(java.awt.Graphics g, int tabPlacement, java.awt.Font font, java.awt.FontMetrics metrics, int tabIndex, java.lang.String title, java.awt.Rectangle textRect, boolean isSelected)
void	setBackgroundColor(java.awt.Color backgroundColor)
void	setBottomBg(java.awt.Color bottomBg)
void	setContentBorderColor(java.awt.Color contentBorderColor)
void	setForceUseSelectedTabBgColors(boolean forceUseSelectedTabBgColors)
void	setPaintBorderOnlyOnSelectedTab(boolean paintBorderOnlyOnSelectedTab)
void	setPaintOnlyTopBorder(boolean paintOnlyTopBorder)
void	setRound(int round)
void	setSelectedBottomBg(java.awt.Color selectedBottomBg)
void	setSelectedTopBg(java.awt.Color selectedTopBg)
void	setShadeWidth(int shadeWidth)
void	setTabBorderColor(java.awt.Color tabBorderColor)
void	setTopBg(java.awt.Color topBg)
void	uninstall(E c, U ui) Called when painter is installed into some component.
void	updateBorder() Updates component with complete border.

Methods inherited from class com.alee.painter.AbstractPainter

addPainterListener, b, borderChange, getBorders, getCompleteBorder, getPreferredSize, i, i, i, installPropertyChangeListener, isOpaque, isSectionPainter, isSettingsUpdateAllowed, orientationChange, p, propertyChange, removePainterListener, repaint, repaint, repaint, revalidate, saveOrientation, uninstallPropertyChangeListener, updateAll, updateOpacity, updateOrientation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.alee.painter.Painter

addPainterListener, getBorders, getPreferredSize, isOpaque, removePainterListener

Field Detail

round

protected int round

Style settings.

shadeWidth

protected int shadeWidth

selectedTopBg

protected java.awt.Color selectedTopBg

selectedBottomBg

protected java.awt.Color selectedBottomBg

topBg

protected java.awt.Color topBg

bottomBg

protected java.awt.Color bottomBg

tabBorderColor

protected java.awt.Color tabBorderColor

contentBorderColor

protected java.awt.Color contentBorderColor

backgroundColor

protected java.awt.Color backgroundColor

paintBorderOnlyOnSelectedTab

protected boolean paintBorderOnlyOnSelectedTab

forceUseSelectedTabBgColors

protected boolean forceUseSelectedTabBgColors

paintOnlyTopBorder

protected boolean paintOnlyTopBorder

focusAdapter

protected java.awt.event.FocusAdapter focusAdapter

Listeners.

tabsOverlapBorder

protected boolean tabsOverlapBorder

Painting variables.

tabsOpaque

protected boolean tabsOpaque

textIconGap

protected int textIconGap

htmlViews

protected java.util.Vector htmlViews

tabRuns

protected int[] tabRuns

rects

protected java.awt.Rectangle[] rects

maxTabHeight

protected int maxTabHeight

maxTabWidth

protected int maxTabWidth

runCount

protected int runCount

scrollableTabLayoutEnabled

protected boolean scrollableTabLayoutEnabled

Constructor Detail

TabbedPanePainter

public TabbedPanePainter()

Method Detail

install

public void install(E c,
                    U ui)

Description copied from interface: Painter

Called when painter is installed onto some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

install in interface Painter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

Overrides:

install in class AbstractPainter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

Parameters:

c - component this painter is being installed onto

ui - component UI

uninstall

public void uninstall(E c,
                      U ui)

Description copied from interface: Painter

Called when painter is installed into some component. You might want to use this method to add custom component listeners or modify component settings.

Specified by:

uninstall in interface Painter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

Overrides:

uninstall in class AbstractPainter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

Parameters:

c - component this painter is being uninstalled from

ui - component UI

updateBorder

public void updateBorder()

Updates component with complete border. This border takes painter borders and component margin and padding into account.

Specified by:

updateBorder in interface BorderMethods

Overrides:

updateBorder in class AbstractPainter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

getShadeWidth

public int getShadeWidth()

setShadeWidth

public void setShadeWidth(int shadeWidth)

getRound

public int getRound()

setRound

public void setRound(int round)

getSelectedTopBg

public java.awt.Color getSelectedTopBg()

setSelectedTopBg

public void setSelectedTopBg(java.awt.Color selectedTopBg)

getSelectedBottomBg

public java.awt.Color getSelectedBottomBg()

setSelectedBottomBg

public void setSelectedBottomBg(java.awt.Color selectedBottomBg)

getTopBg

public java.awt.Color getTopBg()

setTopBg

public void setTopBg(java.awt.Color topBg)

getBottomBg

public java.awt.Color getBottomBg()

setBottomBg

public void setBottomBg(java.awt.Color bottomBg)

getTabBorderColor

public java.awt.Color getTabBorderColor()

setTabBorderColor

public void setTabBorderColor(java.awt.Color tabBorderColor)

getContentBorderColor

public java.awt.Color getContentBorderColor()

setContentBorderColor

public void setContentBorderColor(java.awt.Color contentBorderColor)

isPaintBorderOnlyOnSelectedTab

public boolean isPaintBorderOnlyOnSelectedTab()

setPaintBorderOnlyOnSelectedTab

public void setPaintBorderOnlyOnSelectedTab(boolean paintBorderOnlyOnSelectedTab)

isForceUseSelectedTabBgColors

public boolean isForceUseSelectedTabBgColors()

setForceUseSelectedTabBgColors

public void setForceUseSelectedTabBgColors(boolean forceUseSelectedTabBgColors)

getBackgroundColor

public java.awt.Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(java.awt.Color backgroundColor)

isPaintOnlyTopBorder

public boolean isPaintOnlyTopBorder()

setPaintOnlyTopBorder

public void setPaintOnlyTopBorder(boolean paintOnlyTopBorder)

paint

public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E c,
                  U ui)

Description copied from interface: Painter

Paints visual data using component graphics context. Provided graphics context and component are taken directly from component UI paint method.

It is highly recommended to honor provided painting bounds to avoid painting issues. These bounds might be representing full component size or contain just a small portion of the component.

Specified by:

paint in interface Painter<E extends javax.swing.JTabbedPane,U extends WebTabbedPaneUI>

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

ui - painted component UI

ensureCurrentLayout

protected void ensureCurrentLayout()

paintTabArea

protected void paintTabArea(java.awt.Graphics g,
                            int tabPlacement,
                            int selectedIndex)

Paints the tabs in the tab area. Invoked by paint(). The graphics parameter must be a valid Graphics object. Tab placement may be either: JTabbedPane.TOP, JTabbedPane.BOTTOM, JTabbedPane.LEFT, or JTabbedPane.RIGHT. The selected index must be a valid tabbed pane tab index (0 to tab count - 1, inclusive) or -1 if no tab is currently selected. The handling of invalid parameters is unspecified.

Parameters:

g - the graphics object to use for rendering

tabPlacement - the placement for the tabs within the JTabbedPane

selectedIndex - the tab index of the selected component

paintTab

protected void paintTab(java.awt.Graphics g,
                        int tabPlacement,
                        java.awt.Rectangle[] rects,
                        int tabIndex,
                        java.awt.Rectangle iconRect,
                        java.awt.Rectangle textRect)

isHorizontalTabPlacement

protected boolean isHorizontalTabPlacement()

layoutLabel

protected void layoutLabel(int tabPlacement,
                           java.awt.FontMetrics metrics,
                           int tabIndex,
                           java.lang.String title,
                           javax.swing.Icon icon,
                           java.awt.Rectangle tabRect,
                           java.awt.Rectangle iconRect,
                           java.awt.Rectangle textRect,
                           boolean isSelected)

paintIcon

protected void paintIcon(java.awt.Graphics g,
                         int tabPlacement,
                         int tabIndex,
                         javax.swing.Icon icon,
                         java.awt.Rectangle iconRect,
                         boolean isSelected)

getTextViewForTab

protected javax.swing.text.View getTextViewForTab(int tabIndex)

Returns the text View object required to render stylized text (HTML) for the specified tab or null if no specialized text rendering is needed for this tab. This is provided to support html rendering inside tabs.

Parameters:

tabIndex - the index of the tab

Returns:

the text view to render the tab's text or null if no specialized rendering is required

Since:

1.4

paintTabBackground

protected void paintTabBackground(java.awt.Graphics g,
                                  int tabPlacement,
                                  int tabIndex,
                                  int x,
                                  int y,
                                  int w,
                                  int h,
                                  boolean isSelected)

getIconForTab

protected javax.swing.Icon getIconForTab(int tabIndex)

paintText

protected void paintText(java.awt.Graphics g,
                         int tabPlacement,
                         java.awt.Font font,
                         java.awt.FontMetrics metrics,
                         int tabIndex,
                         java.lang.String title,
                         java.awt.Rectangle textRect,
                         boolean isSelected)

createTabShape

protected java.awt.geom.GeneralPath createTabShape(TabShapeType tabShapeType,
                                                   int tabPlacement,
                                                   int x,
                                                   int y,
                                                   int w,
                                                   int h,
                                                   boolean isSelected)

getChange

protected int getChange(TabShapeType tabShapeType)

getTopTabBgPoint

protected java.awt.Point getTopTabBgPoint(int tabPlacement,
                                          int x,
                                          int y,
                                          int w,
                                          int h)

getBottomTabBgPoint

protected java.awt.Point getBottomTabBgPoint(int tabPlacement,
                                             int x,
                                             int y,
                                             int w,
                                             int h)

paintContentBorder

protected void paintContentBorder(java.awt.Graphics2D g2d,
                                  int tabPlacement,
                                  int selectedIndex)

getTabAreaLength

protected int getTabAreaLength(int tabPlacement)

calculateTabAreaHeight

protected int calculateTabAreaHeight(int tabPlacement,
                                     int horizRunCount,
                                     int maxTabHeight)

calculateTabAreaWidth

protected int calculateTabAreaWidth(int tabPlacement,
                                    int vertRunCount,
                                    int maxTabWidth)

createBackgroundShape

protected java.awt.Shape createBackgroundShape(int tabPlacement,
                                               int tabAreaSize,
                                               java.awt.Insets bi,
                                               java.awt.Rectangle selected)

getTabLabelShiftX

protected int getTabLabelShiftX(int tabPlacement,
                                int tabIndex,
                                boolean isSelected)

getTabLabelShiftY

protected int getTabLabelShiftY(int tabPlacement,
                                int tabIndex,
                                boolean isSelected)