Merge PR #772: macOS: native rounded borders for popups

.github/workflows/natives.yml

@@ -20,6 +20,7 @@ jobs:
             matrix:
                 os:
                     - windows
+                    - macos
                     - ubuntu
 
         runs-on: ${{ matrix.os }}-latest

CHANGELOG.md

@@ -5,6 +5,11 @@ FlatLaf Change Log
 
 #### New features and improvements
 
+- macOS (10.14+): Popups (`JPopupMenu`, `JComboBox`, `JToolTip`, etc.) now use
+  native macOS rounded borders. (PR #772; issue #715)
+- Native libraries: Added `libflatlaf-macos-arm64.dylib` and
+  `libflatlaf-macos-x86_64.dylib`. See also
+  https://www.formdev.com/flatlaf/native-libraries/.
 - ToolBar: Added styling properties `separatorWidth` and `separatorColor`.
 
 #### Fixed bugs

flatlaf-core/build.gradle.kts

@@ -127,9 +127,11 @@ flatlafPublish {
 
 	val natives = "src/main/resources/com/formdev/flatlaf/natives"
 	nativeArtifacts = listOf(
-		NativeArtifact( "${natives}/flatlaf-windows-x86.dll",    "windows-x86",    "dll" ),
-		NativeArtifact( "${natives}/flatlaf-windows-x86_64.dll", "windows-x86_64", "dll" ),
-		NativeArtifact( "${natives}/flatlaf-windows-arm64.dll",  "windows-arm64",  "dll" ),
-		NativeArtifact( "${natives}/libflatlaf-linux-x86_64.so", "linux-x86_64",   "so" ),
+		NativeArtifact( "${natives}/flatlaf-windows-x86.dll",       "windows-x86",    "dll" ),
+		NativeArtifact( "${natives}/flatlaf-windows-x86_64.dll",    "windows-x86_64", "dll" ),
+		NativeArtifact( "${natives}/flatlaf-windows-arm64.dll",     "windows-arm64",  "dll" ),
+		NativeArtifact( "${natives}/libflatlaf-macos-arm64.dylib",  "macos-arm64",    "dylib" ),
+		NativeArtifact( "${natives}/libflatlaf-macos-x86_64.dylib", "macos-x86_64",   "dylib" ),
+		NativeArtifact( "${natives}/libflatlaf-linux-x86_64.so",    "linux-x86_64",   "so" ),
 	)
 }

flatlaf-core/src/main/java/com/formdev/flatlaf/FlatClientProperties.java

@@ -278,19 +278,38 @@ public interface FlatClientProperties
 	 * <p>
 	 * Note that this is not available on all platforms since it requires special support.
 	 * Supported platforms:
-	 * <p>
-	 * <strong>Windows 11</strong> (x86 or x86_64): Only two corner radiuses are supported
-	 * by the OS: {@code DWMWCP_ROUND} is 8px and {@code DWMWCP_ROUNDSMALL} is 4px.
-	 * If this value is {@code 1 - 4}, then {@code DWMWCP_ROUNDSMALL} is used.
-	 * If it is {@code >= 5}, then {@code DWMWCP_ROUND} is used.
-	 * <p>
+	 * <ul>
+	 * <li><strong>Windows 11</strong>: Only two corner radiuses are supported
+	 *     by the OS: {@code DWMWCP_ROUND} is 8px and {@code DWMWCP_ROUNDSMALL} is 4px.
+	 *     If this value is {@code 1 - 4}, then {@code DWMWCP_ROUNDSMALL} is used.
+	 *     If it is {@code >= 5}, then {@code DWMWCP_ROUND} is used.
+	 * <li><strong>macOS</strong> (10.14 and later): Any corner radius is supported.
+	 * </ul>
 	 * <strong>Component</strong> {@link javax.swing.JComponent}<br>
 	 * <strong>Value type</strong> {@link java.lang.Integer}<br>
 	 *
 	 * @since 3.1
 	 */
 	String POPUP_BORDER_CORNER_RADIUS = "Popup.borderCornerRadius";
 
+	/**
+	 * Specifies the popup rounded border width if the component is shown in a popup
+	 * or if the component is the owner of another component that is shown in a popup.
+	 * <p>
+	 * Only used if popup uses rounded border.
+	 * <p>
+	 * Note that this is not available on all platforms since it requires special support.
+	 * Supported platforms:
+	 * <ul>
+	 * <li><strong>macOS</strong> (10.14 and later)
+	 * </ul>
+	 * <strong>Component</strong> {@link javax.swing.JComponent}<br>
+	 * <strong>Value type</strong> {@link java.lang.Integer} or {@link java.lang.Float}<br>
+	 *
+	 * @since 3.3
+	 */
+	String POPUP_ROUNDED_BORDER_WIDTH = "Popup.roundedBorderWidth";
+
 	/**
 	 * Specifies whether a drop shadow is painted if the component is shown in a popup
 	 * or if the component is the owner of another component that is shown in a popup.

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatLineBorder.java

@@ -22,6 +22,7 @@
 import java.awt.Graphics;
 import java.awt.Graphics2D;
 import java.awt.Insets;
+import javax.swing.JComponent;
 
 /**
  * Line border for various components.
@@ -66,6 +67,9 @@ public int getArc() {
 
 	@Override
 	public void paintBorder( Component c, Graphics g, int x, int y, int width, int height ) {
+		if( c instanceof JComponent && ((JComponent)c).getClientProperty( FlatPopupFactory.KEY_POPUP_USES_NATIVE_BORDER ) != null )
+			return;
+
 		Graphics2D g2 = (Graphics2D) g.create();
 		try {
 			FlatUIUtils.setRenderingHints( g2 );

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatNativeLibrary.java

@@ -81,6 +81,12 @@ else if( SystemInfo.isX86_64 )
 			// Instead flatlaf.dll dynamically loads jawt.dll when first used,
 			// which is guaranteed after AWT initialization.
 
+		} else if( SystemInfo.isMacOS_10_14_Mojave_orLater && (SystemInfo.isAARCH64 || SystemInfo.isX86_64) ) {
+			// macOS: requires macOS 10.14 or later (arm64 or x86_64)
+
+			classifier = SystemInfo.isAARCH64 ? "macos-arm64" : "macos-x86_64";
+			ext = "dylib";
+
 		} else if( SystemInfo.isLinux && SystemInfo.isX86_64 ) {
 			// Linux: requires x86_64
 

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatNativeLinuxLibrary.java

@@ -35,6 +35,12 @@
  */
 class FlatNativeLinuxLibrary
 {
+	/**
+	 * Checks whether native library is loaded/available.
+	 * <p>
+	 * <b>Note</b>: It is required to invoke this method before invoking any other
+	 *              method of this class. Otherwise, the native library may not be loaded.
+	 */
 	static boolean isLoaded() {
 		return SystemInfo.isLinux && FlatNativeLibrary.isLoaded();
 	}

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatNativeMacLibrary.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2023 FormDev Software GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.formdev.flatlaf.ui;
+
+import java.awt.Window;
+
+/**
+ * Native methods for macOS.
+ * <p>
+ * <b>Note</b>: This is private API. Do not use!
+ *
+ * <h2>Methods that use windows as parameter</h2>
+ *
+ * For all methods that accept a {@link java.awt.Window} as parameter,
+ * the underlying macOS window must be already created,
+ * otherwise the method fails. You can use following to ensure this:
+ * <pre>{@code
+ * if( !window.isDisplayable() )
+ *     window.addNotify();
+ * }</pre>
+ * or invoke the method after packing the window. E.g.
+ * <pre>{@code
+ * window.pack();
+ * }</pre>
+ *
+ * @author Karl Tauber
+ * @since 3.3
+ */
+public class FlatNativeMacLibrary
+{
+	/**
+	 * Checks whether native library is loaded/available.
+	 * <p>
+	 * <b>Note</b>: It is required to invoke this method before invoking any other
+	 *              method of this class. Otherwise, the native library may not be loaded.
+	 */
+	public static boolean isLoaded() {
+		return FlatNativeLibrary.isLoaded();
+	}
+
+	public native static boolean setWindowRoundedBorder( Window window, float radius, float borderWidth, int borderColor );
+}

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatPopupFactory.java

@@ -71,6 +71,8 @@
 public class FlatPopupFactory
 	extends PopupFactory
 {
+	static final String KEY_POPUP_USES_NATIVE_BORDER = "FlatLaf.internal.FlatPopupFactory.popupUsesNativeBorder";
+
 	private MethodHandle java8getPopupMethod;
 	private MethodHandle java9getPopupMethod;
 
@@ -92,17 +94,20 @@ public Popup getPopup( Component owner, Component contents, int x, int y )
 			return new NonFlashingPopup( getPopupForScreenOfOwner( owner, contents, x, y, forceHeavyWeight ), contents );
 
 		// macOS and Linux adds drop shadow to heavy weight popups
-		if( SystemInfo.isMacOS || SystemInfo.isLinux )
-			return new NonFlashingPopup( getPopupForScreenOfOwner( owner, contents, x, y, true ), contents );
+		if( SystemInfo.isMacOS || SystemInfo.isLinux ) {
+			NonFlashingPopup popup = new NonFlashingPopup( getPopupForScreenOfOwner( owner, contents, x, y, true ), contents );
+			if( popup.popupWindow != null && SystemInfo.isMacOS && FlatNativeMacLibrary.isLoaded() )
+				setupRoundedBorder( popup.popupWindow, owner, contents );
+			return popup;
+		}
 
 		// Windows 11 with FlatLaf native library can use rounded corners and shows drop shadow for heavy weight popups
-		int borderCornerRadius;
 		if( isWindows11BorderSupported() &&
-			(borderCornerRadius = getBorderCornerRadius( owner, contents )) > 0 )
+			getBorderCornerRadius( owner, contents ) > 0 )
 		{
 			NonFlashingPopup popup = new NonFlashingPopup( getPopupForScreenOfOwner( owner, contents, x, y, true ), contents );
 			if( popup.popupWindow != null )
-				setupWindows11Border( popup.popupWindow, contents, borderCornerRadius );
+				setupRoundedBorder( popup.popupWindow, owner, contents );
 			return popup;
 		}
 
@@ -197,7 +202,7 @@ private Popup getHeavyWeightPopup( Component owner, Component contents, int x, i
 		}
 	}
 
-	private boolean isOptionEnabled( Component owner, Component contents, String clientKey, String uiKey ) {
+	private static boolean isOptionEnabled( Component owner, Component contents, String clientKey, String uiKey ) {
 		Object value = getOption( owner, contents, clientKey, uiKey );
 		return (value instanceof Boolean) ? (Boolean) value : false;
 	}
@@ -210,7 +215,7 @@ private boolean isOptionEnabled( Component owner, Component contents, String cli
 	 * <li>UI property {@code uiKey}
 	 * </ol>
 	 */
-	private Object getOption( Component owner, Component contents, String clientKey, String uiKey ) {
+	private static Object getOption( Component owner, Component contents, String clientKey, String uiKey ) {
 		for( Component c : new Component[] { owner, contents } ) {
 			if( c instanceof JComponent ) {
 				Object value = ((JComponent)c).getClientProperty( clientKey );
@@ -314,21 +319,15 @@ private static boolean isWindows11BorderSupported() {
 		return SystemInfo.isWindows_11_orLater && FlatNativeWindowsLibrary.isLoaded();
 	}
 
-	private static void setupWindows11Border( Window popupWindow, Component contents, int borderCornerRadius ) {
-		// make sure that the Windows 11 window is created
+	private static void setupRoundedBorder( Window popupWindow, Component owner, Component contents ) {
+		// make sure that the native window is created
 		if( !popupWindow.isDisplayable() )
 			popupWindow.addNotify();
 
-		// get window handle
-		long hwnd = FlatNativeWindowsLibrary.getHWND( popupWindow );
+		int borderCornerRadius = getBorderCornerRadius( owner, contents );
+		float borderWidth = getRoundedBorderWidth( owner, contents );
 
-		// set corner preference
-		int cornerPreference = (borderCornerRadius <= 4)
-			? FlatNativeWindowsLibrary.DWMWCP_ROUNDSMALL  // 4px
-			: FlatNativeWindowsLibrary.DWMWCP_ROUND;      // 8px
-		FlatNativeWindowsLibrary.setWindowCornerPreference( hwnd, cornerPreference );
-
-		// set border color
+		// get Swing border color
 		Color borderColor = null; // use system default color
 		if( contents instanceof JComponent ) {
 			Border border = ((JComponent)contents).getBorder();
@@ -341,8 +340,31 @@ else if( border instanceof LineBorder )
 				borderColor = ((LineBorder)border).getLineColor();
 			else if( border instanceof EmptyBorder )
 				borderColor = FlatNativeWindowsLibrary.COLOR_NONE; // do not paint border
+
+			// avoid that FlatLineBorder paints the Swing border
+			((JComponent)contents).putClientProperty( KEY_POPUP_USES_NATIVE_BORDER, true );
+		}
+
+		if( SystemInfo.isWindows ) {
+			// get native window handle
+			long hwnd = FlatNativeWindowsLibrary.getHWND( popupWindow );
+
+			// set corner preference
+			int cornerPreference = (borderCornerRadius <= 4)
+				? FlatNativeWindowsLibrary.DWMWCP_ROUNDSMALL  // 4px
+				: FlatNativeWindowsLibrary.DWMWCP_ROUND;      // 8px
+			FlatNativeWindowsLibrary.setWindowCornerPreference( hwnd, cornerPreference );
+
+			// set border color
+			FlatNativeWindowsLibrary.dwmSetWindowAttributeCOLORREF( hwnd, FlatNativeWindowsLibrary.DWMWA_BORDER_COLOR, borderColor );
+		} else if( SystemInfo.isMacOS ) {
+			if( borderColor == null || borderColor == FlatNativeWindowsLibrary.COLOR_NONE )
+				borderWidth = 0;
+
+			// set corner radius, border width and color
+			FlatNativeMacLibrary.setWindowRoundedBorder( popupWindow, borderCornerRadius,
+				borderWidth, (borderColor != null) ? borderColor.getRGB() : 0 );
 		}
-		FlatNativeWindowsLibrary.dwmSetWindowAttributeCOLORREF( hwnd, FlatNativeWindowsLibrary.DWMWA_BORDER_COLOR, borderColor );
 	}
 
 	private static void resetWindows11Border( Window popupWindow ) {
@@ -355,7 +377,7 @@ private static void resetWindows11Border( Window popupWindow ) {
 		FlatNativeWindowsLibrary.setWindowCornerPreference( hwnd, FlatNativeWindowsLibrary.DWMWCP_DONOTROUND );
 	}
 
-	private int getBorderCornerRadius( Component owner, Component contents ) {
+	private static int getBorderCornerRadius( Component owner, Component contents ) {
 		String uiKey =
 			(contents instanceof BasicComboPopup) ? "ComboBox.borderCornerRadius" :
 			(contents instanceof JPopupMenu) ? "PopupMenu.borderCornerRadius" :
@@ -366,6 +388,17 @@ private int getBorderCornerRadius( Component owner, Component contents ) {
 		return (value instanceof Integer) ? (Integer) value : 0;
 	}
 
+	private static float getRoundedBorderWidth( Component owner, Component contents ) {
+		String uiKey =
+			(contents instanceof BasicComboPopup) ? "ComboBox.roundedBorderWidth" :
+			(contents instanceof JPopupMenu) ? "PopupMenu.roundedBorderWidth" :
+			(contents instanceof JToolTip) ? "ToolTip.roundedBorderWidth" :
+			"Popup.roundedBorderWidth";
+
+		Object value = getOption( owner, contents, FlatClientProperties.POPUP_ROUNDED_BORDER_WIDTH, uiKey );
+		return (value instanceof Number) ? ((Number)value).floatValue() : 0;
+	}
+
 	//---- fixes --------------------------------------------------------------
 
 	private static boolean overlapsHeavyWeightComponent( Component owner, Component contents, int x, int y ) {
@@ -508,6 +541,9 @@ public void show() {
 
 		@Override
 		public void hide() {
+			if( contents instanceof JComponent )
+				((JComponent)contents).putClientProperty( KEY_POPUP_USES_NATIVE_BORDER, null );
+
 			if( delegate != null ) {
 				delegate.hide();
 				delegate = null;

flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatDarkLaf.properties

@@ -246,6 +246,7 @@ PasswordField.revealIconColor = @foreground
 
 #---- Popup ----
 
+[mac]Popup.roundedBorderWidth = 1
 Popup.dropShadowColor = #000
 Popup.dropShadowOpacity = 0.25
 

flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatLaf.properties

@@ -289,6 +289,7 @@ ComboBox.popupInsets = 0,0,0,0
 ComboBox.selectionInsets = 0,0,0,0
 ComboBox.selectionArc = 0
 ComboBox.borderCornerRadius = $Popup.borderCornerRadius
+[mac]ComboBox.roundedBorderWidth = $Popup.roundedBorderWidth
 
 
 #---- Component ----
@@ -505,6 +506,7 @@ PasswordField.revealIcon = com.formdev.flatlaf.icons.FlatRevealIcon
 #---- Popup ----
 
 Popup.borderCornerRadius = 4
+[mac]Popup.roundedBorderWidth = 0
 Popup.dropShadowPainted = true
 Popup.dropShadowInsets = -4,-4,4,4
 
@@ -514,6 +516,7 @@ Popup.dropShadowInsets = -4,-4,4,4
 PopupMenu.border = com.formdev.flatlaf.ui.FlatPopupMenuBorder
 PopupMenu.borderInsets = 4,1,4,1
 PopupMenu.borderCornerRadius = $Popup.borderCornerRadius
+[mac]PopupMenu.roundedBorderWidth = $Popup.roundedBorderWidth
 PopupMenu.background = @menuBackground
 PopupMenu.scrollArrowColor = @buttonArrowColor
 
@@ -902,6 +905,7 @@ ToolTipManager.enableToolTipMode = activeApplication
 #---- ToolTip ----
 
 ToolTip.borderCornerRadius = $Popup.borderCornerRadius
+[mac]ToolTip.roundedBorderWidth = $Popup.roundedBorderWidth
 
 
 #---- Tree ----