Merge PR #988: System File Chooser

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

@@ -16,8 +16,10 @@
 
 package com.formdev.flatlaf;
 
+import javax.swing.JFileChooser;
 import javax.swing.JPopupMenu;
 import javax.swing.SwingUtilities;
+import com.formdev.flatlaf.util.SystemFileChooser;
 import com.formdev.flatlaf.util.UIScale;
 
 /**
@@ -246,6 +248,17 @@ public interface FlatSystemProperties
 	 */
 	String USE_SUB_MENU_SAFE_TRIANGLE = "flatlaf.useSubMenuSafeTriangle";
 
+	/**
+	 * Specifies whether {@link SystemFileChooser} uses operating system file dialogs.
+	 * If set to {@code false}, the {@link JFileChooser} is used instead.
+	 * <p>
+	 * <strong>Allowed Values</strong> {@code false} and {@code true}<br>
+	 * <strong>Default</strong> {@code true}
+	 *
+	 * @since 3.7
+	 */
+	String USE_SYSTEM_FILE_CHOOSER = "flatlaf.useSystemFileChooser";
+
 	/**
 	 * Checks whether a system property is set and returns {@code true} if its value
 	 * is {@code "true"} (case-insensitive), otherwise it returns {@code false}.

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

@@ -24,6 +24,7 @@ import java.awt.event.MouseEvent;
 import java.awt.geom.AffineTransform;
 import javax.swing.JDialog;
 import javax.swing.JFrame;
+import javax.swing.JOptionPane;
 import com.formdev.flatlaf.util.SystemInfo;
 
 /**
@@ -34,9 +35,9 @@ import com.formdev.flatlaf.util.SystemInfo;
  * @author Karl Tauber
  * @since 2.5
  */
