Fix for group focus after removing the filter (14084) by ZiadAbdElFatah · Pull Request #14883 · JabRef/jabref

ZiadAbdElFatah · 2026-01-20T15:05:00Z

User description

I saved the group selected after applying a filter, and when the filter changes, I made sure that the new filter isn't empty to ensure the case of clearing, if it is empty I assign the group selected before as the current selected one.

Steps to test

1.
2.
3.

Mandatory checks

I own the copyright of the code submitted and I license it under the MIT license
I manually tested my changes in running JabRef (always required)
[/] I added JUnit tests for changes (if applicable)
I added screenshots in the PR description (if change is visible to the user)
I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

PR Type

Bug fix

Description

Preserves group selection when clearing filter text
Saves selected groups before filter change, restores if filter becomes empty
Uses Platform.runLater to ensure UI update after filter change
Removes unnecessary ENABLE_JAVADOC_FORMATTING configuration option

Diagram Walkthrough

flowchart LR
  A["User clears filter"] --> B["Save current selected groups"]
  B --> C["Apply new empty filter"]
  C --> D["Restore previous selection"]
  D --> E["Update group tree view"]

File Walkthrough

Relevant files

Bug fix

GroupTreeView.java `Restore group selection on filter clear` jabgui/src/main/java/org/jabref/gui/groups/GroupTreeView.java Saves selected groups before applying filter changes Checks if new filter is empty or null Restores previous group selection when filter is cleared Uses Platform.runLater for thread-safe UI updates	+10/-0

Configuration changes

Project.xml `Remove javadoc formatting configuration` .idea/codeStyles/Project.xml Removes ENABLE_JAVADOC_FORMATTING configuration option	+0/-1

github-actions · 2026-01-20T15:05:14Z

Hey @ZiadAbdElFatah! 👋

Thank you for contributing to JabRef!

We have automated checks in place, based on which you will soon get feedback if any of them are failing. We also use Qodo for review assistance. It will update your pull request description with a review help and offer suggestions to improve the pull request.

After all automated checks pass, a maintainer will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs. You can read about the whole pull request process in our contribution guide.

Please ensure that your pull request is in line with our AI Usage Policy and make necessary disclosures.

ZiadAbdElFatah · 2026-01-21T08:19:23Z

I need help here.
I think i accomplished the main goal of the issue, as I tried many cases and all the results were as expected, but i got these github errors that i don't understand, so i don't know what should i do.

I tried to reformat my code but when typed (Ctrl+Alt+L) it changed some lines that are not the lines i wrote, and also didn't change any of the lines i wrote.

ZiadAbdElFatah · 2026-01-21T10:30:57Z

This is my first pr with JabRef, i went with the docs step by step, in this step of checkstyle setup

after enabling JavaDoc formatting this file change happened
https://github.com/JabRef/jabref/pull/14883/files#diff-11745b49c51a1ecde7d4d4cffda53d76594e6711ec81bf1148a05942b0438141

When i tried to restore the file to its original state the JavaDoc formatting is disabled.

I din't know if this is a bug or what.

qodo-free-for-open-source-projects · 2026-01-21T10:57:35Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance

🟢

No security concerns identified

No security vulnerabilities detected by AI analysis. Human verification advised for critical code.

Ticket Compliance

🟡

🎫 #14084

🟢	Keep the group focused/selected after clearing the search filter in the group interface
	When a user clears the search field, the previously selected group should remain selected
	The implementation should handle the filter clearing scenario specifically
⚪	Verify that the group selection is properly restored in the UI after clearing the search filter through manual testing
⚪	Confirm that the Platform.runLater timing is appropriate and doesn't cause UI flickering or race conditions

Codebase Duplication Compliance

⚪

Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance

🟢

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

🔴

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status:
Generic variable naming: Variable newFilter is a generic name that doesn't clearly express its purpose as a
search filter text value

Referred Code

final String newFilter = searchField.getText();
viewModel.filterTextProperty().setValue(newFilter);

⚪

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Missing error handling: No error handling for potential exceptions when restoring previous selection in
Platform.runLater or when accessing prevSelected list

Referred Code

Platform.runLater(() -> {
    viewModel.selectedGroupsProperty().setAll(prevSelected);
});

Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

qodo-free-for-open-source-projects · 2026-01-21T10:58:47Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category Suggestion Impact

Possible issue

Fix incorrect group selection restoration

Refactor the group filter logic to correctly restore the group selection. Save
the selection when filtering begins and restore it from the saved state when the
filter is cleared.

