Tag-Based Selection for Entry fields in Preferences #12592

vi-anusha · 2025-03-02T18:33:21Z

This PR Fixes #12550

This PR replaces the existing text-based field selection with a tag-based selection format, similar to the implementation in the Autocompletion settings.

Changes Made

Converted text-based text input to TagsField components, allowing users to select fields dynamically instead of relying on static text labels.
Improved layout alignment to ensure text and tags are displayed correctly.
Adjusted spacing and padding in HBox to prevent label truncation or misalignment.
Ensured that the new TagsField selection method works consistently with other settings sections.

Screenshots after Fix Applied

Mandatory checks

I own the copyright of the code submitted and I licence it under the MIT license
Change in CHANGELOG.md described in a way that is understandable for the average user (if change is visible to the user)
Tests created for changes (if applicable)
Manually tested changed features in running JabRef (always required)
Screenshots added in PR description (for UI changes)
Checked developer's documentation: Is the information available and up to date? If not, I outlined it in this pull request.
Checked 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 to the documentation repository.

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

github-actions

Your code currently does not meet JabRef's code guidelines. We use Checkstyle to identify issues. Please carefully follow the setup guide for the codestyle. Afterwards, please run checkstyle locally and fix the issues.
In case of issues with the import order, double check that you activated Auto Import. You can trigger fixing imports by pressing Ctrl+Alt+O to trigger Optimize Imports.

subhramit

Hi, welcome to JabRef and thanks for your contribution!
Below are some comments on first look.

subhramit · 2025-03-03T07:41:39Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.fxml

+    <CheckBox fx:id="addModificationDate"
+              text="%Add timestamp to modified entries (field &quot;modificationdate&quot;)"/>


Was this line-break unintentional? Please revert.

subhramit · 2025-03-03T07:41:55Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.java

    }

    public void initialize() {
        this.viewModel = new EntryTabViewModel(preferences);
-


Please revert these.

subhramit · 2025-03-03T07:43:33Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.java

+        setupTagsField();
        resolveStrings.selectedProperty().bindBidirectional(viewModel.resolveStringsProperty());


Revert line break before line 71 and add one after 72.

subhramit · 2025-03-03T07:52:10Z

src/main/java/org/jabref/gui/preferences/entry/EntryTabViewModel.java

        timestampPreferences.setAddCreationDate(addCreationDateProperty.getValue());
        timestampPreferences.setAddModificationDate(addModificationDateProperty.getValue());
+        fieldPreferences.getResolvableFields().clear();
+        fieldPreferences.getResolvableFields().addAll(resolveStringsForFieldsProperty.getValue());


Suggested change

fieldPreferences.getResolvableFields().addAll(resolveStringsForFieldsProperty.getValue());

fieldPreferences.getResolvableFields().addAll(resolveStringsForFieldsProperty.getValue().trim());

The values are in list format, so can not trim them here.

Use map to trim them individually then.

resolveStringsForFieldsProperty.getValue().stream() .map(String::trim) .forEach(fieldPreferences.getResolvableFields()::add);

subhramit · 2025-03-03T07:52:28Z

src/main/java/org/jabref/gui/preferences/entry/EntryTabViewModel.java

+        fieldPreferences.getResolvableFields().clear();
+        fieldPreferences.getResolvableFields().addAll(resolveStringsForFieldsProperty.getValue());
+        fieldPreferences.getNonWrappableFields().clear();
+        fieldPreferences.getNonWrappableFields().addAll(nonWrappableFieldsProperty.getValue());


Suggested change

fieldPreferences.getNonWrappableFields().addAll(nonWrappableFieldsProperty.getValue());

fieldPreferences.getNonWrappableFields().addAll(nonWrappableFieldsProperty.getValue().trim());

subhramit · 2025-03-03T08:06:13Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.java

+    private TextField keywordSeparator;
+    @FXML
+    private CheckBox resolveStrings;
+    @FXML
+    private TagsField<Field> resolveStringsForFields;
+    @FXML
+    private TagsField<Field> nonWrappableFields;


Separate these declarations into groups like before

subhramit · 2025-03-03T08:14:43Z

src/main/java/org/jabref/gui/preferences/entry/EntryTabViewModel.java

+
+            @Override
+            public Field fromString(String string) {
+                return FieldFactory.parseField(string);


Why do we use parseField instead of parseFieldList now?

As I was updating it according to the autocompletion module, and that uses parseFieldList.

subhramit · 2025-03-03T08:15:12Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.java

+        nonWrappableFields.setShowSearchIcon(false);
+        nonWrappableFields.setOnMouseClicked(event -> nonWrappableFields.getEditor().requestFocus());
+        nonWrappableFields.getEditor().getStyleClass().clear();
+        nonWrappableFields.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> nonWrappableFields.pseudoClassStateChanged(FOCUSED, newValue));


Suggested change

nonWrappableFields.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> nonWrappableFields.pseudoClassStateChanged(FOCUSED, newValue));

nonWrappableFields.getEditor().focusedProperty().addListener((_, _, newValue) -> nonWrappableFields.pseudoClassStateChanged(FOCUSED, newValue));

subhramit · 2025-03-03T08:15:33Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.java

