image:https://img.shields.io/maven-central/v/net.rgielen/javafx-weaver[Maven Central Version,link=https://central.sonatype.com/search?q=net.rgielen.javafx-weaver]
== JavaFX-Weaver
An opinionated view on how to do dependency injection and FXML view handling in JavaFX.
Complementary Blog Posts:
- https://rgielen.net/posts/2019/introducing-fxweaver-dependency-injection-support-for-javafx-and-fxml/[Introducing FxWeaver - Dependency Injection Support for JavaFX and FXML]
- https://rgielen.net/posts/2019/creating-a-spring-boot-javafx-application-with-fxweaver/[Creating a Spring Boot JavaFX Application with FxWeaver]
Features:
- Supportive tooling for using JavaFX together with dependency injection frameworks such as Spring or CDI
-
https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#maincontroller-fxmlview-example[Declarative FXML view binding] - Create a controller class and annotate it with
@FxmlViewand letFxWeaverhandle view loading and instantiating -
https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#main-controller-fxml[Support for
fx:controllerattribute in FXML], with controller classes being instantiated, autowired and fully managed by your DI framework of choice - https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#main-controller-loading-example[Acquire managed controller instances] with automatically weaved FXML views
-
https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#tiled-views-re-using-independent-components[Support for tiling / componentisation]: Create view components with independent controllers and aggregate them in other views using
fx:include, again with full DI support - https://gluonhq.com/products/scene-builder/[SceneBuilder] fully supported, even when creating and using view tiles
- Spring and Spring Boot specific:
** https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#springfxweaver-directly-inject-a-fxcontrollerandview-reference[Support for direct injection] ofFxControllerAndViewinstances based on generic types
** https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#spring-boot-starter[Spring Boot Starter] including auto-configuration
=== Getting Started
==== Spring Boot
Add the https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample#spring-boot-starter[Spring Boot Starter] dependency to your project and you are all set:
with Maven:
[source,xml]
with Gradle:
[source,groovy]
implementation 'net.rgielen:javafx-weaver-spring-boot-starter:2.0.0'
==== Manual Setup
Add javafx-weaver-core or javafx-weaver-springas a dependency to your project.
with Maven:
[source,xml]
with Gradle:
[source,groovy]
implementation 'javafx-weaver-spring-boot-starter:2.0.1'
=== Using FxWeaver
For now, refer to the JavaDocs and the https://github.com/rgielen/javafx-weaver/tree/master/samples/springboot-sample[Spring Boot based FxWeaver Sample and Feature Demo Project].
More documentation to come.
=== License
The project is licensed under https://www.apache.org/licenses/LICENSE-2.0[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: https://twitter.com/rgielen[@rgielen]