JavaFXコントローラークラスを指定するとき、インナークラスは指定できるんですか？

Question

JavaFXでFXMLファイルにコントローラークラスを指定するとき、インナークラスをコントローラークラスとして指定できるんですか？
もしできるならやり方を教えてください。

Answer 1

###初めに「Inner classとはなにか」の確認
自分自信、Inner classの定義が曖昧だったのでJava language specification 8.1.3. Inner Classes and Enclosing Instancesを見てみました。Inner classは非staticなネストされたクラスであると定義されています。外側のクラスの特定のインスタンスと結びついてのみ生成できるクラスという意味合いですね。

###Inner classをコントローラーとする方法
FXMLを用いてルートノードとコントローラーの初期化を行うには「FXML内にfx:controllerでコントローラーのFQNを指定し、FXMLLoaderにルートノードとコントローラーを動的に生成させる」方法と「ルートノードとコントローラーを自前で予め生成しFXMLLoaderに指定する」方法の２つがあります。JavaFXでの典型的な方法は前者と思いますが、Inner classであるようなコントローラーインスタンスをFXMLLoaderが動的に生成できるような仕組みはない気がするので後者の方法を用いる必要があると思います。

具体的には次のようなコードになります。

ICApp.java(アプリケーションクラス)

package sample;

import javafx.application.Application;
import javafx.fxml.FXMLLoader;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class ICApp extends Application {
	@Override
	public void start(Stage stage) throws Exception {
		FXMLLoader loader = new FXMLLoader(getClass().getResource("ICMain.fxml"));
		ICVBox root = new ICVBox();
		ICVBox.Controller controller = root.new Controller();
		loader.setRoot(root);
		loader.setController(controller);
		loader.load();
		stage.setScene(new Scene(root));
		stage.show();
	}
}

ICVBox.java(ルートノードおよびコントローラークラス)

package sample;

import javafx.fxml.FXML;
import javafx.fxml.Initializable;
import javafx.scene.control.Button;
import javafx.scene.layout.VBox;

import java.net.URL;
import java.util.ResourceBundle;

public class ICVBox extends VBox {
	public class Controller implements Initializable {
		@FXML
		Button button;
		
		@Override
		public void initialize(URL location, ResourceBundle resources) {
			button.setOnAction(ev -> {
				System.out.println("button clicked");
			});
		}
	}
	
}

ICMain.fxml

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

<?import javafx.scene.control.Button?>
<?import javafx.scene.layout.VBox?>

<fx:root type="VBox" xmlns="http://javafx.com/javafx/8.0.60" xmlns:fx="http://javafx.com/fxml/1">
   <children>
      <Button fx:id="button" mnemonicParsing="false" text="Button" />
   </children>
</fx:root>

###蛇足
ところで、上のようにしてInner classをコントローラーに設定できはしますが、この方法を用いた場合、fx:controllerが指定できないため、Scene Builderなどを用いてFXMLを編集する際にコントローラークラスの定義がScene Builderに不明となり、@FXMLアノテーションによるインジェクションメンバーとFXMLの定義の整合性をScene Builderがチェックできず、不整合があってもアプリケーションを実行してみるまでそれに気づけないのがイマイチです。不整合の内容はFXMLLoader#loadの例外情報を参照することになりますが、この例外情報は決して親切とは言い難いものがありますし・・・

カスタムコントロールを定義する際にカスタムコントロールのノードとコントローラーを同一のインスタンスが兼ねてしまうことを嫌うということでコントローラークラスをInner classに分離しておきたいということでしょうか？もしそうなら、Inner classにしておきたいというのもわからなくはないですが、前述のScene Builderの制限があるためInner classにするのも良し悪しな気がします。