Allow to ignore explicitly defined disabled icons

The algorithm for generating disabled icons on-the-fly has recently been
enhanced. Most explicit disabled icons that have been embedded into
bundles conform to what now can be generated on-the-fly. In addition,
the algorithm is interchangeable, allowing custom stylings of disabled
icons. However, when there are still bundles, such as extensions out of
own control, that still explicitly define disabled icons, exchanging the
algorithm for disabled icons will lead to inconsistent appearance as
only the on-the-fly generated icons will adhere to that.

This change allows to ignore explicitly defined disabled icons, such
that even if some bundles defined disabled icons, they will be ignored
and on-the-fly generated disabled icons according to the selected
algorithm will be used instead. An according preference that can be
configured via the appearance tab is added.

Author: HeikoKlare

bundles/org.eclipse.e4.ui.workbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/AbstractContributionItem.java

@@ -38,6 +38,7 @@
 import org.eclipse.e4.ui.workbench.modeling.EModelService;
 import org.eclipse.e4.ui.workbench.swt.util.ISWTResourceUtilities;
 import org.eclipse.emf.common.util.URI;
+import org.eclipse.jface.action.ActionContributionItem;
 import org.eclipse.jface.action.ContributionItem;
 import org.eclipse.jface.action.IContributionManager;
 import org.eclipse.jface.action.IMenuCreator;
@@ -211,6 +212,9 @@ protected void updateIcons() {
 	}
 
 	private String getDisabledIconURI(MItem toolItem) {
+		if (ActionContributionItem.getIgnoreDisabledIcons()) {
+			return ""; //$NON-NLS-1$
+		}
 		Object obj = toolItem.getTransientData().get(IPresentationEngine.DISABLED_ICON_IMAGE_KEY);
 		return obj instanceof String s ? s : ""; //$NON-NLS-1$
 	}

bundles/org.eclipse.jface/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.jface;singleton:=true
-Bundle-Version: 3.39.100.qualifier
+Bundle-Version: 3.40.0.qualifier
 Bundle-Vendor: %providerName
 Bundle-Localization: plugin
 Export-Package: org.eclipse.jface,

bundles/org.eclipse.jface/src/org/eclipse/jface/action/ActionContributionItem.java

@@ -96,6 +96,33 @@ public static void setUseColorIconsInToolbars(boolean useColorIcons) {
 		USE_COLOR_ICONS = useColorIcons;
 	}
 
+	private static boolean IGNORE_DISABLED_ICONS = false;
+
+	/**
+	 * Returns whether explicitly defined disabled icons should be ignored, such
+	 * that all disabled icons are generated on-the-fly.
+	 *
+	 * @return <code>true</code> if disabled icons set to tool items should be
+	 *         ignored, <code>false</code> otherwise
+	 * @since 3.40
+	 */
+	public static boolean getIgnoreDisabledIcons() {
+		return IGNORE_DISABLED_ICONS;
+	}
+
+	/**
+	 * Sets whether explicitly defined disabled icons should be ignored, such that
+	 * all disabled icons are generated on-the-fly.
+	 *
+	 * @param ignoreDisabledIcons <code>true</code> if disabled icons set to tool
+	 *                            items should be ignored, <code>false</code>
+	 *                            otherwise
+	 * @since 3.40
+	 */
+	public static void setIgnoreDisabledIcons(boolean ignoreDisabledIcons) {
+		IGNORE_DISABLED_ICONS = ignoreDisabledIcons;
+	}
+
 	/**
 	 * The presentation mode.
 	 */