jabgui/src/main/java/org/jabref/gui/groups/GroupTreeView.java [218-231]

-final Timer searchTask = FxTimer.create(Duration.ofMillis(400), () -> {
-    LOGGER.debug("Run group search {}", searchField.getText());
+private List<GroupNodeViewModel> selectionBeforeFiltering;
+...
+// In initialize() method
+...
+    final Timer searchTask = FxTimer.create(Duration.ofMillis(400), () -> {
+        LOGGER.debug("Run group search {}", searchField.getText());
+        final String newFilter = searchField.getText();
+        viewModel.filterTextProperty().setValue(newFilter);
 
-    final List<GroupNodeViewModel> prevSelected = new ArrayList<>(viewModel.selectedGroupsProperty());
-    viewModel.filterTextProperty().setValue(searchField.textProperty().getValue());
-    final String newFilter = searchField.getText();
-    viewModel.filterTextProperty().setValue(newFilter);
+        if (newFilter.isEmpty()) {
+            Platform.runLater(() -> {
+                if (selectionBeforeFiltering != null) {
+                    viewModel.selectedGroupsProperty().setAll(selectionBeforeFiltering);
+                }
+            });
+        }
+    });
+    searchField.textProperty().addListener((observable, oldValue, newValue) -> {
+        if (oldValue.isEmpty() && !newValue.isEmpty()) {
+            // We are starting to filter, so we save the current selection
+            selectionBeforeFiltering = new ArrayList<>(viewModel.selectedGroupsProperty());
+        }
+        searchTask.restart();
+    });
 
-    if (newFilter == null || newFilter.isEmpty()) {
-        Platform.runLater(() -> {
-            viewModel.selectedGroupsProperty().setAll(prevSelected);
-        });
-    }
-});
-

[To ensure code accuracy, apply this suggestion manually]

Suggestion importance[1-10]: 9

__

Why: The suggestion correctly identifies a critical logic flaw in the PR's implementation where the previously selected group is not restored correctly, and it provides a robust solution.

High

Update

qodo-free-for-open-source-projects · 2026-01-21T15:17:37Z

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance

🟢

No security concerns identified

No security vulnerabilities detected by AI analysis. Human verification advised for critical code.

Ticket Compliance

🟢

🎫 #14084

🟢	Keep the group focused/selected after clearing the search filter in the group interface
	When a user clears the search field, the previously selected group should remain selected
	The group tree should maintain its selection state when transitioning from filtered to unfiltered view

Codebase Duplication Compliance

⚪

Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance

🟢

Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

🔴

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status:
Generic variable name: Variable prevSelected uses abbreviated naming that reduces readability; should be
previouslySelectedGroups to clearly express its purpose

Referred Code

final List<GroupNodeViewModel> prevSelected = new ArrayList<>(viewModel.selectedGroupsProperty());
viewModel.filterTextProperty().setValue(searchField.textProperty().getValue());

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

qodo-free-for-open-source-projects · 2026-01-21T15:18:51Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	✅ ~~Remove redundant property setting call~~ Suggestion Impact: The suggestion was implemented. The redundant call to viewModel.filterTextProperty().setValue() on line 222 was removed. The commit also improved the code by introducing a new variable 'filterText' to store the value from searchField.textProperty().getValue() and using it consistently, which aligns with the suggestion's intent to eliminate redundancy. code diff: - final List<GroupNodeViewModel> prevSelected = new ArrayList<>(viewModel.selectedGroupsProperty()); + final List<GroupNodeViewModel> previouslySelectedGroup = new ArrayList<>(viewModel.selectedGroupsProperty()); viewModel.filterTextProperty().setValue(searchField.textProperty().getValue()); - final String newFilter = searchField.getText(); - viewModel.filterTextProperty().setValue(newFilter); - - if (newFilter == null \|\| newFilter.isEmpty()) { + final String filterText = searchField.textProperty().getValue(); + if (filterText == null \|\| filterText.isEmpty()) { Remove the redundant call to `viewModel.filterTextProperty().setValue()` as it is called twice with the same value. jabgui/src/main/java/org/jabref/gui/groups/GroupTreeView.java [221-224] final List<GroupNodeViewModel> prevSelected = new ArrayList<>(viewModel.selectedGroupsProperty()); -viewModel.filterTextProperty().setValue(searchField.textProperty().getValue()); final String newFilter = searchField.getText(); viewModel.filterTextProperty().setValue(newFilter); `[Suggestion processed]` Suggestion importance[1-10]: 4 __ Why: The suggestion correctly identifies that `filterTextProperty` is set twice with the same value. Removing the redundant call on line 222 improves code clarity and is a good practice, although its performance impact is negligible.	Low
More

