JavaFX8 ダイアログ表示でのESCキーイベントの処理

Question

JavaFX８に興味を持って勉強を始めたばかりの初心者です。
どうかご教授よろしくお願いします。

Windows10で作成、実行しています。
JavaFX8で作成した画面に「キャンセル」ボタンを設けて、「キャンセル」をクリック、または「ESC」キーを押したら画面を終了する処理を作成しました。
※「キャンセル」ボタンは、cancelButtonに設定しており、ActionEventを設定しています。

ただ、キャンセルが押された場合、まずは、確認ダイアログ（Alertクラス）を表示して、確認ダイアログで「OK」が選択されてから終了したいと考えています。

質問内容ですが、
「ESC」キーを押した場合の処理がわかりません。
画面で「ESC」キーを押すと、ActionEventで受け取るのですが、キーイベントがそのまま確認ダイアログにも渡されてしまっているようです。
その為、一瞬だけ確認ダイアログが表示され、結果としてキャンセルが戻ってきてしまいます。

希望としては、「ESC」キーを押したイベントが警告ダイアログに渡らないようにしたいのですが、何か方法はありますでしょうか？

画面のコントローラークラスのソースです。

public class FXMLDocumentController implements Initializable {
    
    @FXML
    private void handleButtonAction(ActionEvent event) {
        Alert alert = new Alert(Alert.AlertType.CONFIRMATION);
        alert.setTitle("確認");
        alert.setHeaderText("ヘッダー情報");
        alert.setContentText("コンテンツ情報");
        
        Optional<ButtonType> result = alert.showAndWait();
        
        if(ButtonType.OK.equals(result.get())){
            Platform.exit();
        }
        
    }
    
    @Override
    public void initialize(URL url, ResourceBundle rb) {
        // TODO
    }    
    
}

よろしくお願いします。

追記です。）
ただ、キャンセルが押された場合、まずは、確認ダイアログ（Alertクラス）を表示して、確認ダイアログで「OK」が選択されてから終了したいと考えています。

ではなく

ただ、キャンセルが押された場合__（ESCキーが押された場合も）__、まずは、確認ダイアログ（Alertクラス）を表示して、確認ダイアログで「OK」が選択されてから終了したいと考えています。

fxmlは下記になってます。

<?xml version="1.0" encoding="UTF-8"?>

<?import java.lang.*?>
<?import java.util.*?>
<?import javafx.scene.*?>
<?import javafx.scene.control.*?>
<?import javafx.scene.layout.*?>

<AnchorPane id="AnchorPane" prefHeight="200" prefWidth="320" xmlns="http://javafx.com/javafx/8.0.40" xmlns:fx="http://javafx.com/fxml/1" fx:controller="dialogsample.FXMLDocumentController">
    <children>
        <Button cancelButton="true" layoutX="126" layoutY="90" onAction="#handleButtonAction" text="CANCEL" />
    </children>
</AnchorPane>

Comments

[argius]

ESCキーイベントの処理はどうやっているのですか？

[silver]

ありがとうございます。
ESCキーに対するKeyEventの処理は特にしておりません。
ButtonをcancelButtonに設定すれば、ESCキーを押した場合は、ActionEventが発生するという認識でいますが、そもそもそこが間違えているのでしょうか？
AlertクラスにあるキャンセルボタンもcancelButtonに設定されているので、そのままActionEventが伝播されていると思っていました。
よろしくお願いします。

[argius]

情報の追記、ありがとうございます。問題の意味が分かりました。少し調べてみましたが、一筋縄では行かないようですね。

[silver]

説明足りなく申し訳ありませんでした。やはり難しいのですかね。

Answer 1

（追記）

eripongさんにいただいたコメントによれば、下記のバグによる挙動みたいです。
詳しくは、この回答のコメント欄を参照して下さい。

[JDK-8131151] Pressing ESC in a nested alert closes self and parent alert - Java Bug System
https://bugs.openjdk.java.net/browse/JDK-8131151

そうなると、AlertダイアログのOnKeyReleasedイベントでESCキーを無効にする方がバグの回避方法としては正しいですね。

alert.getDialogPane().setOnKeyReleased(new EventHandler<KeyEvent>() {
    public void handle(KeyEvent e) {
        if (e.getCode() == KeyCode.ESCAPE) {
            e.consume();
        }
    }
});

---

（最初の回答）

根本的な解決ではないのですが、下記のコードを追加すればそれらしい動作にできそうです。

実際は、ESCキーでダイアログを開いた時に即時にダイアログが閉じています。
その直後に、ESCキーのイベント処理で、もう一度handleButtonActionを直接呼び出しています。確実ではありませんが、Platform.runLaterで呼び出すことで、即時にダイアログが閉じることによるちらつきを見えにくくしています。

scene.setOnKeyPressed(new EventHandler<KeyEvent>() {
    public void handle(KeyEvent e) {
        if (e.getCode() == KeyCode.ESCAPE) {
            Platform.runLater(() -> handleButtonAction(new ActionEvent()));
        }
    }
});

Comments

[silver]

なるほどですね。ありがとうございます。
動きとしては、希望通りの動きしました。
大変助かりました。
argiusさんの言う通り、根本ではないですがとりあえず回避策はできました。
もう少し自分でも調べてみます。

[argius]

私のJavaバージョンが少し古かったので、8u66にバージョンアップして確認しましたが、変わりませんでした。
特におかしなことも特殊なことをしているわけでもないと思うので、この挙動は納得いきませんね。
Alertは比較的新しいクラスなので、バグの可能性もあるかも知れません。

[silver]

本当にありがとうございます。
Alertが使えるようになったとのことで楽になるから使ってみたのですが・・・
大変勉強になりました。
いろいろググってみたのですがこの辺の事を突っ込んでいるものがなかったので
本当に助かりました。

[argius]

Alertは情報がまだ少ないですね。

それでもダイアログが使えるようになったのは嬉しいですよね。
というか、なぜ今までなかったのかは本当に不思議でなりません。
Swingを置き換えるものにしては変なところで不足してるんですよね、FXは。

ともあれ、ちゃんとした解決でなくて恐縮ですが、お役に立てたようで良かったです。

[eripong]

https://bugs.openjdk.java.net/browse/JDK-8131151
このバグでしょうか？
該当すれば、JavaFX 9で修正されるらしいです。

[eripong]

> the context menu code was listening for the ESCAPE key on key _pressed_,
> and the dialog code was listening for the escape key on key _released_.
> So, even though the event was being properly consumed in the context
> menu code, the dialog was watching for (and receiving) an entirely
> different event.
コンテキストメニューではキーが押された際(所謂KeyPressedEvent)に処理するのに、
ダイアログではキーが離された際(所謂KeyReleasedEvent)に処理することによる、
と書かれている様で、それらしいのですが。

[argius]

eripongさん
コメントありがとうございます。

どうやらそのバグにまちがい無いようです。
回答欄に追記させていただきます！

[eripong]

お、該当しましたか。
良かったです。

[argius]

eripongさん

はい、自力で見つけられなかったので助かりました。
ありがとうございました！

[silver]

コメントありがとうございます。
バグなんですね・・・
ありがとうございました。

[silver]

試してみました！ジャストフィットですね。
eripongさん、argiusさん
本当にありがとうございました。