Changeset 5158 in josm

Timestamp:

2012-04-01T20:36:32+02:00 (12 years ago)

Author:

simon04

Message:

see #7552 - presets: allow icons for individual combo items

Location:

trunk

Files:

• data/defaultpresets.xml (modified) (3 diffs)
• data/tagging-preset.xsd (modified) (1 diff)
• src/org/openstreetmap/josm/gui/tagging/TaggingPreset.java (modified) (15 diffs)

trunk/data/defaultpresets.xml

@@ -40 +40 @@
   display_values: comma separated list of values to be displayed instead of the
                   database values, order and number must be equal to values
-  short_description: comma separated list of texts to be displayed below each
-                    display_value. (Only if it is not possible to describe 
-                    the entry in 2-3 words.) Instead of comma separeted list, you can
-                    also write it in the following form: 
-                        <short_description>first description</short_description>
-                                ...
-                        <short_description>last description</short_description>
+  short_descriptions: comma separated list of texts to be displayed below each
+                      display_value. (Only if it is not possible to describe
+                      the entry in 2-3 words.) Instead of comma separeted list
+  instead using values, display_values and short_descriptions, the following form is also supported:
+    <list_item value="" display_value="' short_description="" icon=""/>
   default: default string to display (defaults to "")
   use_last_as_default: true/false/force (default is "false")
@@ -60 +58 @@
   display_values: delimiter-separated list of values to be displayed instead of the
                   database values, order and number must be equal to values
-  short_description: delimiter-separated list of texts to be displayed below each
-                    display_value. (Only if it is not possible to describe 
-                    the entry in 2-3 words.) Instead of a separated list, you can
-                    also write it in the following form: 
-                        <short_description>first description</short_description>
-                                ...
-                        <short_description>last description</short_description>
+  short_descriptions: delimiter-separated list of texts to be displayed below each
+                     display_value. (Only if it is not possible to describe
+                     the entry in 2-3 words.) Instead of a separated list
+  instead using values, display_values and short_descriptions, the following form is also supported:
+    <list_item value="" display_value="' short_description="" icon=""/>
   default: default string to display (defaults to "")
   use_last_as_default: true/false/force (default is "false")
@@ -700 +696 @@
             <optional>
                 <text key="name" text="Name" />
-                <combo key="sac_scale" text="SAC Scale" values="hiking,mountain_hiking,demanding_mountain_hiking,alpine_hiking,demanding_alpine_hiking,difficult_alpine_hiking" display_values="T1 - hiking trail,T2 - mountain hiking trail,T3 - difficult\, exposed hiking trail,T4 - difficult\, exposed\, steep alpine trail,T5 - difficult alpine trail with climbing,T6 - hazardous alpine trail with climbing">
-                    <short_description>Trail well cleared. Area flat or slightly sloped, no fall hazard</short_description>
-                    <short_description>Trail with continuous line and balanced ascent. Terrain partially steep, fall hazard possible</short_description>
-                    <short_description>exposed sites may be secured with ropes or chains, possible need to use hands for balance. Partly exposed sites with fall hazard, scree, pathless jagged rocks</short_description>
-                    <short_description>sometimes need for hand use to get ahead. Terrain quite exposed, precarious grassy acclivities, jagged rocks, facile snow-free glaciers.</short_description>
-                    <short_description>single plainly climbing up to second grade. Exposed, demanding terrain, jagged rocks, few dangerous glacier and snow</short_description>
-                    <short_description>climbing up to second grade. Often very exposed, precarious jagged rocks, glacier with danger to slip and fall</short_description>
+                <combo key="sac_scale" text="SAC Scale">
+                    <list_entry value="hiking" display_value="T1 - hiking trail" short_description="Trail well cleared. Area flat or slightly sloped, no fall hazard" />
+                    <list_entry value="mountain_hiking" display_value="T2 - mountain hiking trail" short_description="Trail with continuous line and balanced ascent. Terrain partially steep, fall hazard possible" />
+                    <list_entry value="demanding_mountain_hiking" display_value="T3 - difficult, exposed hiking trail" short_description="exposed sites may be secured with ropes or chains, possible need to use hands for balance. Partly exposed sites with fall hazard, scree, pathless jagged rocks" />
+                    <list_entry value="alpine_hiking" display_value="T4 - difficult, exposed, steep alpine trail" short_description="sometimes need for hand use to get ahead. Terrain quite exposed, precarious grassy acclivities, jagged rocks, facile snow-free glaciers" />
+                    <list_entry value="demanding_alpine_hiking" display_value="T5 - difficult alpine trail with climbing" short_description="single plainly climbing up to second grade. Exposed, demanding terrain, jagged rocks, few dangerous glacier and snow" />
+                    <list_entry value="difficult_alpine_hiking" display_value="T6 - hazardous alpine trail with climbing" short_description="climbing up to second grade. Often very exposed, precarious jagged rocks, glacier with danger to slip and fall" />
                 </combo>
                 <combo key="mtb:scale" text="MTB Scale" values="0,1,2,3,4,5" />

