Changeset 15289 in josm for trunk/src/org

Timestamp:

2019-08-07T21:50:20+02:00 (5 years ago)

Author:

Don-vip

Message:

see #10435 - Enable grouping of similar settings for enabling/disabling several settings at once

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• dialogs/MapPaintDialog.java (modified) (3 diffs)
• mappaint/BooleanStyleSettingGui.java (modified) (2 diffs)
• mappaint/StyleSetting.java (modified) (3 diffs)
• mappaint/StyleSettingGroupGui.java (added)
• mappaint/StyleSource.java (modified) (3 diffs)
• mappaint/mapcss/MapCSSStyleSource.java (modified) (4 diffs)
• mappaint/mapcss/Selector.java (modified) (3 diffs)

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

@@ -25 +25 @@
 import java.util.Collection;
 import java.util.List;
+import java.util.Map.Entry;
+import java.util.stream.Collectors;
 
 import javax.swing.AbstractAction;
@@ -63 +65 @@
 import org.openstreetmap.josm.gui.mappaint.MapPaintStyles.MapPaintSylesUpdateListener;
 import org.openstreetmap.josm.gui.mappaint.StyleSetting;
+import org.openstreetmap.josm.gui.mappaint.StyleSetting.StyleSettingGroup;
+import org.openstreetmap.josm.gui.mappaint.StyleSettingGroupGui;
 import org.openstreetmap.josm.gui.mappaint.StyleSettingGuiFactory;
 import org.openstreetmap.josm.gui.mappaint.StyleSource;
@@ -691 +695 @@
             add(setMenu);
 
-            int sel = tblStyles.getSelectionModel().getLeadSelectionIndex();
-            StyleSource style = null;
-            if (sel >= 0 && sel < model.getRowCount()) {
-                style = model.getRow(sel);
-            }
+            final int sel = tblStyles.getSelectionModel().getLeadSelectionIndex();
+            final StyleSource style = sel >= 0 && sel < model.getRowCount() ? model.getRow(sel) : null;
             if (style == null || style.settings.isEmpty()) {
                 setMenu.setEnabled(false);
             } else {
-                for (StyleSetting s : style.settings) {
+                // Add settings groups
+                for (Entry<StyleSettingGroup, List<StyleSetting>> e : style.settingGroups.entrySet()) {
+                    new StyleSettingGroupGui(e.getKey(), e.getValue()).addMenuEntry(setMenu);
+                }
+                // Add settings not in groups
+                final List<StyleSetting> allStylesInGroups = style.settingGroups.values().stream()
+                        .flatMap(l -> l.stream()).collect(Collectors.toList());
+                for (StyleSetting s : style.settings.stream()
+                        .filter(s -> !allStylesInGroups.contains(s)).collect(Collectors.toList())) {
                     StyleSettingGuiFactory.getStyleSettingGui(s).addMenuEntry(setMenu);
                 }

trunk/src/org/openstreetmap/josm/gui/mappaint/BooleanStyleSettingGui.java

@@ -7 +7 @@
 
 import javax.swing.AbstractAction;
-import javax.swing.Action;
 import javax.swing.JCheckBoxMenuItem;
 import javax.swing.JMenu;
@@ -32 +31 @@
     }
 
+    static class BooleanStyleSettingCheckBoxMenuItem extends JCheckBoxMenuItem {
+        boolean noRepaint = false;
+
+        public BooleanStyleSettingCheckBoxMenuItem(BooleanStyleSetting setting) {
+            setAction(new AbstractAction(setting.label) {
+                @Override
+                public void actionPerformed(ActionEvent e) {
+                    setting.setValue(isSelected());
+                    if (!noRepaint) {
+                        MainApplication.worker.submit(new MapPaintStyleLoader(Arrays.asList(setting.parentStyle)));
+                    }
+                }
+            });
+            setSelected((boolean) setting.getValue());
+            setUI(new StayOpenCheckBoxMenuItemUI());
+        }
+
+        public void doClickWithoutRepaint(int pressTime) {
+            noRepaint = true;
+            doClick(pressTime);
+            noRepaint = false;
+        }
+    }
+
     @Override
     public void addMenuEntry(JMenu menu) {
-        final JCheckBoxMenuItem item = new JCheckBoxMenuItem();
-        Action a = new AbstractAction(setting.label) {
-            @Override
-            public void actionPerformed(ActionEvent e) {
-                setting.setValue(item.isSelected());
-                MainApplication.worker.submit(new MapPaintStyleLoader(Arrays.asList(setting.parentStyle)));
-            }
-        };
-        item.setAction(a);
-        item.setSelected((boolean) setting.getValue());
-        item.setUI(new StayOpenCheckBoxMenuItemUI());
-        menu.add(item);
+        menu.add(new BooleanStyleSettingCheckBoxMenuItem(setting));
     }
 }

