Merge PR #779: macOS: window title bar close/minimize/zoom buttons spacing

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

@@ -270,6 +270,80 @@ public interface FlatClientProperties
 	String COMPONENT_TITLE_BAR_CAPTION = "JComponent.titleBarCaption";
 
 
+	//---- Panel --------------------------------------------------------------
+
+	/**
+	 * Marks the panel as placeholder for the iconfify/maximize/close buttons
+	 * in fullWindowContent mode.
+	 * <p>
+	 * If fullWindowContent mode is enabled, the preferred size of the panel is equal
+	 * to the size of the iconfify/maximize/close buttons. Otherwise is is {@code 0,0}.
+	 * <p>
+	 * You're responsible to layout that panel at the top-left or top-right corner,
+	 * depending on platform, where the iconfify/maximize/close buttons are located.
+	 * <p>
+	 * Syntax of the value string is: {@code "win|mac [horizontal|vertical] [zeroInFullScreen] [leftToRight|rightToLeft]"}.
+	 * <p>
+	 * The string must start with {@code "win"} (for Windows or Linux) or
+	 * with {@code "mac"} (for macOS) and specifies the platform where the placeholder
+	 * should be used. On macOS, you need the placeholder in the top-left corner,
+	 * but on Windows/Linux you need it in the top-right corner. So if your application supports
+	 * fullWindowContent mode on both platforms, you can add two placeholders to your layout
+	 * and FlatLaf automatically uses only one of them. The other gets size {@code 0,0}.
+	 * <p>
+	 * Optionally, you can append following options to the value string (separated by space characters):
+	 * <ul>
+	 *   <li>{@code "horizontal"} - preferred height is zero
+	 *   <li>{@code "vertical"} - preferred width is zero
+	 *   <li>{@code "zeroInFullScreen"} - in full-screen mode on macOS, preferred size is {@code 0,0}
+	 *   <li>{@code "leftToRight"} - in right-to-left component orientation, preferred size is {@code 0,0}
+	 *   <li>{@code "rightToLeft"} - in left-to-right component orientation, preferred size is {@code 0,0}
+	 * </ul>
+	 *
+	 * Example for adding placeholder to top-left corner on macOS:
+	 * <pre>{@code
+	 * JPanel placeholder = new JPanel();
+	 * placeholder.putClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER, "mac" );
+     *
+     * JToolBar toolBar = new JToolBar();
+     * // add tool bar items
+     *
+	 * JPanel toolBarPanel = new JPanel( new BorderLayout() );
+	 * toolBarPanel.add( placeholder, BorderLayout.WEST );
+	 * toolBarPanel.add( toolBar, BorderLayout.CENTER );
+	 *
+	 * frame.getContentPane().add( toolBarPanel, BorderLayout.NORTH );
+	 * }</pre>
+	 *
+	 * Or add placeholder as first item to the tool bar:
+	 * <pre>{@code
+	 * JPanel placeholder = new JPanel();
+	 * placeholder.putClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER, "mac" );
+	 *
+	 * JToolBar toolBar = new JToolBar();
+	 * toolBar.add( placeholder );
+	 * // add tool bar items
+	 *
+	 * frame.getContentPane().add( toolBar, BorderLayout.NORTH );
+	 * }</pre>
+	 *
+	 * If a tabbed pane is located at the top, you can add the placeholder
+	 * as leading component to that tabbed pane:
+	 * <pre>{@code
+	 * JPanel placeholder = new JPanel();
+	 * placeholder.putClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER, "mac" );
+	 *
+	 * tabbedPane.putClientProperty( FlatClientProperties.TABBED_PANE_LEADING_COMPONENT, placeholder );
+	 * }</pre>
+	 * <p>
+	 * <strong>Component</strong> {@link javax.swing.JPanel}<br>
+	 * <strong>Value type</strong> {@link java.lang.String}
+	 *
+	 * @since 3.4
+	 */
+	String FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER = "FlatLaf.fullWindowContent.buttonsPlaceholder";
+
+
 	//---- Popup --------------------------------------------------------------
 
 	/**
@@ -388,6 +462,20 @@ public interface FlatClientProperties
 	 */
 	String MENU_BAR_EMBEDDED = "JRootPane.menuBarEmbedded";
 
