enable folding with "Only show selected Java element" #2302

danthe1st · 2025-06-29T14:28:48Z

Fixes #2264
Depends on eclipse-platform/eclipse.platform.ui#3074 (Is it necessary to change the version requirements in some way even if I am not depending on any new API?)
Depends on #2410 for this to work correctly with extended folding That dependency PR has been merged.

I think this should be tested with JDT-UI (with this PR) before eclipse-platform/eclipse.platform.ui#3074 is merged.

What it does

This PR enables folding when Window > Preferences > Java > Editor > Only show the selected Java element is enabled.

This depends on eclipse-platform/eclipse.platform.ui#3074 to work correctly.

How to test

Include Allow using visible regions with projections eclipse-platform/eclipse.platform.ui#3074
Enable Window > Preferences > Java > Editor > Only show the selected Java element
Enable folding in Window > Preferences > Java > Editor > Folding
Open a Java file
Folding should work
Select an element in the outline
Observe that only the selected element is shown in the editor.
Folding should still work
All of that should work with and without extended folding or custom folding regions. Editing the file shouldn't break it.

Author checklist

I have thoroughly tested my changes
- If only a selected region is shown and one enters text at the end of that region (if the curser is exactly after the closing }), everything after the selected region is displayed. I am not sure whether that's an issue. See https://github.com/user-attachments/assets/18cc621f-1c69-45e6-a7ce-97d609f489fe This was an issue with my changes in eclipse.platform.ui which should be fixed.
- I did not do any performance evaluation.
The change is following the coding conventions
I have signed the Eclipse Contributor Agreement (ECA)

danthe1st · 2025-06-30T19:07:37Z

I wrote some basic tests for the PR in eclipse.platform.ui. Is it also necessary to add integration tests in JDT-UI for this change?

iloveeclipse · 2025-06-30T19:15:40Z

I wrote some basic tests for the PR in eclipse.platform.ui. Is it also necessary to add integration tests in JDT-UI for this change?

If possible, regression test for original problem?

danthe1st · 2025-06-30T19:28:56Z

If possible, regression test for original problem?

