關於JFace中的進度條對話框(ProgressMonitorDialog類)

在Windows操作系統中,最常用的進度條對話框就是文件復制時的彈出框,如果想讓用戶愉快的使用你開發

的軟件,那么在執行某個較長時間的操作時候,就應該彈出一個進度條提示框,告訴用戶程序正在做什么.

做到什么地步了.進度條提示框可以讓用戶更有安全感也可以提高用戶的耐心.

前面用到的SWT組件的進度條ProgressBar類太底層,還需要處理諸如線程分配的問題.現在

JFace提供了更容易使用的ProgressMonitorDialog類來創建進度條對話框.

 

標准的進度條對話框:

ProgressMonitorDialog類還算簡單,只要將執行代碼用IRunnableWithProgress類包裝一下即可,本實例中在窗口中建立 一個GO按鈕,當單擊該按鈕時執行一個需時較長的操作(以每次循環停頓一秒來模擬),並彈出一個進度條對話框.程序在未加進度條時的代碼如下:

ProgressMonitorDialog.java

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

public class ProgressMonitorDialog1 {

    public static void main(String[] args) {
        new ProgressMonitorDialog1().open();
    }

    public void open() {
        final Display display = Display.getDefault();
        final Shell shell = new Shell();
        shell.setSize(500, 375);

        shell.setLayout(new RowLayout());
        Button button = new Button(shell, SWT.NONE);
        button.setText("        GO          ");
        button.addSelectionListener(new SelectionAdapter() {
            public void widgetSelected(SelectionEvent e) {
                // 創建進度條對話框的處理過程對象
                IRunnableWithProgress runnable = new IRunnableWithProgress() {
                    public void run(IProgressMonitor monitor) {
                        monitor.beginTask("開始執行......", 10);
                        for (int i = 0; i < 10; i++) {// 循環10次，每次間隔一秒
                            if (monitor.isCanceled()) // 隨時監控是否選擇了對話框的“取消”按鈕
                                return;// 中斷處理
                            try {
                                Thread.sleep(1000);
                            } catch (Throwable t) {}
                            monitor.setTaskName("第" + (i + 1) + "次循環");// 提示信息
                            monitor.worked(1);// 進度條前進一步
                        }
                        monitor.done();// 進度條前進到完成
                    }
                };
                try {
                    // 創建一個進度條對話框，並將runnable傳入
                    // 第一個參數推薦設為true，如果設為false則處理程序會運行在UI線程里，界面將有一點停滯感。
                    // 第二個參數：true＝對話框的“取消”按鈕有效
                    new ProgressMonitorDialog(shell).run(true, true, runnable);
                } catch (Exception e2) {
                    e2.printStackTrace();
                }
            }
        });

        shell.layout();
        shell.open();
        while (!shell.isDisposed()) {
            if (!display.readAndDispatch())
                display.sleep();
        }
    }

}

 

 運行結果:

要在執行程序時候彈出一個進度條,則就要對GO按鈕的widgetSelected方法做修改(上面代碼已經修改完畢):

· 編寫一個處理過程接口IRunnableWithProgress的匿名實現類,並將耗時代碼嵌入其run方法中,可以用run方法的參數monitor操作進度條向前移動.當然這個類寫成命名內部類或者外部類也是可以的.

·創建一個ProgressMonitorDialog對話框對象,並用它的run方法彈出進度條對話框.接收IRunnableWithProgress對象做參數.run方法有受控異常需要處理,需要用try/catch括起來.

 

程序說明:如果無法確定進度條需要多少格長度,可以將值設置的大一些,即使真實循環數沒有達到或者超過了也不會引起程序出錯.

進度條對話框的實現代碼看是復雜,其實簡化而無變化,代碼框架都一個樣,關鍵是把IRunnableWithProgress.run方法中的處理程序寫好.

 

反復顯示的進度條對話框.

有些后台任務,可能無法將它分解成多少部,它就是一個單一的長時間的處理過程.這時可以彈出一個對話框,進度條不斷的重復移動,直到后台任務結束,或被中止.

實際上這種方案后台處理程序和前台彈出進度框被分為了兩個獨立的部分,但它們之間仍然需要一個信使來傳遞信息.比如,后台任務完成了,那么就應該通知前台進度框關閉:單擊了前台進度框的"取消"按鈕,也需要通知后台任務中斷處理.這個信使可以用一個boolean變量標志位來充當,不必去通知前台后台,自己監控該變量的變化即可.具體的實體如下代碼所示:

ProgressMonitorDialog2.java

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

public class ProgressMonitorDialog2 {

    public static void main(String[] args) {
        new ProgressMonitorDialog2().open();
    }

