Changeset 29384 in osm for applications/editors/josm/plugins/imagery_offset_db/src/iodb/CalibrationLayer.java

Timestamp:

2013-03-22T22:18:26+01:00 (12 years ago)

Author:

zverik

Message:

ImageryID refactoring and javadocs

File:

• applications/editors/josm/plugins/imagery_offset_db/src/iodb/CalibrationLayer.java (modified) (9 diffs)

applications/editors/josm/plugins/imagery_offset_db/src/iodb/CalibrationLayer.java

@@ -20 +20 @@
  * A layer that displays calibration geometry for an offset.
  *
- * @author zverik
+ * @author Zverik
+ * @license WTFPL
  */
 public class CalibrationLayer extends Layer {
@@ -34 +35 @@
     }
 
+    /**
+     * Draw the calibration geometry with thin bright lines (or a crosshair
+     * in case of a point).
+     */
     @Override
     public void paint( Graphics2D g, MapView mv, Bounds box ) {
@@ -79 +84 @@
     }
 
+    /**
+     * This is for determining a bounding box for the layer.
+     */
     @Override
     public void visitBoundingBox( BoundingXYVisitor v ) {
@@ -85 +93 @@
     }
 
+    /**
+     * A simple tooltip with geometry type, status and author.
+     */
     @Override
     public String getToolTipText() {
-        return "A " + (obj.isDeprecated() ? "deprecated " : "") + "calibration " + OffsetInfoAction.getGeometryType(obj)
-                + " by " + obj.getAuthor();
+        return "A " + (obj.isDeprecated() ? "deprecated " : "") + "calibration "
+                + OffsetInfoAction.getGeometryType(obj) + " by " + obj.getAuthor();
     }
 
@@ -96 +107 @@
     }
 
+    /**
+     * This method returns standard actions plus "zoom to layer" and "change color".
+     */
     @Override
     public Action[] getMenuEntries() {
@@ -111 +125 @@
     }
 
+    /**
+     * This method pans to the geometry, preserving zoom. It is used
+     * from {@link GetImageryOffsetAction}, because {@link AutoScaleAction}
+     * doesn't have a relevant method.
+     */
     public void panToCenter() {
         if( center == null ) {
@@ -125 +144 @@
     }
 
+    /**
+     * An action to change a color of a geometry. The color
+     * is specified in the constuctor. See {@link #getMenuEntries()} for
+     * the list of enabled colors.
+     */
     class SelectColorAction extends AbstractAction {
         private Color c;
@@ -140 +164 @@
     }
 
+    /**
+     * A simple icon with a colored rectangle.
+     */
     class SingleColorIcon implements Icon {
         private Color color;
@@ -162 +189 @@
     }
 
+    /**
+     * An action that calls {@link AutoScaleAction} which in turn
+     * uses {@link #visitBoundingBox} to pan and zoom to the calibration geometry.
+     */
     class ZoomToLayerAction extends AbstractAction {
         public ZoomToLayerAction() {
             super(tr("Zoom to layer"));
+            putValue(SMALL_ICON, ImageProvider.get("dialogs/autoscale/layer"));
         }