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

Timestamp:

2016-11-19T12:52:34+01:00 (7 years ago)

Author:

michael2402

Message:

More Javadoc for AreaElement

Location:

trunk/src/org/openstreetmap/josm

Files:

• data/osm/visitor/paint/StyledMapRenderer.java (modified) (1 diff)
• gui/mappaint/styleelement/AreaElement.java (modified) (3 diffs)

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

@@ -756 +756 @@
     }
 
+    /**
+     * Draw a text onto a node
+     * @param n The node to draw the text on
+     * @param bs The text and it's alignment.
+     */
     public void drawBoxText(Node n, BoxTextElement bs) {
         if (!isShowNames() || bs == null)

trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/AreaElement.java

@@ -19 +19 @@
 import org.openstreetmap.josm.tools.Utils;
 
+/**
+ * This is the style that defines how an area is filled.
+ */
 public class AreaElement extends StyleElement {
 
@@ -26 +29 @@
      */
     public Color color;
+
+    /**
+     * An image to cover this area. May be null to disable this feature.
+     */
     public MapImage fillImage;
+
+    /**
+     * The text that should be written on this area.
+     */
     public TextLabel text;
+
+    /**
+     * Fill the area only partially from the borders
+     * <p>
+     * Public access is discouraged.
+     * @see StyledMapRenderer#drawArea(Way, Color, MapImage, Float, Float, boolean, TextLabel)
+     */
     public Float extent;
+
+    /**
+     * Areas smaller than this are filled no matter what value {@link #extent} has.
+     * <p>
+     * Public access is discouraged.
+     * @see StyledMapRenderer#drawArea(Way, Color, MapImage, Float, Float, boolean, TextLabel)
+     */
     public Float extentThreshold;
 
@@ -41 +66 @@
     }
 
+    /**
+     * Create a new {@link AreaElement}
+     * @param env The current style definitions
+     * @return The area element or <code>null</code> if the area should not be filled.
+     */
     public static AreaElement create(final Environment env) {
         final Cascade c = env.mc.getCascade(env.layer);