マウスカーソルの変更が反映されるタイミングについて

Question

JavaFXで画面UIからの操作により、更新処理を実行しています。
その際、更新処理に時間が掛かるのでsetCursor(Cursor.WAIT)でマウスカーソルを変更して
「ただいま更新処理をしてますよ」というのを示したいと思っています。

操作により発生したイベント処理で
setCursor(Cursor.WAIT) → 更新処理 → setCursor(Cursor.DEFAULT)
と書いてみたのですが、更新処理中にマウスカーソルが変化せず狙い通りにいきませんでした。

更新処理をスレッドにすれば上手くいくのではないかと次のように書いたのですが、これでも上手くいきません。

Scene scene = pane.getScene(); // コンテナよりsceneを取得
Cursor bkCur = scene.getCursor();
scene.setCursor(Cursor.WAIT); // マウスカーソル変更

ExecutorService service = Executors.newSingleThreadExecutor();
Future<Boolean> future = service.submit( () -> { // 更新処理スレッド
		Thread.sleep(10000); // ダミー処理
		return true;
	}
);

Boolean thResult = future.get();  // スレッドの終了を待つ
scene.setCursor(bkCur);  // マウスカーソルを戻す
     

処理中にマウスカーソルを変更しても処理が終了して画面に制御が戻らないとカーソルに反映できないようですが、
処理中にマウスカーソルを変更するにはどうしたらよいでしょうか？

Answer 1

原因はFuture#getで結果を得ようとしている点です。getは別スレッドでの計算が完了するのを同期的に待つ機能ですのでこれを使ってしまうと別スレッドの実行が完了するまでJavaFXアプリケーションスレッド(以降単にアプリケーションスレッドと呼びます)が止まることになり、別スレッドとした意味がなくなります。つまりアプリケーションスレッドで時間がかかる処理を直接行うことと変わらなくなるわけです。

コードコメントに「スレッドの終了を待つ」とありますが、一般的にアプリケーションスレッドで何かを待つ処理をするのは不適切ですから、別スレッド側で(処理が完了したタイミングで)Platform.runLaterを用いてGUIの状態変更をするのが簡単と思います。

Button startButton = new Button("start");
startButton.setOnAction(ev -> {
  startButton.setDisable(true);         // 実行中はボタンを押せなくする
  Scene scene = startButton.getScene();
  Cursor currentCursor = scene.getCursor();
  scene.setCursor(Cursor.WAIT);
  
  new Thread(() -> {
    try {
      Thread.sleep(10000);
    } catch (InterruptedException e) {
      ; // この例では割り込みは無視
    } finally {
      Platform.runLater(() -> {
        scene.setCursor(currentCursor);  // カーソルを元に戻す
        startButton.setDisable(false);   // ボタンを再び有効にする
      });
    }
  }).start();
});

なお、もし実行中のバックグラウンド処理の進行状況をProgressBarなどで表示するなどもう少し凝ったことをするならjavafx.concurrent.Task<T>を使うとよいと思います。

Comments

[XCUBE]

KSwordOfHaste様 サンプルコードまで提示いただいてありがとうございます。

なぜ時間の掛かる処理を別スレッドに切り出したかといいますとマルチスレッドにすることによって待ち時間の間にマウスカーソルが切り替わってくれるのではないかと期待したからでした。
やはりイベントハンドラ内で変更したマウスカーソルはイベントハンドラを抜けないと実際に変わらないってことですなんですね。

処理が終わるまで当該イベントだけでなく他の操作を一切できないようにしたいので処理が終わるまでイベントハンドラを抜けたくなかったのですが、それが出来ないとなると他の画面操作もsetDisable(false)だ抑制しなければならなくなり画面の変更による保守性が悪くなるので、なんとしてもイベントハンドラ内でマウスカーソルの切替えをできればと思っていました。

KSwordOfHaste様 の回答を受けてマウスカーソルで処理中を表現するのではなく、イベントハンドラ内でモーダルダイアログを表示させて処理中を表現することも検討しようと思います。

[KSwordOfHaste]

> 他の画面操作もsetDisable(false)だ抑制しなければならなくなり画面の変更による保守性が悪くなる

回答コードでボタンに対してsetDisableしたのは「このボタン以外の他の操作は可能」という想定です。「アプリケーションを終了させる以外の全ての操作を許す」想定なら、シーンのrootノードに対してsetDisableする方法も考えられます。あらゆる全ての操作を禁止するならXCUBEさんがおっしゃるように「しばらくお待ちください」的なメッセージダイアログを
・デコレーションなし(タイトルバーのクローズボタンを押されると困るため)
・アプリケーションモーダル
で表示するのがよいと思います。ただその場合「なんの操作も受け付けなくなる」ことを示すためやはりカーソルをWAITにするのが自然と思います。

ただGUIアプリケーションはなるべくユーザーのストレスをなくせるようにしたいので場合によっては「時間のかかる操作をキャンセル」などなんらかのユーザー操作を受け付けた方がベターとは思います。それだけ作りに配慮が必要になりますが。