Changeset 5464 in josm

Timestamp:

Aug 20, 2012 11:06:41 PM (9 months ago)

Author:

Don-vip

Message:

Rework Properties a bit to simplify management of Color properties

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/Preferences.java (modified) (6 diffs)
• data/osm/visitor/paint/PaintColors.java (modified) (1 diff)
• data/preferences/AbstractProperty.java (modified) (1 diff)
• data/preferences/BooleanProperty.java (modified) (1 diff)
• data/preferences/CachedProperty.java (modified) (3 diffs)
• data/preferences/CollectionProperty.java (modified) (1 diff)
• data/preferences/ColorProperty.java (added)
• data/preferences/IntegerProperty.java (modified) (2 diffs)
• data/preferences/ParametrizedCollectionProperty.java (deleted)
• data/preferences/StringProperty.java (modified) (1 diff)
• gui/conflict/ConflictColors.java (modified) (1 diff)
• gui/layer/ImageryLayer.java (modified) (2 diffs)
• gui/layer/markerlayer/Marker.java (modified) (4 diffs)
• gui/preferences/imagery/ImageryPreference.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/data/Preferences.java

@@ -49 +49 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.preferences.ColorProperty;
 import org.openstreetmap.josm.io.MirroredInputStream;
 import org.openstreetmap.josm.io.XmlWriter;
@@ -241 +242 @@
         String getColorName();
         String getSpecialName();
-        Color getDefault();
+        Color getDefaultValue();
     }
 
@@ -449 +450 @@
     }
 
