Changeset 13636 in josm for trunk/src/org/openstreetmap

Timestamp:

2018-04-15T18:58:21+02:00 (6 years ago)

Author:

Don-vip

Message:

extract style methods to a new Stylable interface

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/osm/IPrimitive.java (modified) (1 diff)
• data/osm/OsmPrimitive.java (modified) (1 diff)
• data/osm/PrimitiveData.java (modified) (2 diffs)
• data/osm/Stylable.java (added)
• gui/dialogs/InspectPrimitiveDialog.java (modified) (1 diff)
• gui/mappaint/ElemStyles.java (modified) (4 diffs)

trunk/src/org/openstreetmap/josm/data/osm/IPrimitive.java

@@ -11 +11 @@
  * @since 4098
  */
-public interface IPrimitive extends Tagged, PrimitiveId {
+public interface IPrimitive extends Tagged, PrimitiveId, Stylable {
 
     /**

trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java

@@ -193 +193 @@
      * MAPPAINT
      *--------*/
-    public StyleCache mappaintStyle;
+    private StyleCache mappaintStyle;
     private short mappaintCacheIdx;
 
-    /* This should not be called from outside. Fixing the UI to add relevant
-       get/set functions calling this implicitely is preferred, so we can have
-       transparent cache handling in the future. */
-    public void clearCachedStyle() {
-        mappaintStyle = null;
-    }
-
-    /**
-     * Check if the cached style for this primitive is up to date.
-     * @return true if the cached style for this primitive is up to date
-     * @since 13420
-     */
+    @Override
+    public final StyleCache getCachedStyle() {
+        return mappaintStyle;
+    }
+
+    @Override
+    public final void setCachedStyle(StyleCache mappaintStyle) {
+        this.mappaintStyle = mappaintStyle;
+    }
+
+    @Override
     public final boolean isCachedStyleUpToDate() {
         return mappaintStyle != null && mappaintCacheIdx == dataSet.getMappaintCacheIndex();
     }
 
-    /**
-     * Declare that the cached style for this primitive is up to date.
-     * @since 13420
-     */
+    @Override
     public final void declareCachedStyleUpToDate() {
         this.mappaintCacheIdx = dataSet.getMappaintCacheIndex();
-    }
-
-    /**
-     * Returns mappaint cache index.
-     * @return mappaint cache index
-     * @deprecated no longer supported (see also {@link #isCachedStyleUpToDate()})
-     */
-    @Deprecated
-    public final short getMappaintCacheIdx() {
-        return mappaintCacheIdx;
-    }
-
-    /**
-     * Sets the mappaint cache index.
-     * @param mappaintCacheIdx mappaint cache index
-     * @deprecated no longer supported (see also {@link #declareCachedStyleUpToDate()})
-     */
-    @Deprecated
-    public final void setMappaintCacheIdx(short mappaintCacheIdx) {
-        this.mappaintCacheIdx = mappaintCacheIdx;
     }
 

trunk/src/org/openstreetmap/josm/data/osm/PrimitiveData.java

@@ -11 +11 @@
 import java.util.List;
 import java.util.Map;
+
+import org.openstreetmap.josm.gui.mappaint.StyleCache;
 
 /**
@@ -130 +132 @@
         ois.defaultReadObject();
     }
+
+    @Override
+    public StyleCache getCachedStyle() {
+        return null;
+    }
+
+    @Override
+    public void setCachedStyle(StyleCache mappaintStyle) {
+        // Override if needed
+    }
+
+    @Override
+    public boolean isCachedStyleUpToDate() {
+        return false;
+    }
+
+    @Override
+    public void declareCachedStyleUpToDate() {
+        // Override if needed
+    }
 }

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

@@ -151 +151 @@
         if (sel.size() == 2) {
             List<OsmPrimitive> selList = new ArrayList<>(sel);
-            StyleCache sc1 = selList.get(0).mappaintStyle;
-            StyleCache sc2 = selList.get(1).mappaintStyle;
+            StyleCache sc1 = selList.get(0).getCachedStyle();
+            StyleCache sc2 = selList.get(1).getCachedStyle();
             if (sc1 == sc2) {
                 txtMappaint.append(tr("The 2 selected objects have identical style caches."));

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

@@ -105 +105 @@
     }
 
+    /**
+     * Returns the background color.
+     * @return the background color
+     */
     public Color getBackgroundColor() {
         if (backgroundColorCache != null)
@@ -144 +148 @@
     public Pair<StyleElementList, Range> getStyleCacheWithRange(OsmPrimitive osm, double scale, NavigatableComponent nc) {
         if (!osm.isCachedStyleUpToDate() || scale <= 0) {
-            osm.mappaintStyle = StyleCache.EMPTY_STYLECACHE;
+            osm.setCachedStyle(StyleCache.EMPTY_STYLECACHE);
         } else {
-            Pair<StyleElementList, Range> lst = osm.mappaintStyle.getWithRange(scale, osm.isSelected());
+            Pair<StyleElementList, Range> lst = osm.getCachedStyle().getWithRange(scale, osm.isSelected());
             if (lst.a != null)
                 return lst;
@@ -191 +195 @@
             }
         }
-        StyleCache style = osm.mappaintStyle != null ? osm.mappaintStyle : StyleCache.EMPTY_STYLECACHE;
+        StyleCache style = osm.getCachedStyle() != null ? osm.getCachedStyle() : StyleCache.EMPTY_STYLECACHE;
         try {
-            osm.mappaintStyle = style.put(p.a, p.b, osm.isSelected());
+            osm.setCachedStyle(style.put(p.a, p.b, osm.isSelected()));
         } catch (RangeViolatedError e) {
             throw new AssertionError("Range violated: " + e.getMessage()
-                    + " (object: " + osm.getPrimitiveId() + ", current style: "+osm.mappaintStyle
+                    + " (object: " + osm.getPrimitiveId() + ", current style: "+osm.getCachedStyle()
                     + ", scale: " + scale + ", new stylelist: " + p.a + ", new range: " + p.b + ')', e);
         }
@@ -462 +466 @@
     }
 
+    /**
+     * Determines whether multipolygons must be drawn.
+     * @return whether multipolygons must be drawn.
+     */
     public boolean isDrawMultipolygon() {
         return drawMultipolygon;
     }
 
+    /**
+     * Sets whether multipolygons must be drawn.
+     * @param drawMultipolygon whether multipolygons must be drawn
+     */
     public void setDrawMultipolygon(boolean drawMultipolygon) {
         this.drawMultipolygon = drawMultipolygon;