Add warning in preferences dialog

Add a warning about flickering effects caused by the Edge browser under Preferences > General > Appearance.
eclipse-platform · Nov 15, 2024 · 493314d · 493314d
1 parent 69f6e45
commit 493314d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 3 deletions.
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/WorkbenchMessages.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/WorkbenchMessages.java
@@ -76,6 +76,8 @@ public class WorkbenchMessages extends NLS {
 
 	public static String StatusUtil_errorOccurred;
 
+	public static String EdgeBrowserDisclaimer;
+
 	// ==============================================================================
 	// Workbench Actions
 	// ==============================================================================

diff --git a/...g.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/dialogs/ViewsPreferencePage.java b/...g.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/dialogs/ViewsPreferencePage.java
@@ -20,11 +20,16 @@
 package org.eclipse.ui.internal.dialogs;
 
 import static org.eclipse.jface.viewers.LabelProvider.createTextProvider;
+import static org.eclipse.swt.events.SelectionListener.widgetSelectedAdapter;
 import static org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants.ATT_COLOR_AND_FONT_ID;
 import static org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants.ATT_OS_VERSION;
 import static org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants.ATT_THEME_ASSOCIATION;
 import static org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants.ATT_THEME_ID;
 
+import java.awt.Desktop;
+import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.text.Collator;
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -77,6 +82,7 @@
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Group;
 import org.eclipse.swt.widgets.Label;
+import org.eclipse.swt.widgets.Link;
 import org.eclipse.ui.IWorkbench;
 import org.eclipse.ui.IWorkbenchPreferenceConstants;
 import org.eclipse.ui.IWorkbenchPreferencePage;
@@ -213,16 +219,27 @@ private void createHiDPISettingsGroup(Composite parent) {
 		group.setFont(parent.getFont());
 		GridLayout layout = new GridLayout(1, false);
 		group.setLayout(layout);
-		Label infoLabel = new Label(group, SWT.WRAP);
-		infoLabel.setText(WorkbenchMessages.RescaleAtRuntimeDisclaimer);
+		Link infoLabel = new Link(group, SWT.WRAP);
+		infoLabel.setText(WorkbenchMessages.RescaleAtRuntimeDisclaimer + System.lineSeparator() + System.lineSeparator()
+				+ WorkbenchMessages.EdgeBrowserDisclaimer);
 		infoLabel.setLayoutData(GridDataFactory.defaultsFor(infoLabel).create());
+		infoLabel.addSelectionListener(widgetSelectedAdapter(c -> openURL(c.text)));
+
 		createLabel(group, ""); //$NON-NLS-1$
 
 		boolean initialStateRescaleAtRuntime = PrefUtil.getAPIPreferenceStore()
 				.getBoolean(IWorkbenchPreferenceConstants.RESCALING_AT_RUNTIME);
 		rescaleAtRuntime = createCheckButton(group, WorkbenchMessages.RescaleAtRuntimeEnabled, initialStateRescaleAtRuntime);
 	}
 
+	private void openURL(String url) {
+		try {
+			Desktop.getDesktop().browse(new URI(url));
+		} catch (IOException | URISyntaxException e) {
+			WorkbenchPlugin.log(e);
+		}
+	}
+
 	private void createThemeIndependentComposits(Composite comp) {
 		createUseRoundTabs(comp);
 		createColoredLabelsPref(comp);

diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/messages.properties b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/messages.properties
@@ -504,7 +504,8 @@ RescaleAtRuntimeSettingChangeWarningTitle = DPI Setting Changed
 RescaleAtRuntimeSettingChangeWarningText = Restart for the DPI setting changes to take effect
 HiDpiSettingsGroupTitle = HiDPI settings
 RescaleAtRuntimeEnabled = Monitor-specific UI &scaling
-RescaleAtRuntimeDisclaimer = EXPERIMENTAL! Activating this option will dynamically scale all windows according to the monitor they are currently in. It will also set the default browser to Edge in order to provide the appropriate scaling of content displayed in a browser. This feature is still in development and therefore considered experimental.
+RescaleAtRuntimeDisclaimer = EXPERIMENTAL! Dynamically scale all windows according to the monitor they are currently in. 
+EdgeBrowserDisclaimer = WARNING! This will also set the default browser to Edge, which is known to cause flickering in some cases and may cause seizures (see <a href="https://github.com/eclipse-platform/eclipse.platform.swt/issues/1122">this issue</a> for details).
 # --- Workbench -----
 WorkbenchPreference_openMode=Open mode
 WorkbenchPreference_doubleClick=D&ouble click