Search code examples
javaswingswingworkerjava-web-start

Dialog isn't responsive while SwingWorker works in the background


Basically I got a JFrame with a main method as entry point. In this main method the program has to download some images.

To inform the user that the program is going to start any minute I want to display a simple dialog.

If I set the dialog to modal. I got to close it after starting the program to trigger the download.

If I set it to non-modal it displays the dialog for the time of the download, but it's not repsonsive. The dialog doesn't even paint my JLabel saying "Please wait..." anymore.

//...
public static void main(String args[]) 
{
    java.awt.EventQueue.invokeLater
    (
        new Runnable() 
        {
            @Override
            public void run() 
            {
                ImageLoadingWorker ilw = new ImageLoadingWorker();

                ilw.execute();

                new MainFrame().setVisible(true);
            }
        }
    );
}

static class ImageLoadingWorker extends SwingWorker<Void, Void>
{ 
    JDialog dialog ;

    public ImageLoadingWorker()
    {
        dialog = new ImageLoadingDialog(null, false);
        dialog.setVisible(true);
    }

    @Override
    protected Void doInBackground()
    {
        ImageLoading.getInstance() ; // download is triggered
        return null;
    }

    @Override
    protected void done()
    {
        dialog.dispose() ;
    }
}
//...

Solution

  • I believe that the solution is easy: You need to start your download, your SwingWorker, first, and then show the modal dialog.

    i.e.,

    public static void main(String args[]) 
    {
        java.awt.EventQueue.invokeLater
        (
            new Runnable() 
            {
                @Override
                public void run() 
                {
                    ImageLoadingWorker ilw = new ImageLoadingWorker();
    
                    // add a PropertyChangeListener to the SwingWorker
                    // when the PCL tells you that the SwingWorker is done, show the mainFrame.
    
                    ilw.execute();
    
                    // .... code for showing the dialog is here.
    
                    //  new MainFrame().setVisible(true);  // done in PCL
                }
            }
        );
    }
    

    More specific example:

    import java.awt.Dimension;
    import java.beans.PropertyChangeEvent;
    import java.beans.PropertyChangeListener;
    import javax.swing.JDialog;
    import javax.swing.JFrame;
    import javax.swing.JProgressBar;
    import javax.swing.SwingWorker;
    
    public class SwingWorkerEg {
       public static void main(String args[]) {
          java.awt.EventQueue.invokeLater(new Runnable() {
             @Override
             public void run() {
    
                // first set everything up
    
                final MainFrame mainFrame = new MainFrame();
                final SomeDialog someDialog = new SomeDialog(mainFrame);
    
                mainFrame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
                mainFrame.pack();
                mainFrame.setLocationRelativeTo(null);
                someDialog.pack();
                someDialog.setLocationRelativeTo(null);
    
                // create SwingWorker and its PropertyChangeListener
                ImageLoadingWorker ilw = new ImageLoadingWorker();
                ilw.addPropertyChangeListener(new PropertyChangeListener() {
    
                   @Override
                   public void propertyChange(PropertyChangeEvent pcEvt) {
                      // since SwingWorker.StateValue is an enum, can use ==
                      if (SwingWorker.StateValue.DONE == pcEvt.getNewValue()) {
    
                         // when *done*, get rid of dialog, and show main JFrame
    
                         someDialog.setVisible(false);
                         mainFrame.setVisible(true);
                      }
                   }
                });
    
                // first start SwingWorker
                ilw.execute();
    
                // And only *after* starting the SW, show the modal dialog
                someDialog.setVisible(true);
             }
          });
       }
    }
    
    class ImageLoadingWorker extends SwingWorker<Void, Void> {
       private static final long SLEEP_TIME = 5 * 1000;
    
       @Override
       protected Void doInBackground() throws Exception {
          // simulate long-running process
          Thread.sleep(SLEEP_TIME);
          return null;
       }
    }
    
    // bad example -- shouldn't extend JDialog!
    class SomeDialog extends JDialog {
       private static final int PREF_W = 300;
       private static final int PREF_H = 60;
    
       public SomeDialog(JFrame frame) {
          super(frame, "Some Dialog", ModalityType.APPLICATION_MODAL);
          JProgressBar progressBar = new JProgressBar();
          progressBar.setIndeterminate(true);
          add(progressBar);
       }
    
       @Override
       public Dimension getPreferredSize() {
          return new Dimension(PREF_W, PREF_H);
       }
    }
    
    // bad example -- shouldn't extend JFrame!
    class MainFrame extends JFrame {
       private static final int PREF_W = 400;
       private static final int PREF_H = PREF_W;
    
       public MainFrame() {
          super("Main Frame");
       }
    
       @Override
       public Dimension getPreferredSize() {
          return new Dimension(PREF_W, PREF_H);
       }
    }
    

    Edit:
    Remember, never create or display the dialog in doInBackground(). That's off the Swing event thread, and no Swing GUI code can go in that method.