trunk/data/tagging-preset.xsd

@@ -126 +126 @@
         </complexType>
 
+        <complexType name="list_entry">
+                <attribute name="value" type="string" use="required" />
+                <attribute name="display_value" type="string" />
+                <attribute name="short_description" type="string" />
+                <attribute name="icon" type="string" />
+        </complexType>
+
         <complexType name="combo">
-                <sequence>
-                        <element name="short_description" type="string" minOccurs="0"
-                                maxOccurs="unbounded" />
-                </sequence>
-                <attribute name="key" type="string" use="required" />
-                <attribute name="text" type="string" />
-                <attribute name="text_context" type="string" />
-                <attribute name="values" type="string" use="required" />
+                <!-- use either list_entry's or a combination of values/display_values -->
+                <sequence>
+                        <element name="list_entry" type="tns:list_entry" minOccurs="0" maxOccurs="unbounded" />
+                </sequence>
+                <attribute name="key" type="string" use="required" />
+                <attribute name="text" type="string" />
+                <attribute name="text_context" type="string" />
+                <attribute name="values" type="string" />
                 <attribute name="values_context" type="string" />
                 <attribute name="display_values" type="string" />

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

@@ -8 +8 @@
 import java.awt.Component;
 import java.awt.Dimension;
+import java.awt.Font;
 import java.awt.GridBagLayout;
 import java.awt.Image;
@@ -72 +73 @@
 import org.openstreetmap.josm.gui.tagging.ac.AutoCompletionList;
 import org.openstreetmap.josm.gui.util.GuiHelper;
-import org.openstreetmap.josm.gui.widgets.HtmlPanel;
 import org.openstreetmap.josm.io.MirroredInputStream;
 import org.openstreetmap.josm.tools.GBC;
@@ -263 +263 @@
     }
 
-    protected static class PresetListEntry {
-        String value;
-        String display_value;
-        String short_description;
+    public static class PresetListEntry {
+        public String value;
+        public String display_value;
+        public String short_description;
+        public String icon;
 
         public String getListDisplay() {
@@ -284 +285 @@
             if (short_description != null) {
                 // wrap in table to restrict the text width
-                res.append("<br><table><td width='232'>(").append(short_description).append(")</td></table>");
+                res.append("<div style=\"width:300px; padding:0 0 5px 5px\">").append(short_description).append("</div>");
             }
             return res.toString();
+        }
+
+        public ImageIcon getIcon() {
+            return icon == null ? null : ImageProvider.getIfAvailable(icon);
+        }
+
+        public PresetListEntry() {
         }
 
@@ -304 +312 @@
             if (value.equals(DIFFERENT))
                 return DIFFERENT;
-            return display_value.replaceAll("<.*>", ""); // remove additional markup, e.g. <br>
+            return display_value == null ? value : display_value.replaceAll("<.*>", ""); // remove additional markup, e.g. <br>
         }
     }
@@ -525 +533 @@
         public String match = MatchType.NONE.getValue();
 
-        protected List<String> short_description_list;
         protected JComponent component;
-        protected Map<String, PresetListEntry> lhm;
+        protected Map<String, PresetListEntry> lhm = new LinkedHashMap<String, PresetListEntry>();
         protected Usage usage;
         protected Object originalValue;
@@ -543 +550 @@
             // find out if our key is already used in the selection.
             usage = determineTextUsage(sel, key);
