Class FlatUIUtils
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final double
static final double
private static UIDefaults
static final double
static final double
static final double
private static final WeakHashMap
<LookAndFeel, IdentityHashMap<Object, ComponentUI>> private static boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Dimension
static Insets
static Rectangle
private static String
buildSubKey
(String key, String subKey) InsertssubKey
at last dot inkey
.static boolean
Returns whether the component UI for the given component can be shared with other components.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 an 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 of 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 Shape
createRoundTrianglePath
(float x1, float y1, float x2, float y2, float x3, float y3, float arc) Creates a rounded triangle shape for the given points and arc radius.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) private static double
distance
(double x1, double y1, double x2, double y2) Calculates the distance between two points.static void
drawShapePure
(Graphics2D g, Shape shape) Draws the given shape with disabled stroke normalization.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.private static Container
Find the first parent that is opaque.static boolean
getBoolean
(JComponent c, String systemPropertyKey, String clientPropertyKey, String uiKey, boolean defaultValue) static float
Returns the scaled arc diameter of the border for the given component.static int
Returns the scaled thickness of the border.static float
Returns the scaled thickness of the outer focus border for the given component.static float
Returns the scaled line thickness used to compute the border insets.static FlatBorder
static Color
Gets the background color of the first opaque parent.static boolean
getSubUIBoolean
(String key, String subKey, boolean defaultValue) static Color
getSubUIColor
(String key, String subKey) static Dimension
getSubUIDimension
(String key, String subKey) static Font
getSubUIFont
(String key, String subKey) static Icon
getSubUIIcon
(String key, String subKey) static Insets
getSubUIInsets
(String key, String subKey) static int
getSubUIInt
(String key, String subKey, int defaultValue) 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 <T extends Enum<T>>
Tstatic float
getUIFloat
(String key, float defaultValue) static int
static boolean
static boolean
(package private) static boolean
static boolean
static boolean
static boolean
Returns whether the given component is in a window that is in full-screen mode.(package private) static boolean
isInActiveWindow
(Component c, Window activeWindow) static boolean
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
static boolean
Returns whether shared UI delegates are used.private static double
lerp
(double v1, double v2, double t) Calculates linear interpolation between two values.static int
minimumHeight
(JComponent c, int minimumHeight) static int
minimumWidth
(JComponent c, int minimumWidth) (package private) static boolean
Checks whether component is used as peer for AWT (on macOS) and whether a dark FlatLaf theme is active, which requires special handling because AWT always uses light colors.static Color
static Font
nonUIResource
(Font font) static Border
nonUIResource
(Border border) static void
paintArrow
(Graphics2D g, int x, int y, int width, int height, int direction, boolean chevron, int arrowSize, float arrowThickness, 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 rounded rectangle.(package private) static void
paintFilledRectangle
(Graphics g, Color color, float x, float y, float w, float h) 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
paintOutline
(Graphics2D g, float x, float y, float w, float h, float lineWidth, float arc) Paints an outline at the given bounds using the given line width.static void
paintOutline
(Graphics2D g, float x, float y, float w, float h, float lineWidth, float arc, float innerArc) Paints an outline at the given bounds using the given line width.static void
paintOutlinedComponent
(Graphics2D g, int x, int y, int width, int height, float focusWidth, float focusWidthFraction, float focusInnerWidth, float borderWidth, float arc, Paint focusColor, Paint borderColor, Paint background) Paints an outlined component with rounded corners, consisting of following parts: an (optional) outer border, which is usually a focus indicator an (optional) component border the (optional) component backgroundprivate static void
paintOutlinedComponentImpl
(Graphics2D g, int x, int y, int width, int height, float focusWidth, float focusWidthFraction, float focusInnerWidth, float borderWidth, float arc, Paint focusColor, Paint borderColor, Paint background) static void
Fill background with parent's background color because the visible component is smaller than its bounds (for the focus decoration).private static void
paintRoundedSelectionImpl
(Graphics2D g, int x, int y, int width, int height, float arcTopLeft, float arcTopRight, float arcBottomLeft, float arcBottomRight) static void
paintSelection
(Graphics2D g, int x, int y, int width, int height, Insets insets, float arcTopLeft, float arcTopRight, float arcBottomLeft, float arcBottomRight, int flags) Paints a selection.static void
resetRenderingHints
(Graphics g, Object[] oldRenderingHints) Resets rendering hints previously set withsetRenderingHints(java.awt.Graphics)
.(package private) static void
runWithLightAWTPeerUIDefaults
(Runnable runnable) static void
runWithoutRenderingHints
(Graphics g, Object[] oldRenderingHints, Runnable runnable) Temporary resets rendering hints set withsetRenderingHints(java.awt.Graphics)
and runs the given runnable.static void
static Object[]
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) (package private) static Border
unwrapNonUIResourceBorder
(Border border)
-
Field Details
-
lightAWTPeerDefaults
-
MOVE_TO
public static final double MOVE_TO- Since:
- 3
- See Also:
-
QUAD_TO
public static final double QUAD_TO- Since:
- 3
- See Also:
-
CURVE_TO
public static final double CURVE_TO- Since:
- 3
- See Also:
-
ROUNDED
public static final double ROUNDED- Since:
- 3
- See Also:
-
CLOSE_PATH
public static final double CLOSE_PATH- Since:
- 3
- See Also:
-
Constructor Details
-
FlatUIUtils
public FlatUIUtils()
-
-
Method Details
-
addInsets
-
subtractInsets
-
addInsets
-
addInsets
-
setInsets
-
getUIColor
-
getUIColor
-
getUIColor
-
getUIBoolean
- Since:
- 1.1
-
getUIInt
-
getUIFloat
-
getUIEnum
- Since:
- 2
-
getSubUIColor
- Since:
- 3.2
-
getSubUIBoolean
- Since:
- 3.2
-
getSubUIInt
- Since:
- 3.2
-
getSubUIInsets
- Since:
- 3.2
-
getSubUIDimension
- Since:
- 3.2
-
getSubUIIcon
- Since:
- 3.2
-
getSubUIFont
- Since:
- 3.2
-
buildSubKey
InsertssubKey
at last dot inkey
.E.g.
buildSubKey( "TitlePane.font", "small" )
returns"TitlePane.small.font"
. -
getBoolean
public static boolean getBoolean(JComponent c, String systemPropertyKey, String clientPropertyKey, String uiKey, boolean defaultValue) - Since:
- 1.1.2
-
isChevron
-
nonUIResource
-
nonUIResource
-
nonUIResource
- Since:
- 2
-
unwrapNonUIResourceBorder
-
minimumWidth
-
minimumHeight
-
isCellEditor
-
isPermanentFocusOwner
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. -
isInActiveWindow
-
isAWTPeer
-
needsLightAWTPeer
Checks whether component is used as peer for AWT (on macOS) and whether a dark FlatLaf theme is active, which requires special handling because AWT always uses light colors. -
runWithLightAWTPeerUIDefaults
-
isFullScreen
Returns whether the given component is in a window that is in full-screen mode. -
isRoundRect
-
getBorderFocusWidth
Returns the scaled thickness of the outer focus border for the given component. -
getBorderLineWidth
Returns the scaled line thickness used to compute the border insets.- Since:
- 2
-
getBorderFocusAndLineWidth
Returns the scaled thickness of the border. This includes the outer focus border and the actual component border.- Since:
- 2
-
getBorderArc
Returns the scaled arc diameter of the border for the given component. -
hasRoundBorder
-
getOutsideFlatBorder
-
setRenderingHints
Sets rendering hints used for painting. -
resetRenderingHints
Resets rendering hints previously set withsetRenderingHints(java.awt.Graphics)
. -
runWithoutRenderingHints
public static void runWithoutRenderingHints(Graphics g, Object[] oldRenderingHints, Runnable runnable) Temporary resets rendering hints set withsetRenderingHints(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
-
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 rounded rectangle.The bounds of the painted rounded rectangle are
x + focusWidth, y + focusWidth, width - (focusWidth * 2), height - (focusWidth * 2)
. The given arc diameter refers to the painted rectangle (and not tox,y,width,height
).- See Also:
-
paintOutlinedComponent
public static void paintOutlinedComponent(Graphics2D g, int x, int y, int width, int height, float focusWidth, float focusWidthFraction, float focusInnerWidth, float borderWidth, float arc, Paint focusColor, Paint borderColor, Paint background) Paints an outlined component with rounded corners, consisting of following parts:- an (optional) outer border, which is usually a focus indicator
- an (optional) component border
- the (optional) component background
Each part is painted only if the corresponding part color is not
null
. The parts are painted in this order:- background
- focus border
- border
Background: The bounds of the filled rounded rectangle are
[x + focusWidth, y + focusWidth, width - (focusWidth * 2), height - (focusWidth * 2)]
. The focus border and the border may paint over the background.Focus border: The outside bounds of the painted focus border are
[x, y, width, height]
. The thickness of the painted focus border is(focusWidth * focusWidthFraction) + focusInnerWidth
. The border may paint over the focus border iffocusInnerWidth > 0
.Border: The outside bounds of the painted border are
[x + focusWidth, y + focusWidth, width - (focusWidth * 2), height - (focusWidth * 2)]
. The thickness of the painted border isborderWidth
.- Parameters:
g
- the graphics context used for paintingx
- the x coordinate of the componenty
- the y coordinate of the componentwidth
- the width of the componentheight
- the height of the componentfocusWidth
- the width of the focus border, or0
focusWidthFraction
- specified how much of the focus border is painted (in range 0 - 1); can be used for animation; the painted thickness of the focus border is(focusWidth * focusWidthFraction) + focusInnerWidth
focusInnerWidth
- the inner width of the focus border, or0
; if a border is painted thenfocusInnerWidth
needs to be larger thanborderWidth
to be not hidden by the borderborderWidth
- the width of the border, or0
arc
- the arc diameter used for the outside shape of the component border; the other needed arc diameters are computed from this arc diameterfocusColor
- the color of the focus border, ornull
borderColor
- the color of the border, ornull
background
- the background color of the component, ornull
- Since:
- 2
-
paintOutlinedComponentImpl
private static void paintOutlinedComponentImpl(Graphics2D g, int x, int y, int width, int height, float focusWidth, float focusWidthFraction, float focusInnerWidth, float borderWidth, float arc, Paint focusColor, Paint borderColor, Paint background) -
paintOutline
public static void paintOutline(Graphics2D g, float x, float y, float w, float h, float lineWidth, float arc) Paints an outline at the given bounds using the given line width. Depending on the given arc, a rectangle, rounded rectangle or circle (if w == h) is painted.- Parameters:
g
- the graphics context used for paintingx
- the x coordinate of the outliney
- the y coordinate of the outlinew
- the width of the outlineh
- the height of the outlinelineWidth
- the width of the outlinearc
- the arc diameter used for the outside shape of the outline- Since:
- 2
-
paintOutline
public static void paintOutline(Graphics2D g, float x, float y, float w, float h, float lineWidth, float arc, float innerArc) Paints an outline at the given bounds using the given line width. Depending on the given arc, a rectangle, rounded rectangle or circle (if w == h) is painted.- Parameters:
g
- the graphics context used for paintingx
- the x coordinate of the outliney
- the y coordinate of the outlinew
- the width of the outlineh
- the height of the outlinelineWidth
- the width of the outlinearc
- the arc diameter used for the outside shape of the outlineinnerArc
- the arc diameter used for the inside shape of the outline- Since:
- 2
-
createComponentRectangle
Creates a (rounded) rectangle used to paint components (border, background, etc.). The given arc diameter is limited to min(width,height). -
paintFilledRectangle
-
paintSelection
public static void paintSelection(Graphics2D g, int x, int y, int width, int height, Insets insets, float arcTopLeft, float arcTopRight, float arcBottomLeft, float arcBottomRight, int flags) Paints a selection.The bounds of the painted selection (rounded) rectangle are
x + insets.left, y + insets.top, width - insets.left - insets.right, height - insets.top - insets.bottom
. The given arc radius refers to the painted rectangle (and not tox,y,width,height
).- Since:
- 3
-
paintRoundedSelectionImpl
private static void paintRoundedSelectionImpl(Graphics2D g, int x, int y, int width, int height, float arcTopLeft, float arcTopRight, float arcBottomLeft, float arcBottomRight) -
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
Fill background with parent's background color because the visible component is smaller than its bounds (for the focus decoration). -
getParentBackground
Gets the background color of the first opaque parent. -
findOpaqueParent
Find the first parent that is opaque. -
createRectangle
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 of 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. -
createRoundTrianglePath
public static Shape createRoundTrianglePath(float x1, float y1, float x2, float y2, float x3, float y3, float arc) Creates a rounded triangle shape for the given points and arc radius.- Since:
- 3
-
paintArrow
public static void paintArrow(Graphics2D g, int x, int y, int width, int height, int direction, boolean chevron, int arrowSize, float arrowThickness, float xOffset, float yOffset) Paints a chevron or triangle arrow in the center of the given rectangle.- Parameters:
g
- the graphics context used for paintingx
- the x coordinate of the rectangley
- the y coordinate of the rectanglewidth
- the width of the rectangleheight
- the height of the rectangledirection
- the arrow direction (SwingConstants.NORTH
,SwingConstants.SOUTH
SwingConstants.WEST
orSwingConstants.EAST
)chevron
-true
for chevron arrow,false
for triangle arrowarrowSize
- the width of the painted arrow (for vertical direction) (will be scaled)arrowThickness
- the thickness of the painted chevron arrow (will be scaled)xOffset
- an offset added to the x coordinate of the arrow to paint it out-of-center. Usually zero. (will be scaled)yOffset
- an offset added to the y coordinate of the arrow to paint it out-of-center. Usually zero. (will be scaled)- Since:
- 3
-
createArrowShape
Creates a chevron or triangle arrow shape for the given direction and size.The chevron shape is an open path that can be painted with
Graphics2D.draw(Shape)
. The triangle shape is a close path that can be painted withGraphics2D.fill(Shape)
.- Parameters:
direction
- the arrow direction (SwingConstants.NORTH
,SwingConstants.SOUTH
SwingConstants.WEST
orSwingConstants.EAST
)chevron
-true
for chevron arrow,false
for triangle arroww
- the width of the returned shapeh
- the height of the returned shape- Since:
- 1.1
-
createPath
Creates a closed path for the given points. -
createPath
Creates an open or closed path for the given points. -
lerp
private static double lerp(double v1, double v2, double t) Calculates linear interpolation between two values. https://en.wikipedia.org/wiki/Linear_interpolation#Programming_language_support -
distance
private static double distance(double x1, double y1, double x2, double y2) Calculates the distance between two points. -
drawShapePure
Draws the given shape with disabled stroke normalization. The x/y coordinates of the shape are translated by a half pixel.- Since:
- 2.1
-
drawString
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()
. UsesHiDPIUtils.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()
. UsesHiDPIUtils.drawStringUnderlineCharAtWithYCorrection(JComponent, Graphics2D, String, int, int, int)
. -
hasOpaqueBeenExplicitlySet
-