ZiadAbdElFatah · 2026-01-21T22:58:33Z

Ignore the comments above, i saw this #14860 got merged, so i updated the branch and everything is fine now.

koppor · 2026-01-27T06:17:35Z

+            final String filterText = searchField.textProperty().getValue();
+            if (filterText == null || filterText.isEmpty()) {
+                Platform.runLater(() -> {
+                    viewModel.selectedGroupsProperty().setAll(previouslySelectedGroup);


Does this work even if the current group is not shown? -- Java comment needed

I just tried it and noticed that if the current group is not shown, it can't be selected.

koppor · 2026-01-27T06:18:08Z

+            final List<GroupNodeViewModel> previouslySelectedGroup = new ArrayList<>(viewModel.selectedGroupsProperty());
            viewModel.filterTextProperty().setValue(searchField.textProperty().getValue());
+            final String filterText = searchField.textProperty().getValue();
+            if (filterText == null || filterText.isEmpty()) {


Can filterText be null in some cases? I know that AI generates this code, but I want to add some confidence.

I would like to add confidence too. So well, for the code logic it is 100% my logic no any AI logic here. For the code itself, I wrote the code at first and gave it to ChatGPT to review it, it told me to add filterText == null to be more secure so i added it.
I don't have AI agent integrated in intillij so there will not be any code generated with AI only, and be sure that I will not submit a single line of code without fully understand it.

I would like to add confidence too.

What is the result? Logger used? Breakpoint used?

Is this reply on the correct comment?
If it is so, I don't really relate.

koppor · 2026-01-27T06:19:26Z

            LOGGER.debug("Run group search {}", searchField.getText());
+
+            final List<GroupNodeViewModel> previouslySelectedGroup = new ArrayList<>(viewModel.selectedGroupsProperty());
            viewModel.filterTextProperty().setValue(searchField.textProperty().getValue());


Isn't the main reason at the listeners running when setValue is called?

After implementing the solution in this pr, I spent about two days trying to fix the problem from its core and tried to fix the listeners that interact with the selected groups after changing the filter but I couldn't find it, but I am still trying.
A hint would be appreciated a lot.

If we keep this solution, a short Java comment should be put above

Maybe

/// Ensure that group selection is kept after clearance of search

I like the solution, because it also helps when typing something in the field.

ZiadAbdElFatah · 2026-01-28T15:51:52Z

I think this solution is better, where the selection stays as long as the user decides to change it. Whether the selected group is shown or not.

koppor · 2026-01-30T01:40:26Z

@ZiadAbdElFatah Please add a CHANGELOG.md entry.

koppor

Add CHANGELOG.md entry - and a small java comment, then this is good to go.

koppor · 2026-01-30T01:39:25Z

            LOGGER.debug("Run group search {}", searchField.getText());
+
+            final List<GroupNodeViewModel> previouslySelectedGroup = new ArrayList<>(viewModel.selectedGroupsProperty());
            viewModel.filterTextProperty().setValue(searchField.textProperty().getValue());


If we keep this solution, a short Java comment should be put above

Maybe

/// Ensure that group selection is kept after clearance of search

koppor · 2026-01-30T01:52:06Z

            LOGGER.debug("Run group search {}", searchField.getText());
+
+            final List<GroupNodeViewModel> previouslySelectedGroup = new ArrayList<>(viewModel.selectedGroupsProperty());
            viewModel.filterTextProperty().setValue(searchField.textProperty().getValue());


I like the solution, because it also helps when typing something in the field.

ZiadAbdElFatah · 2026-01-30T07:55:33Z

Ok, that is nice. I am sorry I will be out today, once I return tomorrow I will make these changes.
Thanks for your help.

github-actions · 2026-01-31T03:49:35Z

Your pull request conflicts with the target branch.

Please merge with your code. For a step-by-step guide to resolve merge conflicts, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.

ZiadAbdElFatah · 2026-02-02T09:04:21Z

@koppor sorry for the mention, but is there anything else remaining to merge this pr?

github-actions Bot added first contrib status: changes-required Pull requests that are not yet complete labels Jan 20, 2026

Fixed group selection when clearing filter

5c020ce

ZiadAbdElFatah force-pushed the fix-for-issue-14084 branch from 8730280 to 5c020ce Compare January 21, 2026 06:45

Fixed group selection when clearing filter

fc6aec9

ZiadAbdElFatah mentioned this pull request Jan 21, 2026

Keep group focussed after clear search #14084

Closed

ZiadAbdElFatah marked this pull request as ready for review January 21, 2026 10:57

ZiadAbdElFatah marked this pull request as draft January 21, 2026 10:57

qodo-free-for-open-source-projects Bot added the Review effort 2/5 label Jan 21, 2026

ZiadAbdElFatah marked this pull request as ready for review January 21, 2026 15:17

Merge remote-tracking branch 'upstream/main' into fix-for-issue-14084

172d317

github-actions Bot removed the status: changes-required Pull requests that are not yet complete label Jan 21, 2026

Merge remote-tracking branch 'upstream/main' into fix-for-issue-14084

431f7c9

koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jan 23, 2026

ZiadAbdElFatah added 2 commits January 25, 2026 21:34

Removed redundancy

fb703d2

Merge branch 'main' into fix-for-issue-14084

0c3e6f4

koppor requested changes Jan 27, 2026

View reviewed changes

github-actions Bot added status: changes-required Pull requests that are not yet complete and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Jan 27, 2026

Optimized solution for fixing group selection when clearing filter

389817b

Merge branch 'main' into fix-for-issue-14084

4e5b3bb

github-actions Bot removed the status: changes-required Pull requests that are not yet complete label Jan 28, 2026

ZiadAbdElFatah requested a review from koppor January 28, 2026 15:55

Fix submodules

841d16c

github-actions Bot added status: changes-required Pull requests that are not yet complete and removed status: changes-required Pull requests that are not yet complete labels Jan 28, 2026

koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Jan 30, 2026

koppor requested changes Jan 30, 2026

View reviewed changes

github-actions Bot added status: changes-required Pull requests that are not yet complete and removed status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers labels Jan 30, 2026

ZiadAbdElFatah added 2 commits January 31, 2026 02:13

Added CHANGELOG.md entry for the change and a java comment

2b50e4f

Fix submodules

efe5ca3

ZiadAbdElFatah requested a review from koppor January 31, 2026 00:17

Merge branch 'main' into fix-for-issue-14084

3b361e5

github-actions Bot removed the status: changes-required Pull requests that are not yet complete label Jan 31, 2026

koppor reviewed Feb 2, 2026

View reviewed changes

Comment thread CHANGELOG.md Outdated

Apply suggestion from @koppor

2968668

koppor approved these changes Feb 2, 2026

View reviewed changes

koppor enabled auto-merge February 2, 2026 09:16

koppor added this pull request to the merge queue Feb 2, 2026

github-actions Bot added the status: to-be-merged PRs which are accepted and should go into the merge-queue. label Feb 2, 2026

Merged via the queue into JabRef:main with commit 50cdffe Feb 2, 2026
52 checks passed

ZiadAbdElFatah deleted the fix-for-issue-14084 branch February 2, 2026 10:14

Uh oh!

Conversation

ZiadAbdElFatah commented Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Steps to test

Mandatory checks

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

github-actions Bot commented Jan 20, 2026

Uh oh!

ZiadAbdElFatah commented Jan 21, 2026

Uh oh!

ZiadAbdElFatah commented Jan 21, 2026

Uh oh!

qodo-free-for-open-source-projects Bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Compliance Guide 🔍

Uh oh!

qodo-free-for-open-source-projects Bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Uh oh!

qodo-free-for-open-source-projects Bot commented Jan 21, 2026

PR Compliance Guide 🔍

Uh oh!

qodo-free-for-open-source-projects Bot commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Code Suggestions ✨

Uh oh!

ZiadAbdElFatah commented Jan 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZiadAbdElFatah commented Jan 28, 2026

Uh oh!

koppor commented Jan 30, 2026

Uh oh!

koppor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZiadAbdElFatah commented Jan 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jan 31, 2026

Uh oh!

ZiadAbdElFatah commented Feb 2, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

ZiadAbdElFatah commented Jan 20, 2026 •

edited

Loading

qodo-free-for-open-source-projects Bot commented Jan 21, 2026 •

edited

Loading

qodo-free-for-open-source-projects Bot commented Jan 21, 2026 •

edited

Loading

qodo-free-for-open-source-projects Bot commented Jan 21, 2026 •

edited

Loading

ZiadAbdElFatah commented Jan 30, 2026 •

edited

Loading