Changeset 18221 in josm for trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/Combo.java

Timestamp:

2021-09-13T00:41:53+02:00 (3 years ago)

Author:

Don-vip

Message:

fix #21319 - Refactoring of class hierarchy around JosmComboBox / AutoCompComboBox (patch by marcello):

• Code reuse: JosmComboBox now uses a JosmTextField as editor
• Code reuse: AutoCompComboBox now uses AutoCompTextField as editor
• JosmComboBox uses more of the original L&F
• JosmComboBox lists now expand all the way to the bottom or the top of the screen
• Variable height items in combobox lists now work, see #19321
• Autocomplete uses different algorithm, fix #21290
• editable="false" comboboxes in Presets now work, fix #6157 see #11024 see #18714
• The user may toggle LTR-RTL script in JosmTextField (menu and ctrl+space)
• LTR-RTL automatically toggles according to key in AddTag and EditTag dialogs, fix #16163

File:

• trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/Combo.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/Combo.java

@@ -6 +6 @@
 import java.awt.Color;
 import java.awt.Cursor;
+import java.awt.Insets;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
+import java.awt.event.ComponentAdapter;
+import java.awt.event.ComponentEvent;
+import java.util.Arrays;
+import java.util.Comparator;
 
 import javax.swing.AbstractAction;
 import javax.swing.JButton;
 import javax.swing.JColorChooser;
+import javax.swing.JComponent;
 import javax.swing.JPanel;
 
+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.mappaint.mapcss.CSSColors;
-import org.openstreetmap.josm.gui.tagging.ac.AutoCompletingTextField;
-import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionList;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBoxEditor;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompComboBoxModel;
+import org.openstreetmap.josm.gui.tagging.ac.AutoCompTextField;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetItem;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetItemGuiSupport;
@@ -36 +44 @@
     public boolean editable = true; // NOSONAR
     /** The length of the combo box (number of characters allowed). */
-    public short length; // NOSONAR
+    public int length; // NOSONAR
 
     protected JosmComboBox<PresetListEntry> combobox;
+    protected AutoCompComboBoxModel<PresetListEntry> dropDownModel;
+    protected AutoCompComboBoxModel<AutoCompletionItem> autoCompModel;
+
+    class ComponentListener extends ComponentAdapter {
+        @Override
+        public void componentResized(ComponentEvent e) {
+            // Make multi-line JLabels the correct size
+            // Only needed if there is any short_description
+            JComponent component = (JComponent) e.getSource();
+            int width = component.getWidth();
+            if (width == 0)
+                width = 200;
+            Insets insets = component.getInsets();
+            width -= insets.left + insets.right + 10;
+            ComboMultiSelectListCellRenderer renderer = (ComboMultiSelectListCellRenderer) combobox.getRenderer();
+            renderer.setWidth(width);
+            combobox.setRenderer(null); // needed to make prop change fire
+            combobox.setRenderer(renderer);
+        }
+    }
 
     /**
@@ -48 +76 @@
 
     @Override
-    protected void addToPanelAnchor(JPanel p, String def, TaggingPresetItemGuiSupport support) {
+    protected JComponent addToPanelAnchor(JPanel p, String def, TaggingPresetItemGuiSupport support) {
         if (!usage.unused()) {
             for (String s : usage.values) {
@@ -59 +87 @@
         presetListEntries.add(new PresetListEntry(""));
 
-        combobox = new JosmComboBox<>(presetListEntries.toArray(new PresetListEntry[0]));
-        component = combobox;
-        combobox.setRenderer(getListCellRenderer());
-        combobox.setEditable(true); // fix incorrect height, see #6157
-        combobox.reinitialize(presetListEntries);
-        combobox.setEditable(editable); // see #6157
-        AutoCompletingTextField tf = new AutoCompletingTextField();
-        initAutoCompletionField(tf, key);
+        dropDownModel = new AutoCompComboBoxModel<PresetListEntry>(Comparator.naturalOrder());
+        autoCompModel = new AutoCompComboBoxModel<AutoCompletionItem>(Comparator.naturalOrder());
+        presetListEntries.forEach(dropDownModel::addElement);
+
+        combobox = new JosmComboBox<>(dropDownModel);
+        AutoCompComboBoxEditor<AutoCompletionItem> editor = new AutoCompComboBoxEditor<>();
+        combobox.setEditor(editor);
+
+        // The default behaviour of JComboBox is to size the editor according to the tallest item in
+        // the dropdown list.  We don't want that to happen because we want to show taller items in
+        // the list than in the editor.  We can't use
+        // {@code combobox.setPrototypeDisplayValue(new PresetListEntry(" "));} because that would
+        // set a fixed cell height in JList.
+        combobox.setPreferredHeight(combobox.getPreferredSize().height);
+
+        // a custom cell renderer capable of displaying a short description text along with the
+        // value
+        combobox.setRenderer(new ComboMultiSelectListCellRenderer(combobox, combobox.getRenderer(), 200, key));
+        combobox.setEditable(editable);
+
+        getAllForKeys(Arrays.asList(key)).forEach(autoCompModel::addElement);
+        getDisplayValues().forEach(s -> autoCompModel.addElement(new AutoCompletionItem(s, AutoCompletionPriority.IS_IN_STANDARD)));
+
+        AutoCompTextField<AutoCompletionItem> tf = editor.getEditorComponent();
+        tf.setModel(autoCompModel);
+
         if (TaggingPresetItem.DISPLAY_KEYS_AS_HINT.get()) {
-            tf.setHint(key);
+            combobox.setHint(key);
         }
         if (length > 0) {
-            tf.setMaxChars((int) length);
+            tf.setMaxTextLength(length);
         }
-        AutoCompletionList acList = tf.getAutoCompletionList();
-        if (acList != null) {
-            acList.add(getDisplayValues(), AutoCompletionPriority.IS_IN_STANDARD);
-        }
-        combobox.setEditor(tf);
-        combobox.setSelectedItem(getItemToSelect(def, support, false));
 
         if (key != null && ("colour".equals(key) || key.startsWith("colour:") || key.endsWith(":colour"))) {
@@ -93 +133 @@
             p.add(combobox, GBC.eol().fill(GBC.HORIZONTAL));
         }
+
+        Object itemToSelect = getItemToSelect(default_, support, false);
+        combobox.setSelectedItemText(itemToSelect == null ? null : itemToSelect.toString());
         combobox.addActionListener(l -> support.fireItemValueModified(this, key, getSelectedValue()));
+        combobox.addComponentListener(new ComponentListener());
+        return combobox;
     }