Changeset 18173 in josm for trunk/src/org

Timestamp:

2021-08-24T02:43:50+02:00 (3 years ago)

Author:

Don-vip

Message:

fix #20690 - fix #21240 - Refactoring of UploadDialog, HistoryComboBox and AutoCompletingComboBox (patch by marcello)

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/OpenLocationAction.java (modified) (3 diffs)
• actions/SearchNotesDownloadAction.java (modified) (3 diffs)
• actions/UploadAction.java (modified) (1 diff)
• actions/search/SearchAction.java (modified) (8 diffs)
• data/osm/search/SearchSetting.java (modified) (3 diffs)
• data/tagging/ac/AutoCompletionItem.java (modified) (1 diff)
• gui/dialogs/OsmIdSelectionDialog.java (modified) (2 diffs)
• gui/dialogs/SearchDialog.java (modified) (10 diffs)
• gui/dialogs/properties/TagEditHelper.java (modified) (13 diffs)
• gui/download/OverpassQueryWizardDialog.java (modified) (4 diffs)
• gui/download/PlaceSelection.java (modified) (2 diffs)
• gui/io/BasicUploadSettingsPanel.java (modified) (15 diffs)
• gui/io/ChangesetCommentModel.java (deleted)
• gui/io/ChangesetManagementPanel.java (modified) (5 diffs)
• gui/io/ChangesetReviewModel.java (deleted)
• gui/io/IUploadDialog.java (modified) (1 diff)
• gui/io/TagSettingsPanel.java (deleted)
• gui/io/UploadDialog.java (modified) (22 diffs)
• gui/io/UploadDialogModel.java (added)
• gui/preferences/projection/CustomProjectionChoice.java (modified) (5 diffs)
• gui/preferences/server/OsmApiUrlInputPanel.java (modified) (2 diffs)
• gui/preferences/server/OverpassServerPanel.java (modified) (2 diffs)
• gui/tagging/TagEditorModel.java (modified) (1 diff)
• gui/tagging/TagEditorPanel.java (modified) (1 diff)
• gui/tagging/ac/AutoCompComboBox.java (added)
• gui/tagging/ac/AutoCompComboBoxModel.java (added)
• gui/tagging/ac/AutoCompletingComboBox.java (modified) (1 diff)
• gui/widgets/ComboBoxHistory.java (deleted)
• gui/widgets/HistoryComboBox.java (modified) (3 diffs)
• gui/widgets/HistoryComboBoxModel.java (added)
• gui/widgets/JosmComboBox.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/actions/OpenLocationAction.java

@@ -44 +44 @@
 import org.openstreetmap.josm.gui.util.WindowGeometry;
 import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
-import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.Logging;
@@ -114 +113 @@
      */
     protected void restoreUploadAddressHistory(HistoryComboBox cbHistory) {
-        cbHistory.setPossibleItemsTopDown(Config.getPref().getList(getClass().getName() + ".uploadAddressHistory",
-                Collections.emptyList()));
+        cbHistory.getModel().prefs().load(getClass().getName() + ".uploadAddressHistory");
     }
 
@@ -124 +122 @@
     protected void remindUploadAddressHistory(HistoryComboBox cbHistory) {
         cbHistory.addCurrentItemToHistory();
-        Config.getPref().putList(getClass().getName() + ".uploadAddressHistory", cbHistory.getHistory());
+        cbHistory.getModel().prefs().save(getClass().getName() + ".uploadAddressHistory");
     }
 

trunk/src/org/openstreetmap/josm/actions/SearchNotesDownloadAction.java

@@ -8 +8 @@
 import java.awt.event.ActionEvent;
 import java.awt.event.KeyEvent;
-import java.util.Collections;
 import java.util.Optional;
 
@@ -45 +44 @@
     public void actionPerformed(ActionEvent e) {
         HistoryComboBox searchTermBox = new HistoryComboBox();
-        searchTermBox.setPossibleItemsTopDown(Config.getPref().getList(HISTORY_KEY, Collections.emptyList()));
+        searchTermBox.getModel().prefs().load(HISTORY_KEY);
 
         JPanel contentPanel = new JPanel(new GridBagLayout());
@@ -73 +72 @@
 
         searchTermBox.addCurrentItemToHistory();
-        Config.getPref().putList(HISTORY_KEY, searchTermBox.getHistory());
+        searchTermBox.getModel().prefs().save(HISTORY_KEY);
 
         performSearch(searchTerm);

trunk/src/org/openstreetmap/josm/actions/UploadAction.java

@@ -240 +240 @@
 
         final UploadDialog dialog = UploadDialog.getUploadDialog();
-        dialog.setChangesetTags(layer.getDataSet());
+        dialog.initLifeCycle(layer.getDataSet());
         dialog.setUploadedPrimitives(apiData);
         dialog.setVisible(true);

trunk/src/org/openstreetmap/josm/actions/search/SearchAction.java

@@ -14 +14 @@
 import java.util.Collections;
 import java.util.HashSet;
-import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Predicate;
-import java.util.stream.Collectors;
 
 import javax.swing.JOptionPane;
@@ -43 +41 @@
 import org.openstreetmap.josm.gui.preferences.ToolbarPreferences.ActionParser;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBoxModel;
 import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.Logging;
@@ -67 +66 @@
     private static final String SEARCH_EXPRESSION = "searchExpression";
 
-    private static final LinkedList<SearchSetting> searchHistory = new LinkedList<>();
+    private static AutoCompComboBoxModel<SearchSetting> model = new AutoCompComboBoxModel<>();
+
+    /** preferences reader/writer with automatic transmogrification to and from String */
+    private static AutoCompComboBoxModel<SearchSetting>.Preferences prefs = model.prefs(
+            SearchSetting::readFromString, SearchSetting::writeToString);
+
     static {
         SearchCompiler.addMatchFactory(new SimpleMatchFactory() {
@@ -87 +91 @@
             }
         });
-
-        for (String s: Config.getPref().getList("search.history", Collections.<String>emptyList())) {
-            SearchSetting ss = SearchSetting.readFromString(s);
-            if (ss != null) {
-                searchHistory.add(ss);
-            }
-        }
+        model.setSize(Config.getPref().getInt("search.history-size", DEFAULT_SEARCH_HISTORY_SIZE));
     }
 
     /**
      * Gets the search history
-     * @return The last searched terms. Do not modify it.
+     * @return The last searched terms.
      */
     public static Collection<SearchSetting> getSearchHistory() {
-        return searchHistory;
+        return model.asCollection();
     }
 
@@ -109 +107 @@
      */
     public static void saveToHistory(SearchSetting s) {
-        if (searchHistory.isEmpty() || !s.equals(searchHistory.getFirst())) {
-            searchHistory.addFirst(new SearchSetting(s));
-        } else if (searchHistory.contains(s)) {
-            // move existing entry to front, fixes #8032 - search history loses entries when re-using queries
-            searchHistory.remove(s);
-            searchHistory.addFirst(new SearchSetting(s));
-        }
-        int maxsize = Config.getPref().getInt("search.history-size", DEFAULT_SEARCH_HISTORY_SIZE);
-        while (searchHistory.size() > maxsize) {
-            searchHistory.removeLast();
-        }
-        List<String> savedHistory = searchHistory.stream()
-                .map(SearchSetting::writeToString)
-                .distinct()
-                .collect(Collectors.toList());
-        Config.getPref().putList("search.history", savedHistory);
+        model.addTopElement(s);
+        prefs.save("search.history");
     }
 
@@ -132 +116 @@
      */
     public static List<String> getSearchExpressionHistory() {
-        return getSearchHistory().stream()
-                .map(ss -> ss.text)
-                .collect(Collectors.toList());
+        return prefs.asStringList();
     }
 
@@ -176 +158 @@
 
         SearchDialog dialog = new SearchDialog(
-                initialValues, getSearchExpressionHistory(), ExpertToggleAction.isExpert());
+                initialValues, model, ExpertToggleAction.isExpert());
 
         if (dialog.showDialog().getValue() != 1) return null;
