Add static method to the interface of ISharedImages to get the instance

laeubi · laeubi · commit 8029b4757fdc · 2025-01-20T06:09:34.000+01:00
Currently one needs to first obtain the PaltformUI Workbench and then
call getSharedImages on this instance. As this actually maps down to
WorkBenchPlugin that do not require a running workbench this limits the
usage of such code only wanting to share images.

This adds a new ISharedImages.get() that directly calls the code the
IWorkbench implementation would call and replace static calls to the
workbench with this one.
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/ISharedImages.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/ISharedImages.java
@@ -18,6 +18,7 @@
 import org.eclipse.swt.graphics.Device;
 import org.eclipse.swt.graphics.Image;
 import org.eclipse.swt.graphics.ImageData;
+import org.eclipse.ui.internal.WorkbenchPlugin;
 
 /**
  * A registry for common images used by the workbench which may be useful to
@@ -855,4 +856,12 @@ public interface ISharedImages {
 	 * @return the image descriptor, or <code>null</code> if not found
 	 */
 	ImageDescriptor getImageDescriptor(String symbolicName);
+
+	/**
+	 * @since 3.135
+	 * @return the default {@link ISharedImages} instance
+	 */
+	static ISharedImages get() {
+		return WorkbenchPlugin.getDefault().getSharedImages();
+	}
 }
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/actions/NewWizardAction.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/actions/NewWizardAction.java
@@ -99,11 +99,11 @@ public NewWizardAction(IWorkbenchWindow window) {
 		this.workbenchWindow = window;
 		tracker = new PerspectiveTracker(window, this);
 		// @issues should be IDE-specific images
-		ISharedImages images = PlatformUI.getWorkbench().getSharedImages();
+		ISharedImages images = window.getWorkbench().getSharedImages();
 		setImageDescriptor(images.getImageDescriptor(ISharedImages.IMG_TOOL_NEW_WIZARD));
 		setDisabledImageDescriptor(images.getImageDescriptor(ISharedImages.IMG_TOOL_NEW_WIZARD_DISABLED));
 		setToolTipText(WorkbenchMessages.NewWizardAction_toolTip);
-		PlatformUI.getWorkbench().getHelpSystem().setHelp(this, IWorkbenchHelpContextIds.NEW_ACTION);
+		window.getWorkbench().getHelpSystem().setHelp(this, IWorkbenchHelpContextIds.NEW_ACTION);
 	}
 
 	/**
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/WorkbenchPartReference.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/WorkbenchPartReference.java
@@ -329,7 +329,7 @@ protected final String getRawTitle() {
 	@Override
 	public final Image getTitleImage() {
 		if (isDisposed()) {
-			return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);
+			return ISharedImages.get().getImage(ISharedImages.IMG_DEF_VIEW);
 		}
 
 		WorkbenchWindow wbw = (WorkbenchWindow) PlatformUI.getWorkbench().getActiveWorkbenchWindow();
@@ -341,7 +341,7 @@ public final Image getTitleImage() {
 			}
 		}
 
-		return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);
+		return wbw.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);
 	}
 
 	/* package */ void fireVisibilityChange() {
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/about/ProductInfoPage.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/about/ProductInfoPage.java
@@ -93,7 +93,7 @@ protected final void addCopySupport(Table table) {
 		MenuItem copyItem = new MenuItem(menu, SWT.NONE);
 		copyItem.addSelectionListener(SelectionListener.widgetSelectedAdapter(e -> handler.copySelection(table)));
 		copyItem.setText(JFaceResources.getString("copy")); //$NON-NLS-1$
-		copyItem.setImage(PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_TOOL_COPY));
+		copyItem.setImage(ISharedImages.get().getImage(ISharedImages.IMG_TOOL_COPY));
 
 		table.setMenu(menu);
 
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/dialogs/WorkbenchWizardElement.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/internal/dialogs/WorkbenchWizardElement.java
@@ -24,6 +24,7 @@
 import org.eclipse.jface.viewers.IStructuredSelection;
 import org.eclipse.jface.viewers.StructuredSelection;
 import org.eclipse.ui.IPluginContribution;
+import org.eclipse.ui.ISharedImages;
 import org.eclipse.ui.IWorkbenchWizard;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.SelectionEnabler;
@@ -169,7 +170,7 @@ public ImageDescriptor getImageDescriptor() {
 			}
 			imageDescriptor = ResourceLocator
 					.imageDescriptorFromBundle(configurationElement.getNamespaceIdentifier(), iconName)
-					.orElse(PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(iconName));
+					.orElse(ISharedImages.get().getImageDescriptor(iconName));
 		}
 		return imageDescriptor;
 	}
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/operations/RedoActionHandler.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/operations/RedoActionHandler.java
@@ -21,7 +21,6 @@
 import org.eclipse.ui.ISharedImages;
 import org.eclipse.ui.IWorkbenchCommandConstants;
 import org.eclipse.ui.IWorkbenchPartSite;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.internal.WorkbenchMessages;
 
 /**
@@ -44,9 +43,9 @@ public final class RedoActionHandler extends OperationHistoryActionHandler {
 	 */
 	public RedoActionHandler(IWorkbenchPartSite site, IUndoContext context) {
 		super(site, context);
-		setImageDescriptor(PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_REDO));
+		setImageDescriptor(ISharedImages.get().getImageDescriptor(ISharedImages.IMG_TOOL_REDO));
 		setDisabledImageDescriptor(
-				PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_REDO_DISABLED));
+				ISharedImages.get().getImageDescriptor(ISharedImages.IMG_TOOL_REDO_DISABLED));
 		setActionDefinitionId(IWorkbenchCommandConstants.EDIT_REDO);
 	}
 
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/operations/UndoActionHandler.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/operations/UndoActionHandler.java
@@ -21,7 +21,6 @@
 import org.eclipse.ui.ISharedImages;
 import org.eclipse.ui.IWorkbenchCommandConstants;
 import org.eclipse.ui.IWorkbenchPartSite;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.internal.WorkbenchMessages;
 
 /**
@@ -44,9 +43,9 @@ public final class UndoActionHandler extends OperationHistoryActionHandler {
 	 */
 	public UndoActionHandler(IWorkbenchPartSite site, IUndoContext context) {
 		super(site, context);
-		setImageDescriptor(PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_UNDO));
+		setImageDescriptor(ISharedImages.get().getImageDescriptor(ISharedImages.IMG_TOOL_UNDO));
 		setDisabledImageDescriptor(
-				PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_TOOL_UNDO_DISABLED));
+				ISharedImages.get().getImageDescriptor(ISharedImages.IMG_TOOL_UNDO_DISABLED));
 		setActionDefinitionId(IWorkbenchCommandConstants.EDIT_UNDO);
 	}
 
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/part/DrillDownAdapter.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/part/DrillDownAdapter.java
@@ -24,7 +24,6 @@
 import org.eclipse.jface.viewers.StructuredSelection;
 import org.eclipse.jface.viewers.TreeViewer;
 import org.eclipse.ui.ISharedImages;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.internal.WorkbenchImages;
 import org.eclipse.ui.internal.WorkbenchMessages;
 