-class FlatNativeLinuxLibrary
+public class FlatNativeLinuxLibrary
 {
-	private static int API_VERSION_LINUX = 3001;
+	private static int API_VERSION_LINUX = 3002;
 
 	/**
 	 * Checks whether native library is loaded/available.
@@ -44,10 +45,13 @@ class FlatNativeLinuxLibrary
 	 * <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() {
+	public static boolean isLoaded() {
 		return SystemInfo.isLinux && FlatNativeLibrary.isLoaded( API_VERSION_LINUX );
 	}
 
+
+	//---- X Window System ----------------------------------------------------
+
 	// direction for _NET_WM_MOVERESIZE message
 	// see https://specifications.freedesktop.org/wm-spec/latest/ar01s04.html
 	static final int
@@ -124,4 +128,109 @@ class FlatNativeLinuxLibrary
 		return (window instanceof JFrame && JFrame.isDefaultLookAndFeelDecorated() && ((JFrame)window).isUndecorated()) ||
 			(window instanceof JDialog && JDialog.isDefaultLookAndFeelDecorated() && ((JDialog)window).isUndecorated());
 	}
+
+
+	//---- GTK ----------------------------------------------------------------
+
+	private static Boolean isGtk3Available;
+
+	/**
+	 * Checks whether GTK 3 is available.
+	 * Use this before invoking any native method that uses GTK.
+	 * Otherwise the app may terminate immediately if GTK is not installed.
+	 * <p>
+	 * This works because Java uses {@code dlopen(RTLD_LAZY)} to load JNI libraries,
+	 * which only resolves symbols as the code that references them is executed.
+	 *
+	 * @since 3.7
+	 */
+	public static boolean isGtk3Available() {
+		if( isGtk3Available == null )
+			isGtk3Available = isLibAvailable( "libgtk-3.so.0" ) || isLibAvailable( "libgtk-3.so" );
+		return isGtk3Available;
+	}
+
+	private native static boolean isLibAvailable( String libname );
+
+	/**
+	 * https://docs.gtk.org/gtk3/iface.FileChooser.html#properties
+	 *
+	 * @since 3.7
+	 */
+	public static final int
+		FC_select_folder					= 1 << 0,
+		FC_select_multiple					= 1 << 1,
+		FC_show_hidden						= 1 << 2,
+		FC_local_only						= 1 << 3,  // default
+		FC_do_overwrite_confirmation		= 1 << 4,  // GTK 3 only; removed and always-on in GTK 4
+		FC_create_folders					= 1 << 5;  // default for Save
+
+	/**
+	 * Shows the Linux/GTK system file dialog
+	 * <a href="https://docs.gtk.org/gtk3/class.FileChooserDialog.html">GtkFileChooserDialog</a>.
+	 * <p>
+	 * Uses {@code GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER} if {@link #FC_select_folder} is set in parameter {@code optionsSet}.
+	 * Otherwise uses {@code GTK_FILE_CHOOSER_ACTION_OPEN} if parameter {@code open} is {@code true},
+	 * or {@code GTK_FILE_CHOOSER_ACTION_SAVE} if {@code false}.
+	 * <p>
+	 * <b>Note:</b> This method blocks the current thread until the user closes
+	 * the file dialog. It is highly recommended to invoke it from a new thread
+	 * to avoid blocking the AWT event dispatching thread.
+	 *
+	 * @param owner the owner of the file dialog; or {@code null}
+	 * @param open if {@code true}, shows the open dialog; if {@code false}, shows the save dialog
+	 * @param title text displayed in dialog title; or {@code null}
+	 * @param okButtonLabel text displayed in default button; or {@code null}.
+	 *        Use '_' for mnemonics (e.g. "_Choose")
+	 *        Use '__' for '_' character (e.g. "Choose__and__Quit").
+	 * @param currentName user-editable filename currently shown in the filename field in save dialog; or {@code null}
+	 * @param currentFolder current directory shown in the dialog; or {@code null}
+	 * @param optionsSet options to set; see {@code FOS_*} constants
+	 * @param optionsClear options to clear; see {@code FOS_*} constants
+	 * @param callback approve callback; or {@code null}
+	 * @param fileTypeIndex the file type that appears as selected (zero-based)
+	 * @param fileTypes file types that the dialog can open or save.
+	 *        Two or more strings and {@code null} are required for each filter.
+	 *        First string is the display name of the filter shown in the combobox (e.g. "Text Files").
+	 *        Subsequent strings are the filter patterns (e.g. "*.txt" or "*").
+	 *        {@code null} is required to mark end of filter.
+	 * @return file path(s) that the user selected; an empty array if canceled;
+	 *         or {@code null} on failures (no dialog shown)
+	 *
+	 * @since 3.7
+	 */
+	public native static String[] showFileChooser( Window owner, boolean open,
+		String title, String okButtonLabel, String currentName, String currentFolder,
+		int optionsSet, int optionsClear, FileChooserCallback callback,
+		int fileTypeIndex, String... fileTypes );
+
+	/** @since 3.7 */
+	public interface FileChooserCallback {
+		boolean approve( String[] files, long hwndFileDialog );
+	}
+
+	/**
+	 * Shows a GTK message box
+	 * <a href="https://docs.gtk.org/gtk3/class.MessageDialog.html">GtkMessageDialog</a>.
+	 * <p>
+	 * For use in {@link FileChooserCallback} only.
+	 *
+	 * @param hwndParent the parent of the message box
+	 * @param messageType type of message being displayed:
+	 *        {@link JOptionPane#ERROR_MESSAGE}, {@link JOptionPane#INFORMATION_MESSAGE},
+	 *        {@link JOptionPane#WARNING_MESSAGE}, {@link JOptionPane#QUESTION_MESSAGE} or
+	 *        {@link JOptionPane#PLAIN_MESSAGE}
+	 * @param primaryText primary text; if the dialog has a secondary text,
+	 *        this will appear as title in a larger bold font
+	 * @param secondaryText secondary text; shown below of primary text; or {@code null}
+	 * @param defaultButton index of the default button, which can be pressed using ENTER key
+	 * @param buttons texts of the buttons; if no buttons given the a default "OK" button is shown.
+	 *        Use '_' for mnemonics (e.g. "_Choose")
+	 *        Use '__' for '_' character (e.g. "Choose__and__Quit").
+	 * @return index of pressed button; or -1 for ESC key
+	 *
+	 * @since 3.7
+	 */
+	public native static int showMessageDialog( long hwndParent, int messageType,
+		String primaryText, String secondaryText, int defaultButton, String... buttons );
 }

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

@@ -18,6 +18,7 @@ package com.formdev.flatlaf.ui;
 
 import java.awt.Rectangle;
 import java.awt.Window;
