java update progressbar

Question

I have a JFrame and following components.

JButton = jButton1 Progress Bar = progressBar and its public static JLabel = status and its public static

When button clicks then different statements execute. I want to update my progressbar after each statement. Here is my code

   private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {                                         
        Task pbu = new Task(25, "Step 1....");
        pbu.execute();

        try {
            Thread.sleep(1000);
        } catch (InterruptedException ex) {
            ex.printStackTrace();
        }

        pbu = new Task(50, "Step 2....");
        pbu.execute();

        try {
            Thread.sleep(1000);
        } catch (InterruptedException ex) {
            ex.printStackTrace();
        }

        pbu = new Task(75, "Step 3....");
        pbu.execute();

        try {
            Thread.sleep(1000);
        } catch (InterruptedException ex) {
            ex.printStackTrace();
        }

        pbu = new Task(100, "Done");
        pbu.execute();
    }

Here is my Task Class extended with SwingWorker

public class Task extends SwingWorker{

    private int progress;
    private String stat;

    public Task(int pr, String st) {
        progress = pr;
        stat = st;
    }

    @Override
    protected Object doInBackground() throws Exception {
        NewJFrame1.progressBar.setValue(progress);
        NewJFrame1.status.setValue(stat);
        return null;
    }

}

Any idea how can I solve this problem?

Mark Peters · Accepted Answer · 2011-06-06T20:59:11.093

   @Override
    protected Object doInBackground() throws Exception {
        NewJFrame1.progressBar.setValue(progress);
        NewJFrame1.status.setValue(stat);
        return null;
    }

You don't want to update GUI components off of the Swing thread. SwingWorker provides hooks for doing stuff back on the Event Dispatch Thread, that's what it's designed for. Call the publish method from doInBackground and override process to detail with incremental updates. Or, if you only need to update the GUI when it's finished, override the done() method.

A very simple example:

//...in some concrete implementation of SwingWorker<Void, Integer>
protected Void doInBackground() throws Exception {
    //do 10% of task
    doLongOp();
    publish(10);

    //do another 20% of task
    doAnotherLongOp();
    publish(20);

    return null;
}

protected void process(List<Integer> pieces) {
    for (Integer percent : pieces ) {
       progressBar.setValue(progressBar.getValue() + percent);
    }
}

Edit

@mKorbel makes a good point that for the above to work it needs to extend SwingWorker<Void, Integer>...Void being the overall return value type (in this case indicating there's no return value) and Integer being the type of the incremental updates.

If the worker produces an actual final result (that will be retrieved with get()) then that type can be used in place of Void. I had left out these details since I didn't include the class declaration.

See

SwingWorker

please amend your answer, and add (that isn't really OP's problem) SwingWorker must be declared SwingWorker not plain vanilla OP's declared 'public class Task extends SwingWorker{..}' — mKorbel, Jun 06 '11 at 18:08
@mKorbel makes a good point. The generic parameters to [`SwingWorker`](http://download.oracle.com/javase/6/docs/api/javax/swing/SwingWorker.html) are well worth the effort. There are related examples [here](http://stackoverflow.com/questions/4637215/can-a-progress-bar-be-used-in-a-class-outside-main/4637725#4637725) and in the API itself. — trashgod, Jun 06 '11 at 20:46
@mKorbel, @trashgod: Thanks I've updated my answer to say that explicitly now. — Mark Peters, Jun 06 '11 at 20:56
Also regarding @trashgod's link, that shows a more direct way of specifically doing a progress bar in the special case that its values are 0-100. My example is thus a bit contrived as there is explicit support for percentage-based progress updates. — Mark Peters, Jun 06 '11 at 21:08

score 2 · Answer 2 · answered Jun 06 '11 at 17:42

2

In addition to the answer from Mark, you really don't want to sleep in the actionPerformed() method. This method is (if linked to a GUI component) called by the AWT/Swing event dispatch thread, the same thread that also does painting and everything. As long as your method is not finished, your GUI will be blocked.

Do all your waiting in a SwingWorker or another thread.

answered Jun 06 '11 at 17:42

Paŭlo Ebermann

73,284
20
146
210

+1 Exactly; this [example](http://stackoverflow.com/questions/4637215/can-a-progress-bar-be-used-in-a-class-outside-main/4637725#4637725) sleeps in the background thread to simulate latency. – trashgod Jun 06 '11 at 20:49

java update progressbar

2 Answers2

Edit

See

Linked