-    synchronized public boolean getBoolean(final String key) {
+    synchronized public Boolean getBoolean(final String key) {
         putDefault(key, null);
         return properties.containsKey(key) ? Boolean.parseBoolean(properties.get(key)) : false;
     }
 
-    synchronized public boolean getBoolean(final String key, final boolean def) {
+    synchronized public Boolean getBoolean(final String key, final boolean def) {
         putDefault(key, Boolean.toString(def));
         return properties.containsKey(key) ? Boolean.parseBoolean(properties.get(key)) : def;
     }
 
-    synchronized public boolean getBoolean(final String key, final String specName, final boolean def) {
+    synchronized public Boolean getBoolean(final String key, final String specName, final boolean def) {
         putDefault(key, Boolean.toString(def));
         String skey = key+"."+specName;
@@ -802 +803 @@
 
     public Color getColor(ColorKey key) {
-        return getColor(key.getColorName(), key.getSpecialName(), key.getDefault());
+        return getColor(key.getColorName(), key.getSpecialName(), key.getDefaultValue());
     }
 
@@ -814 +815 @@
      */
     synchronized public Color getColor(String colName, String specName, Color def) {
-        String colKey = colName.toLowerCase().replaceAll("[^a-z0-9]+",".");
+        String colKey = ColorProperty.getColorKey(colName);
         if(!colKey.equals(colName)) {
             colornames.put(colKey, colName);
@@ -826 +827 @@
     }
 
-    synchronized public Color getDefaultColor(String colName) {
-        String colStr = defaults.get("color."+colName);
+    synchronized public Color getDefaultColor(String colKey) {
+        String colStr = defaults.get("color."+colKey);
         return colStr == null || "".equals(colStr) ? null : ColorHelper.html2color(colStr);
     }
 
-    synchronized public boolean putColor(String colName, Color val) {
-        return put("color."+colName, val != null ? ColorHelper.color2html(val) : null);
+    synchronized public boolean putColor(String colKey, Color val) {
+        return put("color."+colKey, val != null ? ColorHelper.color2html(val) : null);
     }
 

trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/PaintColors.java

@@ -57 +57 @@
     }
 
+    @Override
     public String getColorName() {
         return name;
     }
 
-    public Color getDefault() {
+    @Override
+    public Color getDefaultValue() {
         return defaultColor;
     }
 
+    @Override
     public String getSpecialName() {
         return null;

trunk/src/org/openstreetmap/josm/data/preferences/AbstractProperty.java

@@ -5 +5 @@
 
 /**
- * captures the common functionality of preference properties
+ * Captures the common functionality of preference properties
+ * @param <T> The type of object accessed by this property
  */
 public abstract class AbstractProperty<T> {
     protected final String key;
+    protected final T defaultValue;
 
-    public AbstractProperty(String key) {
+    /**
+     * Constructs a new {@code AbstractProperty}.
+     * @param key The property key
+     * @param defaultValue The default value
+     * @since 5464
+     */
+    public AbstractProperty(String key, T defaultValue) {
         this.key = key;
+        this.defaultValue = defaultValue;
     }
 
+    /**
+     * Replies the property key.
+     * @return The property key
+     */
     public String getKey() {
         return key;
     }
 
+    /**
+     * Determines if this property is currently set in JOSM preferences.
+     * @return true if {@code Main.pref} contains this property.
+     */
     public boolean isSet() {
         return !Main.pref.get(key).isEmpty();
     }
 
-    public abstract T getDefaultValue();
+    /**
+     * Replies the default value of this property.
+     * @return The default value of this property
+     */
+    public T getDefaultValue() {
+        return defaultValue;
+    }
 
+    /**
+     * Removes this property from JOSM preferences (i.e replace it by its default value).
+     */
     public void remove() {
         Main.pref.put(getKey(), String.valueOf(getDefaultValue()));
     }
-
+    
+    /**
+     * Replies the value of this property.
+     * @return the value of this property
+     * @since 5464
+     */
+    public abstract T get();
+    
+    /**
+     * Sets this property to the specified value.
+     * @param value The new value of this property
+     * @return true if something has changed (i.e. value is different than before)
+     * @since 5464
+     */
+    public abstract boolean put(T value);
 }

trunk/src/org/openstreetmap/josm/data/preferences/BooleanProperty.java

@@ -4 +4 @@
 import org.openstreetmap.josm.Main;
 
+/**
+ * A property containing a {@code Boolean} value.
+ */
 public class BooleanProperty extends AbstractProperty<Boolean> {
 
-    protected final boolean defaultValue;
-
+    /**
+     * Constructs a new {@code BooleanProperty}.
+     * @param key The property key
+     * @param defaultValue The default value
+     */
     public BooleanProperty(String key, boolean defaultValue) {
-        super(key);
-        this.defaultValue = defaultValue;
+        super(key, defaultValue);
     }
 
-    public boolean get() {
+    @Override
+    public Boolean get() {
         return Main.pref.getBoolean(getKey(), defaultValue);
     }
 
-    public boolean put(boolean value) {
+    @Override
+    public boolean put(Boolean value) {
         return Main.pref.put(getKey(), value);
     }
-
-    @Override
-    public Boolean getDefaultValue() {
-        return defaultValue;
-    }
 }

trunk/src/org/openstreetmap/josm/data/preferences/CachedProperty.java

@@ -8 +8 @@
 public abstract class CachedProperty<T> extends AbstractProperty<T> implements PreferenceChangedListener {
 
-    protected final String defaultValue;
+    private final String defaultValueAsString;
     private T value;
     private int updateCount;
 
-    protected CachedProperty(String key, String defaultValue) {
-        super(key);
+    protected CachedProperty(String key, T defaultValue, String defaultValueAsString) {
+        super(key, defaultValue);
         Main.pref.addPreferenceChangeListener(this);
-        this.defaultValue = defaultValue;
+        this.defaultValueAsString = defaultValueAsString;
         updateValue();
     }
@@ -30 +30 @@
     protected abstract T fromString(String s);
 
+    @Override
     public T get() {
         return value;
@@ -40 +41 @@
     }
 
+    @Override
+    public final boolean put(T value) {
+        // Not used
+        throw new IllegalAccessError("You cannot use put(T). Use put(String) instead.");
+    }
+
     public int getUpdateCount() {
         return updateCount;
     }
 
-    @Override
-    public T getDefaultValue() {
-        return fromString(getDefaultValueAsString());
-    }
-
     public String getDefaultValueAsString() {
-        return defaultValue;
+        return defaultValueAsString;
     }
 

trunk/src/org/openstreetmap/josm/data/preferences/CollectionProperty.java

@@ -6 +6 @@
 import org.openstreetmap.josm.Main;
 
+/**
+ * A property containing a {@code Collection} of {@code String} as value.
+ */
 public class CollectionProperty extends AbstractProperty<Collection<String>> {
-    protected final Collection<String> defaultValue;
 
+    /**
+     * Constructs a new {@code CollectionProperty}.
+     * @param key The property key
+     * @param defaultValue The default value
+     */
     public CollectionProperty(String key, Collection<String> defaultValue) {
-        super(key);
-        this.defaultValue = defaultValue;
+        super(key, defaultValue);
     }
 
+    @Override
     public Collection<String> get() {
         return Main.pref.getCollection(getKey(), getDefaultValue());
     }
 
+    @Override
     public boolean put(Collection<String> value) {
         return Main.pref.putCollection(getKey(), value);
     }
-
-    @Override
-    public Collection<String> getDefaultValue() {
-        return defaultValue;
-    }
-
 }

trunk/src/org/openstreetmap/josm/data/preferences/IntegerProperty.java

@@ -4 +4 @@
 import org.openstreetmap.josm.Main;
 
+/**
+ * A property containing an {@code Integer} value.
+ */
 public class IntegerProperty extends AbstractProperty<Integer> {
 
-    protected final int defaultValue;
-
+    /**
+     * Constructs a new {@code IntegerProperty}.
+     * @param key The property key
+     * @param defaultValue The default value
+     */
     public IntegerProperty(String key, int defaultValue) {
-        super(key);
-        this.defaultValue = defaultValue;
+        super(key, defaultValue);
     }
 
-    public int get() {
+    @Override
+    public Integer get() {
         return Main.pref.getInteger(getKey(), getDefaultValue());
     }
 
-    public boolean put(int value) {
+    @Override
+    public boolean put(Integer value) {
         return Main.pref.putInteger(getKey(), value);
     }
@@ -36 +43 @@
         return put(intVal);
     }
-
-    @Override
-    public Integer getDefaultValue() {
-        return defaultValue;
-    }
-
 }

trunk/src/org/openstreetmap/josm/data/preferences/StringProperty.java

@@ -4 +4 @@
 import org.openstreetmap.josm.Main;
 
+/**
+ * A property containing an {@code String} value.
+ */
 public class StringProperty extends AbstractProperty<String> {
 
-    protected final String defaultValue;
-
+    /**
+     * Constructs a new {@code StringProperty}.
+     * @param key The property key
+     * @param defaultValue The default value
+     */
     public StringProperty(String key, String defaultValue) {
-        super(key);
-        this.defaultValue = defaultValue;
+        super(key, defaultValue);
     }
 
+    @Override
     public String get() {
         return Main.pref.get(getKey(), getDefaultValue());
     }
 
+    @Override
     public boolean put(String value) {
         return Main.pref.put(getKey(), value);
     }
-
-    @Override
-    public String getDefaultValue() {
-        return defaultValue;
-    }
-
 }

trunk/src/org/openstreetmap/josm/gui/conflict/ConflictColors.java

@@ -45 +45 @@
     }
 
+    @Override
     public String getColorName() {
         return name;
     }
 
-    public Color getDefault() {
+    @Override
+    public Color getDefaultValue() {
         return defaultColor;
     }
 
+    @Override
     public String getSpecialName() {
         return null;

trunk/src/org/openstreetmap/josm/gui/layer/ImageryLayer.java

@@ -35 +35 @@
 import org.openstreetmap.josm.data.imagery.ImageryInfo.ImageryType;
 import org.openstreetmap.josm.data.imagery.OffsetBookmark;
+import org.openstreetmap.josm.data.preferences.ColorProperty;
 import org.openstreetmap.josm.data.preferences.IntegerProperty;
 import org.openstreetmap.josm.gui.MenuScroller;
@@ -43 +44 @@
 public abstract class ImageryLayer extends Layer {
 
+    public static final ColorProperty PROP_FADE_COLOR = new ColorProperty(marktr("Imagery fade"), Color.white);
     public static final IntegerProperty PROP_FADE_AMOUNT = new IntegerProperty("imagery.fade_amount", 0);
     public static final IntegerProperty PROP_SHARPEN_LEVEL = new IntegerProperty("imagery.sharpen_level", 0);
 
     public static Color getFadeColor() {
-        return Main.pref.getColor(marktr("Imagery fade"), Color.white);
+        return PROP_FADE_COLOR.get();
     }
 
     public static Color getFadeColorWithAlpha() {
-        Color c = getFadeColor();
+        Color c = PROP_FADE_COLOR.get();
         return new Color(c.getRed(),c.getGreen(),c.getBlue(),PROP_FADE_AMOUNT.get()*255/100);
-    }
-
-    public static void setFadeColor(Color color) {
-        Main.pref.putColor("imagery.fade", color);
     }
 

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java

@@ -102 +102 @@
             TemplateEntryProperty result = cache.get(key);
             if (result == null) {
-                String defaultValue = layerName == null?getDefaultLabelPattern():"";
-                TemplateEntryProperty parent = layerName == null?null:forMarker(null);
-                result = new TemplateEntryProperty(key, defaultValue, parent);
-                cache.put(key, result);
+                String defaultValue = layerName == null ? getDefaultLabelPattern():"";
+                TemplateEntryProperty parent = layerName == null ? null : forMarker(null);
+                try {
+                    result = new TemplateEntryProperty(key, defaultValue, parent);
+                    cache.put(key, result);
+                } catch (ParseError e) {
+                    System.out.println(String.format("Unable to parse template engine pattern '%s' for property %s", defaultValue, key));
+                }
             }
             return result;
@@ -118 +122 @@
             if (result == null) {
                 String defaultValue = layerName == null?"?{ '{name}' | '{desc}' | '{" + Marker.MARKER_FORMATTED_OFFSET + "}' }":"";
-                TemplateEntryProperty parent = layerName == null?null:forAudioMarker(null);
-                result = new TemplateEntryProperty(key, defaultValue, parent);
-                cache.put(key, result);
+                TemplateEntryProperty parent = layerName == null ? null : forAudioMarker(null);
+                try {
+                    result = new TemplateEntryProperty(key, defaultValue, parent);
+                    cache.put(key, result);
+                } catch (ParseError e) {
+                    System.out.println(String.format("Unable to parse template engine pattern '%s' for property %s", defaultValue, key));
+                }
             }
             return result;
@@ -128 +136 @@
 
 
-        private TemplateEntryProperty(String key, String defaultValue, TemplateEntryProperty parent) {
-            super(key, defaultValue);
+        private TemplateEntryProperty(String key, String defaultValue, TemplateEntryProperty parent) throws ParseError {
+            super(key, new TemplateParser(defaultValue).parse(), defaultValue);
             this.parent = parent;
             updateValue(); // Needs to be called because parent wasn't know in super constructor
@@ -140 +148 @@
             } catch (ParseError e) {
                 System.out.println(String.format("Unable to parse template engine pattern '%s' for property %s. Using default ('%s') instead",
-                        s, getKey(), defaultValue));
+                        s, getKey(), super.getDefaultValueAsString()));
                 return getDefaultValue();
             }

trunk/src/org/openstreetmap/josm/gui/preferences/imagery/ImageryPreference.java

@@ -26 +26 @@
 import java.util.HashSet;
 import java.util.List;
-import java.util.Locale;
 import java.util.Map;
 import java.util.Set;
@@ -129 +128 @@
         final JPanel p = new JPanel(new GridBagLayout());
 
-        this.colFadeColor = ImageryLayer.getFadeColor();
+        this.colFadeColor = ImageryLayer.PROP_FADE_COLOR.get();
         this.btnFadeColor = new JButton();
 
@@ -196 +195 @@
         JLabel labelEast = new JLabel(tr("% of east:"));
         JLabel labelNorth = new JLabel(tr("% of north:"));
-        spinEast = new JSpinner(new SpinnerNumberModel(WMSLayer.PROP_OVERLAP_EAST.get(), 1, 50, 1));
-        spinNorth = new JSpinner(new SpinnerNumberModel(WMSLayer.PROP_OVERLAP_NORTH.get(), 1, 50, 1));
+        spinEast = new JSpinner(new SpinnerNumberModel(WMSLayer.PROP_OVERLAP_EAST.get().intValue(), 1, 50, 1));
+        spinNorth = new JSpinner(new SpinnerNumberModel(WMSLayer.PROP_OVERLAP_NORTH.get().intValue(), 1, 50, 1));
 
         JPanel overlapPanel = new JPanel(new FlowLayout());
@@ -211 +210 @@
         p.add(Box.createHorizontalGlue(), GBC.eol().fill(GBC.HORIZONTAL));
         JLabel labelSimConn = new JLabel(tr("Simultaneous connections"));
-        spinSimConn = new JSpinner(new SpinnerNumberModel(WMSLayer.PROP_SIMULTANEOUS_CONNECTIONS.get(), 1, 30, 1));
+        spinSimConn = new JSpinner(new SpinnerNumberModel(WMSLayer.PROP_SIMULTANEOUS_CONNECTIONS.get().intValue(), 1, 30, 1));
         JPanel overlapPanelSimConn = new JPanel(new FlowLayout(FlowLayout.LEFT));
         overlapPanelSimConn.add(labelSimConn);
@@ -352 +351 @@
 
         ImageryLayer.PROP_FADE_AMOUNT.put(this.fadeAmount.getValue());
-        ImageryLayer.setFadeColor(this.colFadeColor);
+        ImageryLayer.PROP_FADE_COLOR.put(this.colFadeColor);
         ImageryLayer.PROP_SHARPEN_LEVEL.put(sharpen.getSelectedIndex());