+	/**
+	 * Contains the current bounds of the iconfify/maximize/close buttons
+	 * (in root pane coordinates) if fullWindowContent mode is enabled.
+	 * Otherwise its value is {@code null}.
+	 * <p>
+	 * <b>Note</b>: Do not set this client property. It is set by FlatLaf.
+	 * <p>
+	 * <strong>Component</strong> {@link javax.swing.JRootPane}<br>
+	 * <strong>Value type</strong> {@link java.awt.Rectangle}
+	 *
+	 * @since 3.4
+	 */
+	String FULL_WINDOW_CONTENT_BUTTONS_BOUNDS = "FlatLaf.fullWindowContent.buttonsBounds";
+
 	/**
 	 * Specifies whether the window icon should be shown in the window title bar
 	 * (requires enabled window decorations). Default is UI property {@code TitlePane.showIcon}.
@@ -1263,6 +1351,44 @@ public interface FlatClientProperties
 	String TREE_PAINT_SELECTION = "JTree.paintSelection";
 
 
+	//---- macOS --------------------------------------------------------------
+
+	/**
+	 * Specifies the spacing around the macOS window close/minimize/zoom buttons.
+	 * Useful if <a href="https://www.formdev.com/flatlaf/macos/#full_window_content">full window content</a>
+	 * is enabled.
+	 * <p>
+	 * (requires macOS 10.14+ for "medium" spacing and macOS 11+ for "large" spacing, requires Java 17+)
+	 * <p>
+	 * <strong>Component</strong> {@link javax.swing.JRootPane}<br>
+	 * <strong>Value type</strong> {@link java.lang.String}<br>
+	 * <strong>Allowed Values</strong>
+	 *     {@link #MACOS_WINDOW_BUTTONS_SPACING_MEDIUM} or
+	 *     {@link #MACOS_WINDOW_BUTTONS_SPACING_LARGE} (requires macOS 11+)
+	 *
+	 * @since 3.4
+	 */
+	String MACOS_WINDOW_BUTTONS_SPACING = "FlatLaf.macOS.windowButtonsSpacing";
+
+	/**
+	 * Add medium spacing around the macOS window close/minimize/zoom buttons.
+	 *
+	 * @see #MACOS_WINDOW_BUTTONS_SPACING
+	 * @since 3.4
+	 */
+	String MACOS_WINDOW_BUTTONS_SPACING_MEDIUM = "medium";
+
+	/**
+	 * Add large spacing around the macOS window close/minimize/zoom buttons.
+	 * <p>
+	 * (requires macOS 11+; "medium" is used on older systems)
+	 *
+	 * @see #MACOS_WINDOW_BUTTONS_SPACING
+	 * @since 3.4
+	 */
+	String MACOS_WINDOW_BUTTONS_SPACING_LARGE = "large";
+
+
 	//---- helper methods -----------------------------------------------------
 
 	/**

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

@@ -16,7 +16,9 @@
 
 package com.formdev.flatlaf.ui;
 
+import java.awt.Rectangle;
 import java.awt.Window;
+import com.formdev.flatlaf.util.SystemInfo;
 
 /**
  * Native methods for macOS.
@@ -49,8 +51,19 @@ public class FlatNativeMacLibrary
 	 *              method of this class. Otherwise, the native library may not be loaded.
 	 */
 	public static boolean isLoaded() {
-		return FlatNativeLibrary.isLoaded();
+		return SystemInfo.isMacOS && FlatNativeLibrary.isLoaded();
 	}
 
 	public native static boolean setWindowRoundedBorder( Window window, float radius, float borderWidth, int borderColor );
+
+	/** @since 3.4 */
+	public static final int
+		BUTTONS_SPACING_DEFAULT = 0,
+		BUTTONS_SPACING_MEDIUM = 1,
+		BUTTONS_SPACING_LARGE = 2;
+
+	/** @since 3.4 */ public native static boolean setWindowButtonsSpacing( Window window, int buttonsSpacing );
+	/** @since 3.4 */ public native static Rectangle getWindowButtonsBounds( Window window );
+	/** @since 3.4 */ public native static boolean isWindowFullScreen( Window window );
+	/** @since 3.4 */ public native static boolean toggleWindowFullScreen( Window window );
 }

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

@@ -16,6 +16,7 @@
 
 package com.formdev.flatlaf.ui;
 
+import java.awt.Dimension;
 import java.awt.Graphics;
 import java.awt.Graphics2D;
 import java.beans.PropertyChangeEvent;
@@ -23,6 +24,7 @@ import java.beans.PropertyChangeListener;
 import java.util.Map;
 import javax.swing.JComponent;
 import javax.swing.JPanel;
+import javax.swing.LookAndFeel;
 import javax.swing.plaf.ComponentUI;
 import javax.swing.plaf.basic.BasicPanelUI;
 import com.formdev.flatlaf.FlatClientProperties;
