Swing/SwingWorker のバックアップ(No.31)
- バックアップ一覧
- 差分 を表示
- 現在との差分 を表示
- 現在との差分 - Visual を表示
- ソース を表示
- Swing/SwingWorker へ行く。
- 1 (2007-05-08 (火) 17:37:49)
- 2 (2007-07-25 (水) 12:36:00)
- 3 (2007-10-11 (木) 15:53:59)
- 4 (2007-12-21 (金) 14:56:02)
- 5 (2008-04-08 (火) 18:54:29)
- 6 (2008-06-18 (水) 12:35:43)
- 7 (2008-07-11 (金) 15:33:33)
- 8 (2009-11-11 (水) 17:38:54)
- 9 (2009-12-17 (木) 01:47:38)
- 10 (2009-12-17 (木) 11:02:55)
- 11 (2011-03-02 (水) 19:46:37)
- 12 (2011-06-13 (月) 16:55:18)
- 13 (2011-07-25 (月) 15:24:05)
- 14 (2011-12-02 (金) 17:23:03)
- 15 (2013-02-28 (木) 14:47:51)
- 16 (2013-09-19 (木) 19:28:33)
- 17 (2013-10-30 (水) 15:22:49)
- 18 (2014-01-21 (火) 19:07:39)
- 19 (2014-01-23 (木) 17:52:48)
- 20 (2014-06-05 (木) 02:22:21)
- 21 (2014-10-26 (日) 04:00:36)
- 22 (2015-11-15 (日) 03:13:09)
- 23 (2016-02-17 (水) 16:18:34)
- 24 (2016-05-28 (土) 18:23:27)
- 25 (2016-09-06 (火) 13:47:09)
- 26 (2017-03-29 (水) 13:54:29)
- 27 (2017-04-04 (火) 14:17:08)
- 28 (2017-08-18 (金) 18:57:31)
- 29 (2018-02-23 (金) 13:07:56)
- 30 (2019-05-22 (水) 19:35:38)
- 31 (2020-03-03 (火) 17:58:49)
- 32 (2021-08-07 (土) 14:34:10)
- category: swing folder: SwingWorker title: SwingWorkerを使った処理の中断と進捗状況表示 tags: [SwingWorker, JProgressBar, JTextArea, Animation] author: aterai pubdate: 2006-06-10T11:46:45+09:00 description: JDK 6で新しくなったSwingWorkerを使って、処理の中断や進捗状況の表示更新などを行います。 image:
概要
JDK 6
で新しくなったSwingWorker
を使って、処理の中断や進捗状況の表示更新などを行います。
Screenshot
Advertisement
サンプルコード
class Task extends SwingWorker<String, String> {
@Override public String doInBackground() {
System.out.println("doInBackground() is EDT?: " + EventQueue.isDispatchThread());
try {
Thread.sleep(1000);
} catch (InterruptedException ie) {
return "Interrupted";
}
int current = 0;
int lengthOfTask = 120; //list.size();
publish("Length Of Task: " + lengthOfTask);
publish("\n------------------------------\n");
while (current < lengthOfTask && !isCancelled()) {
try {
Thread.sleep(50); //doSomething(file = list(current));
} catch (InterruptedException ie) {
return "Interrupted";
}
setProgress(100 * current / lengthOfTask);
publish(".");
current++;
}
publish("\n");
return "Done";
}
}
class RunAction extends AbstractAction {
public RunAction() {
super("run");
}
@Override public void actionPerformed(ActionEvent evt) {
System.out.println("actionPerformed() is EDT?: " + EventQueue.isDispatchThread());
final JProgressBar bar = new JProgressBar();
runButton.setEnabled(false);
canButton.setEnabled(true);
anil.startAnimation();
statusPanel.removeAll();
statusPanel.add(bar);
statusPanel.revalidate();
bar.setIndeterminate(true);
worker = new Task() {
@Override protected void process(List<String> chunks) {
System.out.println("process() is EDT?: " + EventQueue.isDispatchThread());
if (!isDisplayable()) {
System.out.println("process: DISPOSE_ON_CLOSE");
cancel(true);
return;
}
for (String message : chunks) {
appendText(message);
}
}
@Override public void done() {
System.out.println("done() is EDT?: " + EventQueue.isDispatchThread());
if (!isDisplayable()) {
System.out.println("done: DISPOSE_ON_CLOSE");
cancel(true);
return;
}
anil.stopAnimation();
runButton.setEnabled(true);
canButton.setEnabled(false);
statusPanel.remove(bar);
statusPanel.revalidate();
String text = null;
if (isCancelled()) {
text = "Cancelled";
} else {
try {
text = get();
} catch (InterruptedException | ExecutionException ex) {
ex.printStackTrace();
text = "Exception";
}
}
appendText(text);
}
};
worker.addPropertyChangeListener(new ProgressListener(bar));
worker.execute();
}
}
class CancelAction extends AbstractAction {
public CancelAction() {
super("cancel");
}
@Override public void actionPerformed(ActionEvent evt) {
if (worker != null && !worker.isDone()) {
worker.cancel(true);
}
worker = null;
}
}
View in GitHub: Java, Kotlin解説
JDK 6
以前のSwingWorker.java
から一部メソッド名が変更されていますが、基本的な使い方は一緒のようです。
SwingWorker#execute()
メソッドで処理が開始され、SwingWorker#doInBackground()
メソッドが、バックグラウンドのワーカースレッドで実行されるEDT
で実行する必要のある処理(上記の例では処理中にJTextArea
へのメッセージの書き出し)は、SwingWorker#process()
メソッドをオーバーライドしてSwingWorker#publish()
メソッドで呼び出したり、SwingWorker#firePropertyChange()
を使用する- プログレスバーの処理には、
SwingWorker#setProgress(int)
が予め用意されているので、SwingWorker#addPropertyChangeListener(ProgressListener)
を設定するだけで使用可能 SwingWorker#setProgress(int)
で設定できるのは0
から100
で固定protected final void setProgress(int progress) { if (progress < 0 || progress > 100) { throw new IllegalArgumentException("the value should be from 0 to 100"); } // ...
- 実行中の処理のキャンセルは、
SwingWorker#cancel(boolean)
メソッドで行います。キャンセルされたかどうかは、SwingWorker#isCancelled()
メソッドで判定可能
現在のスレッドがイベントディスパッチスレッド(以下EDT
)かどうかを調べるEventQueue.isDispatchThread()
を、このサンプルで使用すると以下のようになります。
actionPerformed() is EDT?
:true
- 現在のスレッド(このサンプルでは
EDT
)で、ボタンを選択不可にしたり、SwingWorker#execute()
を実行している
- 現在のスレッド(このサンプルでは
doInBackground() is EDT?
:false
- ワーカースレッド(バックグラウンド)で重い処理を行い、
EDT
をブロックして停止状態にならないようにする
- ワーカースレッド(バックグラウンド)で重い処理を行い、
process() is EDT?
:true
done() is EDT?
:true
Swing
関連のすべての作業(例えばJProgressBar
の進捗表示更新)は、EDT
で行う必要があるので、process()
かdone()
メソッド内で実行する
SwingWorker#process()
メソッド内などでJPanel#isDisplayable()
を呼び、アプリケーション(frame.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
が設定されている)が終了している場合は、タスクを中断することでSwingWorker
が生き残るのを防止しています。
参考リンク
- SwingWorker (Java Platform SE 8)
- Improve Application Performance With SwingWorker in Java SE 6
- Worker Threads and SwingWorker
- JTableのセルにJProgressBarを表示
- SwingWorkerで複数のJProgressBarを使用する
- SwingWorkerの一時停止と再開