Changeset 2319 in josm for trunk/src/org/openstreetmap/josm/gui/PleaseWaitDialog.java

Timestamp:

2009-10-25T18:22:28+01:00 (15 years ago)

Author:

Gubaer

Message:

fixed #3725: JOSM doesn't provide indication during upload that the server is sending 410 Gone errors
Progress dialog now includes a small log window for use cases like this. Use appendLogMessage() on the progress monitor.

File:

• trunk/src/org/openstreetmap/josm/gui/PleaseWaitDialog.java (modified) (7 diffs)

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

@@ -2 +2 @@
 package org.openstreetmap.josm.gui;
 
-import java.awt.Dialog;
-import java.awt.Frame;
+import static org.openstreetmap.josm.tools.I18n.tr;
+
+import java.awt.Component;
+import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
+import java.awt.event.ActionListener;
 import java.awt.event.ComponentEvent;
 import java.awt.event.ComponentListener;
@@ -13 +16 @@
 import javax.swing.JDialog;
 import javax.swing.JLabel;
+import javax.swing.JOptionPane;
 import javax.swing.JPanel;
 import javax.swing.JProgressBar;
+import javax.swing.JScrollPane;
+import javax.swing.JTextArea;
 import javax.swing.UIManager;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.tools.GBC;
-import org.openstreetmap.josm.tools.I18n;
+import org.openstreetmap.josm.tools.ImageProvider;
 
 public class PleaseWaitDialog extends JDialog {
@@ -28 +34 @@
     private final JLabel customText = new JLabel("");
     public final BoundedRangeModel progress = progressBar.getModel();
-    public final JButton cancel = new JButton(I18n.tr("Cancel"));
+    private  JButton btnCancel;
+    /** the text area and the scroll pane for the log */
+    private JTextArea taLog = new JTextArea(5,50);
+    private  JScrollPane spLog;
 
     private void initDialog() {
@@ -37 +46 @@
         pane.add(customText, GBC.eol().fill(GBC.HORIZONTAL));
         pane.add(progressBar, GBC.eop().fill(GBC.HORIZONTAL));
-        pane.add(cancel, GBC.eol().anchor(GBC.CENTER));
+        btnCancel = new JButton(tr("Cancel"));
+        btnCancel.setIcon(ImageProvider.get("cancel"));
+        btnCancel.setToolTipText(tr("Click to cancel the current operation"));
+        pane.add(btnCancel, GBC.eol().anchor(GBC.CENTER));
+        GridBagConstraints gc = GBC.eol().fill(GBC.BOTH);
+        gc.weighty = 1.0;
+        gc.weightx = 1.0;
+        pane.add(spLog = new JScrollPane(taLog), gc);
+        spLog.setVisible(false);
         setContentPane(pane);
         //setSize(Main.pref.getInteger("progressdialog.size",600),100);
         setCustomText("");
-        setLocationRelativeTo(Main.parent);
+        setLocationRelativeTo(getParent());
         addComponentListener(new ComponentListener() {
             public void componentHidden(ComponentEvent e) {}
@@ -55 +72 @@
     }
 
-    public PleaseWaitDialog(Frame parent) {
-        super(parent, true);
-        initDialog();
-    }
-
-    public PleaseWaitDialog(Dialog parent) {
-        super(parent, true);
+    public PleaseWaitDialog(Component parent) {
+        super(JOptionPane.getFrameForComponent(parent), true);
         initDialog();
     }
@@ -70 +82 @@
     }
 
+    protected void adjustLayout() {
+        invalidate();
+        pack();
+        setSize(Main.pref.getInteger("progressdialog.size", 600), getSize().height);
+    }
+
     /**
      * Sets a custom text line below currentAction. Can be used to display additional information
@@ -75 +93 @@
      */
     public void setCustomText(String text) {
-        if(text.length() == 0) {
+        if(text == null || text.trim().length() == 0) {
             customText.setVisible(false);
-            setSize(Main.pref.getInteger("progressdialog.size", 600), 100);
+            adjustLayout();
             return;
         }
+        if (!customText.isVisible()) {
+            customText.setVisible(true);
+            adjustLayout();
+        }
+        customText.setText(text);
+    }
 
-        customText.setVisible(true);
-        customText.setText(text);
-        setSize(Main.pref.getInteger("progressdialog.size", 600), 120);
+    /**
+     * Appends a log message to the progress dialog. If the log area isn't visible yet
+     * it becomes visible. The height of the progress dialog is slightly increased too.
+     * 
+     * @param message the message to append to the log. Ignore if null or white space only.
+     */
+    public void appendLogMessage(String message) {
+        if (message == null || message.trim().length() ==0 )
+            return;
+        if (!spLog.isVisible()) {
+            spLog.setVisible(true);
+            taLog.setVisible(true);
+            adjustLayout();
+        }
+        taLog.append(message);
+        taLog.append("\n");
+        spLog.getVerticalScrollBar().setValue(spLog.getVerticalScrollBar().getMaximum());
+    }
+
+    /**
+     * Sets whether the cancel button is enabled or not
+     * 
+     * @param enabled true, if the cancel button is enabled; false otherwise
+     */
+    public void setCancelEnabled(boolean enabled) {
+        btnCancel.setEnabled(enabled);
+    }
+
+    /**
+     * Installs a callback for the cancel button. If callback is null, all action listeners
+     * are removed from the cancel button.
+     * 
+     * @param callback the cancel callback
+     */
+    public void setCancelCallback(ActionListener callback) {
+        if (callback == null) {
+            ActionListener[] listeners = btnCancel.getActionListeners();
+            for (ActionListener l: listeners) {
+                btnCancel.removeActionListener(l);
+            }
+        } else {
+            btnCancel.addActionListener(callback);
+        }
     }
 }