@@ -204 +186 @@
      */
     public static void search() {
+        prefs.load("search.history");
         SearchSetting se = showSearchDialog(lastSearch);
         if (se != null) {

trunk/src/org/openstreetmap/josm/data/osm/search/SearchSetting.java

@@ -7 +7 @@
 
 import org.openstreetmap.josm.tools.Logging;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -50 +51 @@
     @Override
     public String toString() {
+        return Utils.shortenString(text,
+            org.openstreetmap.josm.actions.search.SearchAction.MAX_LENGTH_SEARCH_EXPRESSION_DISPLAY);
+    }
+
+    /**
+     * A more talkative version of toString.
+     * @return a bit more info than toString
+     * @since 18173
+     */
+    public String toStringEx() {
         String cs = caseSensitive ?
                 /*case sensitive*/  trc("search", "CS") :
@@ -140 +151 @@
 
     /**
+     * Build a SearchSetting from a plain unformatted string.
+     * <p>
+     * All attributes are defaulted, only the search string is set. This function is used in
+     * {@link org.openstreetmap.josm.gui.download.OverpassQueryWizardDialog}.
+     *
+     * @param s The string
+     * @return The instance
+     * @since 18173
+     */
+    public static SearchSetting fromString(String s) {
+        if (s.isEmpty())
+            return null;
+        SearchSetting result = new SearchSetting();
+        result.text = s;
+        return result;
+    }
+
+    /**
      * Builds a string representation of the {@code SearchSetting} object,
      * see {@link #readFromString(String)} for more details.

trunk/src/org/openstreetmap/josm/data/tagging/ac/AutoCompletionItem.java

@@ -95 +95 @@
         if (this == obj)
             return true;
-        if (obj == null)
-            return false;
-        if (obj instanceof String)
-            return obj.equals(value);
-        if (getClass() != obj.getClass())
+        if (!(obj instanceof AutoCompletionItem))
             return false;
         final AutoCompletionItem other = (AutoCompletionItem) obj;
-        if (priority == null) {
-            if (other.priority != null)
-                return false;
-        } else if (!priority.equals(other.priority))
+        if (value == null ? other.value != null : !value.equals(other.value))
             return false;
-        if (value == null) {
-            if (other.value != null)
-                return false;
-        } else if (!value.equals(other.value))
-            return false;
-        return true;
+        return priority == null ? other.priority == null : priority.equals(other.priority);
     }
 
     @Override
     public int compareTo(AutoCompletionItem other) {
-        int ret = other.priority.compareTo(priority); // higher priority items come first in the list
-        if (ret != 0)
-            return ret;
-        else
-            return this.value.compareTo(other.value);
+        // sort on priority descending
+        int ret = other.priority.compareTo(priority);
+        // then alphabetic ascending
+        return ret != 0 ? ret : this.value.compareTo(other.value);
     }
 }

trunk/src/org/openstreetmap/josm/gui/dialogs/OsmIdSelectionDialog.java

@@ -179 +179 @@
      */
     protected void restorePrimitivesHistory(HistoryComboBox cbHistory) {
-        cbHistory.setPossibleItemsTopDown(
-                Config.getPref().getList(getClass().getName() + ".primitivesHistory", Collections.emptyList()));
+        cbHistory.getModel().prefs().load(getClass().getName() + ".primitivesHistory");
     }
 
@@ -190 +189 @@
     protected void remindPrimitivesHistory(HistoryComboBox cbHistory) {
         cbHistory.addCurrentItemToHistory();
-        Config.getPref().putList(getClass().getName() + ".primitivesHistory", cbHistory.getHistory());
+        cbHistory.getModel().prefs().save(getClass().getName() + ".primitivesHistory");
     }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/SearchDialog.java

@@ -16 +16 @@
 import java.awt.event.MouseEvent;
 import java.util.Arrays;
-import java.util.List;
 
 import javax.swing.BorderFactory;
@@ -38 +37 @@
 import org.openstreetmap.josm.gui.MainApplication;
 import org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSException;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBox;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBoxModel;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetSelector;
 import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
-import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.JosmRuntimeException;
@@ -55 +55 @@
     private final SearchSetting searchSettings;
 
-    protected final HistoryComboBox hcbSearchString = new HistoryComboBox();
+    protected final AutoCompComboBox<SearchSetting> hcbSearchString;
 
     private JCheckBox addOnToolbar;
@@ -72 +72 @@
     /**
      * Constructs a new {@code SearchDialog}.
-     * @param initialValues initial search settings
-     * @param searchExpressionHistory list of all texts that were recently used in the search
-     * @param expertMode expert mode
+     * @param initialValues initial search settings, eg. when opened for editing from the filter panel
+     * @param model The combobox model.
+     * @param expertMode expert mode. Shows more options and the "search syntax" panel.
+     * @since 18173 (signature)
      */
-    public SearchDialog(SearchSetting initialValues, List<String> searchExpressionHistory, boolean expertMode) {
-        this(initialValues, searchExpressionHistory, new PanelOptions(expertMode, false), MainApplication.getMainFrame(),
+    public SearchDialog(SearchSetting initialValues, AutoCompComboBoxModel<SearchSetting> model, boolean expertMode) {
+        this(initialValues, model, new PanelOptions(expertMode, false), MainApplication.getMainFrame(),
                 initialValues instanceof Filter ? tr("Filter") : tr("Search"),
                 initialValues instanceof Filter ? tr("Submit filter") : tr("Search"),
@@ -85 +86 @@
     }
 
-    protected SearchDialog(SearchSetting initialValues, List<String> searchExpressionHistory, PanelOptions options,
+    protected SearchDialog(SearchSetting initialValues, AutoCompComboBoxModel<SearchSetting> model, PanelOptions options,
                            Component mainFrame, String title, String... buttonTexts) {
         super(mainFrame, title, buttonTexts);
+        hcbSearchString = new AutoCompComboBox<>(model);
         this.searchSettings = new SearchSetting(initialValues);
-        setContent(buildPanel(searchExpressionHistory, options));
+        setContent(buildPanel(options));
     }
 
@@ -101 +103 @@
         /**
          * Constructs new options which determine which parts of the search dialog will be shown
-         * @param expertMode whether export mode is enabled
-         * @param overpassQuery whether the panel shall be adapted for Overpass query
+         * @param expertMode Shows more options and the "search syntax" panel.
+         * @param overpassQuery Don't show left panels and right "preset" panel. Show different "hints".
          */
         public PanelOptions(boolean expertMode, boolean overpassQuery) {
@@ -110 +112 @@
     }
 
-    private JPanel buildPanel(List<String> searchExpressionHistory, PanelOptions options) {
+    private JPanel buildPanel(PanelOptions options) {
 
         // prepare the combo box with the search expressions
@@ -116 +118 @@
 
         String tooltip = tr("Enter the search expression");
-        hcbSearchString.setText(searchSettings.text);
+        hcbSearchString.setText(searchSettings.toString());
         hcbSearchString.setToolTipText(tooltip);
-
-        hcbSearchString.setPossibleItemsTopDown(searchExpressionHistory);
         hcbSearchString.setPreferredSize(new Dimension(40, hcbSearchString.getPreferredSize().height));
         label.setLabelFor(hcbSearchString);
@@ -307 +307 @@
     }
 
-    private static JPanel buildHintsSection(HistoryComboBox hcbSearchString, PanelOptions options) {
+    private static JPanel buildHintsSection(AutoCompComboBox<SearchSetting> hcbSearchString, PanelOptions options) {
         JPanel hintPanel = new JPanel(new GridBagLayout());
         hintPanel.setBorder(BorderFactory.createTitledBorder(tr("Hints")));
@@ -466 +466 @@
     private static class SearchKeywordRow extends JPanel {
 
-        private final HistoryComboBox hcb;
-
-        SearchKeywordRow(HistoryComboBox hcb) {
+        private final AutoCompComboBox<SearchSetting> hcb;
+
+        SearchKeywordRow(AutoCompComboBox<SearchSetting> hcb) {
             super(new FlowLayout(FlowLayout.LEFT));
             this.hcb = hcb;

trunk/src/org/openstreetmap/josm/gui/dialogs/properties/TagEditHelper.java

@@ -88 +88 @@
 import org.openstreetmap.josm.gui.MainApplication;
 import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
-import org.openstreetmap.josm.gui.tagging.ac.AutoCompletingComboBox;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBox;
 import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionManager;
 import org.openstreetmap.josm.gui.util.GuiHelper;
@@ -400 +400 @@
 
     /**
+     * Returns the edited item with whitespaces removed
+     * @param cb the combobox
+     * @return the edited item with whitespaces removed
+     * @since 18173
+     */
+    public static String getEditItem(AutoCompComboBox<AutoCompletionItem> cb) {
+        return Utils.removeWhiteSpaces(cb.getEditor().getItem().toString());
+    }
+
+    /**
+     * Returns the selected item or the edited item as string
+     * @param cb the combobox
+     * @return the selected item or the edited item as string
+     * @since 18173
+     */
+    public static String getSelectedOrEditItem(AutoCompComboBox<AutoCompletionItem> cb) {
+        final Object selectedItem = cb.getSelectedItem();
+        if (selectedItem != null)
+            return selectedItem.toString();
+        return getEditItem(cb);
+    }
+
+    /**
      * Warns user about a key being overwritten.
      * @param action The action done by the user. Must state what key is changed
@@ -476 +499 @@
             List<AutoCompletionItem> keyList = autocomplete.getTagKeys(DEFAULT_AC_ITEM_COMPARATOR);
 
-            keys = new AutoCompletingComboBox(key);
-            keys.setPossibleAcItems(keyList);
+            keys = new AutoCompComboBox<>();
+            keys.getModel().setComparator(Comparator.naturalOrder()); // according to Comparable
+            keys.setPrototypeDisplayValue(new AutoCompletionItem(key));
             keys.setEditable(true);
+            keys.getModel().addAllElements(keyList);
             keys.setSelectedItem(key);
 
@@ -490 +515 @@
             final String selection = m.size() != 1 ? tr("<different>") : m.entrySet().iterator().next().getKey();
 
-            values = new AutoCompletingComboBox(selection);
+            values = new AutoCompComboBox<>();
+            values.getModel().setComparator(Comparator.naturalOrder());
+            values.setPrototypeDisplayValue(new AutoCompletionItem(selection));
             values.setRenderer(cellRenderer);
-
             values.setEditable(true);
-            values.setPossibleAcItems(valueList);
+            values.getModel().addAllElements(valueList);
             values.setSelectedItem(selection);
             values.getEditor().setItem(selection);
+
             p.add(Box.createVerticalStrut(5), GBC.eol());
             p.add(new JLabel(tr("Value")), GBC.std());
@@ -522 +549 @@
         @Override
         public void performTagEdit() {
-            String value = values.getEditItem();
+            String value = getEditItem(values);
             value = Normalizer.normalize(value, Normalizer.Form.NFC);
             if (value.isEmpty()) {
                 value = null; // delete the key
             }
-            String newkey = keys.getEditItem();
+            String newkey = getEditItem(keys);
             newkey = Normalizer.normalize(newkey, Normalizer.Form.NFC);
             if (newkey.isEmpty()) {
@@ -574 +601 @@
 
     protected abstract class AbstractTagsDialog extends ExtendedDialog {
-        protected AutoCompletingComboBox keys;
-        protected AutoCompletingComboBox values;
+        protected AutoCompComboBox<AutoCompletionItem> keys;
+        protected AutoCompComboBox<AutoCompletionItem> values;
 
         AbstractTagsDialog(Component parent, String title, String... buttonTexts) {
@@ -621 +648 @@
         }
 
-        private void selectACComboBoxSavingUnixBuffer(AutoCompletingComboBox cb) {
+        private void selectACComboBoxSavingUnixBuffer(AutoCompComboBox<AutoCompletionItem> cb) {
             // select combobox with saving unix system selection (middle mouse paste)
             Clipboard sysSel = ClipboardUtils.getSystemSelection();
@@ -667 +694 @@
                            && IntStream.range(0, size).allMatch(i -> Objects.equals(currentModel.getElementAt(i), correctItems.get(i)));
                    if (!valuesOK) {
-                       values.setPossibleAcItems(correctItems);
+                       values.getModel().removeAllElements();
+                       values.getModel().addAllElements(correctItems);
                    }
                    if (!Objects.equals(key, objKey)) {
@@ -688 +716 @@
                 return;
             }
-            buttons.get(0).setIcon(findIcon(keys.getSelectedOrEditItem(), values.getSelectedOrEditItem())
+            buttons.get(0).setIcon(findIcon(getSelectedOrEditItem(keys), getSelectedOrEditItem(values))
                     .orElse(ImageProvider.get("ok", ImageProvider.ImageSizes.LARGEICON)));
         }
@@ -732 +760 @@
 
             mainPanel = new JPanel(new GridBagLayout());
-            keys = new AutoCompletingComboBox();
-            values = new AutoCompletingComboBox();
+            keys = new AutoCompComboBox<>();
+            values = new AutoCompComboBox<>();
+            keys.getModel().setComparator(Comparator.naturalOrder()); // according to Comparable
+            values.getModel().setComparator(Comparator.naturalOrder());
+            keys.setPrototypeDisplayValue(new AutoCompletionItem("dummy"));
+            values.setPrototypeDisplayValue(new AutoCompletionItem("dummy"));
             keys.setAutocompleteEnabled(AUTOCOMPLETE_KEYS.get());
             values.setAutocompleteEnabled(AUTOCOMPLETE_VALUES.get());
@@ -748 +780 @@
             keyList.removeIf(item -> containsDataKey(item.getValue()));
 
-            keys.setPossibleAcItems(keyList);
+            keys.getModel().removeAllElements();
+            keys.getModel().addAllElements(keyList);
             keys.setEditable(true);
 
@@ -939 +972 @@
                     @Override
                     public void actionPerformed(ActionEvent e) {
-                        keys.setSelectedItem(t.getKey(), true);
+                        keys.setSelectedItem(t.getKey());
                         // fix #7951, #8298 - update list of values before setting value (?)
                         focus.focusGained(null);
-                        values.setSelectedItem(t.getValue(), true);
+                        values.setSelectedItem(t.getValue());
                         selectValuesCombobox();
                     }
@@ -1094 +1127 @@
          */
         public final void performTagAdding() {
-            String key = keys.getEditItem();
-            String value = values.getEditItem();
+            String key = getEditItem(keys);
+            String value = getEditItem(values);
             if (key.isEmpty() || value.isEmpty())
                 return;

trunk/src/org/openstreetmap/josm/gui/download/OverpassQueryWizardDialog.java

@@ -15 +15 @@
 import org.openstreetmap.josm.gui.dialogs.SearchDialog;
 import org.openstreetmap.josm.gui.download.overpass.OverpassWizardRegistration.OverpassWizardCallbacks;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBoxModel;
 import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.SearchCompilerQueryWizard;
@@ -36 +37 @@
     private static final int CANCEL = 2;
 
+    private AutoCompComboBoxModel<SearchSetting> model;
+
+    /** preferences reader/writer with automatic transmogrification to and from String */
+    private AutoCompComboBoxModel<SearchSetting>.Preferences prefs;
+
     /**
      * Create a new {@link OverpassQueryWizardDialog}
@@ -41 +47 @@
      */
     public OverpassQueryWizardDialog(OverpassWizardCallbacks callbacks) {
-        super(new SearchSetting(), OVERPASS_WIZARD_HISTORY.get(), new PanelOptions(false, true), callbacks.getParent(),
+        super(new SearchSetting(), new AutoCompComboBoxModel<>(), new PanelOptions(false, true), callbacks.getParent(),
                 tr("Overpass Query Wizard"),
                 tr("Build query"), tr("Build query and execute"), tr("Cancel"));
         this.callbacks = callbacks;
+        model = hcbSearchString.getModel();
         setButtonIcons("dialogs/magic-wand", "download-overpass", "cancel");
         setCancelButton(CANCEL + 1);
         setDefaultButton(BUILD_AN_EXECUTE_QUERY + 1);
+        prefs = model.prefs(SearchSetting::fromString, SearchSetting::toString);
+        prefs.load(OVERPASS_WIZARD_HISTORY);
     }
 
@@ -76 +85 @@
      */
     private void saveHistory() {
-        hcbSearchString.addCurrentItemToHistory();
-        OVERPASS_WIZARD_HISTORY.put(hcbSearchString.getHistory());
+        hcbSearchString.getModel().addTopElement(SearchSetting.fromString(hcbSearchString.getText()));
+        prefs.save(OVERPASS_WIZARD_HISTORY);
     }
 

trunk/src/org/openstreetmap/josm/gui/download/PlaceSelection.java

@@ -117 +117 @@
         cbSearchExpression = new HistoryComboBox();
         cbSearchExpression.setToolTipText(tr("Enter a place name to search for"));
-        cbSearchExpression.setPossibleItemsTopDown(Config.getPref().getList(HISTORY_KEY, Collections.emptyList()));
+        cbSearchExpression.getModel().prefs().load(HISTORY_KEY);
         lpanel.add(cbSearchExpression, GBC.std(1, 1).fill(GBC.HORIZONTAL));
 
@@ -195 +195 @@
                 return;
             cbSearchExpression.addCurrentItemToHistory();
-            Config.getPref().putList(HISTORY_KEY, cbSearchExpression.getHistory());
+            cbSearchExpression.getModel().prefs().save(HISTORY_KEY);
             Server server = (Server) serverComboBox.getSelectedItem();
             URL url = server.urlFunction.apply(searchExpression, isSearchMore ? model.getData() : Collections.emptyList());

trunk/src/org/openstreetmap/josm/gui/io/BasicUploadSettingsPanel.java

@@ -4 +4 @@
 import static org.openstreetmap.josm.tools.I18n.tr;
 
+import java.awt.Component;
 import java.awt.GridBagLayout;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
-import java.awt.event.FocusAdapter;
 import java.awt.event.FocusEvent;
+import java.awt.event.FocusListener;
 import java.awt.event.ItemEvent;
-import java.awt.event.KeyAdapter;
+import java.awt.event.ItemListener;
 import java.awt.event.KeyEvent;
+import java.awt.event.KeyListener;
+import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.LinkedList;
+import java.util.Collection;
 import java.util.List;
-import java.util.Objects;
+import java.util.Map;
+import java.util.Optional;
 import java.util.concurrent.TimeUnit;
 
@@ -24 +28 @@
 import javax.swing.JPanel;
 import javax.swing.JTextField;
-import javax.swing.SwingUtilities;
-import javax.swing.event.AncestorEvent;
-import javax.swing.event.AncestorListener;
-import javax.swing.event.ChangeEvent;
-import javax.swing.event.ChangeListener;
-import javax.swing.event.DocumentEvent;
-import javax.swing.event.DocumentListener;
 import javax.swing.event.HyperlinkEvent;
+import javax.swing.event.TableModelEvent;
+import javax.swing.event.TableModelListener;
 
 import org.openstreetmap.josm.data.osm.Changeset;
@@ -39 +38 @@
 import org.openstreetmap.josm.gui.io.UploadTextComponentValidator.UploadCommentValidator;
 import org.openstreetmap.josm.gui.io.UploadTextComponentValidator.UploadSourceValidator;
+import org.openstreetmap.josm.gui.tagging.TagModel;
 import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
 import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
@@ -49 +49 @@
  * @since 2599
  */
-public class BasicUploadSettingsPanel extends JPanel {
-    /**
-     * Preference name for history collection
-     */
-    public static final String HISTORY_KEY = "upload.comment.history";
+public class BasicUploadSettingsPanel extends JPanel implements ActionListener, FocusListener, ItemListener, KeyListener, TableModelListener {
+    /**
+     * Preference name for the history of comments
+     */
+    public static final String COMMENT_HISTORY_KEY = "upload.comment.history";
     /**
      * Preference name for last used upload comment
      */
-    public static final String HISTORY_LAST_USED_KEY = "upload.comment.last-used";
+    public static final String COMMENT_LAST_USED_KEY = "upload.comment.last-used";
     /**
      * Preference name for the max age search comments may have
      */
-    public static final String HISTORY_MAX_AGE_KEY = "upload.comment.max-age";
-    /**
-     * Preference name for the history of source values
+    public static final String COMMENT_MAX_AGE_KEY = "upload.comment.max-age";
+    /**
+     * Preference name for the history of sources
      */
     public static final String SOURCE_HISTORY_KEY = "upload.source.history";
@@ -79 +79 @@
     private final UploadAreaValidator areaValidator = new UploadAreaValidator(new JTextField(), areaValidatorFeedback);
     /** the changeset comment model */
-    private final transient ChangesetCommentModel changesetCommentModel;
-    private final transient ChangesetCommentModel changesetSourceModel;
-    private final transient ChangesetReviewModel changesetReviewModel;
+    private final transient UploadDialogModel model;
     private final transient JLabel uploadCommentFeedback = new JLabel();
     private final transient UploadCommentValidator uploadCommentValidator = new UploadCommentValidator(
@@ -89 +87 @@
             hcbUploadSource.getEditorComponent(), hcbUploadSourceFeedback);
 
+    /** a lock to prevent loops in notifications */
+    private boolean locked;
+
+    /**
+     * Creates the panel
+     *
+     * @param model The tag editor model.
+     *
+     * @since 18173 (signature)
+     */
+    public BasicUploadSettingsPanel(UploadDialogModel model) {
+        this.model = model;
+        this.model.addTableModelListener(this);
+        build();
+    }
+
     protected JPanel buildUploadCommentPanel() {
         JPanel pnl = new JPanel(new GridBagLayout());
@@ -95 +109 @@
         hcbUploadComment.setToolTipText(tr("Enter an upload comment"));
         hcbUploadComment.setMaxTextLength(Changeset.MAX_CHANGESET_TAG_LENGTH);
-        populateHistoryComboBox(hcbUploadComment, HISTORY_KEY, new LinkedList<>());
-        CommentModelListener commentModelListener = new CommentModelListener(hcbUploadComment, changesetCommentModel);
-        hcbUploadComment.getEditor().addActionListener(commentModelListener);
-        hcbUploadComment.getEditorComponent().addFocusListener(commentModelListener);
-        hcbUploadComment.getEditorComponent().getDocument().addDocumentListener(commentModelListener);
+        JTextField editor = hcbUploadComment.getEditorComponent();
+        editor.getDocument().putProperty("tag", "comment");
+        editor.addKeyListener(this);
+        editor.addFocusListener(this);
+        editor.addActionListener(this);
         pnl.add(hcbUploadComment, GBC.eol().fill(GBC.HORIZONTAL));
         pnl.add(uploadCommentFeedback, GBC.eol().insets(0, 3, 0, 0).fill(GBC.HORIZONTAL));
@@ -113 +127 @@
         obtainSourceOnce.addHyperlinkListener(e -> {
             if (HyperlinkEvent.EventType.ACTIVATED.equals(e.getEventType())) {
-                automaticallyAddSource();
+                saveEdits();
+                model.put("source", getSourceFromLayer());
             }
         });
         obtainSourceAutomatically.setSelected(Config.getPref().getBoolean("upload.source.obtainautomatically", false));
         obtainSourceAutomatically.addActionListener(e -> {
-            if (obtainSourceAutomatically.isSelected())
-                automaticallyAddSource();
-
+            if (obtainSourceAutomatically.isSelected()) {
+                model.put("source", getSourceFromLayer());
+            }
             obtainSourceOnce.setVisible(!obtainSourceAutomatically.isSelected());
         });
@@ -133 +148 @@
         hcbUploadSource.setToolTipText(tr("Enter a source"));
         hcbUploadSource.setMaxTextLength(Changeset.MAX_CHANGESET_TAG_LENGTH);
-        populateHistoryComboBox(hcbUploadSource, SOURCE_HISTORY_KEY, getDefaultSources());
-        CommentModelListener sourceModelListener = new CommentModelListener(hcbUploadSource, changesetSourceModel);
-        hcbUploadSource.getEditor().addActionListener(sourceModelListener);
-        hcbUploadSource.getEditorComponent().addFocusListener(sourceModelListener);
-        hcbUploadSource.getEditorComponent().getDocument().addDocumentListener(sourceModelListener);
+        JTextField editor = hcbUploadSource.getEditorComponent();
+        editor.getDocument().putProperty("tag", "source");
+        editor.addKeyListener(this);
+        editor.addFocusListener(this);
+        editor.addActionListener(this);
         pnl.add(hcbUploadSource, GBC.eol().fill(GBC.HORIZONTAL));
         pnl.add(hcbUploadSourceFeedback, GBC.eol().insets(0, 3, 0, 0).fill(GBC.HORIZONTAL));
+
+        return pnl;
+    }
+
+    /**
+     * Initializes this life cycle of the panel.
+     *
+     * Adds any changeset tags to the map.
+     *
+     * @param map Map where tags are added to.
+     * @since 18173
+     */
+    public void initLifeCycle(Map<String, String> map) {
+        Optional.ofNullable(getLastChangesetTagFromHistory(COMMENT_HISTORY_KEY, new ArrayList<>())).ifPresent(
+                x -> map.put("comment", x));
+        Optional.ofNullable(getLastChangesetTagFromHistory(SOURCE_HISTORY_KEY, getDefaultSources())).ifPresent(
+                x -> map.put("source", x));
         if (obtainSourceAutomatically.isSelected()) {
-            automaticallyAddSource();
-        }
-        pnl.addAncestorListener(new AncestorListener() {
-            @Override
-            public void ancestorAdded(AncestorEvent event) {
-                if (obtainSourceAutomatically.isSelected())
-                    automaticallyAddSource();
-            }
-
-            @Override
-            public void ancestorRemoved(AncestorEvent event) {
-                // Do nothing
-            }
-
-            @Override
-            public void ancestorMoved(AncestorEvent event) {
-                // Do nothing
-            }
-        });
-        return pnl;
-    }
-
-    /**
-     * Add the source tags
-     */
-    protected void automaticallyAddSource() {
-        final String source = MainApplication.getMap().mapView.getLayerInformationForSourceTag();
-        hcbUploadSource.getModel().setSelectedItem(null); // fix #20134
-        hcbUploadSource.setText(Utils.shortenString(source, Changeset.MAX_CHANGESET_TAG_LENGTH));
-        changesetSourceModel.setComment(hcbUploadSource.getText()); // Fix #9965
-    }
-
-    /**
-     * Refreshes contents of upload history combo boxes from preferences.
-     */
-    protected void refreshHistoryComboBoxes() {
-        populateHistoryComboBox(hcbUploadComment, HISTORY_KEY, new LinkedList<>());
-        populateHistoryComboBox(hcbUploadSource, SOURCE_HISTORY_KEY, getDefaultSources());
-    }
-
-    private static void populateHistoryComboBox(HistoryComboBox hcb, String historyKey, List<String> defaultValues) {
-        hcb.setPossibleItemsTopDown(Config.getPref().getList(historyKey, defaultValues));
-        hcb.discardAllUndoableEdits();
-    }
-
-    /**
-     * Discards undoable edits of upload history combo boxes.
-     */
-    protected void discardAllUndoableEdits() {
+            map.put("source", getSourceFromLayer());
+        }
+        hcbUploadComment.getModel().prefs().load(COMMENT_HISTORY_KEY);
         hcbUploadComment.discardAllUndoableEdits();
+        hcbUploadSource.getModel().prefs().load(SOURCE_HISTORY_KEY, getDefaultSources());
         hcbUploadSource.discardAllUndoableEdits();
+    }
+
+    /**
+     * Get a key's value from the model.
+     * @param key The key
+     * @return The value or ""
+     * @since 18173
+     */
+    private String get(String key) {
+        TagModel tm = model.get(key);
+        return tm == null ? "" : tm.getValue();
+    }
+
+    /**
+     * Get the topmost item from the history if not expired.
+     *
+     * @param historyKey The preferences key.
+     * @param def A default history.
+     * @return The history item (may be null).
+     * @since 18173 (signature)
+     */
+    public static String getLastChangesetTagFromHistory(String historyKey, List<String> def) {
+        Collection<String> history = Config.getPref().getList(historyKey, def);
+        long age = TimeUnit.MILLISECONDS.toSeconds(System.currentTimeMillis()) - getHistoryLastUsedKey();
+        if (age < getHistoryMaxAgeKey() && !history.isEmpty()) {
+            return history.iterator().next();
+        }
+        return null;
+    }
+
+    /**
+     * Add the "source" tag
+     * @return The source from the layer info.
+     */
+    private String getSourceFromLayer() {
+        String source = MainApplication.getMap().mapView.getLayerInformationForSourceTag();
+        return Utils.shortenString(source, Changeset.MAX_CHANGESET_TAG_LENGTH);
     }
 
@@ -220 +244 @@
         if (Config.getPref().getBoolean("upload.show.review.request", true)) {
             add(cbRequestReview, gbc);
-            cbRequestReview.addItemListener(e -> changesetReviewModel.setReviewRequested(e.getStateChange() == ItemEvent.SELECTED));
+            cbRequestReview.addItemListener(this);
         }
         add(areaValidatorFeedback, gbc);
         add(new JPanel(), GBC.std().fill(GBC.BOTH));
-    }
-
-    /**
-     * Creates the panel
-     *
-     * @param changesetCommentModel the model for the changeset comment. Must not be null
-     * @param changesetSourceModel the model for the changeset source. Must not be null.
-     * @param changesetReviewModel the model for the changeset review. Must not be null.
-     * @throws NullPointerException if a model is null
-     * @since 12719 (signature)
-     */
-    public BasicUploadSettingsPanel(ChangesetCommentModel changesetCommentModel, ChangesetCommentModel changesetSourceModel,
-            ChangesetReviewModel changesetReviewModel) {
-        this.changesetCommentModel = Objects.requireNonNull(changesetCommentModel, "changesetCommentModel");
-        this.changesetSourceModel = Objects.requireNonNull(changesetSourceModel, "changesetSourceModel");
-        this.changesetReviewModel = Objects.requireNonNull(changesetReviewModel, "changesetReviewModel");
-        changesetCommentModel.addChangeListener(new ChangesetCommentChangeListener(hcbUploadComment));
-        changesetSourceModel.addChangeListener(new ChangesetCommentChangeListener(hcbUploadSource));
-        changesetReviewModel.addChangeListener(new ChangesetReviewChangeListener());
-        build();
-    }
-
-    void setUploadTagDownFocusTraversalHandlers(final ActionListener handler) {
-        setHistoryComboBoxDownFocusTraversalHandler(handler, hcbUploadComment);
-        setHistoryComboBoxDownFocusTraversalHandler(handler, hcbUploadSource);
-    }
-
-    private static void setHistoryComboBoxDownFocusTraversalHandler(ActionListener handler, HistoryComboBox hcb) {
-        hcb.getEditor().addActionListener(handler);
-        hcb.getEditorComponent().addKeyListener(new HistoryComboBoxKeyAdapter(hcb, handler));
     }
 
@@ -263 +257 @@
         if (getHistoryMaxAgeKey() > 0) {
             hcbUploadComment.addCurrentItemToHistory();
-            Config.getPref().putList(HISTORY_KEY, hcbUploadComment.getHistory());
-            Config.getPref().putLong(HISTORY_LAST_USED_KEY, TimeUnit.MILLISECONDS.toSeconds(System.currentTimeMillis()));
+            hcbUploadComment.getModel().prefs().save(COMMENT_HISTORY_KEY);
+            Config.getPref().putLong(COMMENT_LAST_USED_KEY, TimeUnit.MILLISECONDS.toSeconds(System.currentTimeMillis()));
         }
         // store the history of sources
         hcbUploadSource.addCurrentItemToHistory();
-        Config.getPref().putList(SOURCE_HISTORY_KEY, hcbUploadSource.getHistory());
+        hcbUploadSource.getModel().prefs().save(SOURCE_HISTORY_KEY);
 
         // store current value of obtaining source automatically
@@ -278 +272 @@
      */
     public void startUserInput() {
-        hcbUploadComment.requestFocusInWindow();
         hcbUploadComment.getEditorComponent().requestFocusInWindow();
         uploadCommentValidator.validate();
@@ -312 +305 @@
     }
 
-    /**
-     * Forces update of comment/source model if matching text field is focused.
-     * @since 14977
-     */
-    public void forceUpdateActiveField() {
-        updateModelIfFocused(hcbUploadComment, changesetCommentModel);
-        updateModelIfFocused(hcbUploadSource, changesetSourceModel);
-    }
-
-    private static void updateModelIfFocused(HistoryComboBox hcb, ChangesetCommentModel changesetModel) {
-        if (hcb.getEditorComponent().hasFocus()) {
-            changesetModel.setComment(hcb.getText());
-        }
-    }
-
     static long getHistoryMaxAgeKey() {
-        return Config.getPref().getLong(HISTORY_MAX_AGE_KEY, TimeUnit.HOURS.toSeconds(4));
+        return Config.getPref().getLong(COMMENT_MAX_AGE_KEY, TimeUnit.HOURS.toSeconds(4));
     }
 
     static long getHistoryLastUsedKey() {
-        return Config.getPref().getLong(BasicUploadSettingsPanel.HISTORY_LAST_USED_KEY, 0);
-    }
-
-    static final class HistoryComboBoxKeyAdapter extends KeyAdapter {
-        private final HistoryComboBox hcb;
-        private final ActionListener handler;
-
-        HistoryComboBoxKeyAdapter(HistoryComboBox hcb, ActionListener handler) {
-            this.hcb = hcb;
-            this.handler = handler;
-        }
-
-        @Override
-        public void keyTyped(KeyEvent e) {
-            if (e.getKeyCode() == KeyEvent.VK_TAB) {
-                handler.actionPerformed(new ActionEvent(hcb, 0, "focusDown"));
+        return Config.getPref().getLong(COMMENT_LAST_USED_KEY, 0);
+    }
+
+    /**
+     * Updates the combobox histories when a combobox editor loses focus.
+     *
+     * @param text The {@code JTextField} of the combobox editor.
+     */
+    private void updateHistory(JTextField text) {
+        String tag = (String) text.getDocument().getProperty("tag"); // tag is either "comment" or "source"
+        if (tag.equals("comment")) {
+            hcbUploadComment.addCurrentItemToHistory();
+        }
+        if (tag.equals("source")) {
+            hcbUploadSource.addCurrentItemToHistory();
+        }
+    }
+
+    /**
+     * Updates the table editor model with changes in the comboboxes.
+     *
+     * The lock prevents loops in change notifications, eg. the combobox
+     * notifies the table model and the table model notifies the combobox, which
+     * throws IllegalStateException.
+     *
+     * @param text The {@code JTextField} of the combobox editor.
+     */
+    private void updateModel(JTextField text) {
+        if (!locked) {
+            locked = true;
+            try {
+                String tag = (String) text.getDocument().getProperty("tag"); // tag is either "comment" or "source"
+                String value = text.getText();
+                model.put(tag, value.isEmpty() ? null : value); // remove tags with empty values
+            } finally {
+                locked = false;
             }
         }
@@ -353 +351 @@
 
     /**
-     * Updates the changeset comment model upon changes in the input field.
-     */
-    static class CommentModelListener extends FocusAdapter implements ActionListener, DocumentListener {
-
-        private final HistoryComboBox source;
-        private final ChangesetCommentModel destination;
-
-        CommentModelListener(HistoryComboBox source, ChangesetCommentModel destination) {
-            this.source = source;
-            this.destination = destination;
-        }
-
-        private void setComment() {
-            SwingUtilities.invokeLater(() -> destination.setComment(source.getText()));
-        }
-
-        @Override
-        public void actionPerformed(ActionEvent e) {
-            setComment();
-        }
-
-        @Override
-        public void focusLost(FocusEvent e) {
-            setComment();
-        }
-
-        @Override
-        public void insertUpdate(DocumentEvent e) {
-            setComment();
-        }
-
-        @Override
-        public void removeUpdate(DocumentEvent e) {
-            setComment();
-        }
-
-        @Override
-        public void changedUpdate(DocumentEvent e) {
-            setComment();
-        }
-    }
-
-    /**
-     * Observes the changeset comment model and keeps the comment input field
-     * in sync with the current changeset comment
-     */
-    static class ChangesetCommentChangeListener implements ChangeListener {
-
-        private final HistoryComboBox destination;
-
-        ChangesetCommentChangeListener(HistoryComboBox destination) {
-            this.destination = destination;
-        }
-
-        @Override
-        public void stateChanged(ChangeEvent e) {
-            if (!(e.getSource() instanceof ChangesetCommentModel)) return;
-            String newComment = ((ChangesetCommentModel) e.getSource()).getComment();
-            if (!destination.getText().trim().equals(newComment)) {
-                destination.setText(newComment);
+     * Save all outstanding edits to the model.
+     * @see UploadDialog#saveEdits
+     * @since 18173
+     */
+    public void saveEdits() {
+        updateModel(hcbUploadComment.getEditorComponent());
+        hcbUploadComment.addCurrentItemToHistory();
+        updateModel(hcbUploadSource.getEditorComponent());
+        hcbUploadSource.addCurrentItemToHistory();
+    }
+
+    /**
+     * Returns the UplodDialog that is our ancestor
+     *
+     * @return the UploadDialog or null
+     */
+    private UploadDialog getDialog() {
+        Component d = getRootPane();
+        while ((d = d.getParent()) != null) {
+            if (d instanceof UploadDialog)
+                return (UploadDialog) d;
+        }
+        return null;
+    }
+
+    /**
+     * Update the model when the selection changes in a combobox.
+     * @param e The action event.
+     */
+    @Override
+    public void actionPerformed(ActionEvent e) {
+        getDialog().setFocusToUploadButton();
+    }
+
+    @Override
+    public void focusGained(FocusEvent e) {
+    }
+
+    /**
+     * Update the model and combobox history when a combobox editor loses focus.
+     */
+    @Override
+    public void focusLost(FocusEvent e) {
+        Object c = e.getSource();
+        if (c instanceof JTextField) {
+            updateModel((JTextField) c);
+            updateHistory((JTextField) c);
+        }
+    }
+
+    /**
+     * Updates the table editor model upon changes in the "review" checkbox.
+     */
+    @Override
+    public void itemStateChanged(ItemEvent e) {
+        if (!locked) {
+            locked = true;
+            try {
+                model.put("review_requested", e.getStateChange() == ItemEvent.SELECTED ? "yes" : null);
+            } finally {
+                locked = false;
             }
         }
@@ -418 +417 @@
 
     /**
-     * Observes the changeset review model and keeps the review checkbox
-     * in sync with the current changeset review request
-     */
-    class ChangesetReviewChangeListener implements ChangeListener {
-        @Override
-        public void stateChanged(ChangeEvent e) {
-            if (!(e.getSource() instanceof ChangesetReviewModel)) return;
-            boolean newState = ((ChangesetReviewModel) e.getSource()).isReviewRequested();
-            if (cbRequestReview.isSelected() != newState) {
-                cbRequestReview.setSelected(newState);
+     * Updates the controls upon changes in the table editor model.
+     */
+    @Override
+    public void tableChanged(TableModelEvent e) {
+        if (!locked) {
+            locked = true;
+            try {
+                hcbUploadComment.setText(get("comment"));
+                hcbUploadSource.setText(get("source"));
+                cbRequestReview.setSelected(get("review_requested").equals("yes"));
+            } finally {
+                locked = false;
             }
         }
     }
+
+    /**
+     * Set the focus directly to the upload button if "Enter" key is pressed in any combobox.
+     */
+    @Override
+    public void keyTyped(KeyEvent e) {
+        if (e.getKeyChar() == KeyEvent.VK_ENTER) {
+            getDialog().setFocusToUploadButton();
+        }
+    }
+
+    @Override
+    public void keyPressed(KeyEvent e) {
+    }
+
+    @Override
+    public void keyReleased(KeyEvent e) {
+    }
 }

trunk/src/org/openstreetmap/josm/gui/io/ChangesetManagementPanel.java

@@ -29 +29 @@
 import org.openstreetmap.josm.gui.widgets.JosmComboBox;
 import org.openstreetmap.josm.spi.preferences.Config;
-import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.ImageProvider;
 
@@ -56 +55 @@
     private OpenChangesetComboBoxModel model;
 
+    /** the changeset comment model */
+    private final transient UploadDialogModel uploadDialogModel;
+
     /**
      * Constructs a new {@code ChangesetManagementPanel}.
      *
-     * @param changesetCommentModel the changeset comment model. Must not be null.
-     * @throws IllegalArgumentException if {@code changesetCommentModel} is null
-     */
-    public ChangesetManagementPanel(ChangesetCommentModel changesetCommentModel) {
-        CheckParameterUtil.ensureParameterNotNull(changesetCommentModel, "changesetCommentModel");
+     * @param uploadDialogModel The tag editor model.
+     *
+     * @since 18173 (signature)
+     */
+    public ChangesetManagementPanel(UploadDialogModel uploadDialogModel) {
+        this.uploadDialogModel = uploadDialogModel;
         build();
         refreshGUI();
@@ -273 +276 @@
                 Changeset cs = (Changeset) cbOpenChangesets.getSelectedItem();
                 if (cs == null) return;
+                uploadDialogModel.putAll(getSelectedChangeset().getKeys());
                 firePropertyChange(SELECTED_CHANGESET_PROP, null, cs);
             }
@@ -280 +284 @@
     /**
      * Refreshes the list of open changesets
-     *
      */
     class RefreshAction extends AbstractAction {
@@ -296 +299 @@
     /**
      * Closes the currently selected changeset
-     *
      */
     class CloseChangesetAction extends AbstractAction implements ItemListener {

trunk/src/org/openstreetmap/josm/gui/io/IUploadDialog.java

@@ -66 +66 @@
      */
     void handleIllegalChunkSize();
-
-    /**
-     * Forces update of comment/source model if matching text field is active.
-     * @since 14977
-     */
-    void forceUpdateActiveField();
 }

trunk/src/org/openstreetmap/josm/gui/io/UploadDialog.java

@@ -18 +18 @@
 import java.lang.Character.UnicodeBlock;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Collections;
 import java.util.HashMap;
-import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Locale;
@@ -27 +25 @@
 import java.util.Map.Entry;
 import java.util.Optional;
-import java.util.Set;
 import java.util.stream.Collectors;
 
@@ -40 +37 @@
 
 import org.openstreetmap.josm.data.APIDataSet;
-import org.openstreetmap.josm.data.Version;
 import org.openstreetmap.josm.data.osm.Changeset;
 import org.openstreetmap.josm.data.osm.DataSet;
@@ -48 +44 @@
 import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
 import org.openstreetmap.josm.gui.help.HelpUtil;
+import org.openstreetmap.josm.gui.tagging.TagEditorPanel;
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.gui.util.MultiLineFlowLayout;
@@ -61 +58 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.InputMapUtils;
+import org.openstreetmap.josm.tools.Logging;
 import org.openstreetmap.josm.tools.Utils;
 
@@ -72 +70 @@
     private static UploadDialog uploadDialog;
 
-    /** the "created_by" changeset OSM key */
-    private static final String CREATED_BY = "created_by";
-
     /** the panel with the objects to upload */
     private UploadedObjectsSummaryPanel pnlUploadedObjects;
@@ -85 +80 @@
 
     private TitledBorder tagSettingsBorder;
-    /** checkbox for selecting whether an atomic upload is to be used  */
-    private TagSettingsPanel pnlTagSettings;
+    /** a border around the tag editor panel */
+    private JPanel pnlTagEditorBorder;
+    /** the tag editor panel */
+    private TagEditorPanel pnlTagEditor;
     /** the tabbed pane used below of the list of primitives  */
     private JTabbedPane tpConfigPanels;
@@ -92 +89 @@
     private JButton btnUpload;
 
-    /** the changeset comment model keeping the state of the changeset comment */
-    private final transient ChangesetCommentModel changesetCommentModel = new ChangesetCommentModel();
-    private final transient ChangesetCommentModel changesetSourceModel = new ChangesetCommentModel();
-    private final transient ChangesetReviewModel changesetReviewModel = new ChangesetReviewModel();
+    /** the model keeping the state of the changeset tags */
+    private final transient UploadDialogModel model = new UploadDialogModel();
 
     private transient DataSet dataSet;
@@ -138 +133 @@
         splitPane.setRightComponent(tpConfigPanels);
 
-        pnlBasicUploadSettings = new BasicUploadSettingsPanel(changesetCommentModel, changesetSourceModel, changesetReviewModel);
+        pnlBasicUploadSettings = new BasicUploadSettingsPanel(model);
         tpConfigPanels.add(pnlBasicUploadSettings);
         tpConfigPanels.setTitleAt(0, tr("Description"));
-        tpConfigPanels.setToolTipTextAt(0, tr("Decide how to upload the data and which changeset to use"));
-
+        tpConfigPanels.setToolTipTextAt(0, tr("Describe the changes you made"));
+
+        JPanel pnlSettings = new JPanel(new GridBagLayout());
+        pnlTagEditorBorder = new JPanel(new BorderLayout());
         tagSettingsBorder = BorderFactory.createTitledBorder(tr("Tags of new changeset"));
-        pnlTagSettings = new TagSettingsPanel(changesetCommentModel, changesetSourceModel, changesetReviewModel);
-        pnlTagSettings.setBorder(tagSettingsBorder);
-        pnlChangesetManagement = new ChangesetManagementPanel(changesetCommentModel);
+        pnlTagEditorBorder.setBorder(tagSettingsBorder);
+        pnlTagEditor = new TagEditorPanel(model, null, Changeset.MAX_CHANGESET_TAG_LENGTH);
+        pnlTagEditorBorder.add(pnlTagEditor, BorderLayout.CENTER);
+
+        pnlChangesetManagement = new ChangesetManagementPanel(model);
         pnlUploadStrategySelectionPanel = new UploadStrategySelectionPanel();
-        JPanel pnlChangeset = new JPanel(new GridBagLayout());
-        pnlChangeset.add(pnlChangesetManagement, GBC.eop().fill(GBC.HORIZONTAL));
-        pnlChangeset.add(pnlUploadStrategySelectionPanel, GBC.eop().fill(GBC.HORIZONTAL));
-        pnlChangeset.add(pnlTagSettings, GBC.eol().fill(GBC.BOTH));
-        tpConfigPanels.add(pnlChangeset);
+        pnlSettings.add(pnlChangesetManagement, GBC.eop().fill(GBC.HORIZONTAL));
+        pnlSettings.add(pnlUploadStrategySelectionPanel, GBC.eop().fill(GBC.HORIZONTAL));
+        pnlSettings.add(pnlTagEditorBorder, GBC.eol().fill(GBC.BOTH));
+
+        tpConfigPanels.add(pnlSettings);
         tpConfigPanels.setTitleAt(1, tr("Settings"));
+        tpConfigPanels.setToolTipTextAt(1, tr("Decide how to upload the data and which changeset to use"));
 
         JPanel pnl = new JPanel(new BorderLayout());
@@ -181 +181 @@
         pnl.add(new JButton(cancelAction));
         InputMapUtils.addEscapeAction(getRootPane(), cancelAction);
+
+        // -- help button
         pnl.add(new JButton(new ContextSensitiveHelpAction(ht("/Dialog/Upload"))));
         HelpUtil.setHelpContext(getRootPane(), ht("/Dialog/Upload"));
@@ -201 +203 @@
                 pnlBasicUploadSettings.getUploadParameterSummaryPanel()
         );
-        pnlChangesetManagement.addPropertyChangeListener(this);
+        pnlUploadedObjects.addPropertyChangeListener(pnlUploadStrategySelectionPanel);
         pnlUploadedObjects.addPropertyChangeListener(
                 pnlBasicUploadSettings.getUploadParameterSummaryPanel()
         );
-        pnlUploadedObjects.addPropertyChangeListener(pnlUploadStrategySelectionPanel);
+        pnlUploadStrategySelectionPanel.addPropertyChangeListener(this);
         pnlUploadStrategySelectionPanel.addPropertyChangeListener(
                 pnlBasicUploadSettings.getUploadParameterSummaryPanel()
@@ -218 +220 @@
         );
 
-        pnlBasicUploadSettings.setUploadTagDownFocusTraversalHandlers(e -> btnUpload.requestFocusInWindow());
-
         // Enable/disable the upload button if at least an upload validator rejects upload
         pnlBasicUploadSettings.getUploadTextValidators().forEach(v -> v.addChangeListener(e -> btnUpload.setEnabled(
@@ -227 +227 @@
 
         Config.getPref().addPreferenceChangeListener(this);
+    }
+
+    /**
+     * Initializes this life cycle of the dialog.
+     *
+     * Initializes the dialog each time before it is made visible. We cannot do
+     * this in the constructor because the dialog is a singleton.
+     *
+     * @param dataSet The Dataset we want to upload
+     * @since 18173
+     */
+    public void initLifeCycle(DataSet dataSet) {
+        Map<String, String> map = new HashMap<>();
+        this.dataSet = dataSet;
+        pnlBasicUploadSettings.initLifeCycle(map);
+        model.clear();
+        model.putAll(map);
+        model.putAll(this.dataSet);
     }
 
@@ -253 +271 @@
 
     /**
-     * Sets the tags for this upload based on (later items overwrite earlier ones):
-     * <ul>
-     * <li>previous "source" and "comment" input</li>
-     * <li>the tags set in the dataset (see {@link DataSet#getChangeSetTags()})</li>
-     * <li>the tags from the selected open changeset</li>
-     * <li>the JOSM user agent (see {@link Version#getAgentString(boolean)})</li>
-     * </ul>
-     *
-     * @param dataSet to obtain the tags set in the dataset
-     */
-    public void setChangesetTags(DataSet dataSet) {
-        setChangesetTags(dataSet, false);
-    }
-
-    /**
-     * Sets the tags for this upload based on (later items overwrite earlier ones):
-     * <ul>
-     * <li>previous "source" and "comment" input</li>
-     * <li>the tags set in the dataset (see {@link DataSet#getChangeSetTags()})</li>
-     * <li>the tags from the selected open changeset</li>
-     * <li>the JOSM user agent (see {@link Version#getAgentString(boolean)})</li>
-     * </ul>
-     *
-     * @param dataSet to obtain the tags set in the dataset
-     * @param keepSourceComment if {@code true}, keep upload {@code source} and {@code comment} current values from models
-     */
-    private void setChangesetTags(DataSet dataSet, boolean keepSourceComment) {
-        final Map<String, String> tags = new HashMap<>();
-
-        // obtain from previous input
-        if (!keepSourceComment) {
-            tags.put("source", getLastChangesetSourceFromHistory());
-            tags.put("comment", getCommentWithDataSetHashTag(getLastChangesetCommentFromHistory(), dataSet));
-        }
-
-        // obtain from dataset
-        if (dataSet != null) {
-            tags.putAll(dataSet.getChangeSetTags());
-        }
-        this.dataSet = dataSet;
-
-        // obtain from selected open changeset
-        if (pnlChangesetManagement.getSelectedChangeset() != null) {
-            tags.putAll(pnlChangesetManagement.getSelectedChangeset().getKeys());
-        }
-
-        // set/adapt created_by
-        final String agent = Version.getInstance().getAgentString(false);
-        final String createdBy = tags.get(CREATED_BY);
-        if (createdBy == null || createdBy.isEmpty()) {
-            tags.put(CREATED_BY, agent);
-        } else if (!createdBy.contains(agent)) {
-            tags.put(CREATED_BY, createdBy + ';' + agent);
-        }
-
-        // remove empty values
-        tags.keySet().removeIf(key -> {
-            final String v = tags.get(key);
-            return v == null || v.isEmpty();
-        });
-
-        // ignore source/comment to keep current values from models ?
-        if (keepSourceComment) {
-            tags.put("source", changesetSourceModel.getComment());
-            tags.put("comment", getCommentWithDataSetHashTag(changesetCommentModel.getComment(), dataSet));
-        }
-
-        pnlTagSettings.initFromTags(tags);
-        pnlTagSettings.tableChanged(null);
-        pnlBasicUploadSettings.discardAllUndoableEdits();
-    }
-
-    /**
-     * Returns the given comment with appended hashtags from dataset changeset tags, if not already present.
-     * @param comment changeset comment. Can be null
-     * @param dataSet optional dataset, which can contain hashtags in its changeset tags
-     * @return comment with dataset changesets tags, if any, not duplicated
-     */
-    static String getCommentWithDataSetHashTag(String comment, DataSet dataSet) {
-        StringBuilder result = comment == null ? new StringBuilder() : new StringBuilder(comment);
-        if (dataSet != null) {
-            String hashtags = dataSet.getChangeSetTags().get("hashtags");
-            if (hashtags != null) {
-                Set<String> sanitizedHashtags = new LinkedHashSet<>();
-                for (String hashtag : hashtags.split(";", -1)) {
-                    sanitizedHashtags.add(hashtag.startsWith("#") ? hashtag : "#" + hashtag);
-                }
-                if (!sanitizedHashtags.isEmpty()) {
-                    result.append(' ').append(String.join(" ", sanitizedHashtags));
-                }
-            }
-        }
-        return result.toString();
+     * Sets the input focus to upload button.
+     * @since 18173
+     */
+    public void setFocusToUploadButton() {
+        btnUpload.requestFocus();
     }
 
@@ -360 +290 @@
         tpConfigPanels.setSelectedIndex(0);
         pnlBasicUploadSettings.startUserInput();
-        pnlTagSettings.startUserInput();
+        pnlTagEditor.initAutoCompletion(MainApplication.getLayerManager().getEditLayer());
         pnlUploadStrategySelectionPanel.initFromPreferences();
         UploadParameterSummaryPanel pnl = pnlBasicUploadSettings.getUploadParameterSummaryPanel();
@@ -375 +305 @@
     public Changeset getChangeset() {
         Changeset cs = Optional.ofNullable(pnlChangesetManagement.getSelectedChangeset()).orElseGet(Changeset::new);
-        cs.setKeys(pnlTagSettings.getTags(false));
+        cs.setKeys(model.getTags(false));
         return cs;
     }
@@ -395 +325 @@
     }
 
+    /**
+     * Get the upload dialog model.
+     *
+     * @return The model.
+     * @since 18173
+     */
+    public UploadDialogModel getModel() {
+        return model;
+    }
+
     @Override
     public String getUploadComment() {
-        return changesetCommentModel.getComment();
+        return model.getValue("comment");
     }
 
     @Override
     public String getUploadSource() {
-        return changesetSourceModel.getComment();
+        return model.getValue("source");
     }
 
@@ -496 +436 @@
         @Override
         public void actionPerformed(ActionEvent e) {
-            // force update of model in case dialog is closed before focus lost event, see #17452
-            dialog.forceUpdateActiveField();
+            Map<String, String> tags = dialog.getTags(true);
+            Logging.info("Starting upload with tags {0}", tags);
 
             /* test for empty tags in the changeset metadata and proceed only after user's confirmation.
              * though, accept if key and value are empty (cf. xor). */
             List<String> emptyChangesetTags = new ArrayList<>();
-            for (final Entry<String, String> i : dialog.getTags(true).entrySet()) {
+            for (final Entry<String, String> i : tags.entrySet()) {
                 final boolean isKeyEmpty = Utils.isStripEmpty(i.getKey());
                 final boolean isValueEmpty = Utils.isStripEmpty(i.getValue());
@@ -589 +529 @@
         if (evt.getPropertyName().equals(ChangesetManagementPanel.SELECTED_CHANGESET_PROP)) {
             Changeset cs = (Changeset) evt.getNewValue();
-            setChangesetTags(dataSet, cs == null); // keep comment/source of first tab for new changesets
             if (cs == null) {
                 tagSettingsBorder.setTitle(tr("Tags of new changeset"));
@@ -610 +549 @@
                     osmServerUrlChanged(e.getNewValue());
                     break;
-                case BasicUploadSettingsPanel.HISTORY_KEY:
-                case BasicUploadSettingsPanel.SOURCE_HISTORY_KEY:
-                    pnlBasicUploadSettings.refreshHistoryComboBoxes();
-                    break;
                 default:
                     return;
@@ -630 +565 @@
     }
 
-    private static String getLastChangesetTagFromHistory(String historyKey, List<String> def) {
-        Collection<String> history = Config.getPref().getList(historyKey, def);
-        long age = System.currentTimeMillis() / 1000 - BasicUploadSettingsPanel.getHistoryLastUsedKey();
-        if (age < BasicUploadSettingsPanel.getHistoryMaxAgeKey() && !history.isEmpty()) {
-            return history.iterator().next();
-        }
-        return null;
-    }
-
-    /**
-     * Returns the last changeset comment from history.
-     * @return the last changeset comment from history
-     */
-    public static String getLastChangesetCommentFromHistory() {
-        return getLastChangesetTagFromHistory(BasicUploadSettingsPanel.HISTORY_KEY, new ArrayList<String>());
-    }
-
-    /**
-     * Returns the last changeset source from history.
-     * @return the last changeset source from history
-     */
-    public static String getLastChangesetSourceFromHistory() {
-        return getLastChangesetTagFromHistory(BasicUploadSettingsPanel.SOURCE_HISTORY_KEY, BasicUploadSettingsPanel.getDefaultSources());
-    }
-
+    /* -------------------------------------------------------------------------- */
+    /* Interface IUploadDialog                                                    */
+    /* -------------------------------------------------------------------------- */
     @Override
     public Map<String, String> getTags(boolean keepEmpty) {
-        return pnlTagSettings.getTags(keepEmpty);
+        saveEdits();
+        return model.getTags(keepEmpty);
     }
 
@@ -677 +591 @@
     }
 
-    @Override
-    public void forceUpdateActiveField() {
-        if (tpConfigPanels.getSelectedComponent() == pnlBasicUploadSettings) {
-            pnlBasicUploadSettings.forceUpdateActiveField();
-        }
+    /**
+     * Save all outstanding edits to the model.
+     * <p>
+     * The combobox editors and the tag cell editor need to be manually saved
+     * because they normally save on focus loss, eg. when the "Upload" button is
+     * pressed, but there's no focus change when Ctrl+Enter is pressed.
+     *
+     * @since 18173
+     */
+    public void saveEdits() {
+        pnlBasicUploadSettings.saveEdits();
+        pnlTagEditor.saveEdits();
     }
 

trunk/src/org/openstreetmap/josm/gui/preferences/projection/CustomProjectionChoice.java

@@ -23 +23 @@
 import org.openstreetmap.josm.data.projection.ProjectionConfigurationException;
 import org.openstreetmap.josm.data.projection.Projections;
-import org.openstreetmap.josm.data.tagging.ac.AutoCompletionItem;
 import org.openstreetmap.josm.gui.ExtendedDialog;
 import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
@@ -29 +28 @@
 import org.openstreetmap.josm.gui.widgets.HtmlPanel;
 import org.openstreetmap.josm.gui.widgets.JosmTextField;
-import org.openstreetmap.josm.spi.preferences.Config;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -64 +62 @@
             input = new JosmTextField(30);
             cbInput = new HistoryComboBox();
-            cbInput.setPrototypeDisplayValue(new AutoCompletionItem("xxxx"));
             cbInput.setEditor(new BasicComboBoxEditor() {
                 @Override
@@ -74 +71 @@
                     "+proj=lonlat +ellps=WGS84 +datum=WGS84 +bounds=-180,-90,180,90",
                     "+proj=tmerc +lat_0=0 +lon_0=9 +k_0=1 +x_0=3500000 +y_0=0 +ellps=bessel +nadgrids=BETA2007.gsb");
-            cbInput.setPossibleItemsTopDown(Config.getPref().getList("projection.custom.value.history", samples));
+            cbInput.getModel().prefs().load("projection.custom.value.history", samples);
             cbInput.setText(initialText == null ? "" : initialText);
 
@@ -146 +143 @@
         public void rememberHistory() {
             cbInput.addCurrentItemToHistory();
-            Config.getPref().putList("projection.custom.value.history", cbInput.getHistory());
+            cbInput.getModel().prefs().save("projection.custom.value.history");
         }
     }

trunk/src/org/openstreetmap/josm/gui/preferences/server/OsmApiUrlInputPanel.java

@@ -109 +109 @@
     public void initFromPreferences() {
         String url = OsmApi.getOsmApi().getServerUrl();
-        tfOsmServerUrl.setPossibleItems(SERVER_URL_HISTORY.get());
+        tfOsmServerUrl.getModel().prefs().load(SERVER_URL_HISTORY);
         if (Config.getUrls().getDefaultOsmApiUrl().equals(url.trim())) {
             cbUseDefaultServerUrl.setSelected(true);
@@ -131 +131 @@
             Config.getPref().put("osm-server.url", hmiUrl);
             tfOsmServerUrl.addCurrentItemToHistory();
-            SERVER_URL_HISTORY.put(tfOsmServerUrl.getHistory());
+            tfOsmServerUrl.getModel().prefs().save(SERVER_URL_HISTORY);
         }
         String newUrl = OsmApi.getOsmApi().getServerUrl();

trunk/src/org/openstreetmap/josm/gui/preferences/server/OverpassServerPanel.java

@@ -42 +42 @@
      */
     public final void initFromPreferences() {
-        overpassServer.setPossibleItems(OverpassDownloadReader.OVERPASS_SERVER_HISTORY.get());
+        overpassServer.getModel().prefs().load(OverpassDownloadReader.OVERPASS_SERVER_HISTORY);
         overpassServer.setText(OverpassDownloadReader.OVERPASS_SERVER.get());
         forMultiFetch.setSelected(OverpassDownloadReader.FOR_MULTI_FETCH.get());
@@ -52 +52 @@
     public final void saveToPreferences() {
         OverpassDownloadReader.OVERPASS_SERVER.put(overpassServer.getText());
-        OverpassDownloadReader.OVERPASS_SERVER_HISTORY.put(overpassServer.getHistory());
+        overpassServer.getModel().prefs().save(OverpassDownloadReader.OVERPASS_SERVER_HISTORY);
         OverpassDownloadReader.FOR_MULTI_FETCH.put(forMultiFetch.isSelected());
     }

trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorModel.java

@@ -646 +646 @@
     }
 
-    private void commitPendingEdit() {
+    protected void commitPendingEdit() {
         if (endEditListener != null) {
             endEditListener.endCellEditing();

trunk/src/org/openstreetmap/josm/gui/tagging/TagEditorPanel.java

@@ -222 +222 @@
         validate();
     }
+
+    /**
+     * Save all outstanding edits to the model.
+     * @see org.openstreetmap.josm.gui.io.UploadDialog#saveEdits
+     * @since 18173
+     */
+    public void saveEdits() {
+        tagTable.endCellEditing();
+    }
 }

trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletingComboBox.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui.tagging.ac;
 
-import java.awt.datatransfer.Clipboard;
-import java.awt.datatransfer.Transferable;
-import java.awt.event.FocusEvent;
-import java.awt.event.FocusListener;
-import java.awt.im.InputContext;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.LinkedList;
-import java.util.Locale;
-
-import javax.swing.ComboBoxModel;
-import javax.swing.DefaultComboBoxModel;
-import javax.swing.text.AttributeSet;
-import javax.swing.text.BadLocationException;
-import javax.swing.text.JTextComponent;
-import javax.swing.text.PlainDocument;
-import javax.swing.text.StyleConstants;
-
 import org.openstreetmap.josm.data.tagging.ac.AutoCompletionItem;
-import org.openstreetmap.josm.data.tagging.ac.AutoCompletionPriority;
-import org.openstreetmap.josm.gui.MainApplication;
-import org.openstreetmap.josm.gui.MapFrame;
-import org.openstreetmap.josm.gui.datatransfer.ClipboardUtils;
-import org.openstreetmap.josm.gui.widgets.JosmComboBox;
-import org.openstreetmap.josm.spi.preferences.Config;
-import org.openstreetmap.josm.tools.Logging;
-import org.openstreetmap.josm.tools.Utils;
 
 /**
- * Auto-completing ComboBox.
+ * An auto-completing ComboBox.
+ *
  * @author guilhem.bonnefille@gmail.com
  * @since 272
+ * @deprecated Use the generic type {@link AutoCompComboBox} instead.  Eg.
+ *             {@code AutoCompComboBox<AutoCompletionItem>} or {@code AutoCompComboBox<String>}.
  */
-public class AutoCompletingComboBox extends JosmComboBox<AutoCompletionItem> {
-
-    private boolean autocompleteEnabled = true;
-    private boolean locked;
-
-    private int maxTextLength = -1;
-    private boolean useFixedLocale;
-
-    private final transient InputContext privateInputContext = InputContext.getInstance();
-
-    static final class InnerFocusListener implements FocusListener {
-        private final JTextComponent editorComponent;
-
-        InnerFocusListener(JTextComponent editorComponent) {
-            this.editorComponent = editorComponent;
-        }
-
-        @Override
-        public void focusLost(FocusEvent e) {
-            MapFrame map = MainApplication.getMap();
-            if (map != null) {
-                map.keyDetector.setEnabled(true);
-            }
-        }
-
-        @Override
-        public void focusGained(FocusEvent e) {
-            MapFrame map = MainApplication.getMap();
-            if (map != null) {
-                map.keyDetector.setEnabled(false);
-            }
-            // save unix system selection (middle mouse paste)
-            Clipboard sysSel = ClipboardUtils.getSystemSelection();
-            if (sysSel != null) {
-                Transferable old = ClipboardUtils.getClipboardContent(sysSel);
-                editorComponent.selectAll();
-                if (old != null) {
-                    sysSel.setContents(old, null);
-                }
-            } else if (e != null && e.getOppositeComponent() != null) {
-                // Select all characters when the change of focus occurs inside JOSM only.
-                // When switching from another application, it is annoying, see #13747
-                editorComponent.selectAll();
-            }
-        }
-    }
-
-    /**
-     * Auto-complete a JosmComboBox.
-     * <br>
-     * Inspired by <a href="http://www.orbital-computer.de/JComboBox">Thomas Bierhance example</a>.
-     */
-    class AutoCompletingComboBoxDocument extends PlainDocument {
-
-        @Override
-        public void remove(int offs, int len) throws BadLocationException {
-            try {
-                super.remove(offs, len);
-            } catch (IllegalArgumentException e) {
-                // IAE can happen with Devanagari script, see #15825
-                Logging.error(e);
-            }
-        }
-
-        @Override
-        public void insertString(int offs, String str, AttributeSet a) throws BadLocationException {
-            // TODO get rid of code duplication w.r.t. AutoCompletingTextField.AutoCompletionDocument.insertString
-
-            if (maxTextLength > -1 && str.length() + getLength() > maxTextLength)
-                return;
-
-            super.insertString(offs, str, a);
-
-            if (locked)
-                return; // don't get in a loop
-
-            if (!autocompleteEnabled)
-                return;
-
-            // input method for non-latin characters (e.g. scim)
-            if (a != null && a.isDefined(StyleConstants.ComposedTextAttribute))
-                return;
-
-            // if the cursor isn't at the end of the text we don't autocomplete.
-            // If a highlighted autocompleted suffix was present and we get here Swing has
-            // already removed it from the document. getLength() therefore doesn't include the autocompleted suffix.
-            if (offs + str.length() < getLength()) {
-                return;
-            }
-
-            String prefix = getText(0, getLength()); // the whole text after insertion
-
-            if (Config.getPref().getBoolean("autocomplete.dont_complete_numbers", true)
-                    && prefix.matches("^\\d+$"))
-                return;
-
-            autocomplete(prefix);
-
-            // save unix system selection (middle mouse paste)
-            Clipboard sysSel = ClipboardUtils.getSystemSelection();
-            if (sysSel != null) {
-                Transferable old = ClipboardUtils.getClipboardContent(sysSel);
-                if (old != null) {
-                    sysSel.setContents(old, null);
-                }
-            }
-        }
-    }
-
-    /**
-     * Creates a <code>AutoCompletingComboBox</code> with a default prototype display value.
-     */
-    public AutoCompletingComboBox() {
-        this("Foo");
-    }
-
-    /**
-     * Creates a <code>AutoCompletingComboBox</code> with the specified prototype display value.
-     * @param prototype the <code>Object</code> used to compute the maximum number of elements to be displayed at once
-     *                  before displaying a scroll bar. It also affects the initial width of the combo box.
-     * @since 5520
-     */
-    public AutoCompletingComboBox(String prototype) {
-        super(new AutoCompletionItem(prototype));
-        final JTextComponent editorComponent = this.getEditorComponent();
-        editorComponent.setDocument(new AutoCompletingComboBoxDocument());
-        editorComponent.addFocusListener(new InnerFocusListener(editorComponent));
-    }
-
-    /**
-     * Autocomplete a string.
-     * <p>
-     * Look in the model for an item whose true prefix matches the string. If
-     * found, set the editor to the item and select the item in the model too.
-     *
-     * @param prefix The prefix to autocomplete.
-     */
-    private void autocomplete(String prefix) {
-        // candidate item for autocomplete
-        AutoCompletionItem item = findBestCandidate(prefix);
-        if (item != null) {
-            try {
-                locked = true;
-                setSelectedItem(item);
-                getEditor().setItem(item);
-                // select the autocompleted suffix in the editor
-                getEditorComponent().select(prefix.length(), item.getValue().length());
-            } finally {
-                locked = false;
-            }
-        }
-    }
-
-    /**
-     * Find the best candidate for autocompletion.
-     * @param prefix The true prefix to match.
-     * @return The best candidate (may be null)
-     */
-    private AutoCompletionItem findBestCandidate(String prefix) {
-        ComboBoxModel<AutoCompletionItem> model = getModel();
-        AutoCompletionItem bestCandidate = null;
-        for (int i = 0, n = model.getSize(); i < n; i++) {
-            AutoCompletionItem currentItem = model.getElementAt(i);
-            // the "same" string is always the best candidate, but it is of
-            // no use for autocompletion
-            if (currentItem.getValue().equals(prefix))
-                return null;
-            if (currentItem.getValue().startsWith(prefix)
-            && (bestCandidate == null || currentItem.getPriority().compareTo(bestCandidate.getPriority()) > 0)) {
-                bestCandidate = currentItem;
-            }
-        }
-        return bestCandidate;
-    }
-
-    /**
-     * Sets the maximum text length.
-     * @param length the maximum text length in number of characters
-     */
-    public void setMaxTextLength(int length) {
-        this.maxTextLength = length;
-    }
-
-    /**
-     * Selects a given item in the ComboBox model
-     * @param item the item of type AutoCompletionItem, String or null
-     * @param disableAutoComplete if true, autocomplete {@linkplain #setAutocompleteEnabled is disabled} during the operation
-     * @since 15885
-     */
-    public void setSelectedItem(Object item, final boolean disableAutoComplete) {
-        final boolean previousState = isAutocompleteEnabled();
-        if (disableAutoComplete) {
-            // disable autocomplete to prevent unnecessary actions in AutoCompletingComboBoxDocument#insertString
-            setAutocompleteEnabled(false);
-        }
-        setSelectedItem(item);
-        setAutocompleteEnabled(previousState);
-    }
-
-    /**
-     * Sets the items of the combobox to the given {@code String}s in reversed order (last element first).
-     * @param elems String items
-     */
-    public void setPossibleItems(Collection<String> elems) {
-        DefaultComboBoxModel<AutoCompletionItem> model = (DefaultComboBoxModel<AutoCompletionItem>) this.getModel();
-        Object oldValue = this.getEditor().getItem(); // Do not use getSelectedItem(); (fix #8013)
-        model.removeAllElements();
-        for (String elem : elems) {
-            model.addElement(new AutoCompletionItem(elem, AutoCompletionPriority.UNKNOWN));
-        }
-        this.setSelectedItem(null);
-        this.setSelectedItem(oldValue, true);
-    }
-
-    /**
-     * Sets the items of the combobox to the given {@code String}s in top down order.
-     * @param elems Collection of String items (is not changed)
-     * @since 15011
-     */
-    public void setPossibleItemsTopDown(Collection<String> elems) {
-        // We have to reverse the history, because ComboBoxHistory will reverse it again in addElement()
-        LinkedList<String> reversed = new LinkedList<>(elems);
-        Collections.reverse(reversed);
-        setPossibleItems(reversed);
-    }
-
-    /**
-     * Sets the items of the combobox to the given {@code AutoCompletionItem}s.
-     * @param elems AutoCompletionItem items
-     * @since 12859
-     */
-    public void setPossibleAcItems(Collection<AutoCompletionItem> elems) {
-        DefaultComboBoxModel<AutoCompletionItem> model = (DefaultComboBoxModel<AutoCompletionItem>) this.getModel();
-        Object oldValue = getSelectedItem();
-        Object editorOldValue = this.getEditor().getItem();
-        model.removeAllElements();
-        for (AutoCompletionItem elem : elems) {
-            model.addElement(elem);
-        }
-        setSelectedItem(oldValue);
-        this.getEditor().setItem(editorOldValue);
-    }
-
-    /**
-     * Determines if autocompletion is enabled.
-     * @return {@code true} if autocompletion is enabled, {@code false} otherwise.
-     */
-    public final boolean isAutocompleteEnabled() {
-        return autocompleteEnabled;
-    }
-
-    /**
-     * Sets whether the autocompletion is enabled
-     * @param autocompleteEnabled {@code true} to enable autocompletion
-     * @since 15567 (visibility)
-     */
-    public void setAutocompleteEnabled(boolean autocompleteEnabled) {
-        this.autocompleteEnabled = autocompleteEnabled;
-    }
-
-    /**
-     * If the locale is fixed, English keyboard layout will be used by default for this combobox
-     * all other components can still have different keyboard layout selected
-     * @param f fixed locale
-     */
-    public void setFixedLocale(boolean f) {
-        useFixedLocale = f;
-        if (useFixedLocale) {
-            Locale oldLocale = privateInputContext.getLocale();
-            Logging.info("Using English input method");
-            if (!privateInputContext.selectInputMethod(new Locale("en", "US"))) {
-                // Unable to use English keyboard layout, disable the feature
-                Logging.warn("Unable to use English input method");
-                useFixedLocale = false;
-                if (oldLocale != null) {
-                    Logging.info("Restoring input method to " + oldLocale);
-                    if (!privateInputContext.selectInputMethod(oldLocale)) {
-                        Logging.warn("Unable to restore input method to " + oldLocale);
-                    }
-                }
-            }
-        }
-    }
-
-    @Override
-    public InputContext getInputContext() {
-        if (useFixedLocale) {
-            return privateInputContext;
-        }
-        return super.getInputContext();
-    }
-
-    /**
-     * Returns the edited item with whitespaces removed
-     * @return the edited item with whitespaces removed
-     * @since 15835
-     */
-    public String getEditItem() {
-        return Utils.removeWhiteSpaces(getEditor().getItem().toString());
-    }
-
-    /**
-     * Returns the selected item or the edited item as string
-     * @return the selected item or the edited item as string
-     * @see #getSelectedItem()
-     * @see #getEditItem()
-     * @since 15835
-     */
-    public String getSelectedOrEditItem() {
-        final Object selectedItem = getSelectedItem();
-        if (selectedItem instanceof AutoCompletionItem) {
-            return ((AutoCompletionItem) selectedItem).getValue();
-        } else if (selectedItem instanceof String) {
-            return (String) selectedItem;
-        } else {
-            return getEditItem();
-        }
-    }
+@Deprecated
+public class AutoCompletingComboBox extends AutoCompComboBox<AutoCompletionItem> {
 }

trunk/src/org/openstreetmap/josm/gui/widgets/HistoryComboBox.java

@@ -4 +4 @@
 import java.util.List;
 
-import javax.swing.text.JTextComponent;
-
-import org.openstreetmap.josm.data.tagging.ac.AutoCompletionItem;
-import org.openstreetmap.josm.gui.tagging.ac.AutoCompletingComboBox;
-import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBox;
 
 /**
- * An {@link AutoCompletingComboBox} which keeps a history
+ * A History ComboBox
+ * <p>
+ * A HistoryComboBox is an {@link AutoCompComboBox} specialized in {@code String}s.
  */
-public class HistoryComboBox extends AutoCompletingComboBox {
-    private final ComboBoxHistory model;
-
-    /**
-     * The default size of the search history.
-     */
-    public static final int DEFAULT_SEARCH_HISTORY_SIZE = 15;
+public class HistoryComboBox extends AutoCompComboBox<String> {
 
     /**
@@ -25 +17 @@
      */
     public HistoryComboBox() {
-        int maxsize = Config.getPref().getInt("search.history-size", DEFAULT_SEARCH_HISTORY_SIZE);
-        model = new ComboBoxHistory(maxsize);
-        setModel(model);
-        setEditable(true);
+        super(new HistoryComboBoxModel());
+        setPrototypeDisplayValue("dummy");
+    }
+
+    @Override
+    public HistoryComboBoxModel getModel() {
+        return (HistoryComboBoxModel) dataModel;
     }
 
     /**
-     * Returns the text contained in this component
-     * @return the text
-     * @see JTextComponent#getText()
-     */
-    public String getText() {
-        return getEditorComponent().getText();
-    }
-
-    /**
-     * Sets the text of this component to the specified text
-     * @param value the text to set
-     * @see JTextComponent#setText(java.lang.String)
-     */
-    public void setText(String value) {
-        setAutocompleteEnabled(false);
-        getEditorComponent().setText(value);
-        setAutocompleteEnabled(true);
-    }
-
-    /**
-     * Adds or moves the current element to the top of the history
-     * @see ComboBoxHistory#addElement(java.lang.String)
+     * Adds the item in the editor to the top of the history. If the item is already present, don't
+     * add another but move it to the top. The item is then selected.
      */
     public void addCurrentItemToHistory() {
-        Object item = getEditor().getItem();
-        // This avoids instantiating multiple AutoCompletionItems
-        if (item instanceof AutoCompletionItem) {
-            model.addElement((AutoCompletionItem) item);
-        } else {
-            model.addElement(item.toString());
-        }
-    }
-
-    /**
-     * Sets the elements of the ComboBox to the given items
-     * @param history the items to set
-     * @see ComboBoxHistory#setItemsAsString(java.util.List)
-     */
-    public void setHistory(List<String> history) {
-        model.setItemsAsString(history);
+        String newItem = getModel().addTopElement(getEditor().getItem().toString());
+        getModel().setSelectedItem(newItem);
     }
 
@@ -77 +38 @@
      * Returns the items as strings
      * @return the items as strings
-     * @see ComboBoxHistory#asStringList()
+     * @deprecated Has been moved to the model, where it belongs. Use
+     *     {@link HistoryComboBoxModel#asStringList} instead.  Probably you want to use
+     *     {@link HistoryComboBoxModel.Preferences#load} and
+     *     {@link HistoryComboBoxModel.Preferences#save}.
      */
+    @Deprecated
     public List<String> getHistory() {
-        return model.asStringList();
+        return getModel().asStringList();
     }
 }

trunk/src/org/openstreetmap/josm/gui/widgets/JosmComboBox.java

@@ -107 +107 @@
     public JTextField getEditorComponent() {
         return (JTextField) getEditor().getEditorComponent();
+    }
+
+    /**
+     * Returns the text in the combobox editor.
+     * @return the text
+     * @see JTextComponent#getText
+     * @since 18173
+     */
+    public String getText() {
+        return getEditorComponent().getText();
+    }
+
+    /**
+     * Sets the text in the combobox editor.
+     * @param value the text to set
+     * @see JTextComponent#setText
+     * @since 18173
+     */
+    public void setText(String value) {
+        getEditorComponent().setText(value);
     }
 
@@ -164 +184 @@
     }
 
-    protected final void init(E prototype) {
-        init(prototype, true);
-    }
-
-    protected final void init(E prototype, boolean registerPropertyChangeListener) {
+    /**
+     * Set the prototypeCellValue property and calculate the height of the dropdown.
+     */
+    @Override
+    public void setPrototypeDisplayValue(E prototype) {
         if (prototype != null) {
-            setPrototypeDisplayValue(prototype);
+            super.setPrototypeDisplayValue(prototype);
             int screenHeight = GuiHelper.getScreenSize().height;
             // Compute maximum number of visible items based on the preferred size of the combo box.
@@ -189 +209 @@
             setMaximumRowCount(Math.max(getMaximumRowCount(), maxsize));
         }
+    }
+
+    protected final void init(E prototype) {
+        init(prototype, true);
+    }
+
+    protected final void init(E prototype, boolean registerPropertyChangeListener) {
+        setPrototypeDisplayValue(prototype);
         // Handle text contextual menus for editable comboboxes
         if (registerPropertyChangeListener) {