Fix for group focus after removing the filter (14084)

[ZiadAbdElFatah]

User description

Closes 14084

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"]

Loading

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]

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]

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.

Your code currently does not meet JabRef's code guidelines. IntelliJ auto format covers some cases. There seem to be issues with your code style and autoformat configuration. Please reformat your code (Ctrl+Alt+L) and commit, then push.

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]

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]

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 Learn more about managing compliance generic rules or creating your own custom rules
	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 Learn more about managing compliance generic rules or creating your own custom rules
	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 Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
🔴	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); Learn more about managing compliance generic rules or creating your own custom rules
⚪	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); }); Learn more about managing compliance generic rules or creating your own custom rules
Update

Compliance status legend

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

[qodo-free-for-open-source-projects]

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]

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 Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	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 Learn more about managing compliance generic rules or creating your own custom rules
	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 Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
🔴	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()); Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

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

[qodo-free-for-open-source-projects]

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]

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

[koppor]

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

[koppor]

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

[koppor]

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