Package com.formdev.flatlaf.ui

Class FlatButtonUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.ButtonUI

javax.swing.plaf.basic.BasicButtonUI

com.formdev.flatlaf.ui.FlatButtonUI

All Implemented Interfaces:

FlatStylingSupport.StyleableUI

Direct Known Subclasses:

FlatToggleButtonUI

public class FlatButtonUI
extends BasicButtonUI
implements FlatStylingSupport.StyleableUI

Provides the Flat LaF UI delegate for JButton.

UiDefault:

Button.font Font, Button.background Color, Button.foreground Color, Button.border Border, Button.margin Insets, Button.rollover boolean , Button.minimumWidth int, Button.iconTextGap int, Button.startBackground Color optional; if set, a gradient paint is used and Button.background is ignored, Button.endBackground Color optional; if set, a gradient paint is used, Button.focusedBackground Color optional, Button.focusedForeground Color optional, Button.hoverBackground Color optional, Button.hoverForeground Color optional, Button.pressedBackground Color optional, Button.pressedForeground Color optional, Button.selectedBackground Color, Button.selectedForeground Color, Button.disabledBackground Color optional, Button.disabledText Color, Button.disabledSelectedBackground Color, Button.disabledSelectedForeground Color optional, Button.default.background Color, Button.default.startBackground Color optional; if set, a gradient paint is used and Button.default.background is ignored, Button.default.endBackground Color optional; if set, a gradient paint is used, Button.default.foreground Color, Button.default.focusedBackground Color optional, Button.default.focusedForeground Color optional, Button.default.hoverBackground Color optional, Button.default.hoverForeground Color optional, Button.default.pressedBackground Color optional, Button.default.pressedForeground Color optional, Button.default.boldText boolean, Button.paintShadow boolean default is false, Button.shadowWidth int default is 2, Button.shadowColor Color optional, Button.default.shadowColor Color optional, Button.toolbar.spacingInsets Insets, Button.toolbar.hoverBackground Color, Button.toolbar.hoverForeground Color optional, Button.toolbar.pressedBackground Color, Button.toolbar.pressedForeground Color optional, Button.toolbar.selectedBackground Color, Button.toolbar.selectedForeground Color optional, Button.toolbar.disabledSelectedBackground Color optional, Button.toolbar.disabledSelectedForeground Color optional

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FlatButtonUI.FlatButtonListener

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	background
protected String	buttonType
protected Color	defaultBackground
protected boolean	defaultBoldText
protected Color	defaultEndBackground
protected Color	defaultFocusedBackground
protected Color	defaultFocusedForeground
protected Color	defaultForeground
protected Color	defaultHoverBackground
protected Color	defaultHoverForeground
protected Color	defaultPressedBackground
protected Color	defaultPressedForeground
protected Color	defaultShadowColor
protected Color	disabledBackground
protected Color	disabledSelectedBackground
protected Color	disabledSelectedForeground
protected Color	disabledText
protected Color	endBackground
protected Color	focusedBackground
protected Color	focusedForeground
protected Color	foreground
protected Color	hoverBackground
protected Color	hoverForeground
protected int	iconTextGap
protected int	minimumHeight
protected int	minimumWidth
protected boolean	paintShadow
protected Color	pressedBackground
protected Color	pressedForeground
protected Color	selectedBackground
protected Color	selectedForeground
protected Color	shadowColor
protected int	shadowWidth
protected boolean	squareSize
protected Color	startBackground
protected Color	toolbarDisabledSelectedBackground
protected Color	toolbarDisabledSelectedForeground
protected Color	toolbarHoverBackground
protected Color	toolbarHoverForeground
protected Color	toolbarPressedBackground
protected Color	toolbarPressedForeground
protected Color	toolbarSelectedBackground
protected Color	toolbarSelectedForeground

Fields inherited from class javax.swing.plaf.basic.BasicButtonUI

defaultTextIconGap, defaultTextShiftOffset

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FlatButtonUI(boolean shared)

Method Summary

