8301302: Platform preferences API

modules/javafx.graphics/.classpath

@@ -30,7 +30,7 @@
 	<classpathentry combineaccessrules="false" kind="src" path="/base">
 		<attributes>
 			<attribute name="module" value="true"/>
-			<attribute name="add-exports" value="javafx.base/com.sun.javafx.property=javafx.graphics:javafx.base/test.util.memory=javafx.graphics"/>
+			<attribute name="add-exports" value="javafx.base/com.sun.javafx.property=javafx.graphics:javafx.base/test.javafx.collections=javafx.graphics:javafx.base/test.util.memory=javafx.graphics"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5">

modules/javafx.graphics/src/main/java/com/sun/glass/ui/Application.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010, 2022, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2010, 2023, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -84,8 +84,7 @@ public void handleOpenFilesAction(Application app, long time, String files[]) {
         // currently used only on Mac OS X
         public void handleQuitAction(Application app, long time) {
         }
-        public boolean handleThemeChanged(String themeName) {
-            return false;
+        public void handlePreferencesChanged(Map<String, Object> preferences) {
         }
     }
 
@@ -259,12 +258,11 @@ protected void notifyWillResignActive() {
         }
     }
 
-    protected boolean notifyThemeChanged(String themeName) {
+    protected void notifyPreferencesChanged(Map<String, Object> preferences) {
         EventHandler handler = getEventHandler();
         if (handler != null) {
-            return handler.handleThemeChanged(themeName);
+            handler.handlePreferencesChanged(preferences);
         }
-        return false;
     }
 
     protected void notifyDidResignActive() {
@@ -675,19 +673,6 @@ protected abstract FileChooserResult staticCommonDialogs_showFileChooser(Window
     protected abstract int staticView_getMultiClickMaxX();
     protected abstract int staticView_getMultiClickMaxY();
 
-    public String getHighContrastScheme(String themeName) {
-        return themeName;
-    }
-
-    /**
-     * Gets the Name of the currently active high contrast theme.
-     * If null, then high contrast is not enabled.
-     */
-    public String getHighContrastTheme() {
-        checkEventThread();
-        return null;
-    }
-
     protected boolean _supportsInputMethods() {
         // Overridden in subclasses
         return false;
@@ -768,4 +753,51 @@ public final Optional<Boolean> isKeyLocked(int keyCode) {
                 return Optional.empty();
         }
     }
+
+    /**
+     * Returns the current set of platform properties as a map of platform-specific keys to
+     * arbitrary values. This is a snapshot, and won't be updated. There are no guarantees on
+     * the implementation type, modifiability or serializability of the returned {@code Map}.
+     *
+     * @return the current set of platform preferences
+     */
+    public Map<String, Object> getPlatformPreferences() {
+        return Map.of();
+    }
+
+    /**
+     * Returns a map of platform-specific keys to platform-independent keys defined by JavaFX.
+     * <p>
+     * For example, the platform-specific key "Windows.UIColor.Foreground" is mapped to the key "foregroundColor",
+     * which makes it easier to write shared code without depending on platform-specific details.
+     * <p>
+     * The following platform-independent keys are currently supported, which correspond to the names of color
+     * properties on the {@link com.sun.javafx.application.preferences.PreferenceProperties} class:
+     * <ul>
+     *     <li>foregroundColor
+     *     <li>backgroundColor
+     *     <li>accentColor
+     * </ul>
+     *
+     * @return a map of platform-specific keys to well-known keys
+     */
+    public Map<String, String> getPlatformKeyMappings() {
+        return Map.of();
+    }
+
+    /**
+     * Returns a mapping of platform-specific keys to the types of their values.
+     * Polymorphic types are supported by specifying the common base type; for example, a key can
+     * be mapped to {@code Paint.class} to support any type of paint.
+     * <p>
+     * Implementors must keep this map in sync with the mappings reported by the native Glass toolkit.
+     * If a native toolkit reports mappings for keys that are not contained in this map, the typed getters
+     * in {@link javafx.application.Platform.Preferences} might not throw {@code IllegalArgumentException}
+     * as specified.
+     *
+     * @return a map of platform-specific keys to types
+     */
+    public Map<String, Class<?>> getPlatformKeys() {
+        return Map.of();
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/gtk/GtkApplication.java

@@ -40,6 +40,7 @@
 import com.sun.glass.utils.NativeLibLoader;
 import com.sun.prism.impl.PrismSettings;
 import com.sun.javafx.logging.PlatformLogger;
+import javafx.scene.paint.Color;
 
 import java.io.File;
 import java.nio.ByteBuffer;
@@ -467,4 +468,40 @@ protected boolean _supportsInputMethods() {
     @Override
     protected native int _isKeyLocked(int keyCode);
 
+    @Override
+    public native Map<String, Object> getPlatformPreferences();
+
+    @Override
+    public Map<String, String> getPlatformKeyMappings() {
+        return Map.of(
+            "GTK.theme_fg_color", "foregroundColor",
+            "GTK.theme_bg_color", "backgroundColor"
+        );
+    }
+
+    // This list needs to be kept in sync with PlatformSupport.cpp in the Glass toolkit for GTK.
+    @Override
+    public Map<String, Class<?>> getPlatformKeys() {
+        return Map.ofEntries(
+            Map.entry("GTK.theme_name", String.class),
+            Map.entry("GTK.theme_fg_color", Color.class),
+            Map.entry("GTK.theme_bg_color", Color.class),
+            Map.entry("GTK.theme_base_color", Color.class),
+            Map.entry("GTK.theme_selected_bg_color", Color.class),
+            Map.entry("GTK.theme_selected_fg_color", Color.class),
+            Map.entry("GTK.theme_unfocused_fg_color", Color.class),
+            Map.entry("GTK.theme_unfocused_bg_color", Color.class),
+            Map.entry("GTK.theme_unfocused_base_color", Color.class),
+            Map.entry("GTK.theme_unfocused_selected_bg_color", Color.class),
+            Map.entry("GTK.theme_unfocused_selected_fg_color", Color.class),
+            Map.entry("GTK.insensitive_bg_color", Color.class),
+            Map.entry("GTK.insensitive_fg_color", Color.class),
+            Map.entry("GTK.insensitive_base_color", Color.class),
+            Map.entry("GTK.borders", Color.class),
+            Map.entry("GTK.unfocused_borders", Color.class),
+            Map.entry("GTK.warning_color", Color.class),
+            Map.entry("GTK.error_color", Color.class),
+            Map.entry("GTK.success_color", Color.class)
+        );
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/mac/MacApplication.java

@@ -29,13 +29,15 @@
 import com.sun.glass.ui.CommonDialogs.ExtensionFilter;
 import com.sun.glass.ui.CommonDialogs.FileChooserResult;
 import com.sun.javafx.util.Logging;
+import javafx.scene.paint.Color;
 
 import java.io.File;
 import java.nio.ByteBuffer;
 import java.nio.IntBuffer;
 
 import java.security.AccessController;
 import java.security.PrivilegedAction;
+import java.util.Map;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
 
@@ -388,4 +390,69 @@ public String getDataDirectory() {
 
     @Override
     protected native int _isKeyLocked(int keyCode);
+
+    @Override
+    public native Map<String, Object> getPlatformPreferences();
+
+    @Override
+    public Map<String, String> getPlatformKeyMappings() {
+        return Map.of(
+            "macOS.NSColor.textColor", "foregroundColor",
+            "macOS.NSColor.textBackgroundColor", "backgroundColor",
+            "macOS.NSColor.controlAccentColor", "accentColor"
+        );
+    }
+
+    // This list needs to be kept in sync with PlatformSupport.m in the Glass toolkit for macOS.
+    @Override
+    public Map<String, Class<?>> getPlatformKeys() {
+        return Map.ofEntries(
+            Map.entry("macOS.NSColor.labelColor", Color.class),
+            Map.entry("macOS.NSColor.secondaryLabelColor", Color.class),
+            Map.entry("macOS.NSColor.tertiaryLabelColor", Color.class),
+            Map.entry("macOS.NSColor.quaternaryLabelColor", Color.class),
+            Map.entry("macOS.NSColor.textColor", Color.class),
+            Map.entry("macOS.NSColor.placeholderTextColor", Color.class),
+            Map.entry("macOS.NSColor.selectedTextColor", Color.class),
+            Map.entry("macOS.NSColor.textBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.selectedTextBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.keyboardFocusIndicatorColor", Color.class),
+            Map.entry("macOS.NSColor.unemphasizedSelectedTextColor", Color.class),
+            Map.entry("macOS.NSColor.unemphasizedSelectedTextBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.linkColor", Color.class),
+            Map.entry("macOS.NSColor.separatorColor", Color.class),
+            Map.entry("macOS.NSColor.selectedContentBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.unemphasizedSelectedContentBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.selectedMenuItemTextColor", Color.class),
+            Map.entry("macOS.NSColor.gridColor", Color.class),
+            Map.entry("macOS.NSColor.headerTextColor", Color.class),
+            Map.entry("macOS.NSColor.alternatingContentBackgroundColors", Color[].class),
+            Map.entry("macOS.NSColor.controlAccentColor", Color.class),
+            Map.entry("macOS.NSColor.controlColor", Color.class),
+            Map.entry("macOS.NSColor.controlBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.controlTextColor", Color.class),
+            Map.entry("macOS.NSColor.disabledControlTextColor", Color.class),
+            Map.entry("macOS.NSColor.selectedControlColor", Color.class),
+            Map.entry("macOS.NSColor.selectedControlTextColor", Color.class),
+            Map.entry("macOS.NSColor.alternateSelectedControlTextColor", Color.class),
+            Map.entry("macOS.NSColor.currentControlTint", String.class),
+            Map.entry("macOS.NSColor.windowBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.windowFrameTextColor", Color.class),
+            Map.entry("macOS.NSColor.underPageBackgroundColor", Color.class),
+            Map.entry("macOS.NSColor.findHighlightColor", Color.class),
+            Map.entry("macOS.NSColor.highlightColor", Color.class),
+            Map.entry("macOS.NSColor.shadowColor", Color.class),
+            Map.entry("macOS.NSColor.systemBlueColor", Color.class),
+            Map.entry("macOS.NSColor.systemBrownColor", Color.class),
+            Map.entry("macOS.NSColor.systemGrayColor", Color.class),
+            Map.entry("macOS.NSColor.systemGreenColor", Color.class),
+            Map.entry("macOS.NSColor.systemIndigoColor", Color.class),
+            Map.entry("macOS.NSColor.systemOrangeColor", Color.class),
+            Map.entry("macOS.NSColor.systemPinkColor", Color.class),
+            Map.entry("macOS.NSColor.systemPurpleColor", Color.class),
+            Map.entry("macOS.NSColor.systemRedColor", Color.class),
+            Map.entry("macOS.NSColor.systemTealColor", Color.class),
+            Map.entry("macOS.NSColor.systemYellowColor", Color.class)
+        );
+    }
 }

modules/javafx.graphics/src/main/java/com/sun/glass/ui/win/WinApplication.java

@@ -27,21 +27,20 @@
 import com.sun.glass.ui.*;
 import com.sun.glass.ui.CommonDialogs.ExtensionFilter;
 import com.sun.glass.ui.CommonDialogs.FileChooserResult;
-import com.sun.javafx.application.PlatformImpl;
 import com.sun.prism.impl.PrismSettings;
 import com.sun.javafx.tk.Toolkit;
+import javafx.scene.paint.Color;
 
 import java.io.File;
 import java.nio.ByteBuffer;
 import java.nio.IntBuffer;
 import java.security.AccessController;
 import java.security.PrivilegedAction;
-import java.util.ResourceBundle;
+import java.util.Map;
 
 final class WinApplication extends Application implements InvokeLaterDispatcher.InvokeLaterSubmitter {
 
     static float overrideUIScale;
-    private static final String BASE_NAME = "com/sun/glass/ui/win/themes";
 
     private static boolean getBoolean(String propname, boolean defval, String description) {
         String str = System.getProperty(propname);
@@ -341,17 +340,6 @@ public Pixels createPixels(int width, int height, IntBuffer data, float scalex,
         }
     }
 
-    @Override
-    public String getHighContrastScheme(String themeName) {
-        return PlatformImpl.HighContrastScheme.fromThemeName(ResourceBundle.getBundle(BASE_NAME)::getString, themeName);
-    }
-
-    private native String _getHighContrastTheme();
-    @Override public String getHighContrastTheme() {
-        checkEventThread();
-        return getHighContrastScheme(_getHighContrastTheme());
-    }
-
     @Override
     protected boolean _supportsInputMethods() {
         return true;
@@ -380,4 +368,42 @@ public String getDataDirectory() {
 
     @Override
     protected native int _isKeyLocked(int keyCode);
+
+    @Override
+    public native Map<String, Object> getPlatformPreferences();
+
+    @Override
+    public Map<String, String> getPlatformKeyMappings() {
+        return Map.of(
+            "Windows.UIColor.ForegroundColor", "foregroundColor",
+            "Windows.UIColor.BackgroundColor", "backgroundColor",
+            "Windows.UIColor.AccentColor", "accentColor"
+        );
+    }
+
+    // This list needs to be kept in sync with PlatformSupport.cpp in the Glass toolkit for Windows.
+    @Override
+    public Map<String, Class<?>> getPlatformKeys() {
+        return Map.ofEntries(
+            Map.entry("Windows.SPI.HighContrast", Boolean.class),
+            Map.entry("Windows.SPI.HighContrastColorScheme", String.class),
+            Map.entry("Windows.SysColor.COLOR_3DFACE", Color.class),
+            Map.entry("Windows.SysColor.COLOR_BTNTEXT", Color.class),
+            Map.entry("Windows.SysColor.COLOR_GRAYTEXT", Color.class),
+            Map.entry("Windows.SysColor.COLOR_HIGHLIGHT", Color.class),
+            Map.entry("Windows.SysColor.COLOR_HIGHLIGHTTEXT", Color.class),
+            Map.entry("Windows.SysColor.COLOR_HOTLIGHT", Color.class),
+            Map.entry("Windows.SysColor.COLOR_WINDOW", Color.class),
+            Map.entry("Windows.SysColor.COLOR_WINDOWTEXT", Color.class),
+            Map.entry("Windows.UIColor.Background", Color.class),
+            Map.entry("Windows.UIColor.Foreground", Color.class),
+            Map.entry("Windows.UIColor.AccentDark3", Color.class),
+            Map.entry("Windows.UIColor.AccentDark2", Color.class),
+            Map.entry("Windows.UIColor.AccentDark1", Color.class),
+            Map.entry("Windows.UIColor.Accent", Color.class),
+            Map.entry("Windows.UIColor.AccentLight1", Color.class),
+            Map.entry("Windows.UIColor.AccentLight2", Color.class),
+            Map.entry("Windows.UIColor.AccentLight3", Color.class)
+        );
+    }
 }