I added a test that ensures folding is active (even though I am not sure whether this is actually a bug I'm fixing or more implementing a feature/enhancement).

But note that in order to work correctly, the other PR would need to be merged/integrated first (and my test wouldn't detect that currently).

danthe1st · 2025-07-05T14:41:21Z

The test failure should be because this depends on eclipse-platform/eclipse.platform.ui#3074 which is not merged.

danthe1st · 2025-07-05T14:49:08Z

The changes I made to DefaultJavaFoldingStructureProvider (making sure the IJavaElement is present) are necessary because it uses the IJavaElement to determine which folding regions are equal. Without this, it tries to update the existing folding projection annotations in a way that caused issues with my change (I think it tried to set existing folding regions to other ones).

...t.text.tests/src/org/eclipse/jdt/text/tests/folding/FoldingWithShowSelectedElementTests.java

danthe1st · 2025-07-07T19:33:06Z

In situations where #2327 occurs and that region is added/removed when editing the editor, the parts after the visible region can become visible but that's fixed by that PR.

Other than that, I think this PR and eclipse-platform/eclipse.platform.ui#3074 are ready for someone to take a look at it.

danthe1st · 2025-07-10T17:53:28Z

Would @iloveeclipse or someone else care to review these two PRs at some point?

org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/text/folding/DefaultJavaFoldingStructureProvider.java

iloveeclipse · 2025-07-23T11:25:48Z

Seem to work fine except the binary types (e.g. java.lang.String etc), I guess similar change like it was in JavaEditor is needed for ClassFileEditor.

danthe1st · 2025-07-23T14:47:24Z

Seem to work fine except the binary types (e.g. java.lang.String etc), I guess similar change like it was in JavaEditor is needed for ClassFileEditor.

Did the "Only show the selected Java element" option ever work with the Class File Editor? I didn't see that doing anything without my change and this PR doesn't seem to impact that.

iloveeclipse · 2025-07-23T14:48:54Z

Seem to work fine except the binary types (e.g. java.lang.String etc), I guess similar change like it was in JavaEditor is needed for ClassFileEditor.

Did the "Only show the selected Java element" option ever work with the Class File Editor? I didn't see that doing anything without my change and this PR doesn't seem to impact that.

Honestly, no idea, I never used this "Only show the selected Java element" option, just assumed it should work there too :-)
So if it wasn't ther ebefore, don't care!

danthe1st · 2025-08-03T14:58:57Z

The changes to DefaultJavaFoldingStructureProvider (and CustomFoldingRegionTest) are necessary to prevent issues with changing the document with enhanced folding in cases like this:

// region outer

class SomeClass {
    // region inner
    void someMethod() {
        // content
    }
    // endregion
}

// endregion

That class would have the following issues when the file is modified:

With the changes to allow folding with "Only show selected Java element" without the changes I made to DefaultJavaFoldingStructureProvider, if someMethod is selected (and only that is shown), editing the code results in the full inner region being shown
Even without this PR/in the current master (or without the changes to DefaultJavaFoldingStructureProvider), if region outer is collapsed, editing the file expands it

The reason this happens is that it tries to "update" the outer region with the inner region or vice-versa (it confuses the folding regions with each other) so it re-expands the old folding region.

If wanted, I could factor out this fix to its own PR.

danthe1st · 2025-08-05T18:23:33Z

I have factored out the other bugfix into #2410 because smaller changes are typically preferred. This PR now only contains the logic for folding with "Only show the selected Java element".
I also updated the PR description.

Edit: That change is merged now.

eclipse-jdt-bot · 2025-09-02T16:00:56Z

This pull request changes some projects for the first time in this development cycle.
Therefore the following files need a version increment:

org.eclipse.jdt.text.tests/META-INF/MANIFEST.MF
org.eclipse.jdt.text.tests/pom.xml
org.eclipse.jdt.ui/META-INF/MANIFEST.MF
org.eclipse.jdt.ui/pom.xml

An additional commit containing all the necessary changes was pushed to the top of this PR's branch. To obtain these changes (for example if you want to push more changes) either fetch from your fork or apply the git patch.

Git patch

From e630ad7489024e7f982099c5da270b5aebbb467e Mon Sep 17 00:00:00 2001
From: Eclipse JDT Bot <[email protected]>
Date: Tue, 2 Sep 2025 16:00:34 +0000
Subject: [PATCH] Version bump(s) for 4.38 stream


diff --git a/org.eclipse.jdt.text.tests/META-INF/MANIFEST.MF b/org.eclipse.jdt.text.tests/META-INF/MANIFEST.MF
index 819c467448..7ba7965716 100644
--- a/org.eclipse.jdt.text.tests/META-INF/MANIFEST.MF
+++ b/org.eclipse.jdt.text.tests/META-INF/MANIFEST.MF
@@ -3,7 +3,7 @@ Automatic-Module-Name: org.eclipse.jdt.text.tests
 Bundle-ManifestVersion: 2
 Bundle-Name: %Plugin.name
 Bundle-SymbolicName: org.eclipse.jdt.text.tests;singleton:=true
-Bundle-Version: 3.15.200.qualifier
+Bundle-Version: 3.15.300.qualifier
 Bundle-Activator: org.eclipse.jdt.text.tests.JdtTextTestPlugin
 Bundle-ActivationPolicy: lazy
 Bundle-Vendor: %Plugin.providerName
diff --git a/org.eclipse.jdt.text.tests/pom.xml b/org.eclipse.jdt.text.tests/pom.xml
index 219999036e..c6742bad41 100644
--- a/org.eclipse.jdt.text.tests/pom.xml
+++ b/org.eclipse.jdt.text.tests/pom.xml
@@ -20,7 +20,7 @@
   </parent>
   <groupId>org.eclipse.jdt</groupId>
   <artifactId>org.eclipse.jdt.text.tests</artifactId>
-  <version>3.15.200-SNAPSHOT</version>
+  <version>3.15.300-SNAPSHOT</version>
   <packaging>eclipse-test-plugin</packaging>
 
   <properties>
diff --git a/org.eclipse.jdt.ui/META-INF/MANIFEST.MF b/org.eclipse.jdt.ui/META-INF/MANIFEST.MF
index 53f1b0d306..a5dc720767 100644
--- a/org.eclipse.jdt.ui/META-INF/MANIFEST.MF
+++ b/org.eclipse.jdt.ui/META-INF/MANIFEST.MF
@@ -3,7 +3,7 @@ Automatic-Module-Name: org.eclipse.jdt.ui
 Bundle-ManifestVersion: 2
 Bundle-Name: %pluginName
 Bundle-SymbolicName: org.eclipse.jdt.ui; singleton:=true
-Bundle-Version: 3.35.100.qualifier
+Bundle-Version: 3.35.200.qualifier
 Bundle-Activator: org.eclipse.jdt.internal.ui.JavaPlugin
 Bundle-ActivationPolicy: lazy
 Bundle-Vendor: %providerName
diff --git a/org.eclipse.jdt.ui/pom.xml b/org.eclipse.jdt.ui/pom.xml
index e81c09a125..fa432d58f4 100644
--- a/org.eclipse.jdt.ui/pom.xml
+++ b/org.eclipse.jdt.ui/pom.xml
@@ -18,7 +18,7 @@
   </parent>
   <groupId>org.eclipse.jdt</groupId>
   <artifactId>org.eclipse.jdt.ui</artifactId>
-  <version>3.35.100-SNAPSHOT</version>
+  <version>3.35.200-SNAPSHOT</version>
   <packaging>eclipse-plugin</packaging>
 
 	<build>
-- 
2.51.0

Further information are available in Common Build Issues - Missing version increments.

danthe1st marked this pull request as draft June 29, 2025 14:29

danthe1st mentioned this pull request Jun 29, 2025

Allow using visible regions with projections eclipse-platform/eclipse.platform.ui#3074

Open

danthe1st marked this pull request as ready for review June 30, 2025 19:06

danthe1st force-pushed the folding-selected-regions branch from 6967565 to a6a006f Compare June 30, 2025 19:27

danthe1st force-pushed the folding-selected-regions branch 4 times, most recently from f8e0768 to 84fa6a1 Compare July 5, 2025 12:27

danthe1st force-pushed the folding-selected-regions branch 5 times, most recently from ef87738 to 2cc9c2d Compare July 6, 2025 09:13

danthe1st commented Jul 6, 2025

View reviewed changes

...t.text.tests/src/org/eclipse/jdt/text/tests/folding/FoldingWithShowSelectedElementTests.java Show resolved Hide resolved

danthe1st force-pushed the folding-selected-regions branch from 2cc9c2d to ebe65ee Compare July 10, 2025 16:49

danthe1st force-pushed the folding-selected-regions branch 2 times, most recently from 1b8ff59 to 36e790f Compare July 22, 2025 16:48

iloveeclipse reviewed Jul 23, 2025

View reviewed changes

org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/text/folding/DefaultJavaFoldingStructureProvider.java Outdated Show resolved Hide resolved

org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/text/folding/DefaultJavaFoldingStructureProvider.java Outdated Show resolved Hide resolved

danthe1st force-pushed the folding-selected-regions branch from 36e790f to 8e29d7c Compare July 23, 2025 14:18

danthe1st force-pushed the folding-selected-regions branch from 8e29d7c to 98e8c31 Compare July 27, 2025 09:34

danthe1st force-pushed the folding-selected-regions branch 4 times, most recently from b36140c to a9036dc Compare August 3, 2025 10:21

danthe1st mentioned this pull request Aug 5, 2025

preserve contextual information with enhanced folding #2410

Merged

3 tasks

danthe1st force-pushed the folding-selected-regions branch from a9036dc to ff0ff09 Compare August 5, 2025 18:15

danthe1st force-pushed the folding-selected-regions branch from ff0ff09 to b4d8551 Compare August 15, 2025 20:23

enable folding with "Only show selected Java element" eclipse-jdt#2264

f6c5035

danthe1st force-pushed the folding-selected-regions branch from b4d8551 to f6c5035 Compare September 2, 2025 15:55

Version bump(s) for 4.38 stream

5998c84

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

enable folding with "Only show selected Java element" #2302

enable folding with "Only show selected Java element" #2302

danthe1st commented Jun 29, 2025 •

edited

Loading

Uh oh!

danthe1st commented Jun 30, 2025

Uh oh!

iloveeclipse commented Jun 30, 2025

Uh oh!

danthe1st commented Jun 30, 2025 •

edited

Loading

Uh oh!

danthe1st commented Jul 5, 2025 •

edited

Loading

Uh oh!

danthe1st commented Jul 5, 2025

Uh oh!

Uh oh!

danthe1st commented Jul 7, 2025 •

edited

Loading

Uh oh!

danthe1st commented Jul 10, 2025

Uh oh!

Uh oh!

Uh oh!

iloveeclipse commented Jul 23, 2025

Uh oh!

danthe1st commented Jul 23, 2025 •

edited

Loading

Uh oh!

iloveeclipse commented Jul 23, 2025

Uh oh!

danthe1st commented Aug 3, 2025

Uh oh!

danthe1st commented Aug 5, 2025 •

edited

Loading

Uh oh!

eclipse-jdt-bot commented Sep 2, 2025

Uh oh!

Uh oh!

enable folding with "Only show selected Java element" #2302

Are you sure you want to change the base?

enable folding with "Only show selected Java element" #2302

Conversation

danthe1st commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What it does

How to test

Author checklist

Uh oh!

danthe1st commented Jun 30, 2025

Uh oh!

iloveeclipse commented Jun 30, 2025

Uh oh!

danthe1st commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danthe1st commented Jul 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danthe1st commented Jul 5, 2025

Uh oh!

Uh oh!

danthe1st commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

danthe1st commented Jul 10, 2025

Uh oh!

Uh oh!

Uh oh!

iloveeclipse commented Jul 23, 2025

Uh oh!

danthe1st commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iloveeclipse commented Jul 23, 2025

Uh oh!

danthe1st commented Aug 3, 2025

Uh oh!

danthe1st commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eclipse-jdt-bot commented Sep 2, 2025

Uh oh!

Uh oh!

danthe1st commented Jun 29, 2025 •

edited

Loading

danthe1st commented Jun 30, 2025 •

edited

Loading

danthe1st commented Jul 5, 2025 •

edited

Loading

danthe1st commented Jul 7, 2025 •

edited

Loading

danthe1st commented Jul 23, 2025 •

edited

Loading

danthe1st commented Aug 5, 2025 •

edited

Loading