Changeset 23762 in osm

Timestamp:

2010-10-23T15:52:13+02:00 (14 years ago)

Author:

oliverw

Message:

Added documentation.

File:

• applications/editors/josm/plugins/ElevationProfile/src/org/openstreetmap/josm/plugins/elevation/gui/ElevationProfileDialog.java (modified) (9 diffs)

applications/editors/josm/plugins/ElevationProfile/src/org/openstreetmap/josm/plugins/elevation/gui/ElevationProfileDialog.java

@@ -19 +19 @@
 import java.awt.BorderLayout;
 import java.awt.Font;
-import java.awt.GridBagConstraints;
 import java.awt.GridLayout;
-import java.awt.Insets;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
@@ -36 +34 @@
 import javax.swing.JPanel;
 import javax.swing.JRadioButton;
-import javax.swing.JSeparator;
 import javax.swing.JTextField;
 
@@ -57 +54 @@
 /**
  * @author Oliver
- * 
+ * Implements a JOSM ToggleDialog to show the elevation profile. It monitors the 
+ * connection between layer and elevation profile. 
  */
 public class ElevationProfileDialog extends ToggleDialog implements
@@ -68 +66 @@
          */
         private static final long serialVersionUID = -868463893732535577L;
+        /* Elevation profile instance */
+        private IElevationProfile profile;
+        /* GPX data */
+        private GpxLayer activeLayer = null;
+        private HashMap<GpxLayer, ElevationModel> layerMap = new HashMap<GpxLayer, ElevationModel>();
+        
+        /* UI elements */
+        private ElevationProfilePanel profPanel;
         private JLabel minHeightLabel;
         private JLabel maxHeightLabel;
-
-        private IElevationProfile profile;
-        private ElevationProfilePanel profPanel;
-        private GpxLayer activeLayer = null;
-        private HashMap<GpxLayer, ElevationModel> layerMap = new HashMap<GpxLayer, ElevationModel>();
-        private List<IElevationModelListener> listeners = new ArrayList<IElevationModelListener>();
         private JLabel avrgHeightLabel;
         private JLabel elevationGainLabel;
         private JLabel totalTimeLabel;
-
+        private JLabel distLabel;
         private JRadioButton geoidNone;
         private JRadioButton geoidAuto;
         private JRadioButton geoidFixed;
         private JTextField geoidFixedValue;
+        /* Listener to the elevation model */
+        private List<IElevationModelListener> listeners = new ArrayList<IElevationModelListener>();
         
-        private ElevationProfileLayer profileLayer;
-        private JLabel distLabel;
+        /**
+         * Corresponding layer instance within map view.
+         */
+        private ElevationProfileLayer profileLayer;     
 
         /**
@@ -384 +388 @@
         }
 
+        /* (non-Javadoc)
+         * @see org.openstreetmap.josm.gui.MapView.LayerChangeListener#activeLayerChange(org.openstreetmap.josm.gui.layer.Layer, org.openstreetmap.josm.gui.layer.Layer)
+         */
         public void activeLayerChange(Layer oldLayer, Layer newLayer) {
                 if (newLayer instanceof GpxLayer) {
@@ -390 +397 @@
         }
 
+        /**
+         * Internal helper to create elevation data for a new layer.
+         * @param newLayer The layer added by the user.
+         */
         private void createLayer(Layer newLayer) {
                 if (newLayer != null) {
@@ -400 +411 @@
         }
 
+        /**
+         * Internal helper to update internal cache and synchronize elevation model.
+         * @param newLayer The layer added by the user.
+         */
         private void setActiveLayer(GpxLayer newLayer) {
                 if (activeLayer != newLayer) {
@@ -416 +431 @@
                         ElevationModel em = layerMap.get(newLayer);
                         em.setSliceSize(slices);
-                        setModel(em);
-                        
-                }
-        }
-
+                        setModel(em);                   
+                }
+        }
+
+        /* (non-Javadoc)
+         * @see org.openstreetmap.josm.gui.MapView.LayerChangeListener#layerAdded(org.openstreetmap.josm.gui.layer.Layer)
+         */
         public void layerAdded(Layer newLayer) {
                 createLayer(newLayer);
         }
 
+        /* (non-Javadoc)
+         * @see org.openstreetmap.josm.gui.MapView.LayerChangeListener#layerRemoved(org.openstreetmap.josm.gui.layer.Layer)
+         */
         public void layerRemoved(Layer oldLayer) {
                 if (layerMap.containsKey(oldLayer)) {
-                        // TODO: Handle UI stuff properly
                         layerMap.remove(oldLayer);
                 }
@@ -436 +455 @@
         }
 
+        /* (non-Javadoc)
+         * @see org.openstreetmap.josm.gui.MapView.EditLayerChangeListener#editLayerChanged(org.openstreetmap.josm.gui.layer.OsmDataLayer, org.openstreetmap.josm.gui.layer.OsmDataLayer)
+         */
         public void editLayerChanged(OsmDataLayer oldLayer, OsmDataLayer newLayer) {
                 // Nothing to do...