    public void open() {
        final Display display = Display.getDefault();
        final Shell shell = new Shell();
        shell.setSize(500, 375);

        shell.setLayout(new RowLayout());
        Button button = new Button(shell, SWT.NONE);
        button.setText("        GO          ");
        button.addSelectionListener(new SelectionAdapter() {
            private boolean stopFlag;// 停止標志

            private void go() {
                for (int i = 0; i < 10; i++) {// 循環10次，每次間隔一秒
                    System.out.println("第" + (i + 1) + "個任務執行完畢");
                    if (stopFlag) {// 監控是否要讓停止后台任務
                        System.out.println("被中斷了");
                        return;
                    }
                    try {
                        Thread.sleep(1000);
                    } catch (Throwable t) {}
                }
                stopFlag = true;// 執行完畢后把標志位設為停止，好通知給進度框
                System.out.println("全部任務執行完畢");
            }

            public void widgetSelected(SelectionEvent e) {
                stopFlag = false;// 每次都設初值為false
                new Thread() {// 把后台任務放到一個新開線程里執行
                    public void run() {
                        go();
                    }
                }.start();
                showProgressDialog();// 打開一個進度框
            }

            private void showProgressDialog() {
                IRunnableWithProgress runnable = new IRunnableWithProgress() {
                    public void run(IProgressMonitor monitor) {
                        monitor.beginTask("正在執行中......", 30);
                        int i = 0;
                        while (true) {
                            // 監聽是否單擊了進度框的“取消”按鈕，stopFlag則是監聽后台任務是否停止
                            if (monitor.isCanceled() || stopFlag) {
                                stopFlag = true; // 單擊了“取消”按鈕要設標志位為停止，好通知后台任務中斷執行
                                break;// 中斷處理
                            }
                            // i到30后清零。並將進度條重新來過
                            if ((++i) == 30) {
                                i = 0;
                                monitor.beginTask("正在執行中......", 30);
                            }
                            // 進度條每前進一步體息一會，不用太長或太短，時間可任意設。
                            try {
                                Thread.sleep(99);
                            } catch (Throwable t) {}
                            monitor.worked(1);// 進度條前進一步
                        }
                        monitor.done();// 進度條前進到完成
                    }
                };
                try {
                    new ProgressMonitorDialog(shell).run(true, true, runnable);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        });

        shell.layout();
        shell.open();
        while (!shell.isDisposed()) {
            if (!display.readAndDispatch())
                display.sleep();
        }
    }

}

 

運行結果如下:

點擊cancle按鈕,對應的后面沒有執行的任務取消.

 

封裝反復顯示的進度條對話框

雖然實例2實現了一個不斷反復顯示的進度框,但它的代碼如此凌亂,而且許多代碼復生冗長,所以應該把這種不斷反復的進度框封裝成一個組件,讓其使用起來更方便.封裝成組件會遇到兩個問題:

(1)如何封裝?第一個想到的是集成ProgressMonitorDialog來實現新組件.這種方法未嘗不可,但這樣新組件就和ProgressMonitorDialog類耦合在了一起,如果以后不想用進度條而想改用一個動畫,就不容易了.所以還是用組合方式的擴展比較好.實現起來也簡單.

(2)封裝后分成了多個類.由於boolean是簡單類型是值傳遞.它已經不適合作為進度框和后台任務之間的信使.而Boolean類雖然是引用傳遞,但它是不可變化類.要改變它要重新創建一個對象.所以他也不能用.因此方案只有兩個,用boolean數組,或者創建一個專門的標識類做信使.這里選擇第二個方案.

打方案定了,接着開始做具體的實現,首先是這個新組件應該提供什么方法.可以從使用的角度來考慮,經過考慮之后使用方式可以參照ProgressMonitorDialog.具體代碼如下所示:

ProgressMonitorDialog3.java

import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;


public class ProgressMonitorDialog3 {

    public static void main(String[] args) {
        new ProgressMonitorDialog3().open();
    }

    public void open() {
        final Display display = Display.getDefault();
        final Shell shell = new Shell();
        shell.setSize(500, 375);

        shell.setLayout(new RowLayout());
        Button button = new Button(shell, SWT.NONE);
        button.setText("        GO          ");
        button.addSelectionListener(new SelectionAdapter() {
            public void widgetSelected(SelectionEvent e) {
                new LoopProgressDialog(shell).run(true, new IProgressDialogRunnable() {
                    public void run(BooleanFlag stopFlag) {
                        for (int i = 0; i < 10; i++) {
                            System.out.println("第" + (i + 1) + "個任務執行完畢");
                            if (stopFlag.getFlag()) {
                                System.out.println("被中斷了");
                                return;
                            }
                            try {
                                Thread.sleep(1000);
                            } catch (Throwable t) {}
                        }
                        stopFlag.setFlag(true);
                        System.out.println("全部任務執行完畢");
                    }
                });
            }
        });

        shell.layout();
        shell.open();
        while (!shell.isDisposed()) {
            if (!display.readAndDispatch())
                display.sleep();
        }
    }

}

 程序說明:LoopProgressDialog是這里的新組件.它的使用看起來非常像ProgressMonitorDialog,區別是:IProgressDialogRunnable是一個我們自己定義的接口,它提供一個run方法.方法的參數是一個用作信使的標志類BooleanFlag.BooleanFlag實際是對boolean的一個封裝,和Boolean封裝類不同的是它提供了setFlag修改方法.

IProgressDialogRunnable和BooleanFlag的代碼比較簡單.如下所示:

IProgressDialogRunnable.java

public interface IProgressDialogRunnable {
    void run(BooleanFlag stopFlag);
}

 

 BooleanFlag.java

public final class BooleanFlag {
    private boolean flag = false;

    public BooleanFlag() {}

    public BooleanFlag(boolean flag) {
        this.flag = flag;
    }

    public synchronized boolean getFlag() {
        return flag;
    }

    public synchronized void setFlag(boolean flag) {
        this.flag = flag;
    }
}

 

 接下來就是新組件LoopProgressDialog的實現了.

LoopProgressDialog.java

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.swt.widgets.Shell;


public class LoopProgressDialog {
    private ProgressMonitorDialog dialog;
    public BooleanFlag stopFlag = new BooleanFlag();

    public LoopProgressDialog(Shell shell) {
        dialog = new ProgressMonitorDialog(shell);
    }

    public void run(boolean cancelable, final IProgressDialogRunnable runnable) {
        new Thread() {
            public void run() {
                runnable.run(stopFlag);
            }
        }.start();

        try {
            dialog.run(true, cancelable, new LoopRunnable());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private class LoopRunnable implements IRunnableWithProgress {
        public void run(IProgressMonitor monitor) {
            monitor.beginTask("正在執行中......", 30);
            int i = 0;
            while (true) {
                // 監聽是否單擊了進度框的“取消”按鈕，stopFlag則是監聽后台任務是否停止
                if (monitor.isCanceled() || stopFlag.getFlag()) {
                    stopFlag.setFlag(true);
                    break;// 中斷處理
                }
                // i到30后清零。並將進度條重新來過
                if ((++i) == 30) {
                    i = 0;
                    monitor.beginTask("正在執行中......", 30);
                }
                // 進度條每前進一步體息一會，不用太長或太短，時間可任意設。
                try {
                    Thread.sleep(99);
                } catch (Throwable t) {}
                monitor.worked(1);// 進度條前進一步
            }
            monitor.done();// 進度條前進到完成
        }
    }

}

 

 

 用動畫GIF來表示進度

ProgressMonitorDialog4.java和ProgressMonitorDialog3.java唯一不同之處就是把LoopProgressDialog改成了動畫GIF界面類LoopImageDialog.

LoopImageDialog的內部實現沒有采用Dialog或者其子類,而是用Shell來彈出界面的.所以嚴格來說它不能算是一個對話框.

ProgressMonitorDialog4.java

import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;


public class ProgressMonitorDialog4 {

    public static void main(String[] args) {
        new ProgressMonitorDialog4().open();
    }

    public void open() {
        final Display display = Display.getDefault();
        final Shell shell = new Shell();
        shell.setSize(500, 375);

        shell.setLayout(new RowLayout());
        Button button = new Button(shell, SWT.NONE);
        button.setText("        GO          ");
        button.addSelectionListener(new SelectionAdapter() {
            public void widgetSelected(SelectionEvent e) {
                new LoopImageDialog(shell).run(true, new IProgressDialogRunnable() {
                    public void run(BooleanFlag stopFlag) {
                        for (int i = 0; i < 10; i++) {
                            System.out.println("第" + (i + 1) + "個任務執行完畢");
                            if (stopFlag.getFlag()) {
                                System.out.println("被中斷了");
                                return;
                            }
                            try {
                                Thread.sleep(1000);
                            } catch (Throwable t) {}
                        }
                        stopFlag.setFlag(true);
                        System.out.println("全部任務執行完畢");
                    }
                });
            }
        });

        shell.layout();
        shell.open();
        while (!shell.isDisposed()) {
            if (!display.readAndDispatch())
                display.sleep();
        }
    }

}

LoopImageDialog.java

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.ImageLoader;
import org.eclipse.swt.layout.FillLayout;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Shell;

import cn.com.chengang.swt.SWTUtils;

public class LoopImageDialog {
    private Shell parentShell;
    public BooleanFlag stopFlag = new BooleanFlag();

    protected LoopImageDialog(Shell parentShell) {
        this.parentShell = parentShell;
    }

    public void run(boolean cancelable, final IProgressDialogRunnable runnable) {
        new Thread() {
            public void run() {
                runnable.run(stopFlag);
            }
        }.start();
        showDialog();
    }

    private void showDialog() {
        final Display display = Display.getDefault();
        Shell shell = new Shell(parentShell);
        shell.setSize(250, 180);
        SWTUtils.setCenter(shell); // 使用shell居中
        shell.setLayout(new FillLayout());
        // 在Shell窗口顯示一個動畫GIF
        final ImageLoader imageLoader = new ImageLoader();
        imageLoader.load("icons/animation2.gif");
        new AnimationGIF(shell, SWT.BORDER, imageLoader);
        // 彈出窗口。Shell和Dialog不同，它在open彈出界面之后會繼承執行下面的語句
        shell.open();
        while (!shell.isDisposed()) {
            if (stopFlag.getFlag())
                shell.dispose();
            if (!display.readAndDispatch())
                display.sleep();
        }
        stopFlag.setFlag(true);
    }
}