Fix: Unable to open Advanced Search Dialog more than once

[ptziegler]

When opening this dialog, the tab items are decorated with images created by the individual search panels. When the dialog is closed, those images are disposed again.

Problem arises because the search panels don't create new images, but instead use shared images. Meaning when the dialog is opened a second time, those images have already been disposed, preventing the dialog from showing up.

Reason for this regression is the switch from the Icons class of the bndtools project to the PDE Resources class. Former has an explicit "isDisposed()" check, which would've created a new image on-the-fly, while latter doesn't. Given that the images are not owned by this dialog, the solution to this problem is to simply not have them be disposed by the dialog.

See #1365

[ptziegler]

This is the original code that was used to create those images. The "isDisposed()" check is what prevents this problem from showing up with the bndtools.:

public static Image image(String name, String... decorators) {
	synchronized (images) {
		Key k = new Key(name, decorators);
		Image image = images.get(k);
		if (image != null && !image.isDisposed())
			return image;


		if (decorators.length == 0) {
			ImageDescriptor desc = desc(name, false);
			if (desc == null) {
				desc = desc(ICONS_MISSING_GIF);
			}
			Image baseImage = desc.createImage();
			images.put(k, baseImage);
			return baseImage;
		}


		Image baseImage = image(name);


		ImageDescriptor overlays[] = new ImageDescriptor[decorators.length];
		for (int i = 0; i < decorators.length; i++) {
			overlays[i] = desc(decorators[i], true);
		}
		DecorationOverlayIcon decoratedImage = new DecorationOverlayIcon(baseImage, overlays);
		Image result = decoratedImage.createImage();
		images.put(k, result);
		return result;
	}
}

[github-actions]

Test Results

   285 files  ±0     285 suites  ±0   48m 23s ⏱️ - 2m 22s
 3 580 tests ±0   3 502 ✅  - 2   76 💤 ±0  0 ❌ ±0  2 🔥 +2 
10 932 runs  ±0  10 699 ✅  - 2  231 💤 ±0  0 ❌ ±0  2 🔥 +2 

For more details on these errors, see this check.

Results for commit 1452454. ± Comparison against base commit 8f742cd.

♻️ This comment has been updated with latest results.

[HannesWell]

That's a good catch and nice investigation. 👍🏽

Thank you.

Test failure is unrelated.