Package com.formdev.flatlaf.ui

Class FlatUIUtils

java.lang.Object

com.formdev.flatlaf.ui.FlatUIUtils

public class FlatUIUtils
extends Object

Utility methods for UI delegates.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FlatUIUtils.RepaintFocusListener

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	MAC_USE_QUARTZ

Constructor Summary

Constructors

Constructor	Description
FlatUIUtils()

Method Summary

Modifier and Type	Method	Description
static Dimension	addInsets(Dimension dim, Insets insets)
static Insets	addInsets(Insets insets1, Insets insets2)
static Rectangle	addInsets(Rectangle r, Insets insets)
static Shape	createArrowShape(int direction, boolean chevron, float w, float h)	Creates a chevron or triangle arrow shape for the given direction and size.
static Shape	createComponentRectangle(float x, float y, float w, float h, float arc)	Creates a (rounded) rectangle used to paint components (border, background, etc).
static Path2D	createPath(boolean close, double... points)	Creates a open or closed path for the given points.
static Path2D	createPath(double... points)	Creates a closed path for the given points.
static Path2D	createRectangle(float x, float y, float width, float height, float lineWidth)	Creates a not-filled rectangle shape with the given line width.
static Path2D	createRoundRectangle(float x, float y, float width, float height, float lineWidth, float arcTopLeft, float arcTopRight, float arcBottomLeft, float arcBottomRight)	Creates a not-filled rounded rectangle shape and allows specifying the line width and the radius or each corner.
static Shape	createRoundRectanglePath(float x, float y, float width, float height, float arcTopLeft, float arcTopRight, float arcBottomLeft, float arcBottomRight)	Creates a filled rounded rectangle shape and allows specifying the radius of each corner.
static ComponentUI	createSharedUI(Object key, Supplier<ComponentUI> newInstanceSupplier)	Creates a shared component UI for the given key and the current Laf.
static Color	deriveColor(Color color, Color baseColor)
static void	drawString(JComponent c, Graphics g, String text, int x, int y)	Draws the given string at the specified location.
static void	drawStringUnderlineCharAt(JComponent c, Graphics g, String text, int underlinedIndex, int x, int y)	Draws the given string at the specified location underlining the specified character.
static boolean	getBoolean(JComponent c, String systemPropertyKey, String clientPropertyKey, String uiKey, boolean defaultValue)
static float	getBorderArc(JComponent c)	Returns the scaled arc diameter of the border for the given component.
static float	getBorderFocusWidth(JComponent c)	Returns the scaled thickness of the outer focus border for the given component.
static FlatBorder	getOutsideFlatBorder(JComponent c)
static Color	getParentBackground(JComponent c)	Gets the background color of the first opaque parent.
static boolean	getUIBoolean(String key, boolean defaultValue)
static Color	getUIColor(String key, int defaultColorRGB)
static Color	getUIColor(String key, Color defaultColor)
static Color	getUIColor(String key, String defaultKey)
static float	getUIFloat(String key, float defaultValue)
static int	getUIInt(String key, int defaultValue)
static boolean	hasOpaqueBeenExplicitlySet(JComponent c)
static boolean	hasRoundBorder(JComponent c)
static boolean	isCellEditor(Component c)
static boolean	isChevron(String arrowType)
static boolean	isFullScreen(Component c)	Returns whether the given component is in a window that is in full-screen mode.
static boolean	isPermanentFocusOwner(Component c)	Returns whether the given component is the permanent focus owner and is in the active window or in a popup window owned by the active window.
static Boolean	isRoundRect(Component c)
static boolean	isUseSharedUIs()	Returns whether shared UI delegates are used.
static int	minimumHeight(JComponent c, int minimumHeight)
static int	minimumWidth(JComponent c, int minimumWidth)
static Color	nonUIResource(Color c)
static Font	nonUIResource(Font font)
static void	paintArrow(Graphics2D g, int x, int y, int width, int height, int direction, boolean chevron, int arrowSize, float xOffset, float yOffset)	Paints a chevron or triangle arrow in the center of the given rectangle.
static void	paintComponentBackground(Graphics2D g, int x, int y, int width, int height, float focusWidth, float arc)	Fills the background of a component with a round rectangle.
static void	paintComponentBorder(Graphics2D g, int x, int y, int width, int height, float focusWidth, float lineWidth, float arc)	Draws the border of a component as round rectangle.
static void	paintComponentOuterBorder(Graphics2D g, int x, int y, int width, int height, float focusWidth, float lineWidth, float arc)	Paints an outer border, which is usually a focus border.
static void	paintGrip(Graphics g, int x, int y, int width, int height, boolean horizontal, int dotCount, int dotSize, int gap, boolean centerPrecise)
static void	paintParentBackground(Graphics g, JComponent c)	Fill background with parent's background color because the visible component is smaller than its bounds (for the focus decoration).
static void	resetRenderingHints(Graphics g, Object[] oldRenderingHints)	Resets rendering hints previously set with setRenderingHints(java.awt.Graphics).
static void	runWithoutRenderingHints(Graphics g, Object[] oldRenderingHints, Runnable runnable)	Temporary resets rendering hints set with setRenderingHints(java.awt.Graphics) and runs the given runnable.
static void	setInsets(Insets dest, Insets src)
static Object[]	setRenderingHints(Graphics g)	Sets rendering hints used for painting.
static boolean	setUseSharedUIs(boolean useSharedUIs)	Specifies whether shared UI delegates are used.
static Rectangle	subtractInsets(Rectangle r, Insets insets)