trunk/src/org/openstreetmap/josm/gui/mappaint/StyleSetting.java

@@ -2 +2 @@
 package org.openstreetmap.josm.gui.mappaint;
 
+import java.util.Objects;
+import java.util.Optional;
+
+import javax.swing.Icon;
+
 import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.ImageProvider.ImageSizes;
 import org.openstreetmap.josm.tools.Logging;
 
@@ -34 +41 @@
 
     /**
+     * Superclass of style settings and groups.
+     * @since 15289
+     */
+    abstract class LabeledStyleSetting implements Comparable<LabeledStyleSetting> {
+        public final StyleSource parentStyle;
+        public final String label;
+
+        LabeledStyleSetting(StyleSource parentStyle, String label) {
+            this.parentStyle = Objects.requireNonNull(parentStyle);
+            this.label = Objects.requireNonNull(label);
+        }
+
+        @Override
+        public int compareTo(LabeledStyleSetting o) {
+            return label.compareTo(o.label);
+        }
+    }
+
+    /**
+     * A style setting group.
+     * @since 15289
+     */
+    class StyleSettingGroup extends LabeledStyleSetting {
+        public final String key;
+        public final Icon icon;
+
+        public StyleSettingGroup(StyleSource parentStyle, String label, String key, Icon icon) {
+            super(parentStyle, label);
+            this.key = Objects.requireNonNull(key);
+            this.icon = icon;
+        }
+
+        public static StyleSettingGroup create(Cascade c, StyleSource parentStyle, String key) {
+            String label = c.get("label", null, String.class);
+            if (label == null) {
+                Logging.warn("property 'label' required for boolean style setting");
+                return null;
+            }
+            Icon icon = Optional.ofNullable(c.get("icon", null, String.class))
+                    .map(s -> ImageProvider.get(s, ImageSizes.MENU)).orElse(null);
+            return new StyleSettingGroup(parentStyle, label, key, icon);
+        }
+    }
+
+    /**
      * A style setting for boolean value (yes / no).
      */
-    class BooleanStyleSetting implements StyleSetting, Comparable<BooleanStyleSetting> {
-        public final StyleSource parentStyle;
+    class BooleanStyleSetting extends LabeledStyleSetting implements StyleSetting {
         public final String prefKey;
-        public final String label;
         public final boolean def;
 
         public BooleanStyleSetting(StyleSource parentStyle, String prefKey, String label, boolean def) {
-            this.parentStyle = parentStyle;
-            this.prefKey = prefKey;
-            this.label = label;
+            super(parentStyle, label);
+            this.prefKey = Objects.requireNonNull(prefKey);
             this.def = def;
         }
@@ -82 +131 @@
             }
         }
-
-        @Override
-        public int compareTo(BooleanStyleSetting o) {
-            return label.compareTo(o.label);
-        }
     }
 }

trunk/src/org/openstreetmap/josm/gui/mappaint/StyleSource.java

@@ -15 +15 @@
 import java.util.Map;
 import java.util.Set;
+import java.util.TreeMap;
 import java.util.concurrent.CopyOnWriteArrayList;
 import java.util.concurrent.CopyOnWriteArraySet;
@@ -24 +25 @@
 import org.openstreetmap.josm.data.preferences.sources.SourceType;
 import org.openstreetmap.josm.gui.mappaint.MapPaintStyles.IconReference;
+import org.openstreetmap.josm.gui.mappaint.StyleSetting.StyleSettingGroup;
 import org.openstreetmap.josm.io.CachedFile;
 import org.openstreetmap.josm.tools.ImageOverlay;
@@ -65 +67 @@
      */
     public Map<String, Object> settingValues = new HashMap<>();
