Bug 429327

Description Paul Webster 2014-02-28 11:00:51 EST

backport to 4.2.2+

+++ This bug was initially created as a clone of Bug #409332 +++

Image/Icon information returned by EditorReference implementation is inconsistent with the IEditorPart implementation.

Please see the detailed explanation at the following link
http://www.eclipse.org/forums/index.php/t/487787/

It seems that the EditorReference implementation is returning the Image information for the editor using the "Icon" attribute in the org.eclipse.ui.editor extension of an editor.
But the Image that is displayed for the editor in the workbench area does not reply on this and instead relies on the getTitleImage() implementation of IEditorPart.

Anyone who relies on the EditorReference of the editor to get the image could potentially get a different image than the one displayed for the editor in the workbench area. One such consumer is the CTRL + F6 (or next editor dialog).

I verified this by looking at the code of the handler class "CycleEditorHandler" which is invoked on "CTRL + F6". 
The method that adds the items in the dialog is as follows.

I have highlighted the code that sets the image for the editor in the dialog.

protected void addItems(Table table, WorkbenchPage page) {
List<EditorReference> refs = page.getSortedEditorReferences();
for (EditorReference ref : refs) {
TableItem item = null;
item = new TableItem(table, SWT.NONE);
if (ref.isDirty()) {
item.setText("*" + ref.getTitle()); //$NON-NLS-1$
} else {
item.setText(ref.getTitle());
}
item.setImage(ref.getTitleImage());
item.setData(ref);
}
}