Methods inherited from class java.lang.Object

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

Field Detail

MAC_USE_QUARTZ

public static final boolean MAC_USE_QUARTZ

Constructor Detail

FlatUIUtils

public FlatUIUtils()

Method Detail

addInsets

public static Rectangle addInsets(Rectangle r,
                                  Insets insets)

subtractInsets

public static Rectangle subtractInsets(Rectangle r,
                                       Insets insets)

addInsets

public static Dimension addInsets(Dimension dim,
                                  Insets insets)

addInsets

public static Insets addInsets(Insets insets1,
                               Insets insets2)

setInsets

public static void setInsets(Insets dest,
                             Insets src)

getUIColor

public static Color getUIColor(String key,
                               int defaultColorRGB)

getUIColor

public static Color getUIColor(String key,
                               Color defaultColor)

getUIColor

public static Color getUIColor(String key,
                               String defaultKey)

getUIBoolean

public static boolean getUIBoolean(String key,
                                   boolean defaultValue)

Since:

1.1

getUIInt

public static int getUIInt(String key,
                           int defaultValue)

getUIFloat

public static float getUIFloat(String key,
                               float defaultValue)

getBoolean

public static boolean getBoolean(JComponent c,
                                 String systemPropertyKey,
                                 String clientPropertyKey,
                                 String uiKey,
                                 boolean defaultValue)

Since:

1.1.2

isChevron

public static boolean isChevron(String arrowType)

nonUIResource

public static Color nonUIResource(Color c)

nonUIResource

public static Font nonUIResource(Font font)

minimumWidth

public static int minimumWidth(JComponent c,
                               int minimumWidth)

minimumHeight

public static int minimumHeight(JComponent c,
                                int minimumHeight)

isCellEditor

public static boolean isCellEditor(Component c)

isPermanentFocusOwner

public static boolean isPermanentFocusOwner(Component c)

Returns whether the given component is the permanent focus owner and is in the active window or in a popup window owned by the active window. Used to paint focus indicators.

isFullScreen

public static boolean isFullScreen(Component c)

Returns whether the given component is in a window that is in full-screen mode.

isRoundRect

public static Boolean isRoundRect(Component c)

getBorderFocusWidth

public static float getBorderFocusWidth(JComponent c)

Returns the scaled thickness of the outer focus border for the given component.

getBorderArc

public static float getBorderArc(JComponent c)

Returns the scaled arc diameter of the border for the given component.

hasRoundBorder

public static boolean hasRoundBorder(JComponent c)

getOutsideFlatBorder

public static FlatBorder getOutsideFlatBorder(JComponent c)

setRenderingHints

public static Object[] setRenderingHints(Graphics g)

