Changeset 11672 in josm for trunk/src/org

Timestamp:

2017-03-04T23:06:30+01:00 (8 years ago)

Author:

michael2402

Message:

PleaseWaitDialog: Javadoc and make direct progress model access deprecated.

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• PleaseWaitDialog.java (modified) (8 diffs)
• progress/PleaseWaitProgressMonitor.java (modified) (1 diff)

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

@@ -28 +28 @@
 import org.openstreetmap.josm.tools.ImageProvider;
 
+/**
+ * This is a dialog that displays the progress of an action to the user.
+ */
 public class PleaseWaitDialog extends JDialog implements ProgressMonitorDialog {
 
@@ -34 +37 @@
     private final JLabel currentAction = new JLabel("");
     private final JLabel customText = new JLabel("");
+    /**
+     * The direct progress access.
+     * @deprecated To be removed in mid-2017. Use {@link #updateProgress(int)}
+     */
+    @Deprecated
     public final transient BoundedRangeModel progress = progressBar.getModel();
     private JButton btnCancel;
@@ -40 +48 @@
     private final JosmTextArea taLog = new JosmTextArea(5, 50);
     private final JScrollPane spLog = new JScrollPane(taLog);
+
+
+    /**
+     * Constructs a new {@code PleaseWaitDialog}.
+     * @param parent the {@code Component} from which the dialog is displayed. Can be {@code null}.
+     */
+    public PleaseWaitDialog(Component parent) {
+        super(GuiHelper.getFrameForComponent(parent), ModalityType.DOCUMENT_MODAL);
+        initDialog();
+    }
 
     private void initDialog() {
@@ -76 +94 @@
     }
 
-    /**
-     * Constructs a new {@code PleaseWaitDialog}.
-     * @param parent the {@code Component} from which the dialog is displayed. Can be {@code null}.
-     */
-    public PleaseWaitDialog(Component parent) {
-        super(GuiHelper.getFrameForComponent(parent), ModalityType.DOCUMENT_MODAL);
-        initDialog();
-    }
-
     @Override
     public void setIndeterminate(boolean newValue) {
@@ -99 +108 @@
 
     /**
-     * Sets a custom text line below currentAction. Can be used to display additional information
+     * Sets a custom text line below currentAction. Can be used to display additional information.
      * @param text custom text
      */
@@ -142 +151 @@
 
     /**
-     * Sets whether the cancel button is enabled or not
+     * Sets whether the cancel button is enabled or not.
      *
      * @param enabled true, if the cancel button is enabled; false otherwise
+     * @see #setCancelCallback(ActionListener)
      */
     public void setCancelEnabled(boolean enabled) {
@@ -150 +160 @@
     }
 
+    /**
+     * Enables / disables a button that can be pressed to run the task in background.
+     *
+     * @param value <code>true</code> iff that button should be displayed.
+     * @see #setInBackgroundCallback(ActionListener)
+     */
     public void setInBackgroundPossible(boolean value) {
         btnInBackground.setVisible(value);
@@ -190 +206 @@
     @Override
     public void updateProgress(int progress) {
-        this.progress.setValue(progress);
+        this.progressBar.setValue(progress);
         this.progressBar.repaint();
     }
+
+    /**
+     * Sets the maximum progress value.
+     * @param progressBarMax The value that represents the rightmost point of the progress bar (100%).
+     */
+    public void setMaximumProgress(int progressBarMax) {
+        this.progressBar.setMaximum(progressBarMax);
+    }
 }

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

@@ -191 +191 @@
             dialog.setCustomText("");
             dialog.addWindowListener(windowListener);
-            dialog.progress.setMaximum(PROGRESS_BAR_MAX);
+            dialog.setMaximumProgress(PROGRESS_BAR_MAX);
             dialog.setVisible(true);
         });