Skip to content
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

Add drop down for citation key patterns #12516

Merged
merged 19 commits into from
Feb 21, 2025
+286 −4
Merged

Add drop down for citation key patterns #12516

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
1618eec
Add a suggestions text field
priyanshu16095 Feb 16, 2025
7597467
Improve text field and make use of CitationKeyPattern record
priyanshu16095 Feb 17, 2025
1b819f9
Fix the check
priyanshu16095 Feb 17, 2025
b8527aa
Change a comment
priyanshu16095 Feb 17, 2025
88965e9
Make the fields private
priyanshu16095 Feb 17, 2025
40ce160
Make remaining fields private
priyanshu16095 Feb 17, 2025
948a495
Fix the check
priyanshu16095 Feb 17, 2025
b874dfd
Make fields public again
priyanshu16095 Feb 18, 2025
fac8fbc
Fix the UI issue
priyanshu16095 Feb 20, 2025
7a61dad
Update CitationKeyPattern.java
priyanshu16095 Feb 20, 2025
ed42bcc
Define the MAX_ENTRIES variable
priyanshu16095 Feb 20, 2025
43292ba
Merge branch 'main' into addDropdown
subhramit Feb 21, 2025
249229b
Add submenu and improve suggestions
priyanshu16095 Feb 21, 2025
4dff9f2
Add pattern in Java record
priyanshu16095 Feb 21, 2025
10522b4
Fix the check
priyanshu16095 Feb 21, 2025
58ef2f4
Add setOnAction on menu item
priyanshu16095 Feb 21, 2025
539c1fd
Add a CHANGELOG.md entry
priyanshu16095 Feb 21, 2025
6f235c9
Fix the issue
priyanshu16095 Feb 21, 2025
353f1bd
Add keys in JabRef_en.properties
priyanshu16095 Feb 21, 2025
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
81 changes: 81 additions & 0 deletions src/main/java/org/jabref/gui/commonfxcontrols/CitationKeyPatternSuggestionCell.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
package org.jabref.gui.commonfxcontrols;

import java.util.List;
import java.util.stream.Collectors;

import javafx.collections.FXCollections;
import javafx.scene.control.ListView;
import javafx.scene.control.TextField;
import javafx.scene.control.cell.TextFieldTableCell;
import javafx.stage.Popup;

public class CitationKeyPatternSuggestionCell extends TextFieldTableCell<CitationKeyPatternsPanelItemModel, String> {
private final TextField searchField = new TextField();
private final ListView<String> suggestionList = new ListView<>();
private final Popup popup = new Popup();

private final List<String> fullData;

public CitationKeyPatternSuggestionCell(List<String> fullData) {
this.fullData = fullData;
popup.getContent().add(suggestionList);
popup.setAutoHide(true);

searchField.textProperty().addListener((obs, oldVal, newVal) -> {
List<String> filtered = fullData.stream()
.filter(item -> item.toLowerCase().contains(newVal.toLowerCase()))
.collect(Collectors.toList());

suggestionList.setItems(FXCollections.observableArrayList(filtered));
if (!filtered.isEmpty()) {
popup.show(searchField, searchField.localToScreen(0, searchField.getHeight()).getX(),
searchField.localToScreen(0, searchField.getHeight() * 2).getY());
} else {
popup.hide();
}
});

suggestionList.setOnMouseClicked(event -> {
String selected = suggestionList.getSelectionModel().getSelectedItem();
if (selected != null) {
searchField.setText(selected);
popup.hide();
}
});

searchField.setOnAction(event -> commitEdit(searchField.getText()));
}

@Override
public void startEdit() {
super.startEdit();
searchField.setText(getItem());
setGraphic(searchField);
searchField.requestFocus();
}

@Override
public void cancelEdit() {
super.cancelEdit();
setGraphic(null);
popup.hide();
}

@Override
public void commitEdit(String newValue) {
super.commitEdit(newValue);
getTableView().getItems().get(getIndex()).setPattern(newValue);
setGraphic(null);
}

@Override
public void updateItem(String item, boolean empty) {
super.updateItem(item, empty);
if (empty || item == null) {
setGraphic(null);
setText(null);
} else {
setText(item);
}
}
}
14 changes: 12 additions & 2 deletions src/main/java/org/jabref/gui/commonfxcontrols/CitationKeyPatternsPanel.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@

