Skip to content

Make unsaved changes indicator the default on tabs #4070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vogella merged 1 commit into from
Jun 8, 2026
Merged

Make unsaved changes indicator the default on tabs #4070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ....workbench.renderers.swt/src/org/eclipse/e4/ui/workbench/renderers/swt/CTabRendering.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,16 @@ public class CTabRendering extends CTabFolderRenderer implements ICTabRendering,
* A named preference for setting CTabFolder's to be rendered with dirty
* indicator overlay on close button
* <p>
* The default value for this preference is: <code>false</code> (do not show
* dirty indicator)
* The default value for this preference is: <code>true</code> (show dirty
* indicator)
* </p>
*/
public static final String SHOW_DIRTY_INDICATOR_ON_TABS = "SHOW_DIRTY_INDICATOR_ON_TABS"; //$NON-NLS-1$

/**
* Default value for "dirty indicator" preference for tabs
*/
public static final boolean SHOW_DIRTY_INDICATOR_ON_TABS_DEFAULT = false;
public static final boolean SHOW_DIRTY_INDICATOR_ON_TABS_DEFAULT = true;

private static int MIN_VIEW_CHARS = 1;
private static int MAX_VIEW_CHARS = Integer.MAX_VALUE;
Expand Down
70 changes: 42 additions & 28 deletions tests/org.eclipse.e4.ui.tests/src/org/eclipse/e4/ui/tests/workbench/MPartTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import static org.junit.jupiter.api.Assertions.assertNull;

import jakarta.inject.Inject;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.e4.core.contexts.IEclipseContext;
import org.eclipse.e4.ui.model.application.MApplication;
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
Expand All @@ -30,6 +32,7 @@
import org.eclipse.e4.ui.tests.rules.WorkbenchContextExtension;
import org.eclipse.e4.ui.workbench.IPresentationEngine;
import org.eclipse.e4.ui.workbench.modeling.EModelService;
import org.eclipse.e4.ui.workbench.renderers.swt.CTabRendering;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -191,34 +194,45 @@ public void testMPart_getContext() {

@Test
public void testMPartBug369866() {
final MWindow window = createWindowWithOneView("Part");

application.getChildren().add(window);
contextRule.createAndRunWorkbench(window);

MPartSashContainer container = (MPartSashContainer) window.getChildren().get(0);
MPartStack stack = (MPartStack) container.getChildren().get(0);
MPart part = (MPart) stack.getChildren().get(0);

CTabFolder folder = (CTabFolder) stack.getWidget();
CTabItem item = folder.getItem(0);

// bug 369866 has a StringIOOBE from toggling the dirty flag with an
// empty part name
assertFalse(part.isDirty());
assertEquals("Part", item.getText());

part.setDirty(true);
assertEquals("*Part", item.getText());

part.setLabel("");
assertEquals("*", item.getText());

part.setDirty(false);
assertEquals("", item.getText());

part.setDirty(true);
assertEquals("*", item.getText());
// This test verifies the textual '*' dirty prefix, which is only used
// when the graphical dirty indicator is disabled.
IEclipsePreferences prefs = InstanceScope.INSTANCE
.getNode(CTabRendering.PREF_QUALIFIER_ECLIPSE_E4_UI_WORKBENCH_RENDERERS_SWT);
boolean previous = prefs.getBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS,
CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS_DEFAULT);
prefs.putBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS, false);
try {
final MWindow window = createWindowWithOneView("Part");

application.getChildren().add(window);
contextRule.createAndRunWorkbench(window);

MPartSashContainer container = (MPartSashContainer) window.getChildren().get(0);
MPartStack stack = (MPartStack) container.getChildren().get(0);
MPart part = (MPart) stack.getChildren().get(0);

CTabFolder folder = (CTabFolder) stack.getWidget();
CTabItem item = folder.getItem(0);

// bug 369866 has a StringIOOBE from toggling the dirty flag with an
// empty part name
assertFalse(part.isDirty());
assertEquals("Part", item.getText());

part.setDirty(true);
assertEquals("*Part", item.getText());

part.setLabel("");
assertEquals("*", item.getText());

part.setDirty(false);
assertEquals("", item.getText());

part.setDirty(true);
assertEquals("*", item.getText());
} finally {
prefs.putBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS, previous);
}
}

