README.adoc

JavaFX-Weaver

An opinionated view on how to do dependency injection and FXML view handling in JavaFX.

Complementary Blog Posts:

• Introducing FxWeaver - Dependency Injection Support for JavaFX and FXML

• Creating a Spring Boot JavaFX Application with FxWeaver

Features:

• Supportive tooling for using JavaFX together with dependency injection frameworks such as Spring or CDI

• Declarative FXML view binding - Create a controller class and annotate it with @FxmlView and let FxWeaver handle view loading and instantiating

• Support for fx:controller attribute in FXML, with controller classes being instantiated, autowired and fully managed by your DI framework of choice

• Acquire managed controller instances with automatically weaved FXML views

• Support for tiling / componentisation: Create view components with independent controllers and aggregate them in other views using fx:include, again with full DI support

• SceneBuilder fully supported, even when creating and using view tiles

• Spring and Spring Boot specific:

  • Support for direct injection of FxControllerAndView instances based on generic types

  • Spring Boot Starter including auto-configuration

Getting Started

Spring Boot

Add the Spring Boot Starter dependency to your project and you are all set:

with Maven:

<dependency>
    <groupId>net.rgielen</groupId>
    <artifactId>javafx-weaver-spring-boot-starter</artifactId>
    <version>2.0.1</version>
</dependency>

with Gradle:

implementation 'net.rgielen:javafx-weaver-spring-boot-starter:2.0.0'

Manual Setup

Add javafx-weaver-core or `javafx-weaver-spring`as a dependency to your project.

with Maven:

<dependency>
    <groupId>net.rgielen</groupId>
    <artifactId>javafx-weaver-core</artifactId>
    <version>2.0.1</version>
</dependency>

with Gradle:

implementation 'javafx-weaver-spring-boot-starter:2.0.1'

Using FxWeaver

For now, refer to the JavaDocs and the Spring Boot based FxWeaver Sample and Feature Demo Project.

More documentation to come.

License

The project is licensed under Apache License V2.0.

Contributing

Feel free to open issues and pull requests on GitHub. This is a side project of mine, so please don’t expect enterprise grade support.

You can find me on Twitter as well: @rgielen