Changeset 12391 in josm for trunk/src/org/openstreetmap/josm/gui/MapStatus.java

Timestamp:

2017-06-11T13:57:28+02:00 (7 years ago)

Author:

michael2402

Message:

See #14794: Documentation for the gui package

File:

• trunk/src/org/openstreetmap/josm/gui/MapStatus.java (modified) (6 diffs)

trunk/src/org/openstreetmap/josm/gui/MapStatus.java

@@ -154 +154 @@
     }
 
+    /**
+     * The progress monitor that is used to display the progress if the user selects to run in background
+     */
     public class BackgroundProgressMonitor implements ProgressMonitorDialog {
 
@@ -225 +228 @@
     private final JProgressBar progressBar = new JProgressBar();
     private final transient ComponentAdapter mvComponentAdapter;
+    /**
+     * The progress monitor for displaying a background progress
+     */
     public final transient BackgroundProgressMonitor progressMonitor = new BackgroundProgressMonitor();
 
@@ -971 +977 @@
     }
 
+    /**
+     * Gets the panel that displays the angle
+     * @return The angle panel
+     */
     public JPanel getAnglePanel() {
         return angleText;
@@ -986 +996 @@
     }
 
-    public void setHelpText(String t) {
-        setHelpText(null, t);
-    }
-
+    /**
+     * Sets the help text in the status panel
+     * @param text The text
+     */
+    public void setHelpText(String text) {
+        setHelpText(null, text);
+    }
+
+    /**
+     * Sets the help status text to display
+     * @param id The object that caused the status update (or a id object it selects). May be <code>null</code>
+     * @param text The text
+     */
     public void setHelpText(Object id, final String text) {
-
         StatusTextHistory entry = new StatusTextHistory(id, text);
 
@@ -1003 +1021 @@
     }
 
+    /**
+     * Removes a help text and restores the previous one
+     * @param id The id passed to {@link #setHelpText(Object, String)}
+     */
     public void resetHelpText(Object id) {
         if (statusText.isEmpty())
@@ -1019 +1041 @@
     }
 
+    /**
+     * Sets the angle to display in the angle panel
+     * @param a The angle
+     */
     public void setAngle(double a) {
         angleText.setText(a < 0 ? "--" : DECIMAL_FORMAT.format(a) + " \u00B0");
     }
 
+    /**
+     * Sets the heading to display in the heading panel
+     * @param h The heading
+     */
     public void setHeading(double h) {
         headingText.setText(h < 0 ? "--" : DECIMAL_FORMAT.format(h) + " \u00B0");