import javafx.beans.property.ListProperty;
import javafx.beans.property.ObjectProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.fxml.FXML;
import javafx.scene.control.ListView;
import javafx.scene.control.TableColumn;
import javafx.scene.control.TableRow;
import javafx.scene.control.TableView;
import javafx.scene.control.cell.TextFieldTableCell;
import javafx.scene.control.TextField;
import javafx.scene.input.KeyEvent;

import org.jabref.gui.icon.IconTheme;
Expand All @@ -27,6 +30,8 @@ public class CitationKeyPatternsPanel extends TableView<CitationKeyPatternsPanel
@FXML public TableColumn<CitationKeyPatternsPanelItemModel, EntryType> entryTypeColumn;
@FXML public TableColumn<CitationKeyPatternsPanelItemModel, String> patternColumn;
@FXML public TableColumn<CitationKeyPatternsPanelItemModel, EntryType> actionsColumn;
@FXML private TextField searchField;
@FXML private ListView<String> suggestionList;

@Inject private CliPreferences preferences;

Expand Down Expand Up @@ -58,10 +63,15 @@ private void initialize() {
this.setOnSort(event ->
viewModel.patternListProperty().sort(CitationKeyPatternsPanelViewModel.defaultOnTopComparator));

ObservableList<String> fullData = FXCollections.observableArrayList(
"[auth]", "[authFirstFull]", "[authForeIni]", "[auth.etal]", "[authEtAl]",
"[auth.auth.ea]", "[authors]", "[authorsN]", "[authIniN]", "[authN]", "[authN_M]",
"[authorIni]", "[authshort]", "[authorsAlpha]");
Copy link
Member

@subhramit subhramit Feb 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also add [authorsAlphaLNI] (added in #12499).
Also, the issue asks for special field markers, which also includes Editor-related field markers, Title-related field markers, Other field markers and Bibentry fields apart from the author-related ones. Please add them as well.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should either think how to auto-populate this list - or add a Java comment on how to populate the list manually.

Copy link
Member

@subhramit subhramit Feb 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, @priyanshu16095 - lets make this neat.
This is what I brainstormed, need a second opinion from @Siedlerchr and @koppor so that we know this is the best way and doesn't break things:
There is a record class, CitationKeyPatterns.java.

  1. Modify it to make it a final class.
  2. Hardcode the patterns as constants there. Leave proper comments with //region - citation key patterns offered. for any new pattern, add them here and // endregion below.
  3. Make a public static function getAllPatterns, see if this works (I chatgpt'd this snippet - make any modifications needed):
Arrays.stream(CitationKeyPatterns.class.getDeclaredFields())
             .filter(field -> {
                 int modifiers = field.getModifiers();
                 return Modifier.isPublic(modifiers) && 
                        Modifier.isStatic(modifiers) && 
                        Modifier.isFinal(modifiers) &&
                        field.getType() == CitationKeyPattern.class &&
                        field != CitationKeyPattern.NULL_CITATION_KEY_PATTERN;
             })
             .map(field -> {
                 try {
                     return (CitationKeyPattern) field.get(null);
                 } catch (IllegalAccessException e) {
                     throw new RuntimeException("Could not access field", e);
                 }
             })
             .collect(Collectors.toList());
  1. Use that list returned in your observable array list

This way, the developer has to just change one line when adding a new pattern, without the overhead of finding the list where patterns are populated, or just using raw strings or using constants (you have to put them everywhere otherwise).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually no need to even change the class type. You can add the method in the record itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure! Great suggestions, thanks!


patternColumn.setSortable(true);
patternColumn.setReorderable(false);
patternColumn.setCellValueFactory(cellData -> cellData.getValue().pattern());
patternColumn.setCellFactory(TextFieldTableCell.forTableColumn());
patternColumn.setCellFactory(column -> new CitationKeyPatternSuggestionCell(fullData));
patternColumn.setEditable(true);
patternColumn.setOnEditCommit(
(TableColumn.CellEditEvent<CitationKeyPatternsPanelItemModel, String> event) ->
Expand Down
Loading