Fix content selector present for custom entry type (JabRef#11371)

* Fix typos

* Add JavaDoc

* Group map-based field editors into org.jabref.gui.fieldeditors.mapbased

* Introduce package org.jabref.gui.fieldeditors.optioneditors

* Introduce StringMapBasedEditorViewModel

* Use selector dropdown only if there if selections are available

* Fix import

src/main/java/org/jabref/gui/fieldeditors/FieldEditors.java

@@ -11,6 +11,15 @@
 import org.jabref.gui.autocompleter.SuggestionProvider;
 import org.jabref.gui.autocompleter.SuggestionProviders;
 import org.jabref.gui.fieldeditors.identifier.IdentifierEditor;
+import org.jabref.gui.fieldeditors.optioneditors.MonthEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.OptionEditor;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.CustomFieldEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.EditorTypeEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.GenderEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.PaginationEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.PatentTypeEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.TypeEditorViewModel;
+import org.jabref.gui.fieldeditors.optioneditors.mapbased.YesNoEditorViewModel;
 import org.jabref.gui.util.TaskExecutor;
 import org.jabref.logic.integrity.FieldCheckers;
 import org.jabref.logic.journals.JournalAbbreviationRepository;
@@ -98,11 +107,16 @@ public static FieldEditorFX getForField(final Field field,
             return new CitationKeyEditor(field, suggestionProvider, fieldCheckers, databaseContext);
         } else if (fieldProperties.contains(FieldProperty.MARKDOWN)) {
             return new MarkdownEditor(field, suggestionProvider, fieldCheckers, preferences, undoManager);
-        } else if (fieldProperties.contains(FieldProperty.CUSTOM_FIELD) && !isMultiLine) {
-            return new OptionEditor<>(new CustomFieldEditorViewModel(field, suggestionProvider, fieldCheckers, undoManager, databaseContext));
         } else {
-            // default
-            return new SimpleEditor(field, suggestionProvider, fieldCheckers, preferences, isMultiLine, undoManager);
+            // There was no specific editor found
+
+            // Check whether there are selectors defined for the field at hand
+            List<String> selectorValues = databaseContext.getMetaData().getContentSelectorValuesForField(field);
+            if (!isMultiLine && !selectorValues.isEmpty()) {
+                return new OptionEditor<>(new CustomFieldEditorViewModel(field, suggestionProvider, fieldCheckers, undoManager, selectorValues));
+            } else {
+                return new SimpleEditor(field, suggestionProvider, fieldCheckers, preferences, isMultiLine, undoManager);
+            }
         }
     }
 

src/main/java/org/jabref/gui/fieldeditors/MonthEditorViewModel.java → src/main/java/org/jabref/gui/fieldeditors/optioneditors/MonthEditorViewModel.java

@@ -1,7 +1,7 @@
-package org.jabref.gui.fieldeditors;
+package org.jabref.gui.fieldeditors.optioneditors;
 
 import java.util.Arrays;
-import java.util.List;
+import java.util.Collection;
 
 import javax.swing.undo.UndoManager;
 
@@ -50,7 +50,7 @@ public Month fromString(String string) {
     }
 
     @Override
-    public List<Month> getItems() {
+    public Collection<Month> getItems() {
         return Arrays.asList(Month.values());
     }
 

src/main/java/org/jabref/gui/fieldeditors/OptionEditor.fxml → src/main/java/org/jabref/gui/fieldeditors/optioneditors/OptionEditor.fxml

@@ -3,7 +3,7 @@
 <?import javafx.scene.control.ComboBox?>
 <?import javafx.scene.layout.HBox?>
 <fx:root xmlns:fx="http://javafx.com/fxml/1" type="HBox" xmlns="http://javafx.com/javafx/8.0.112"
-         fx:controller="org.jabref.gui.fieldeditors.OptionEditor">
+         fx:controller="org.jabref.gui.fieldeditors.optioneditors.OptionEditor">
     <ComboBox fx:id="comboBox" editable="true" prefHeight="0" HBox.hgrow="ALWAYS" maxHeight="Infinity"
               maxWidth="Infinity"/>
 </fx:root>

src/main/java/org/jabref/gui/fieldeditors/OptionEditor.java → src/main/java/org/jabref/gui/fieldeditors/optioneditors/OptionEditor.java

@@ -1,4 +1,4 @@
-package org.jabref.gui.fieldeditors;
+package org.jabref.gui.fieldeditors.optioneditors;
 
 import javafx.fxml.FXML;
 import javafx.scene.Parent;
@@ -7,6 +7,7 @@
 import javafx.scene.layout.HBox;
 
 import org.jabref.gui.Globals;
+import org.jabref.gui.fieldeditors.FieldEditorFX;
 import org.jabref.gui.fieldeditors.contextmenu.EditorContextAction;
 import org.jabref.gui.util.ViewModelListCellFactory;
 import org.jabref.model.entry.BibEntry;

src/main/java/org/jabref/gui/fieldeditors/OptionEditorViewModel.java → src/main/java/org/jabref/gui/fieldeditors/optioneditors/OptionEditorViewModel.java

@@ -1,12 +1,13 @@
-package org.jabref.gui.fieldeditors;
+package org.jabref.gui.fieldeditors.optioneditors;
 
-import java.util.List;
+import java.util.Collection;
 
 import javax.swing.undo.UndoManager;
 
 import javafx.util.StringConverter;
 
 import org.jabref.gui.autocompleter.SuggestionProvider;
+import org.jabref.gui.fieldeditors.AbstractEditorViewModel;
 import org.jabref.logic.integrity.FieldCheckers;
 import org.jabref.model.entry.field.Field;
 
@@ -16,9 +17,18 @@ public OptionEditorViewModel(Field field, SuggestionProvider<?> suggestionProvid
         super(field, suggestionProvider, fieldCheckers, undoManager);
     }
 
+    /**
+     * Converts the user input to a String used in BibTeX
+     */
     public abstract StringConverter<T> getStringConverter();
 
-    public abstract List<T> getItems();
+    /**
+     * Returns all available items
+     */
+    public abstract Collection<T> getItems();
 
+    /**
+     * Used for filling the ComboBox for selecting a value. Needs to return something meaningful for each item in {@link #getItems()}
+     */
     public abstract String convertToDisplayText(T object);
 }