private MWindow createWindowWithOneView(String partName) {
Expand Down
56 changes: 35 additions & 21 deletions tests/org.eclipse.e4.ui.tests/src/org/eclipse/e4/ui/tests/workbench/MSaveablePartTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,16 @@
import static org.junit.jupiter.api.Assertions.assertFalse;

import jakarta.inject.Inject;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.e4.ui.model.application.MApplication;
import org.eclipse.e4.ui.model.application.ui.basic.MPart;
import org.eclipse.e4.ui.model.application.ui.basic.MPartSashContainer;
import org.eclipse.e4.ui.model.application.ui.basic.MPartStack;
import org.eclipse.e4.ui.model.application.ui.basic.MWindow;
import org.eclipse.e4.ui.tests.rules.WorkbenchContextExtension;
import org.eclipse.e4.ui.workbench.modeling.EModelService;
import org.eclipse.e4.ui.workbench.renderers.swt.CTabRendering;
import org.eclipse.swt.custom.CTabFolder;
import org.eclipse.swt.custom.CTabItem;
import org.junit.jupiter.api.Test;
Expand All @@ -44,27 +47,38 @@ public class MSaveablePartTest {

@Test
public void testCreateView() {
final MWindow window = createWindowWithOneView("Part Name");

application.getChildren().add(window);
contextRule.createAndRunWorkbench(window);

MPartSashContainer container = (MPartSashContainer) window
.getChildren().get(0);
MPartStack stack = (MPartStack) container.getChildren().get(0);
MPart part = (MPart) stack.getChildren().get(0);

CTabFolder folder = (CTabFolder) stack.getWidget();
CTabItem item = folder.getItem(0);
assertEquals("Part Name", item.getText());

assertFalse(part.isDirty());

part.setDirty(true);
assertEquals("*Part Name", item.getText());

part.setDirty(false);
assertEquals("Part Name", item.getText());
// This test verifies the textual '*' dirty prefix, which is only used
// when the graphical dirty indicator is disabled.
IEclipsePreferences prefs = InstanceScope.INSTANCE
.getNode(CTabRendering.PREF_QUALIFIER_ECLIPSE_E4_UI_WORKBENCH_RENDERERS_SWT);
boolean previous = prefs.getBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS,
CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS_DEFAULT);
prefs.putBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS, false);
try {
final MWindow window = createWindowWithOneView("Part Name");

application.getChildren().add(window);
contextRule.createAndRunWorkbench(window);

MPartSashContainer container = (MPartSashContainer) window
.getChildren().get(0);
MPartStack stack = (MPartStack) container.getChildren().get(0);
MPart part = (MPart) stack.getChildren().get(0);

CTabFolder folder = (CTabFolder) stack.getWidget();
CTabItem item = folder.getItem(0);
assertEquals("Part Name", item.getText());

assertFalse(part.isDirty());

part.setDirty(true);
assertEquals("*Part Name", item.getText());

part.setDirty(false);
assertEquals("Part Name", item.getText());
} finally {
prefs.putBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS, previous);
}
}

private MWindow createWindowWithOneView(String partName) {
Expand Down
12 changes: 12 additions & 0 deletions ...g.eclipse.ui.tests/Eclipse UI Tests/org/eclipse/ui/tests/multieditor/MultiEditorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@
import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.ILogListener;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.preferences.IEclipsePreferences;
import org.eclipse.core.runtime.preferences.InstanceScope;
import org.eclipse.e4.ui.workbench.renderers.swt.CTabRendering;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.jface.action.ToolBarContributionItem;
import org.eclipse.jface.action.ToolBarManager;
Expand Down Expand Up @@ -233,6 +236,14 @@ public void testDirty() throws Throwable {
MockEditorPart editorA = (MockEditorPart) innerEditors[0];
MockEditorPart editorB = (MockEditorPart) innerEditors[0];

// This test verifies the textual '*' dirty prefix, which is only used
// when the graphical dirty indicator is disabled.
IEclipsePreferences prefs = InstanceScope.INSTANCE
.getNode(CTabRendering.PREF_QUALIFIER_ECLIPSE_E4_UI_WORKBENCH_RENDERERS_SWT);
boolean previous = prefs.getBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS,
CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS_DEFAULT);
prefs.putBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS, false);

char firstChar = item.getText().charAt(0);
assertFalse(firstChar == '*');

Expand All @@ -249,6 +260,7 @@ public void testDirty() throws Throwable {
editorB.setDirty(false);
assertEquals(firstChar, item.getText().charAt(0));
} finally {
prefs.putBoolean(CTabRendering.SHOW_DIRTY_INDICATOR_ON_TABS, previous);
page.closeAllEditors(false);
}
}
Expand Down
Loading