Changeset 3726 in josm for trunk

Timestamp:

2010-12-15T20:36:19+01:00 (13 years ago)

Author:

bastiK

Message:

add short_description (for sac_scale preset)

Location:

trunk

Files:

• data/defaultpresets.xml (modified) (1 diff)
• src/org/openstreetmap/josm/gui/tagging/TaggingPreset.java (modified) (13 diffs)

trunk/data/defaultpresets.xml

@@ -506 +506 @@
             <optional>
                 <text key="name" text="Name" default="" delete_if_empty="true" />
-                <combo key="sac_scale" text="SAC Scale" values="hiking,mountain_hiking,demanding_mountain_hiking,alpine_hiking,demanding_alpine_hiking,difficult_alpine_hiking" default="" delete_if_empty="true" />
+                <combo key="sac_scale" text="SAC Scale" values="hiking,mountain_hiking,demanding_mountain_hiking,alpine_hiking,demanding_alpine_hiking,difficult_alpine_hiking" default="" delete_if_empty="true" display_values="T1 - hiking trail,T2 - mountain hiking trail,T3 - difficult,T4 - difficult\, exposed\, steep alpine trail,T5 - difficult\, exposed\, steep alpine trail&lt;br&gt;with climbing,T6 - difficult\, hazardous alpine trail with&lt;br&gt;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>
                 <combo key="surface" text="Surface" values="paved,unpaved,asphalt,concrete,metal,wood,paving_stones,cobblestone,gravel,pebblestone,compacted,grass_paver,grass,sand,ground" default="" delete_if_empty="true" />
                 <combo key="mtb:scale" text="MTB Scale" values="0,1,2,3,4,5" default="" delete_if_empty="true" />

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

@@ -7 +7 @@
 
 import java.awt.Component;
+import java.awt.Dimension;
 import java.awt.GridBagLayout;
 import java.awt.Image;
@@ -27 +28 @@
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Map;
 import java.util.TreeSet;
 
@@ -35 +37 @@
 import javax.swing.JComponent;
 import javax.swing.JLabel;
+import javax.swing.JList;
 import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JTextField;
+import javax.swing.ListCellRenderer;
 import javax.swing.SwingUtilities;
 
@@ -61 +65 @@
 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;
@@ -344 +349 @@
         public String display_values;
         public String locale_display_values;
+        public String short_descriptions;
+        public String locale_short_descriptions;
         public String default_;
         public boolean delete_if_empty = false;
@@ -350 +357 @@
         public boolean required = false;
 
+        private List<String> short_description_list;
         private JComboBox combo;
-        private LinkedHashMap<String,String> lhm;
+        private Map<String, PresetListEnty> lhm;
         private Usage usage;
-        private String originalValue;
+        private PresetListEnty originalValue;
 
         @Override public boolean addToPanel(JPanel p, Collection<OsmPrimitive> sel) {
@@ -363 +371 @@
             String[] value_array = values.split(",");
             String[] display_array;
+            String[] short_descriptions_array = null;
 
             if(locale_display_values != null) {
-                display_array = locale_display_values.split(",");
-            } else if(display_values != null) {
-                display_array = display_values.split(",");
+                display_array = splitEscaped(locale_display_values);
+            } else if (display_values != null) {
+                display_array = splitEscaped(display_values);
             } else {
                 display_array = value_array;
             }
 
-            if(use_last_as_default && def == null && lastValue.containsKey(key))
-            {
+            if (locale_short_descriptions != null) {
+                short_descriptions_array = splitEscaped(locale_short_descriptions);
+            } else if (short_descriptions != null) {
+                short_descriptions_array = splitEscaped(short_descriptions);
+            } else if (short_description_list != null) {
+                short_descriptions_array = short_description_list.toArray(new String[0]);
+            }
+
+            if (use_last_as_default && def == null && lastValue.containsKey(key)) {
                 def = lastValue.get(key);
             }
@@ -382 +398 @@
             }
 
-            lhm = new LinkedHashMap<String,String>();
-            if (!usage.hasUniqueValue() && !usage.unused()){
-                lhm.put(DIFFERENT, DIFFERENT);
+            if (short_descriptions_array != null && short_descriptions_array.length != value_array.length) {
+                System.err.println(tr("Broken tagging preset \"{0}-{1}\" - number of items in short_descriptions must be the same as in values", key, text));
+                short_descriptions_array = null;
+            }
+
+            lhm = new LinkedHashMap<String, PresetListEnty>();
+            if (!usage.hasUniqueValue() && !usage.unused()) {
+                lhm.put(DIFFERENT, new PresetListEnty(DIFFERENT));
             }
             for (int i=0; i<value_array.length; i++) {
-                lhm.put(value_array[i], (locale_display_values == null)
+                PresetListEnty e = new PresetListEnty(value_array[i]);
+                e.display_value = (locale_display_values == null)
                         ? (values_context == null ? tr(display_array[i])
-                                : trc(values_context, display_array[i])) : display_array[i]);
+                                : trc(values_context, display_array[i])) : display_array[i];
+                if (short_descriptions_array != null) {
+                    e.short_description = locale_short_descriptions == null ? tr(short_descriptions_array[i])
+                            : short_descriptions_array[i];
+                }
+                lhm.put(value_array[i], e);
             }
             if(!usage.unused()){
                 for (String s : usage.values) {
                     if (!lhm.containsKey(s)) {
-                        lhm.put(s, s);
+                        lhm.put(s, new PresetListEnty(s));
                     }
                 }
             }
             if (def != null && !lhm.containsKey(def)) {
-                lhm.put(def, def);
-            }
-            if(!lhm.containsKey("")) {
-                lhm.put("", "");
-            }
+                lhm.put(def, new PresetListEnty(def));
+            }
+            lhm.put("", new PresetListEnty(""));
 
             combo = new JComboBox(lhm.values().toArray());