Modifier and Type	Method	Description
protected void	applyStyle(AbstractButton b, Object style)
protected Object	applyStyleProperty(AbstractButton b, String key, Object value)
static Color	buttonStateColor(Component c, Color enabledColor, Color disabledColor, Color focusedColor, Color hoverColor, Color pressedColor)
protected BasicButtonListener	createButtonListener(AbstractButton b)
static ComponentUI	createUI(JComponent c)
protected Color	getBackground(JComponent c)
protected Color	getBackgroundBase(JComponent c, boolean def)
int	getBaseline(JComponent c, int width, int height)
protected Color	getForeground(JComponent c)
protected Color	getForegroundBase(JComponent c, boolean def)
Dimension	getPreferredSize(JComponent c)
Map<String,Class<?>>	getStyleableInfos(JComponent c)
Object	getStyleableValue(JComponent c, String key)
protected void	installDefaults(AbstractButton b)
protected void	installStyle(AbstractButton b)
void	installUI(JComponent c)
protected boolean	isCustomBackground(Color bg)
protected boolean	isCustomForeground(Color fg)
static boolean	isFocusPainted(Component c)
void	paint(Graphics g, JComponent c)	Similar to BasicButtonUI.paint(), but does not use zero insets for HTML text, which is done in BasicButtonUI.layout() since Java 19.
protected void	paintBackground(Graphics g, JComponent c)
protected void	paintIcon(Graphics g, JComponent c, Rectangle iconRect)
protected void	paintText(Graphics g, AbstractButton b, Rectangle textRect, String text)
static void	paintText(Graphics g, AbstractButton b, Rectangle textRect, String text, Color foreground)
protected void	propertyChange(AbstractButton b, PropertyChangeEvent e)
protected void	uninstallDefaults(AbstractButton b)
void	update(Graphics g, JComponent c)

Methods inherited from class javax.swing.plaf.basic.BasicButtonUI

clearTextShiftOffset, getBaselineResizeBehavior, getDefaultTextIconGap, getMaximumSize, getMinimumSize, getPropertyPrefix, getTextShiftOffset, installKeyboardActions, installListeners, paintButtonPressed, paintFocus, paintText, setTextShiftOffset, uninstallKeyboardActions, uninstallListeners, uninstallUI

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount

Methods inherited from class java.lang.Object

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

Field Detail

minimumWidth

protected int minimumWidth

iconTextGap

protected int iconTextGap

background

protected Color background

foreground

protected Color foreground

startBackground

protected Color startBackground

endBackground

protected Color endBackground

focusedBackground

protected Color focusedBackground

focusedForeground

protected Color focusedForeground

Since:

2.3

hoverBackground

protected Color hoverBackground

hoverForeground

protected Color hoverForeground

Since:

2.3

pressedBackground

protected Color pressedBackground

pressedForeground

protected Color pressedForeground

Since:

2.3

selectedBackground

protected Color selectedBackground

selectedForeground

protected Color selectedForeground

disabledBackground

protected Color disabledBackground

disabledText

protected Color disabledText

disabledSelectedBackground

protected Color disabledSelectedBackground

disabledSelectedForeground

protected Color disabledSelectedForeground

Since:

2.3

defaultBackground

protected Color defaultBackground

defaultEndBackground

protected Color defaultEndBackground

defaultForeground

protected Color defaultForeground

defaultFocusedBackground

protected Color defaultFocusedBackground

defaultFocusedForeground

protected Color defaultFocusedForeground

Since:

2.3

defaultHoverBackground

protected Color defaultHoverBackground

defaultHoverForeground

protected Color defaultHoverForeground

Since:

2.3

defaultPressedBackground

protected Color defaultPressedBackground

defaultPressedForeground

protected Color defaultPressedForeground

Since:

2.3

defaultBoldText

protected boolean defaultBoldText

paintShadow

protected boolean paintShadow

shadowWidth

protected int shadowWidth

shadowColor

protected Color shadowColor

defaultShadowColor

protected Color defaultShadowColor

toolbarHoverBackground

protected Color toolbarHoverBackground

toolbarHoverForeground

protected Color toolbarHoverForeground

Since:

2.3

toolbarPressedBackground

protected Color toolbarPressedBackground

