ダイアログの使い方

ここでは特にButtonTypeボタンの有無による動作の違いについて述べる。

Converting ButtonType to Return Type

Dialogの型パラメータはDialogの返り値を示すはずだが、ボタンをつけると全く意味がなくなる。以下のresultはString型のはずだが、そのままではButtonTypeが返されてしまうため、ClassCastExceptionが発生する。この場合ResultConverterの設定が必要。

Type Parameter of Dialog class should designate the return type of it. But if you use some buttons, it has no meaning. Actually the Dialog returns ButtonType. So the following code will occur ClassCastException. You need ResultConverter.

import java.util.*;

import javafx.application.*;
import javafx.scene.*;
import javafx.scene.control.*;
import javafx.stage.*;

public class DialogTest1 extends Dialog<String> {

  public DialogTest1() {
    Label label = new Label("test dialog");
    this.getDialogPane().setContent(label);
    this.getDialogPane().getButtonTypes().addAll(ButtonType.OK, ButtonType.CANCEL);
    // setResultConverter(type-> type == ButtonType.OK? "OK":"CANCEL");
  }
    
  public static class Kicker extends Application {
    DialogTest1 dialogTest = new DialogTest1();
    public void start(Stage stage) {
      Button open = new Button("open");
      open.setOnAction(a-> {        
        Optional<String> result = dialogTest.showAndWait();
        System.out.println("result " + result.orElse(null)); <-- Without ResultConverter, ClassCastException raised
      });
      stage.setScene(new Scene(open));
      stage.show();
    }
  }
  
  public static void main(String[] args) throws Exception {
    Kicker.launch(Kicker.class);
  }
}

ちなみに、ダイアログ表示中にEscapeキー押下すると、CANCELとみなされる。また、ResultConverterにてOKの時にnull値を返すと、それもCANCELとみなされる。

Hitting Escape key on the Dialog is regarded as CANCEL. Returning (String)null value when clicking OK button is also regarded as CANCEL.