+import javax.swing.JOptionPane;
 import com.formdev.flatlaf.util.SystemInfo;
 
 /**
@@ -44,7 +45,7 @@ import com.formdev.flatlaf.util.SystemInfo;
  */
 public class FlatNativeMacLibrary
 {
-	private static int API_VERSION_MACOS = 2001;
+	private static int API_VERSION_MACOS = 2002;
 
 	/**
 	 * Checks whether native library is loaded/available.
@@ -68,4 +69,88 @@ public class FlatNativeMacLibrary
 	/** @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 );
+
+
+	/** @since 3.7 */
+	public static final int
+		// NSOpenPanel (extends NSSavePanel)
+		FC_canChooseFiles					= 1 << 0,  // default
+		FC_canChooseDirectories				= 1 << 1,
+		FC_resolvesAliases					= 1 << 2,  // default
+		FC_allowsMultipleSelection			= 1 << 3,
+		FC_accessoryViewDisclosed			= 1 << 4,
+		// NSSavePanel
+		FC_showsTagField					= 1 << 8,  // default for Save
+		FC_canCreateDirectories				= 1 << 9,  // default for Save
+		FC_canSelectHiddenExtension			= 1 << 10,
+		FC_showsHiddenFiles					= 1 << 11,
+		FC_extensionHidden					= 1 << 12,
+		FC_allowsOtherFileTypes				= 1 << 13,
+		FC_treatsFilePackagesAsDirectories	= 1 << 14,
+		// custom
+		FC_showSingleFilterField			= 1 << 24;
+
+	/**
+	 * Shows the macOS system file dialogs
+	 * <a href="https://developer.apple.com/documentation/appkit/nsopenpanel?language=objc">NSOpenPanel</a> or
+	 * <a href="https://developer.apple.com/documentation/appkit/nssavepanel?language=objc">NSSavePanel</a>.
+	 * <p>
+	 * <b>Note:</b> This method blocks the current thread until the user closes
+	 * the file dialog. It is highly recommended to invoke it from a new thread
+	 * to avoid blocking the AWT event dispatching thread.
+	 *
+	 * @param owner the owner of the file dialog; or {@code null}
+	 * @param dark appearance of the file dialog: {@code 1} = dark, {@code 0} = light, {@code -1} = default
+	 * @param open if {@code true}, shows the open dialog; if {@code false}, shows the save dialog
+	 * @param title text displayed at top of save dialog (not used in open dialog); or {@code null}
+	 * @param prompt text displayed in default button; or {@code null}
+	 * @param message text displayed at top of open/save dialogs; or {@code null}
+	 * @param filterFieldLabel text displayed in front of the filter combobox; or {@code null}
+	 * @param nameFieldLabel text displayed in front of the filename text field in save dialog (not used in open dialog); or {@code null}
+	 * @param nameFieldStringValue user-editable filename currently shown in the name field in save dialog (not used in open dialog); or {@code null}
+	 * @param directoryURL current directory shown in the dialog; or {@code null}
+	 * @param optionsSet options to set; see {@code FC_*} constants
+	 * @param optionsClear options to clear; see {@code FC_*} constants
+	 * @param fileTypeIndex the file type that appears as selected (zero-based)
+	 * @param fileTypes file types that the dialog can open or save.
+	 *        Two or more strings and {@code null} are required for each filter.
+	 *        First string is the display name of the filter shown in the combobox (e.g. "Text Files").
+	 *        Subsequent strings are the filter patterns (e.g. "txt" or "*").
+	 *        {@code null} is required to mark end of filter.
+	 * @return file path(s) that the user selected; an empty array if canceled;
+	 *         or {@code null} on failures (no dialog shown)
+	 *
+	 * @since 3.7
+	 */
+	public native static String[] showFileChooser( Window owner, int dark, boolean open,
+		String title, String prompt, String message, String filterFieldLabel,
+		String nameFieldLabel, String nameFieldStringValue, String directoryURL,
+		int optionsSet, int optionsClear, FileChooserCallback callback,
+		int fileTypeIndex, String... fileTypes );
+
+	/** @since 3.7 */
+	public interface FileChooserCallback {
+		boolean approve( String[] files, long hwndFileDialog );
+	}
+
+	/**
+	 * Shows a macOS alert
+	 * <a href="https://developer.apple.com/documentation/appkit/nsalert?language=objc">NSAlert</a>.
+	 * <p>
+	 * For use in {@link FileChooserCallback} only.
+	 *
+	 * @param hwndParent the parent of the message box
+	 * @param alertStyle type of alert being displayed:
+	 *        {@link JOptionPane#ERROR_MESSAGE}, {@link JOptionPane#INFORMATION_MESSAGE} or
+	 *        {@link JOptionPane#WARNING_MESSAGE}
+	 * @param messageText main message of the alert
+	 * @param informativeText additional information about the alert; shown below of main message; or {@code null}
+	 * @param defaultButton index of the default button, which can be pressed using ENTER key
+	 * @param buttons texts of the buttons; if no buttons given the a default "OK" button is shown
+	 * @return index of pressed button
+	 *
+	 * @since 3.7
+	 */
+	public native static int showMessageDialog( long hwndParent, int alertStyle,
+		String messageText, String informativeText, int defaultButton, String... buttons );
 }

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