toolbarPressedForeground

protected Color toolbarPressedForeground

Since:

2.3

toolbarSelectedBackground

protected Color toolbarSelectedBackground

toolbarSelectedForeground

protected Color toolbarSelectedForeground

Since:

2.3

toolbarDisabledSelectedBackground

protected Color toolbarDisabledSelectedBackground

Since:

2.3

toolbarDisabledSelectedForeground

protected Color toolbarDisabledSelectedForeground

Since:

2.3

buttonType

protected String buttonType

Since:

2

squareSize

protected boolean squareSize

Since:

2

minimumHeight

protected int minimumHeight

Since:

2

Constructor Detail

FlatButtonUI

protected FlatButtonUI(boolean shared)

Since:

2

Method Detail

createUI

public static ComponentUI createUI(JComponent c)

installUI

public void installUI(JComponent c)

Overrides:

installUI in class BasicButtonUI

installDefaults

protected void installDefaults(AbstractButton b)

Overrides:

installDefaults in class BasicButtonUI

uninstallDefaults

protected void uninstallDefaults(AbstractButton b)

Overrides:

uninstallDefaults in class BasicButtonUI

createButtonListener

protected BasicButtonListener createButtonListener(AbstractButton b)

Overrides:

createButtonListener in class BasicButtonUI

propertyChange

protected void propertyChange(AbstractButton b,
                              PropertyChangeEvent e)

installStyle

protected void installStyle(AbstractButton b)

Since:

2

applyStyle

protected void applyStyle(AbstractButton b,
                          Object style)

Since:

2

applyStyleProperty

protected Object applyStyleProperty(AbstractButton b,
                                    String key,
                                    Object value)

Since:

2

getStyleableInfos

public Map<String,Class<?>> getStyleableInfos(JComponent c)

Specified by:

getStyleableInfos in interface FlatStylingSupport.StyleableUI

Since:

2

getStyleableValue

public Object getStyleableValue(JComponent c,
                                String key)

Specified by:

getStyleableValue in interface FlatStylingSupport.StyleableUI

Since:

2.5

isFocusPainted

public static boolean isFocusPainted(Component c)

update

public void update(Graphics g,
                   JComponent c)

Overrides:

update in class ComponentUI

paintBackground

protected void paintBackground(Graphics g,
                               JComponent c)

paint

public void paint(Graphics g,
                  JComponent c)

Similar to BasicButtonUI.paint(), but does not use zero insets for HTML text, which is done in BasicButtonUI.layout() since Java 19. See https://github.com/openjdk/jdk/pull/8407 and https://github.com/openjdk/jdk/pull/8407#issuecomment-1761583430

Overrides:

paint in class BasicButtonUI

paintIcon

protected void paintIcon(Graphics g,
                         JComponent c,
                         Rectangle iconRect)

Overrides:

paintIcon in class BasicButtonUI

paintText

protected void paintText(Graphics g,
                         AbstractButton b,
                         Rectangle textRect,
                         String text)

Overrides:

paintText in class BasicButtonUI

paintText

public static void paintText(Graphics g,
                             AbstractButton b,
                             Rectangle textRect,
                             String text,
                             Color foreground)

getBackground

protected Color getBackground(JComponent c)

getBackgroundBase

protected Color getBackgroundBase(JComponent c,
                                  boolean def)

isCustomBackground

protected boolean isCustomBackground(Color bg)

buttonStateColor

public static Color buttonStateColor(Component c,
                                     Color enabledColor,
                                     Color disabledColor,
                                     Color focusedColor,
                                     Color hoverColor,
                                     Color pressedColor)

getForeground

protected Color getForeground(JComponent c)

getForegroundBase

protected Color getForegroundBase(JComponent c,
                                  boolean def)

Since:

2.3

isCustomForeground

protected boolean isCustomForeground(Color fg)

getPreferredSize

public Dimension getPreferredSize(JComponent c)

Overrides:

getPreferredSize in class BasicButtonUI

getBaseline

public int getBaseline(JComponent c,
                       int width,
                       int height)

Overrides:

getBaseline in class BasicButtonUI