+    /**
+     * Map of settings per group.
+     */
+    public final Map<StyleSettingGroup, List<StyleSetting>> settingGroups = new TreeMap<>();
 
     /**

trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/MapCSSStyleSource.java

@@ -49 +49 @@
 import org.openstreetmap.josm.gui.mappaint.StyleSetting;
 import org.openstreetmap.josm.gui.mappaint.StyleSetting.BooleanStyleSetting;
+import org.openstreetmap.josm.gui.mappaint.StyleSetting.StyleSettingGroup;
 import org.openstreetmap.josm.gui.mappaint.StyleSource;
 import org.openstreetmap.josm.gui.mappaint.mapcss.ConditionFactory.KeyCondition;
@@ -502 +503 @@
                     case Selector.BASE_META:
                     case Selector.BASE_SETTING:
+                    case Selector.BASE_SETTINGS:
                         break;
                     default:
@@ -576 +578 @@
     }
 
+    private static void loadSettings(MapCSSRule r, GeneralSelector gs, Environment env) {
+        if (gs.matchesConditions(env)) {
+            env.layer = null;
+            env.layer = gs.getSubpart().getId(env);
+            r.execute(env);
+        }
+    }
+
     private void loadSettings() {
         settings.clear();
         settingValues.clear();
+        settingGroups.clear();
         MultiCascade mc = new MultiCascade();
+        MultiCascade mcGroups = new MultiCascade();
         Node n = new Node();
-        String code = LanguageInfo.getJOSMLocaleCode();
-        n.put("lang", code);
+        n.put("lang", LanguageInfo.getJOSMLocaleCode());
         // create a fake environment to read the meta data block
         Environment env = new Environment(n, mc, "default", this);
-
+        Environment envGroups = new Environment(n, mcGroups, "default", this);
+
+        // Parse rules
         for (MapCSSRule r : rules) {
             if (r.selector instanceof GeneralSelector) {
                 GeneralSelector gs = (GeneralSelector) r.selector;
                 if (Selector.BASE_SETTING.equals(gs.getBase())) {
-                    if (!gs.matchesConditions(env)) {
-                        continue;
-                    }
-                    env.layer = null;
-                    env.layer = gs.getSubpart().getId(env);
-                    r.execute(env);
-                }
-            }
-        }
+                    loadSettings(r, gs, env);
+                } else if (Selector.BASE_SETTINGS.equals(gs.getBase())) {
+                    loadSettings(r, gs, envGroups);
+                }
+            }
+        }
+        // Load groups
+        for (Entry<String, Cascade> e : mcGroups.getLayers()) {
+            if ("default".equals(e.getKey())) {
+                Logging.warn("settings requires layer identifier e.g. 'settings::settings_group {...}'");
+                continue;
+            }
+            settingGroups.put(StyleSettingGroup.create(e.getValue(), this, e.getKey()), new ArrayList<>());
+        }
+        // Load settings
         for (Entry<String, Cascade> e : mc.getLayers()) {
             if ("default".equals(e.getKey())) {
@@ -610 +629 @@
                 set = BooleanStyleSetting.create(c, this, e.getKey());
             } else {
-                Logging.warn("Unknown setting type: "+type);
+                Logging.warn("Unknown setting type: {0}", type);
             }
             if (set != null) {
                 settings.add(set);
                 settingValues.put(e.getKey(), set.getValue());
+                String groupId = c.get("group", null, String.class);
+                if (groupId != null) {
+                    settingGroups.get(settingGroups.keySet().stream().filter(g -> g.key.equals(groupId)).findAny()
+                            .orElseThrow(() -> new IllegalArgumentException("Unknown settings group: " + groupId))).add(set);
+                }
             }
         }

trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Selector.java

@@ -74 +74 @@
     /** selector base for artificial bases created to use preferences. */
     String BASE_SETTING = "setting";
+
+    /** selector base for grouping settings. */
+    String BASE_SETTINGS = "settings";
 
     /**
@@ -703 +706 @@
             case "canvas": return BASE_CANVAS;
             case "setting": return BASE_SETTING;
+            case "settings": return BASE_SETTINGS;
             default:
                 throw new IllegalArgumentException(MessageFormat.format("Unknown MapCSS base selector {0}", base));
@@ -779 +783 @@
         @Override
         public String toString() {
-            return base + (Range.ZERO_TO_INFINITY.equals(range) ? "" : range) + Utils.join("", conds)
+            return base + (Range.ZERO_TO_INFINITY.equals(range) ? "" : range) + (conds != null ? Utils.join("", conds) : "")
                     + (subpart != null && subpart != Subpart.DEFAULT_SUBPART ? ("::" + subpart) : "");
         }