+            combo.setRenderer(new PresetComboListCellRenderer());
             combo.setEditable(editable);
             combo.setMaximumRowCount(13);
@@ -414 +440 @@
 
             if (usage.hasUniqueValue() && !usage.unused()){
-                originalValue=usage.getFirst();
-                combo.setSelectedItem(lhm.get(originalValue));
+                originalValue=lhm.get(usage.getFirst());
             }
             // use default only in case it is a totally new entry
             else if(def != null && !usage.hadKeys()) {
-                combo.setSelectedItem(def);
-                originalValue=DIFFERENT;
+                originalValue=lhm.get(DIFFERENT);
             }
             else if(usage.unused()){
-                combo.setSelectedItem("");
-                originalValue="";
+                originalValue=lhm.get("");
             }
             else{
-                combo.setSelectedItem(DIFFERENT);
-                originalValue=DIFFERENT;
-            }
+                originalValue=lhm.get(DIFFERENT);
+            }
+            combo.setSelectedItem(originalValue);
 
             if(locale_text == null) {
@@ -442 +465 @@
             return true;
         }
+
+        private static class PresetListEnty {
+            String value;
+            String display_value;
+            String short_description;
+
+            public String getListDisplay() {
+                if (value.equals(DIFFERENT))
+                    return "<b>"+DIFFERENT.replaceAll("<", "&lt;").replaceAll(">", "&gt;")+"</b>";
+
+                if (value.equals(""))
+                    return "&nbsp;";
+
+                StringBuilder res = new StringBuilder("<b>");
+                if (display_value != null) {
+                    res.append(display_value);
+                } else {
+                    res.append(value);
+                }
+                res.append("</b>");
+                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>");
+                }
+                return res.toString();
+            }
+
+            public PresetListEnty(String value) {
+                this.value = value;
+                this.display_value = value;
+            }
+
+            public PresetListEnty(String value, String display_value) {
+                this.value = value;
+                this.display_value = display_value;
+            }
+
+            // toString is mainly used to initialize the Editor
+            @Override
+            public String toString() {
+                if (value.equals(DIFFERENT))
+                    return DIFFERENT;
+                return display_value.replaceAll("<.*>", ""); // remove additional markup, e.g. <br>
+            }
+        }
+
+        private static class PresetComboListCellRenderer implements ListCellRenderer {
+
+            HtmlPanel lbl;
+            JComponent dummy = new JComponent() {};
+
+            public PresetComboListCellRenderer() {
+                lbl = new HtmlPanel();
+            }
+
+            public Component getListCellRendererComponent(
+                    JList list,
+                    Object value,
+                    int index,
+                    boolean isSelected,
+                    boolean cellHasFocus)
+            {
+                if (isSelected) {
+                    lbl.setBackground(list.getSelectionBackground());
+                    lbl.setForeground(list.getSelectionForeground());
+                } else {
+                    lbl.setBackground(list.getBackground());
+                    lbl.setForeground(list.getForeground());
+                }
+
+                PresetListEnty item = (PresetListEnty) value;
+                String s = item.getListDisplay();
+                lbl.setText(s);
+                // We do not want the editor to have the maximum height of all
+                // entries. Return a dummy with bogus height.
+                if (index == -1) {
+                    dummy.setPreferredSize(new Dimension(lbl.getPreferredSize().width, 10));
+                    return dummy;
+                }
+                return lbl;
+            }
+        }
+
+        // allow escaped comma in comma separated list:
+        // "A\, B\, C,one\, two" --> ["A, B, C", "one, two"]
+        private static String[] splitEscaped(String s) {
+            String[] res = s.replaceAll("\\\\,", "\u0091").split(",");
+            for (int i=0; i<res.length; ++i) {
+                res[i] = res[i].replaceAll("\u0091", ",");
+            }
+            return res;
+        }
+
         @Override public void addCommands(List<Tag> changedTags) {
             Object obj = combo.getSelectedItem();
@@ -453 +569 @@
             {
                 for (String key : lhm.keySet()) {
-                    String k = lhm.get(key);
+                    String k = lhm.get(key).toString();
                     if (k != null && k.equals(display)) {
                         value=key;
@@ -466 +582 @@
 
             // no change if same as before
-            if (value.equals(originalValue) || (originalValue == null &&  value.length() == 0)) return;
+            if (originalValue == null) {
+                if (value.length() == 0)
+                    return;
+            } else if (value.equals(originalValue.toString()))
+                return;
 
             if (delete_if_empty && value.length() == 0) {
@@ -474 +594 @@
                 lastValue.put(key, value);
             }
+            System.err.print("change: "+key+" "+value);
             changedTags.add(new Tag(key, value));
         }
+
+        public void setShort_description(String s) {
+            if (short_description_list == null) {
+                short_description_list = new ArrayList<String>();
+            }
+            short_description_list.add(tr(s));
+        }
+
         @Override boolean requestFocusInWindow() {return combo.requestFocusInWindow();}
     }