@@ -69,6 +71,8 @@ public class FlatPanelUI
 		super.installUI( c );
 
 		c.addPropertyChangeListener( this );
+		if( c.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER ) != null )
+			FullWindowContentSupport.registerPlaceholder( c );
 
 		installStyle( (JPanel) c );
 	}
@@ -78,10 +82,20 @@ public class FlatPanelUI
 		super.uninstallUI( c );
 
 		c.removePropertyChangeListener( this );
+		if( c.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER ) != null )
+			FullWindowContentSupport.unregisterPlaceholder( c );
 
 		oldStyleValues = null;
 	}
 
+	@Override
+	protected void installDefaults( JPanel p ) {
+		super.installDefaults( p );
+
+		if( p.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER ) != null )
+			LookAndFeel.installProperty( p, "opaque", false );
+	}
+
 	/** @since 2.0.1 */
 	@Override
 	public void propertyChange( PropertyChangeEvent e ) {
@@ -98,6 +112,17 @@ public class FlatPanelUI
 				c.revalidate();
 				c.repaint();
 				break;
+
+			case FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER:
+				JPanel p = (JPanel) e.getSource();
+				if( e.getOldValue() != null )
+					FullWindowContentSupport.unregisterPlaceholder( p );
+				if( e.getNewValue() != null )
+					FullWindowContentSupport.registerPlaceholder( p );
+
+				// make panel non-opaque for placeholders
+				LookAndFeel.installProperty( p, "opaque", e.getNewValue() == null );
+				break;
 		}
 	}
 
@@ -162,4 +187,19 @@ public class FlatPanelUI
 
 		paint( g, c );
 	}
+
+	@Override
+	public Dimension getPreferredSize( JComponent c ) {
+		Object value = c.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER );
+		if( value != null )
+			return FullWindowContentSupport.getPlaceholderPreferredSize( c, (String) value );
+
+		return super.getPreferredSize( c );
+	}
+
+	@Override
+	public void paint( Graphics g, JComponent c ) {
+		if( c.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_PLACEHOLDER ) != null )
+			FullWindowContentSupport.debugPaint( g, c );
+	}
 }

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

@@ -89,6 +89,7 @@ public class FlatRootPaneUI
 	private LayoutManager oldLayout;
 	private PropertyChangeListener ancestorListener;
 	private ComponentListener componentListener;
+	private ComponentListener macFullWindowContentListener;
 
 	public static ComponentUI createUI( JComponent c ) {
 		return new FlatRootPaneUI();
@@ -207,6 +208,9 @@ public class FlatRootPaneUI
 			};
 			root.addPropertyChangeListener( "ancestor", ancestorListener );
 		}
+
+		if( SystemInfo.isMacFullWindowContentSupported )
+			macFullWindowContentListener = FullWindowContentSupport.macInstallListeners( root );
 	}
 
 	@Override
@@ -223,6 +227,11 @@ public class FlatRootPaneUI
 			root.removePropertyChangeListener( "ancestor", ancestorListener );
 			ancestorListener = null;
 		}
+
+		if( SystemInfo.isMacFullWindowContentSupported ) {
+			FullWindowContentSupport.macUninstallListeners( root, macFullWindowContentListener );
+			macFullWindowContentListener = null;
+		}
 	}
 
 	/** @since 1.1.2 */
@@ -359,6 +368,10 @@ public class FlatRootPaneUI
 					titlePane.titleBarColorsChanged();
 				break;
 
+			case FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_BOUNDS:
+				FullWindowContentSupport.revalidatePlaceholders( rootPane );
+				break;
+
 			case FlatClientProperties.GLASS_PANE_FULL_HEIGHT:
 				rootPane.revalidate();
 				break;
@@ -367,6 +380,50 @@ public class FlatRootPaneUI
 				if( rootPane.isDisplayable() )
 					throw new IllegalComponentStateException( "The client property 'Window.style' must be set before the window becomes displayable." );
 				break;