Sets rendering hints used for painting.

resetRenderingHints

public static void resetRenderingHints(Graphics g,
                                       Object[] oldRenderingHints)

Resets rendering hints previously set with setRenderingHints(java.awt.Graphics).

runWithoutRenderingHints

public static void runWithoutRenderingHints(Graphics g,
                                            Object[] oldRenderingHints,
                                            Runnable runnable)

Temporary resets rendering hints set with setRenderingHints(java.awt.Graphics) and runs the given runnable.

This is intended for painting text while rendering hints are set.

If text antialiasing is disabled (in OS system settings or via -Dawt.useSystemAAFontSettings=off), but general antialiasing is enabled, then text is still painted using some kind of "grayscale" antialiasing, which may make the text look bold (depends on font and font size). To avoid this, temporary disable general antialiasing. This does not affect text rendering if text antialiasing is enabled (usually the default).

deriveColor

public static Color deriveColor(Color color,
                                Color baseColor)

paintComponentOuterBorder

public static void paintComponentOuterBorder(Graphics2D g,
                                             int x,
                                             int y,
                                             int width,
                                             int height,
                                             float focusWidth,
                                             float lineWidth,
                                             float arc)

Paints an outer border, which is usually a focus border.

The outside bounds of the painted border are x,y,width,height. The line thickness of the painted border is focusWidth + lineWidth. The given arc diameter refers to the inner rectangle (x,y,width,height minus focusWidth).

See Also:

paintComponentBorder(java.awt.Graphics2D, int, int, int, int, float, float, float), paintComponentBackground(java.awt.Graphics2D, int, int, int, int, float, float)

paintComponentBorder

public static void paintComponentBorder(Graphics2D g,
                                        int x,
                                        int y,
                                        int width,
                                        int height,
                                        float focusWidth,
                                        float lineWidth,
                                        float arc)

Draws the border of a component as round rectangle.

The outside bounds of the painted border are x + focusWidth, y + focusWidth, width - (focusWidth * 2), height - (focusWidth * 2). The line thickness of the painted border is lineWidth. The given arc diameter refers to the painted rectangle (and not to x,y,width,height).

See Also:

paintComponentOuterBorder(java.awt.Graphics2D, int, int, int, int, float, float, float), paintComponentBackground(java.awt.Graphics2D, int, int, int, int, float, float)

paintComponentBackground

public static void paintComponentBackground(Graphics2D g,
                                            int x,
                                            int y,
                                            int width,
                                            int height,
                                            float focusWidth,
                                            float arc)

Fills the background of a component with a round rectangle.

The bounds of the painted round rectangle are x + focusWidth, y + focusWidth, width - (focusWidth * 2), height - (focusWidth * 2). The given arc diameter refers to the painted rectangle (and not to x,y,width,height).

See Also:

paintComponentOuterBorder(java.awt.Graphics2D, int, int, int, int, float, float, float), paintComponentBorder(java.awt.Graphics2D, int, int, int, int, float, float, float)

createComponentRectangle

public static Shape createComponentRectangle(float x,
                                             float y,
                                             float w,
                                             float h,
                                             float arc)

Creates a (rounded) rectangle used to paint components (border, background, etc). The given arc diameter is limited to min(width,height).

paintGrip

public static void paintGrip(Graphics g,
                             int x,
                             int y,
                             int width,
                             int height,
                             boolean horizontal,
                             int dotCount,
                             int dotSize,
                             int gap,
                             boolean centerPrecise)

paintParentBackground

public static void paintParentBackground(Graphics g,
                                         JComponent c)

Fill background with parent's background color because the visible component is smaller than its bounds (for the focus decoration).

getParentBackground

public static Color getParentBackground(JComponent c)

Gets the background color of the first opaque parent.

createRectangle

public static Path2D createRectangle(float x,
                                     float y,
                                     float width,
                                     float height,
                                     float lineWidth)

Creates a not-filled rectangle shape with the given line width.

createRoundRectangle