-            String def = default_;
+
+            String[] display_array;
+            if (lhm.isEmpty()) {
+                display_array = initListEntriesFromAttributes();
+            } else {
+                if (values != null) {
+                    System.err.println(tr("Warning in tagging preset \"{0}-{1}\": "
+                            + "Ignoring ''{2}'' attribute as ''{3}'' elements are given.",
+                            key, text, "values", "list_entry"));
+                }
+                if (display_values != null || locale_display_values != null) {
+                    System.err.println(tr("Warning in tagging preset \"{0}-{1}\": "
+                            + "Ignoring ''{2}'' attribute as ''{3}'' elements are given.",
+                            key, text, "display_values", "list_entry"));
+                }
+                if (short_descriptions != null || locale_short_descriptions != null) {
+                    System.err.println(tr("Warning in tagging preset \"{0}-{1}\": "
+                            + "Ignoring ''{2}'' attribute as ''{3}'' elements are given.",
+                            key, text, "short_descriptions", "list_entry"));
+                }
+                display_array = new String[lhm.values().size()];
+                int i = 0;
+                for (PresetListEntry e : lhm.values()) {
+                    display_array[i++] = e.display_value;
+                }
+            }
+
+            if (locale_text == null) {
+                if (text_context != null) {
+                    locale_text = trc(text_context, fixPresetString(text));
+                } else {
+                    locale_text = tr(fixPresetString(text));
+                }
+            }
+            p.add(new JLabel(locale_text + ":"), GBC.std().insets(0, 0, 10, 0));
+
+            addToPanelAnchor(p, default_, display_array);
+
+            return true;
+
+        }
+
+        private String[] initListEntriesFromAttributes() {
 
             char delChar = getDelChar();
@@ -563 +612 @@
             } else if (short_descriptions != null) {
                 short_descriptions_array = splitEscaped(delChar, short_descriptions);
-            } else if (short_description_list != null) {
-                short_descriptions_array = short_description_list.toArray(new String[0]);
-            }
-
-            if (!"false".equals(use_last_as_default) && def == null && lastValue.containsKey(key)) {
-                def = lastValue.get(key);
             }
 
@@ -581 +624 @@
             }
 
-            lhm = new LinkedHashMap<String, PresetListEntry>();
             if (!usage.hasUniqueValue() && !usage.unused()) {
                 lhm.put(DIFFERENT, new PresetListEntry(DIFFERENT));
@@ -597 +639 @@
             }
 
-            if (locale_text == null) {
-                if (text_context != null) {
-                    locale_text = trc(text_context, fixPresetString(text));
-                } else {
-                    locale_text = tr(fixPresetString(text));
-                }
-            }
-            p.add(new JLabel(locale_text + ":"), GBC.std().insets(0, 0, 10, 0));
-
-            addToPanelAnchor(p, def, display_array);
-
-            return true;
-
+            return display_array;
         }
 
@@ -653 +683 @@
         }
 
-        public void setShort_description(String s) {
-            if (short_description_list == null) {
-                short_description_list = new ArrayList<String>();
-            }
-            short_description_list.add(tr(s));
+        public void addListEntry(PresetListEntry e) {
+            lhm.put(e.value, e);
+        }
+
+        public void addListEntries(Collection<PresetListEntry> e) {
+            for (PresetListEntry i : e) {
+                addListEntry(i);
+            }
         }
 
@@ -668 +701 @@
             return new ListCellRenderer() {
 
-                HtmlPanel lbl = new HtmlPanel();
+                JLabel lbl = new JLabel();
                 JComponent dummy = new JComponent() {
                 };
@@ -687 +720 @@
 
                     PresetListEntry item = (PresetListEntry) value;
-                    String s = item.getListDisplay();
-                    lbl.setText(s);
+                    lbl.setOpaque(true);
+                    lbl.setFont(lbl.getFont().deriveFont(Font.PLAIN));
+                    lbl.setText("<html>" + item.getListDisplay() + "</html>");
+                    lbl.setIcon(item.getIcon());
                     lbl.setEnabled(list.isEnabled());
                     // We do not want the editor to have the maximum height of all
@@ -1292 +1327 @@
         parser.map("space", Space.class);
         parser.map("key", Key.class);
+        parser.map("list_entry", PresetListEntry.class);
         LinkedList<TaggingPreset> all = new LinkedList<TaggingPreset>();
         TaggingPresetMenu lastmenu = null;
         Roles lastrole = null;
+        List<PresetListEntry> listEntries = new LinkedList<PresetListEntry>();
 
         if (validate) {
@@ -1328 +1365 @@
                 lastrole = null;
             } else {
-                if(all.size() != 0) {
-                    if(o instanceof Roles) {
-                        all.getLast().data.add((Item)o);
+                if (all.size() != 0) {
+                    if (o instanceof Roles) {
+                        all.getLast().data.add((Item) o);
                         lastrole = (Roles) o;
-                    }
-                    else if(o instanceof Role) {
-                        if(lastrole == null)
+                    } else if (o instanceof Role) {
+                        if (lastrole == null) {
                             throw new SAXException(tr("Preset role element without parent"));
+                        }
                         lastrole.roles.add((Role) o);
-                    }
-                    else {
-                        all.getLast().data.add((Item)o);
+                    } else if (o instanceof PresetListEntry) {
+                        listEntries.add((PresetListEntry) o);
+                    } else {
+                        all.getLast().data.add((Item) o);
+                        if (o instanceof ComboMultiSelect) {
+                            ((ComboMultiSelect) o).addListEntries(listEntries);
+                        }
+                        listEntries = new LinkedList<PresetListEntry>();
                         lastrole = null;
                     }