+
+			case "ancestor":
+				// FlatNativeMacLibrary.setWindowButtonsSpacing() and
+				// FullWindowContentSupport.macUpdateFullWindowContentButtonsBoundsProperty()
+				// require a native window, but setting the client properties
+				// "apple.awt.fullWindowContent" or FlatClientProperties.MACOS_WINDOW_BUTTONS_SPACING
+				// is usually done before the native window is created
+				// --> try again when native window is created
+				if( !SystemInfo.isMacOS || e.getNewValue() == null )
+					break;
+
+				// fall through
+
+			case FlatClientProperties.MACOS_WINDOW_BUTTONS_SPACING:
+				if( SystemInfo.isMacOS ) {
+					// set window buttons spacing
+					if( SystemInfo.isJava_17_orLater && rootPane.isDisplayable() && FlatNativeMacLibrary.isLoaded() ) {
+						int buttonsSpacing = FlatNativeMacLibrary.BUTTONS_SPACING_DEFAULT;
+						String value = (String) rootPane.getClientProperty( FlatClientProperties.MACOS_WINDOW_BUTTONS_SPACING );
+						if( value != null ) {
+							switch( value ) {
+								case FlatClientProperties.MACOS_WINDOW_BUTTONS_SPACING_MEDIUM:
+									buttonsSpacing = FlatNativeMacLibrary.BUTTONS_SPACING_MEDIUM;
+									break;
+
+								case FlatClientProperties.MACOS_WINDOW_BUTTONS_SPACING_LARGE:
+									buttonsSpacing = FlatNativeMacLibrary.BUTTONS_SPACING_LARGE;
+									break;
+							}
+						}
+
+						Window window = SwingUtilities.windowForComponent( rootPane );
+						FlatNativeMacLibrary.setWindowButtonsSpacing( window, buttonsSpacing );
+					}
+
+					// update buttons bounds client property
+					FullWindowContentSupport.macUpdateFullWindowContentButtonsBoundsProperty( rootPane );
+				}
+				break;
+
+			case "apple.awt.fullWindowContent":
+				if( SystemInfo.isMacOS )
+					FullWindowContentSupport.macUpdateFullWindowContentButtonsBoundsProperty( rootPane );
+				break;
 		}
 	}
 

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