public static Path2D createRoundRectangle(float x,
                                          float y,
                                          float width,
                                          float height,
                                          float lineWidth,
                                          float arcTopLeft,
                                          float arcTopRight,
                                          float arcBottomLeft,
                                          float arcBottomRight)

Creates a not-filled rounded rectangle shape and allows specifying the line width and the radius or each corner.

createRoundRectanglePath

public static Shape createRoundRectanglePath(float x,
                                             float y,
                                             float width,
                                             float height,
                                             float arcTopLeft,
                                             float arcTopRight,
                                             float arcBottomLeft,
                                             float arcBottomRight)

Creates a filled rounded rectangle shape and allows specifying the radius of each corner.

paintArrow

public static void paintArrow(Graphics2D g,
                              int x,
                              int y,
                              int width,
                              int height,
                              int direction,
                              boolean chevron,
                              int arrowSize,
                              float xOffset,
                              float yOffset)

Paints a chevron or triangle arrow in the center of the given rectangle.

Parameters:

g - the graphics context used for painting

x - the x coordinate of the rectangle

y - the y coordinate of the rectangle

width - the width of the rectangle

height - the height of the rectangle

direction - the arrow direction (SwingConstants.NORTH, SwingConstants.SOUTH SwingConstants.WEST or SwingConstants.EAST)

chevron - true for chevron arrow, false for triangle arrow

arrowSize - the width of the painted arrow (for vertical direction) (will be scaled)

xOffset - a offset added to the x coordinate of the arrow to paint it out-of-center. Usually zero. (will be scaled)

yOffset - a offset added to the y coordinate of the arrow to paint it out-of-center. Usually zero. (will be scaled)

Since:

1.1

createArrowShape

public static Shape createArrowShape(int direction,
                                     boolean chevron,
                                     float w,
                                     float h)

Creates a chevron or triangle arrow shape for the given direction and size.

The chevron shape is a open path that can be painted with Graphics2D.draw(Shape). The triangle shape is a close path that can be painted with Graphics2D.fill(Shape).

Parameters:

direction - the arrow direction (SwingConstants.NORTH, SwingConstants.SOUTH SwingConstants.WEST or SwingConstants.EAST)

chevron - true for chevron arrow, false for triangle arrow

w - the width of the returned shape

h - the height of the returned shape

Since:

1.1

createPath

public static Path2D createPath(double... points)

Creates a closed path for the given points.

createPath

public static Path2D createPath(boolean close,
                                double... points)

Creates a open or closed path for the given points.

drawString

public static void drawString(JComponent c,
                              Graphics g,
                              String text,
                              int x,
                              int y)

Draws the given string at the specified location. The provided component is used to query text properties and anti-aliasing hints.

Use this method instead of Graphics.drawString(String, int, int) for correct anti-aliasing.

Replacement for SwingUtilities2.drawString(). Uses HiDPIUtils.drawStringWithYCorrection(JComponent, Graphics2D, String, int, int).

drawStringUnderlineCharAt

public static void drawStringUnderlineCharAt(JComponent c,
                                             Graphics g,
                                             String text,
                                             int underlinedIndex,
                                             int x,
                                             int y)

Draws the given string at the specified location underlining the specified character. The provided component is used to query text properties and anti-aliasing hints.

Replacement for SwingUtilities2.drawStringUnderlineCharAt(). Uses HiDPIUtils.drawStringUnderlineCharAtWithYCorrection(JComponent, Graphics2D, String, int, int, int).

hasOpaqueBeenExplicitlySet

public static boolean hasOpaqueBeenExplicitlySet(JComponent c)

isUseSharedUIs

public static boolean isUseSharedUIs()

Returns whether shared UI delegates are used.

Since:

1.6

setUseSharedUIs

public static boolean setUseSharedUIs(boolean useSharedUIs)

Specifies whether shared UI delegates are used. This does not change already existing UI delegates.

Since:

1.6

createSharedUI

public static ComponentUI createSharedUI(Object key,
                                         Supplier<ComponentUI> newInstanceSupplier)

Creates a shared component UI for the given key and the current Laf. Each Laf instance has its own shared component UI instance.

This is for GUI builders that support Laf switching and may use multiple Laf instances at the same time.