+        resolveStringsForFields.setShowSearchIcon(false);
+        resolveStringsForFields.setOnMouseClicked(event -> resolveStringsForFields.getEditor().requestFocus());
+        resolveStringsForFields.getEditor().getStyleClass().clear();
+        resolveStringsForFields.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> resolveStringsForFields.pseudoClassStateChanged(FOCUSED, newValue));


Suggested change

resolveStringsForFields.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> resolveStringsForFields.pseudoClassStateChanged(FOCUSED, newValue));

resolveStringsForFields.getEditor().focusedProperty().addListener((_, _, newValue) -> resolveStringsForFields.pseudoClassStateChanged(FOCUSED, newValue));

subhramit · 2025-03-03T08:22:15Z

src/main/java/org/jabref/gui/preferences/entry/EntryTab.fxml

+<?import javafx.scene.control.*?>
+<?import javafx.scene.layout.*?>


Also, please don't use * here. Import only what you're using.

trag-bot · 2025-03-13T07:14:30Z

@trag-bot didn't find any issues in the code! ✅✨

koppor · 2025-03-13T10:13:44Z

Cannot enter custom field:
Pressing ENTER when entering a field should NOT close the dialog -> the focus should be in the fields
There is no suggestion of keywords while typing. see keywords fields for an implementation

vi-anusha added 2 commits March 2, 2025 23:48

fix UI: Preferences -> Entry

f9744d8

fix padding

439988c

github-actions bot reviewed Mar 2, 2025

View reviewed changes

reformat code in entry

c8b9cf8

github-actions bot reviewed Mar 2, 2025

View reviewed changes

reformat imports

af00b52

github-actions bot reviewed Mar 2, 2025

View reviewed changes

remove extra lines in entryTab

076e6f5

vi-anusha mentioned this pull request Mar 2, 2025

Use a Tag Field for Resolve strings and Do not wrap under Preferences -> Entry for #12550

Open

subhramit requested changes Mar 3, 2025

View reviewed changes

subhramit changed the title ~~Fix for issue 12550 Tag-Based Selection in Preferences -> Entry Fields~~ Tag-Based Selection for Entry fields in Preferences Mar 3, 2025

subhramit reviewed Mar 3, 2025

View reviewed changes

Siedlerchr added the status: changes required Pull requests that are not yet complete label Mar 7, 2025

Siedlerchr marked this pull request as draft March 8, 2025 20:51

reverting & fixing as per feedback

366e163

vi-anusha requested a review from subhramit March 13, 2025 07:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tag-Based Selection for Entry fields in Preferences #12592

Tag-Based Selection for Entry fields in Preferences #12592

vi-anusha commented Mar 2, 2025 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

subhramit left a comment

subhramit Mar 3, 2025

subhramit Mar 3, 2025

subhramit Mar 3, 2025 •

edited

Loading

subhramit Mar 3, 2025

vi-anusha Mar 13, 2025

subhramit Mar 13, 2025 •

edited

Loading

subhramit Mar 3, 2025

subhramit Mar 3, 2025

subhramit Mar 3, 2025

vi-anusha Mar 13, 2025

subhramit Mar 3, 2025

subhramit Mar 3, 2025

subhramit Mar 3, 2025

trag-bot bot commented Mar 13, 2025

koppor commented Mar 13, 2025

		<CheckBox fx:id="addModificationDate"
		text="%Add timestamp to modified entries (field "modificationdate")"/>

		setupTagsField();
		resolveStrings.selectedProperty().bindBidirectional(viewModel.resolveStringsProperty());

	fieldPreferences.getResolvableFields().addAll(resolveStringsForFieldsProperty.getValue());
	fieldPreferences.getResolvableFields().addAll(resolveStringsForFieldsProperty.getValue().trim());

	fieldPreferences.getNonWrappableFields().addAll(nonWrappableFieldsProperty.getValue());
	fieldPreferences.getNonWrappableFields().addAll(nonWrappableFieldsProperty.getValue().trim());

	nonWrappableFields.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> nonWrappableFields.pseudoClassStateChanged(FOCUSED, newValue));
	nonWrappableFields.getEditor().focusedProperty().addListener((_, _, newValue) -> nonWrappableFields.pseudoClassStateChanged(FOCUSED, newValue));

	resolveStringsForFields.getEditor().focusedProperty().addListener((observable, oldValue, newValue) -> resolveStringsForFields.pseudoClassStateChanged(FOCUSED, newValue));
	resolveStringsForFields.getEditor().focusedProperty().addListener((_, _, newValue) -> resolveStringsForFields.pseudoClassStateChanged(FOCUSED, newValue));

		<?import javafx.scene.control.*?>
		<?import javafx.scene.layout.*?>

Tag-Based Selection for Entry fields in Preferences #12592

Are you sure you want to change the base?

Tag-Based Selection for Entry fields in Preferences #12592

Conversation

vi-anusha commented Mar 2, 2025 • edited Loading

Changes Made

Screenshots after Fix Applied

Mandatory checks

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

subhramit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

subhramit Mar 3, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

subhramit Mar 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trag-bot bot commented Mar 13, 2025

koppor commented Mar 13, 2025

vi-anusha commented Mar 2, 2025 •

edited

Loading

subhramit Mar 3, 2025 •

edited

Loading

subhramit Mar 13, 2025 •

edited

Loading