@@ -0,0 +1,210 @@
+/*
+ * Copyright 2024 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.Color;
+import java.awt.Component;
+import java.awt.Dimension;
+import java.awt.Graphics;
+import java.awt.Rectangle;
+import java.awt.Window;
+import java.awt.event.ComponentAdapter;
+import java.awt.event.ComponentEvent;
+import java.awt.event.ComponentListener;
+import java.lang.ref.WeakReference;
+import java.util.ArrayList;
+import java.util.Iterator;
+import javax.swing.JComponent;
+import javax.swing.JRootPane;
+import javax.swing.SwingUtilities;
+import javax.swing.UIManager;
+import com.formdev.flatlaf.FlatClientProperties;
+import com.formdev.flatlaf.util.SystemInfo;
+
+/**
+ * @author Karl Tauber
+ */
+class FullWindowContentSupport
+{
+	private static final String KEY_DEBUG_SHOW_PLACEHOLDERS = "FlatLaf.debug.panel.showPlaceholders";
+
+	private static ArrayList<WeakReference<JComponent>> placeholders = new ArrayList<>();
+
+	static Dimension getPlaceholderPreferredSize( JComponent c, String options ) {
+		JRootPane rootPane;
+		Rectangle bounds;
+
+		if( !options.startsWith( SystemInfo.isMacOS ? "mac" : "win" ) ||
+			!c.isDisplayable() ||
+			(rootPane = SwingUtilities.getRootPane( c )) == null ||
+			(bounds = (Rectangle) rootPane.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_BOUNDS )) == null )
+		  return new Dimension( 0, 0 );
+
+		if( options.length() > 3 ) {
+			if( (options.contains( "leftToRight" ) && !c.getComponentOrientation().isLeftToRight()) ||
+				(options.contains( "rightToLeft" ) && c.getComponentOrientation().isLeftToRight()) )
+			  return new Dimension( 0, 0 );
+		}
+
+		// On macOS, the client property is updated very late when toggling full screen,
+		// which results in "jumping" layout after full screen toggle finished.
+		// To avoid that, get up-to-date buttons bounds from macOS.
+		if( SystemInfo.isMacFullWindowContentSupported && FlatNativeMacLibrary.isLoaded() ) {
+			Rectangle r = FlatNativeMacLibrary.getWindowButtonsBounds( SwingUtilities.windowForComponent( c ) );
+			if( r != null )
+				bounds = r;
+		}
+
+		int width = bounds.width;
+		int height = bounds.height;
+
+		if( options.length() > 3 ) {
+			if( width == 0 && options.contains( "zeroInFullScreen" ) )
+				height = 0;
+
+			if( options.contains( "horizontal" ) )
+				height = 0;
+			if( options.contains( "vertical" ) )
+				width = 0;
+		}
+
+		return new Dimension( width, height );
+	}
+
+	static void registerPlaceholder( JComponent c ) {
+		synchronized( placeholders ) {
+			if( indexOfPlaceholder( c ) < 0 )
+				placeholders.add( new WeakReference<>( c ) );
+		}
+	}
+
+	static void unregisterPlaceholder( JComponent c ) {
+		synchronized( placeholders ) {
+			int index = indexOfPlaceholder( c );
+			if( index >= 0 )
+				placeholders.remove( index );
+		}
+	}
+
+	private static int indexOfPlaceholder( JComponent c ) {
+		int size = placeholders.size();
+		for( int i = 0; i < size; i++ ) {
+			if( placeholders.get( i ).get() == c )
+				return i;
+		}
+		return -1;
+	}
+
+	static void revalidatePlaceholders( Component container ) {
+		synchronized( placeholders ) {
+			if( placeholders.isEmpty() )
+				return;
+
+			for( Iterator<WeakReference<JComponent>> it = placeholders.iterator(); it.hasNext(); ) {
+				WeakReference<JComponent> ref = it.next();
+				JComponent c = ref.get();
+
+				// remove already released placeholder
+				if( c == null ) {
+					it.remove();
+					continue;
+				}
+
+				// revalidate placeholder if is in given container
+				if( SwingUtilities.isDescendingFrom( c, container ) )
+					c.revalidate();
+			}
+		}
+	}
+
+	static ComponentListener macInstallListeners( JRootPane rootPane ) {
+		ComponentListener l = new ComponentAdapter() {
+			boolean lastFullScreen;
+
+			@Override
+			public void componentResized( ComponentEvent e ) {
+				Window window = SwingUtilities.windowForComponent( rootPane );
+				if( window == null )
+					return;
+
+				boolean fullScreen = FlatNativeMacLibrary.isLoaded() && FlatNativeMacLibrary.isWindowFullScreen( window );
+				if( fullScreen == lastFullScreen )
+					return;
+
+				lastFullScreen = fullScreen;
+				macUpdateFullWindowContentButtonsBoundsProperty( rootPane );
+			}
+		};
+
+		rootPane.addComponentListener( l );
+		return l;
+	}
+
+	static void macUninstallListeners( JRootPane rootPane, ComponentListener l ) {
+		if( l != null )
+			rootPane.removeComponentListener( l );
+	}
+
+	static void macUpdateFullWindowContentButtonsBoundsProperty( JRootPane rootPane ) {
+		if( !SystemInfo.isMacFullWindowContentSupported || !rootPane.isDisplayable() )
+			return;
+
+		Rectangle bounds = null;
+		if( FlatClientProperties.clientPropertyBoolean( rootPane, "apple.awt.fullWindowContent", false ) ) {
+			bounds = FlatNativeMacLibrary.isLoaded()
+				? FlatNativeMacLibrary.getWindowButtonsBounds( SwingUtilities.windowForComponent( rootPane ) )
+				: new Rectangle( 68, 28 ); // default size
+		}
+		rootPane.putClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_BOUNDS, bounds );
+	}
+
+	static void debugPaint( Graphics g, JComponent c ) {
+		if( !UIManager.getBoolean( KEY_DEBUG_SHOW_PLACEHOLDERS ) )
+			return;
+
+		int width = c.getWidth();
+		int height = c.getHeight();
+		if( width <= 0 || height <= 0 )
+			return;
+
+		// draw red figure
+		g.setColor( Color.red );
+		debugPaintRect( g, new Rectangle( width, height ) );
+
+		// draw magenta figure if buttons bounds are not equal to placeholder bounds
+		JRootPane rootPane;
+		Rectangle bounds;
+		if( (rootPane = SwingUtilities.getRootPane( c )) != null &&
+			(bounds = (Rectangle) rootPane.getClientProperty( FlatClientProperties.FULL_WINDOW_CONTENT_BUTTONS_BOUNDS )) != null &&
+			(bounds.width != width || bounds.height != height) )
+		{
+			g.setColor( Color.magenta );
+			debugPaintRect( g, SwingUtilities.convertRectangle( rootPane, bounds, c ) );
+		}
+	}
+
+	private static void debugPaintRect( Graphics g, Rectangle r ) {
+		// draw rectangle
+		g.drawRect( r.x, r.y, r.width - 1, r.height - 1 );
+
+		// draw diagonal cross
+		Object[] oldRenderingHints = FlatUIUtils.setRenderingHints( g );
+		g.drawLine( r.x, r.y, r.width - 1, r.height - 1 );
+		g.drawLine( r.x, r.height - 1, r.width - 1, r.y );
+		FlatUIUtils.resetRenderingHints( g, oldRenderingHints );
+	}
+}