Changeset 12369 in josm for trunk/src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java

Timestamp:

2017-06-09T20:33:26+02:00 (7 years ago)

Author:

michael2402

Message:

Javadoc for gui.progress package

File:

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

trunk/src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java

@@ -29 +29 @@
      */
     public interface ProgressMonitorDialog {
+        /**
+         * Sets the visibility of this dialog
+         * @param visible The visibility, <code>true</code> to show it, <code>false</code> to hide it
+         */
         void setVisible(boolean visible);
 
@@ -37 +41 @@
         void updateProgress(int progress);
 
+        /**
+         * Sets the description of what is done
+         * @param text The description of the task
+         */
         void setCustomText(String text);
 
+        /**
+         * Sets the current action that is done
+         * @param text The current action
+         */
         void setCurrentAction(String text);
 
+        /**
+         * Display that the current progress cannot be determined
+         * @param newValue wether the progress cannot be determined
+         */
         void setIndeterminate(boolean newValue);
 
-        // TODO Not implemented properly in background monitor, log message will get lost if progress runs in background
+        /**
+         * Append a message to the progress log
+         * <p>
+         * TODO Not implemented properly in background monitor, log message will get lost if progress runs in background
+         * @param message The message
+         */
         void appendLogMessage(String message);
     }
@@ -174 +195 @@
     };
 
+    /**
+     * See if this task is canceleable
+     * @return <code>true</code> if it can be canceled
+     */
     public final boolean isCancelable() {
         return cancelable;
     }
 
+    /**
+     * Sets this task to be cancelable
+     * @param cancelable Whether it can be canceled
+     */
     public final void setCancelable(boolean cancelable) {
         this.cancelable = cancelable;
@@ -274 +303 @@
     }
 
+    /**
+     * Update the dialog values
+     */
     public void reset() {
         if (dialog != null) {
@@ -294 +326 @@
     }
 
+    /**
+     * Close the progress dialog window.
+     */
     public void close() {
         doInEDT(() -> {
@@ -312 +347 @@
     }
 
+    /**
+     * Show the progress dialog in foreground
+     */
     public void showForegroundDialog() {
         isInBackground = false;