Changeset 16690 in josm

Timestamp:

2020-06-21T09:54:52+02:00 (4 years ago)

Author:

simon04

Message:

Extract PresetListEntry class

Location:

trunk

Files:

• src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetItem.java (modified) (1 diff)
• src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetReader.java (modified) (4 diffs)
• src/org/openstreetmap/josm/gui/tagging/presets/items/ComboMultiSelect.java (modified) (3 diffs)
• src/org/openstreetmap/josm/gui/tagging/presets/items/PresetListEntry.java (added)
• test/unit/org/openstreetmap/josm/gui/tagging/presets/items/PresetListEntryTest.java (moved) (moved from trunk/test/unit/org/openstreetmap/josm/gui/tagging/presets/items/ComboMultiSelectTest.java ) (1 diff)

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetItem.java

@@ -126 +126 @@
     }
 
-    protected static ImageIcon loadImageIcon(String iconName, File zipIcons, Integer maxSize) {
+    /**
+     * Loads a tagging preset icon
+     * @param iconName the icon name
+     * @param zipIcons zip file where the image is located
+     * @param maxSize maximum image size (or null)
+     * @return the requested image or null if the request failed
+     */
+    public static ImageIcon loadImageIcon(String iconName, File zipIcons, Integer maxSize) {
         final Collection<String> s = Config.getPref().getList("taggingpreset.icon.sources", null);
         ImageProvider imgProv = new ImageProvider(iconName).setDirs(s).setId("presets").setArchive(zipIcons).setOptional(true);

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetReader.java

@@ -37 +37 @@
 import org.openstreetmap.josm.gui.tagging.presets.items.Optional;
 import org.openstreetmap.josm.gui.tagging.presets.items.PresetLink;
+import org.openstreetmap.josm.gui.tagging.presets.items.PresetListEntry;
 import org.openstreetmap.josm.gui.tagging.presets.items.Roles;
 import org.openstreetmap.josm.gui.tagging.presets.items.Roles.Role;
@@ -151 +152 @@
         parser.map("space", Space.class);
         parser.map("key", Key.class);
-        parser.map("list_entry", ComboMultiSelect.PresetListEntry.class);
+        parser.map("list_entry", PresetListEntry.class);
         parser.map("item_separator", ItemSeparator.class);
         parser.mapBoth("chunk", Chunk.class);
@@ -188 +189 @@
         Roles lastrole = null;
         final List<Check> checks = new LinkedList<>();
-        final List<ComboMultiSelect.PresetListEntry> listEntries = new LinkedList<>();
+        final List<PresetListEntry> listEntries = new LinkedList<>();
         final Map<String, List<Object>> byId = new HashMap<>();
         final Deque<String> lastIds = new ArrayDeque<>();
@@ -299 +300 @@
                             all.getLast().data.add((TaggingPresetItem) o);
                         }
-                    } else if (o instanceof ComboMultiSelect.PresetListEntry) {
-                        listEntries.add((ComboMultiSelect.PresetListEntry) o);
+                    } else if (o instanceof PresetListEntry) {
+                        listEntries.add((PresetListEntry) o);
                     } else if (o instanceof CheckGroup) {
                         CheckGroup cg = (CheckGroup) o;

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

@@ -22 +22 @@
 import java.util.stream.IntStream;
 
-import javax.swing.ImageIcon;
 import javax.swing.JComponent;
 import javax.swing.JLabel;
@@ -31 +30 @@
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Tag;
-import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetReader;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPresetSelector;
 import org.openstreetmap.josm.spi.preferences.Config;
-import org.openstreetmap.josm.tools.AlphanumComparator;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.Logging;
@@ -152 +149 @@
 
             return lbl;
-        }
-    }
-
-    /**
-     * Preset list entry.
-     */
-    public static class PresetListEntry implements Comparable<PresetListEntry> {
-        /** Entry value */
-        public String value; // NOSONAR
-        /** The context used for translating {@link #value} */
-        public String value_context; // NOSONAR
-        /** Value displayed to the user */
-        public String display_value; // NOSONAR
-        /** Text to be displayed below {@code display_value}. */
-        public String short_description; // NOSONAR
-        /** The location of icon file to display */
-        public String icon; // NOSONAR
-        /** The size of displayed icon. If not set, default is size from icon file */
-        public short icon_size; // NOSONAR
-        /** The localized version of {@link #display_value}. */
-        public String locale_display_value; // NOSONAR
-        /** The localized version of {@link #short_description}. */
-        public String locale_short_description; // NOSONAR
-
-        /** Cached width (currently only for Combo) to speed up preset dialog initialization */
-        public short preferredWidth = -1; // NOSONAR
-        /** Cached height (currently only for Combo) to speed up preset dialog initialization */
-        public short preferredHeight = -1; // NOSONAR
-
-        /**
-         * Constructs a new {@code PresetListEntry}, uninitialized.
-         */
-        public PresetListEntry() {
-            // Public default constructor is needed
-        }
-
-        /**
-         * Constructs a new {@code PresetListEntry}, initialized with a value.
-         * @param value value
-         */
-        public PresetListEntry(String value) {
-            this.value = value;
-        }
-
-        /**
-         * Returns HTML formatted contents.
-         * @return HTML formatted contents
-         */
-        public String getListDisplay() {
-            if (value.equals(DIFFERENT))
-                return "<b>" + Utils.escapeReservedCharactersHTML(DIFFERENT) + "</b>";
-
-            String displayValue = Utils.escapeReservedCharactersHTML(getDisplayValue());
-            String shortDescription = getShortDescription(true);
-
-            if (displayValue.isEmpty() && (shortDescription == null || shortDescription.isEmpty()))
-                return "&nbsp;";
-
-            final StringBuilder res = new StringBuilder("<b>").append(displayValue).append("</b>");
-            if (shortDescription != null) {
-                // wrap in table to restrict the text width
-                res.append("<div style=\"width:300px; padding:0 0 5px 5px\">")
-                   .append(shortDescription)
-                   .append("</div>");
-            }
-            return res.toString();
-        }
-
-        /**
-         * Returns the entry icon, if any.
-         * @return the entry icon, or {@code null}
-         */
-        public ImageIcon getIcon() {
-            return icon == null ? null : loadImageIcon(icon, TaggingPresetReader.getZipIcons(), (int) icon_size);
-        }
-
-        /**
-         * Returns the value to display.
-         * @return the value to display
-         */
-        public String getDisplayValue() {
-            return Utils.firstNonNull(locale_display_value, tr(display_value), trc(value_context, value));
-        }
-
-        /**
-         * Returns the short description to display.
-         * @param translated whether the text must be translated
-         * @return the short description to display
-         */
-        public String getShortDescription(boolean translated) {
-            return translated
-                    ? Utils.firstNonNull(locale_short_description, tr(short_description))
-                            : short_description;
-        }
-
-        // toString is mainly used to initialize the Editor
-        @Override
-        public String toString() {
-            if (DIFFERENT.equals(value))
-                return DIFFERENT;
-            String displayValue = getDisplayValue();
-            return displayValue != null ? displayValue.replaceAll("<.*>", "") : ""; // remove additional markup, e.g. <br>
-        }
-
-        @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (o == null || getClass() != o.getClass()) return false;
-            PresetListEntry that = (PresetListEntry) o;
-            return Objects.equals(value, that.value);
-        }
-
-        @Override
-        public int hashCode() {
-            return Objects.hash(value);
-        }
-
-        @Override
-        public int compareTo(PresetListEntry o) {
-            return AlphanumComparator.getInstance().compare(this.getDisplayValue(), o.getDisplayValue());
         }
     }

trunk/test/unit/org/openstreetmap/josm/gui/tagging/presets/items/PresetListEntryTest.java

@@ -7 +7 @@
 import org.junit.Test;
 import org.openstreetmap.josm.JOSMFixture;
-import org.openstreetmap.josm.gui.tagging.presets.items.ComboMultiSelect.PresetListEntry;
 
 /**
- * Unit tests of {@link ComboMultiSelect} class.
+ * Unit tests of {@link PresetListEntry} class.
  */
-public class ComboMultiSelectTest {
+public class PresetListEntryTest {
 
     /**