@@ -18,6 +18,7 @@ package com.formdev.flatlaf.ui;
 
 import java.awt.Color;
 import java.awt.Window;
+import javax.swing.JOptionPane;
 import com.formdev.flatlaf.util.SystemInfo;
 
 /**
@@ -30,7 +31,7 @@ import com.formdev.flatlaf.util.SystemInfo;
  */
 public class FlatNativeWindowsLibrary
 {
-	private static int API_VERSION_WINDOWS = 1001;
+	private static int API_VERSION_WINDOWS = 1002;
 
 	private static long osBuildNumber = Long.MIN_VALUE;
 
@@ -158,4 +159,125 @@ public class FlatNativeWindowsLibrary
 		// DwmSetWindowAttribute() expects COLORREF as attribute value, which is defined as DWORD
 		return dwmSetWindowAttributeDWORD( hwnd, attribute, rgb );
 	}
+
+
+	/**
+	 * FILEOPENDIALOGOPTIONS
+	 * see https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/ne-shobjidl_core-_fileopendialogoptions
+	 *
+	 * @since 3.7
+	 */
+	public static final int
+		FOS_OVERWRITEPROMPT = 0x2,		// default for Save
+		FOS_STRICTFILETYPES = 0x4,
+		FOS_NOCHANGEDIR = 0x8,			// default
+		FOS_PICKFOLDERS = 0x20,
+		FOS_FORCEFILESYSTEM = 0x40,
+		FOS_ALLNONSTORAGEITEMS = 0x80,
+		FOS_NOVALIDATE = 0x100,
+		FOS_ALLOWMULTISELECT = 0x200,
+		FOS_PATHMUSTEXIST = 0x800,		// default
+		FOS_FILEMUSTEXIST = 0x1000,		// default for Open
+		FOS_CREATEPROMPT = 0x2000,
+		FOS_SHAREAWARE = 0x4000,
+		FOS_NOREADONLYRETURN = 0x8000,	// default for Save
+		FOS_NOTESTFILECREATE = 0x10000,
+		FOS_HIDEMRUPLACES = 0x20000,
+		FOS_HIDEPINNEDPLACES = 0x40000,
+		FOS_NODEREFERENCELINKS = 0x100000,
+		FOS_OKBUTTONNEEDSINTERACTION = 0x200000,
+		FOS_DONTADDTORECENT = 0x2000000,
+		FOS_FORCESHOWHIDDEN = 0x10000000,
+		FOS_DEFAULTNOMINIMODE = 0x20000000,
+		FOS_FORCEPREVIEWPANEON = 0x40000000,
+		FOS_SUPPORTSTREAMABLEITEMS = 0x80000000;
+
+	/**
+	 * Shows the Windows system
+	 * <a href="https://learn.microsoft.com/en-us/windows/win32/shell/common-file-dialog">file dialogs</a>
+	 * <a href="https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nn-shobjidl_core-ifileopendialog">IFileOpenDialog</a> or
+	 * <a href="https://learn.microsoft.com/en-us/windows/win32/api/shobjidl_core/nn-shobjidl_core-ifilesavedialog">IFileSaveDialog</a>.
+	 * <p>
+	 * <b>Note:</b> This method blocks the current thread until the user closes
+	 * the file dialog. It is highly recommended to invoke it from a new thread
+	 * to avoid blocking the AWT event dispatching thread.
+	 *
+	 * @param owner the owner of the file dialog; or {@code null}
+	 * @param open if {@code true}, shows the open dialog; if {@code false}, shows the save dialog
+	 * @param title text displayed in dialog title; or {@code null}
+	 * @param okButtonLabel text displayed in default button; or {@code null}.
+	 *        Use '&amp;' for mnemonics (e.g. "&amp;Choose").
+	 *        Use '&amp;&amp;' for '&amp;' character (e.g. "Choose &amp;&amp; Quit").
+	 * @param fileNameLabel text displayed in front of the filename text field; or {@code null}
+	 * @param fileName user-editable filename currently shown in the filename field; or {@code null}
+	 * @param folder current directory shown in the dialog; or {@code null}
+	 * @param saveAsItem file to be used as the initial entry in a Save As dialog; or {@code null}.
+	 *        File name is shown in filename text field, folder is selected in view.
+	 *        To be used for saving files that already exist. For new files use {@code fileName}.
+	 * @param defaultFolder folder used as a default if there is not a recently used folder value available; or {@code null}.
+	 *        Windows somewhere stores default folder on a per-app basis.
+	 *        So this is probably used only once when the app opens a file dialog for first time.
+	 * @param defaultExtension default extension to be added to file name in save dialog; or {@code null}
+	 * @param optionsSet options to set; see {@code FOS_*} constants
+	 * @param optionsClear options to clear; see {@code FOS_*} constants
+	 * @param callback approve callback; or {@code null}
+	 * @param fileTypeIndex the file type that appears as selected (zero-based)
+	 * @param fileTypes file types that the dialog can open or save.
+	 *        Pairs of strings are required for each filter.
+	 *        First string is the display name of the filter shown in the combobox (e.g. "Text Files").
+	 *        Second string is the filter pattern (e.g. "*.txt", "*.exe;*.dll" or "*.*").
+	 * @return file path(s) that the user selected; an empty array if canceled;
+	 *         or {@code null} on failures (no dialog shown)
+	 *
+	 * @since 3.7
+	 */
+	public native static String[] showFileChooser( Window owner, boolean open,
+		String title, String okButtonLabel, String fileNameLabel, String fileName,
+		String folder, String saveAsItem, String defaultFolder, String defaultExtension,
+		int optionsSet, int optionsClear, FileChooserCallback callback,
+		int fileTypeIndex, String... fileTypes );
+
+	/** @since 3.7 */
+	public interface FileChooserCallback {
+		boolean approve( String[] files, long hwndFileDialog );
+	}
+
+	/**
+	 * Shows a modal Windows message dialog.
+	 * <p>
+	 * For use in {@link FileChooserCallback} only.
+	 *
+	 * @param hwndParent the parent of the message box
+	 * @param messageType type of message being displayed:
+	 *        {@link JOptionPane#ERROR_MESSAGE}, {@link JOptionPane#INFORMATION_MESSAGE},
+	 *        {@link JOptionPane#WARNING_MESSAGE}, {@link JOptionPane#QUESTION_MESSAGE} or
+	 *        {@link JOptionPane#PLAIN_MESSAGE}
+	 * @param title dialog box title; or {@code null} to use title from parent window
+	 * @param text message to be displayed
+	 * @param defaultButton index of the default button, which can be pressed using ENTER key
+	 * @param buttons texts of the buttons.
+	 *        Use '&amp;' for mnemonics (e.g. "&amp;Choose").
+	 *        Use '&amp;&amp;' for '&amp;' character (e.g. "Choose &amp;&amp; Quit").
+	 * @return index of pressed button; or -1 for ESC key
+	 *
+	 * @since 3.7
+	 */
+	public native static int showMessageDialog( long hwndParent, int messageType,
+		String title, String text, int defaultButton, String... buttons );
+
+	/**
+	 * Shows a Windows message box
+	 * <a href="https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-messagebox">MessageBox</a>.
+	 * <p>
+	 * For use in {@link FileChooserCallback} only.
+	 *
+	 * @param hwndParent the parent of the message box
+	 * @param text message to be displayed
+	 * @param caption dialog box title
+	 * @param type see <a href="https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-messagebox#parameters">MessageBox parameter uType</a>
+	 * @return see <a href="https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-messagebox#return-value">MessageBox Return value</a>
+	 *
+	 * @since 3.7
+	 */
+	public native static int showMessageBox( long hwndParent, String text, String caption, int type );
 }