src/main/java/org/jabref/gui/fieldeditors/optioneditors/mapbased/CustomFieldEditorViewModel.java

@@ -0,0 +1,27 @@
+package org.jabref.gui.fieldeditors.optioneditors.mapbased;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javax.swing.undo.UndoManager;
+
+import org.jabref.gui.autocompleter.SuggestionProvider;
+import org.jabref.logic.integrity.FieldCheckers;
+import org.jabref.model.entry.field.Field;
+
+public class CustomFieldEditorViewModel extends StringMapBasedEditorViewModel {
+
+    public CustomFieldEditorViewModel(Field field, SuggestionProvider<?> suggestionProvider,
+                                      FieldCheckers fieldCheckers, UndoManager undoManager, List<String> selectorValues) {
+        super(field, suggestionProvider, fieldCheckers, undoManager, getMap(selectorValues));
+    }
+
+    private static Map<String, String> getMap(List<String> selectorValues) {
+        Map<String, String> map = new HashMap<>();
+        for (String value : selectorValues) {
+            map.put(value, value);
+        }
+        return map;
+    }
+}

src/main/java/org/jabref/gui/fieldeditors/optioneditors/mapbased/EditorTypeEditorViewModel.java

@@ -0,0 +1,24 @@
+package org.jabref.gui.fieldeditors.optioneditors.mapbased;
+
+import java.util.Map;
+
+import javax.swing.undo.UndoManager;
+
+import org.jabref.gui.autocompleter.SuggestionProvider;
+import org.jabref.logic.integrity.FieldCheckers;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.field.Field;
+
+public class EditorTypeEditorViewModel extends StringMapBasedEditorViewModel {
+
+    public EditorTypeEditorViewModel(Field field, SuggestionProvider<?> suggestionProvider, FieldCheckers fieldCheckers, UndoManager undoManager) {
+        super(field, suggestionProvider, fieldCheckers, undoManager, Map.of(
+                "editor", Localization.lang("Editor"),
+                "compiler", Localization.lang("Compiler"),
+                "founder", Localization.lang("Founder"),
+                "continuator", Localization.lang("Continuator"),
+                "redactor", Localization.lang("Redactor"),
+                "reviser", Localization.lang("Reviser"),
+                "collaborator", Localization.lang("Collaborator")));
+    }
+}

src/main/java/org/jabref/gui/fieldeditors/optioneditors/mapbased/GenderEditorViewModel.java

@@ -0,0 +1,24 @@
+package org.jabref.gui.fieldeditors.optioneditors.mapbased;
+
+import java.util.Map;
+
+import javax.swing.undo.UndoManager;
+
+import org.jabref.gui.autocompleter.SuggestionProvider;
+import org.jabref.logic.integrity.FieldCheckers;
+import org.jabref.logic.l10n.Localization;
+import org.jabref.model.entry.field.Field;
+
+public class GenderEditorViewModel extends StringMapBasedEditorViewModel {
+
+    public GenderEditorViewModel(Field field, SuggestionProvider<?> suggestionProvider, FieldCheckers fieldCheckers, UndoManager undoManager) {
+        super(field, suggestionProvider, fieldCheckers, undoManager, Map.of(
+                "sf", Localization.lang("Female name"),
+                "sm", Localization.lang("Male name"),
+                "sn", Localization.lang("Neuter name"),
+                "pf", Localization.lang("Female names"),
+                "pm", Localization.lang("Male names"),
+                "pn", Localization.lang("Neuter names"),
+                "pp", Localization.lang("Mixed names")));
+    }
+}