@@ -166,7 +165,7 @@ public void run() {
 		homeAction.setImageDescriptor(WorkbenchImages.getImageDescriptor(ISharedImages.IMG_ETOOL_HOME_NAV));
 
 		// Back.
-		ISharedImages images = PlatformUI.getWorkbench().getSharedImages();
+		ISharedImages images = ISharedImages.get();
 		backAction = new Action(WorkbenchMessages.GoBack_text) {
 			@Override
 			public void run() {
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/part/IntroPart.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/part/IntroPart.java
@@ -32,7 +32,6 @@
 import org.eclipse.ui.IPropertyListener;
 import org.eclipse.ui.ISharedImages;
 import org.eclipse.ui.PartInitException;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.internal.intro.IntroMessages;
 import org.eclipse.ui.internal.registry.IWorkbenchRegistryConstants;
 import org.eclipse.ui.intro.IIntroPart;
@@ -151,7 +150,7 @@ protected IConfigurationElement getConfigurationElement() {
 	 * @return the default image
 	 */
 	protected Image getDefaultImage() {
-		return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);
+		return ISharedImages.get().getImage(ISharedImages.IMG_DEF_VIEW);
 	}
 
 	@Override
diff --git a/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/part/WorkbenchPart.java b/bundles/org.eclipse.ui.workbench/eclipseui/org/eclipse/ui/part/WorkbenchPart.java
@@ -43,7 +43,6 @@
 import org.eclipse.ui.IWorkbenchPart3;
 import org.eclipse.ui.IWorkbenchPartConstants;
 import org.eclipse.ui.IWorkbenchPartSite;
-import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.internal.PartSite;
 import org.eclipse.ui.internal.WorkbenchMessages;
 import org.eclipse.ui.internal.WorkbenchPlugin;
@@ -168,7 +167,7 @@ protected IConfigurationElement getConfigurationElement() {
 	 * @return the default image
 	 */
 	protected Image getDefaultImage() {
-		return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);
+		return ISharedImages.get().getImage(ISharedImages.IMG_DEF_VIEW);
 	}
 
 	@Override
@@ -233,7 +232,7 @@ public void setInitializationData(IConfigurationElement cfig, String propertyNam
 		}
 		imageDescriptor = ResourceLocator.imageDescriptorFromBundle(configElement.getContributor().getName(), strIcon);
 		if (!imageDescriptor.isPresent()) {
-			ImageDescriptor shared = PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(strIcon);
+			ImageDescriptor shared = ISharedImages.get().getImageDescriptor(strIcon);
 			imageDescriptor = Optional.ofNullable(shared);
 		}
 		imageDescriptor.ifPresent(d -> titleImage = JFaceResources.getResources().createImageWithDefault(d));

Original file line number	Diff line number	Diff line change
`@@ -329,7 +329,7 @@ protected final String getRawTitle() {`
`329`	`329`	`@Override`
`330`	`330`	`public final Image getTitleImage() {`
`331`	`331`	`if (isDisposed()) {`
`332`		`- return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);`
	`332`	`+ return ISharedImages.get().getImage(ISharedImages.IMG_DEF_VIEW);`
`333`	`333`	`}`
`334`	`334`
`335`	`335`	`WorkbenchWindow wbw = (WorkbenchWindow) PlatformUI.getWorkbench().getActiveWorkbenchWindow();`
`@@ -341,7 +341,7 @@ public final Image getTitleImage() {`
`341`	`341`	`}`
`342`	`342`	`}`
`343`	`343`
`344`		`- return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);`
	`344`	`+ return wbw.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW);`
`345`	`345`	`}`
`346`	`346`
`347`	`347`	`/* package */ void fireVisibilityChange() {`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`import org.eclipse.jface.viewers.IStructuredSelection;`
`25`	`25`	`import org.eclipse.jface.viewers.StructuredSelection;`
`26`	`26`	`import org.eclipse.ui.IPluginContribution;`
	`27`	`+import org.eclipse.ui.ISharedImages;`
`27`	`28`	`import org.eclipse.ui.IWorkbenchWizard;`
`28`	`29`	`import org.eclipse.ui.PlatformUI;`
`29`	`30`	`import org.eclipse.ui.SelectionEnabler;`
`@@ -169,7 +170,7 @@ public ImageDescriptor getImageDescriptor() {`
`169`	`170`	`}`
`170`	`171`	`imageDescriptor = ResourceLocator`
`171`	`172`	`.imageDescriptorFromBundle(configurationElement.getNamespaceIdentifier(), iconName)`
`172`		`- .orElse(PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(iconName));`
	`173`	`+ .orElse(ISharedImages.get().getImageDescriptor(iconName));`
`173`	`174`	`}`
`174`	`175`	`return imageDescriptor;`
`175`	`176`	`}`