@@ -988,7 +1015,10 @@ private boolean updateImages(boolean forceImage) {
 		if (widget instanceof ToolItem) {
 			ImageDescriptor image = action.getImageDescriptor();
 			ImageDescriptor hoverImage = action.getHoverImageDescriptor();
-			ImageDescriptor disabledImage = action.getDisabledImageDescriptor();
+			ImageDescriptor disabledImage = null;
+			if (!getIgnoreDisabledIcons()) {
+				disabledImage = action.getDisabledImageDescriptor();
+			}
 			// Make sure there is a valid image in case images are forced.
 			if (image == null && forceImage) {
 				image = ImageDescriptor.getMissingImageDescriptor();

bundles/org.eclipse.ui.workbench/META-INF/MANIFEST.MF

@@ -2,7 +2,7 @@ Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.ui.workbench; singleton:=true
-Bundle-Version: 3.138.100.qualifier
+Bundle-Version: 3.139.0.qualifier
 Bundle-Activator: org.eclipse.ui.internal.WorkbenchPlugin
 Bundle-ActivationPolicy: lazy
 Bundle-Vendor: %providerName

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/IWorkbenchPreferenceConstants.java

@@ -721,4 +721,15 @@ public interface IWorkbenchPreferenceConstants {
 	 * @since 3.134
 	 */
 	String RESCALING_AT_RUNTIME = "monitorSpecificScaling"; //$NON-NLS-1$
+
+	/**
+	 * <p>
+	 * Whether explicitly defined disabled icons shall be ignored in favor of using
+	 * on-the-fly generated disabled icons.
+	 * </p>
+	 *
+	 * @since 3.139
+	 */
+	String IGNORE_DISABLED_ICONS = "ignoreDisabledIcons"; //$NON-NLS-1$
+
 }

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/WorkbenchMessages.java

@@ -480,6 +480,9 @@ public class WorkbenchMessages extends NLS {
 	public static String ViewsPreference_viewTabs_icons_and_titles_label;
 	public static String ViewsPreference_showFullTextForViewTabs;
 	public static String ViewsPreference_hideIconsForViewTabs;
+	public static String ViewsPreference_disabledIcons_description;
+	public static String ViewsPreference_ignoreDisabledIcons;
+	public static String ViewsPreference_ignoreDisabledIcons_tooltip;
 	public static String ToggleFullScreenMode_ActivationPopup_Description;
 	public static String ToggleFullScreenMode_ActivationPopup_Description_NoKeybinding;
 	public static String ToggleFullScreenMode_ActivationPopup_DoNotShowAgain;

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/dialogs/ViewsPreferencePage.java

@@ -114,6 +114,7 @@ public class ViewsPreferencePage extends PreferencePage implements IWorkbenchPre
 
 	private Button themingEnabled;
 	private Button rescaleAtRuntime;
+	private Button ignoreDisabledIcons;
 
 	private Button hideIconsForViewTabs;
 	private Button showFullTextForViewTabs;
@@ -139,6 +140,7 @@ protected Control createContents(Composite parent) {
 			layout.horizontalSpacing = 10;
 			comp.setLayout(layout);
 			createThemeIndependentComposits(comp);
+			createDisabledIconsButtons(comp);
 			createRescaleAtRuntimeCheckButton(comp);
 			return comp;
 		}
@@ -183,6 +185,7 @@ protected Control createContents(Composite parent) {
 		createHideIconsForViewTabs(comp);
 		createDependency(showFullTextForViewTabs, hideIconsForViewTabs);
 
+		createDisabledIconsButtons(comp);
 		createRescaleAtRuntimeCheckButton(comp);
 
 		if (currentTheme != null) {
@@ -234,6 +237,17 @@ private void createRescaleAtRuntimeCheckButton(Composite parent) {
 		}
 	}
 
+	private void createDisabledIconsButtons(Composite parent) {
+		createLabel(parent, ""); //$NON-NLS-1$
+		createLabel(parent, WorkbenchMessages.ViewsPreference_disabledIcons_description);
+
+		boolean initialStateIgnoreDisabledIcons = PrefUtil.getAPIPreferenceStore()
+				.getBoolean(IWorkbenchPreferenceConstants.IGNORE_DISABLED_ICONS);
+		ignoreDisabledIcons = createCheckButton(parent, WorkbenchMessages.ViewsPreference_ignoreDisabledIcons,
+				initialStateIgnoreDisabledIcons);
+		ignoreDisabledIcons.setToolTipText(WorkbenchMessages.ViewsPreference_ignoreDisabledIcons_tooltip);
+	}
+
 	private void createThemeIndependentComposits(Composite comp) {
 		createColoredLabelsPref(comp);
 		createEnableMruPref(comp);
@@ -357,6 +371,8 @@ public boolean performOk() {
 					.getSelection();
 			prefs.putBoolean(PartRenderingEngine.ENABLED_THEME_KEY, themingEnabled.getSelection());
 		}
+		PrefUtil.getAPIPreferenceStore().setValue(IWorkbenchPreferenceConstants.IGNORE_DISABLED_ICONS,
+				ignoreDisabledIcons.getSelection());
 
 		boolean isRescaleAtRuntimeChanged = false;
 		if (rescaleAtRuntime != null) {
@@ -459,6 +475,8 @@ protected void performDefaults() {
 		}
 		IPreferenceStore apiStore = PrefUtil.getAPIPreferenceStore();
 		useColoredLabels.setSelection(apiStore.getDefaultBoolean(IWorkbenchPreferenceConstants.USE_COLORED_LABELS));
+		ignoreDisabledIcons
+				.setSelection(apiStore.getDefaultBoolean(IWorkbenchPreferenceConstants.IGNORE_DISABLED_ICONS));
 
 		enableMru.setSelection(defaultPrefs.getBoolean(StackRenderer.MRU_KEY_DEFAULT, StackRenderer.MRU_DEFAULT));
 		super.performDefaults();

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/messages.properties

@@ -434,6 +434,9 @@ ViewsPreference_enableMRU = Show &most recently used tabs
 ViewsPreference_showFullTextForViewTabs = Always show full titles
 ViewsPreference_hideIconsForViewTabs = Hide icons
 ViewsPreference_viewTabs_icons_and_titles_label = Tab icons and titles in view areas:
+ViewsPreference_disabledIcons_description = Icons for disabled actions:
+ViewsPreference_ignoreDisabledIcons = Ignore pre-generated disabled icons
+ViewsPreference_ignoreDisabledIcons_tooltip = When enabled ignores pre-generated disabled icons in favor of generating consistently styled disabled icons on the fly
 ToggleFullScreenMode_ActivationPopup_Description=You have gone full screen. Use the Toggle Full Screen command ({0}) to deactivate.
 ToggleFullScreenMode_ActivationPopup_Description_NoKeybinding=You have gone full screen. Use the Toggle Full Screen command to deactivate.
 ToggleFullScreenMode_ActivationPopup_DoNotShowAgain=Do not show again

bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/menus/CommandContributionItem.java

@@ -28,6 +28,7 @@
 import org.eclipse.core.commands.common.NotDefinedException;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
+import org.eclipse.jface.action.ActionContributionItem;
 import org.eclipse.jface.action.ContributionItem;
 import org.eclipse.jface.action.IContributionManager;
 import org.eclipse.jface.action.IMenuListener2;
@@ -892,7 +893,9 @@ private void updateIcons() {
 			localResourceManager = m;
 		} else if (widget instanceof ToolItem item) {
 			LocalResourceManager m = new LocalResourceManager(JFaceResources.getResources());
-			item.setDisabledImage(disabledIcon == null ? null : m.create(disabledIcon));
+			if (!ActionContributionItem.getIgnoreDisabledIcons()) {
+				item.setDisabledImage(disabledIcon == null ? null : m.create(disabledIcon));
+			}
 			item.setHotImage(hoverIcon == null ? null : m.create(hoverIcon));
 			item.setImage(icon == null ? null : m.create(icon));
 			disposeOldImages();

bundles/org.eclipse.ui/src/org/eclipse/ui/internal/UIPlugin.java

@@ -14,8 +14,10 @@
 package org.eclipse.ui.internal;
 
 import org.eclipse.core.runtime.Assert;
+import org.eclipse.jface.action.ActionContributionItem;
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.resource.ImageRegistry;
+import org.eclipse.ui.IWorkbenchPreferenceConstants;
 import org.eclipse.ui.internal.util.PrefUtil;
 import org.eclipse.ui.plugin.AbstractUIPlugin;
 import org.osgi.framework.BundleContext;
@@ -98,5 +100,14 @@ public void savePreferences() {
 				UIPlugin.this.savePluginPreferences();
 			}
 		});
+		initializeIconConfigurations();
 	}
+
+	private void initializeIconConfigurations() {
+		// configure disabled icons appearance
+		boolean ignoreDisabledIcons = PrefUtil.getAPIPreferenceStore()
+				.getBoolean(IWorkbenchPreferenceConstants.IGNORE_DISABLED_ICONS);
+		ActionContributionItem.setIgnoreDisabledIcons(ignoreDisabledIcons);
+	}
+
 }