From 8694899e57a81f08100ceeffe49a1735b2926208 Mon Sep 17 00:00:00 2001 From: Konrad Neitzel Date: Wed, 2 Apr 2025 18:51:31 +0200 Subject: [PATCH] Refactoring and modified README. --- README.md | 36 ++++++++----------- fx-example/pom.xml | 2 +- .../fx/component/example/Address.java | 2 +- .../fx/component/example/ExampleApp.java | 4 +-- .../{core => }/fx/component/example/Main.java | 2 +- .../fx/component/example/Person.java | 2 +- .../fx/injectfx/example/JavaFXApp.java | 2 +- .../{core => }/fx/injectfx/example/Main.java | 2 +- .../fx/injectfx/example/MainWindow.java | 2 +- fx-example/src/main/resources/address.fxml | 2 +- .../fx/injectfx/example/MainWindow.fxml | 2 +- fx-example/src/main/resources/person.fxml | 2 +- .../fx/component/AutoViewModel.java | 2 +- .../fx/component/ComponentController.java | 2 +- .../fx/component/ComponentLoader.java | 2 +- .../fx/injectfx/FXMLComponentInstances.java | 2 +- .../injectfx/InjectingControllerFactory.java | 2 +- .../fx/injectfx/InjectingFXMLLoader.java | 2 +- .../{core => }/fx/mvvm/BindDirection.java | 2 +- .../fx/mvvm/BindingAwareFXMLLoader.java | 2 +- .../fx/mvvm/GenericViewController.java | 2 +- .../{core => }/fx/mvvm/GenericViewModel.java | 2 +- 22 files changed, 37 insertions(+), 43 deletions(-) rename fx-example/src/main/java/de/neitzel/{core => }/fx/component/example/Address.java (75%) rename fx-example/src/main/java/de/neitzel/{core => }/fx/component/example/ExampleApp.java (90%) rename fx-example/src/main/java/de/neitzel/{core => }/fx/component/example/Main.java (89%) rename fx-example/src/main/java/de/neitzel/{core => }/fx/component/example/Person.java (75%) rename fx-example/src/main/java/de/neitzel/{core => }/fx/injectfx/example/JavaFXApp.java (93%) rename fx-example/src/main/java/de/neitzel/{core => }/fx/injectfx/example/Main.java (90%) rename fx-example/src/main/java/de/neitzel/{core => }/fx/injectfx/example/MainWindow.java (93%) rename fx-example/src/main/resources/de/neitzel/{core => }/fx/injectfx/example/MainWindow.fxml (88%) rename fx/src/main/java/de/neitzel/{core => }/fx/component/AutoViewModel.java (98%) rename fx/src/main/java/de/neitzel/{core => }/fx/component/ComponentController.java (94%) rename fx/src/main/java/de/neitzel/{core => }/fx/component/ComponentLoader.java (99%) rename fx/src/main/java/de/neitzel/{core => }/fx/injectfx/FXMLComponentInstances.java (99%) rename fx/src/main/java/de/neitzel/{core => }/fx/injectfx/InjectingControllerFactory.java (97%) rename fx/src/main/java/de/neitzel/{core => }/fx/injectfx/InjectingFXMLLoader.java (97%) rename fx/src/main/java/de/neitzel/{core => }/fx/mvvm/BindDirection.java (97%) rename fx/src/main/java/de/neitzel/{core => }/fx/mvvm/BindingAwareFXMLLoader.java (99%) rename fx/src/main/java/de/neitzel/{core => }/fx/mvvm/GenericViewController.java (98%) rename fx/src/main/java/de/neitzel/{core => }/fx/mvvm/GenericViewModel.java (99%) diff --git a/README.md b/README.md index 5ea55c4..65fafaf 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,23 @@ -# JavaFX Maven Project +# NeitzelLib Maven Project -Example Maven Project for a JavaFX Application. +Small Library with classes that I found helpfully or interesting. -**Update**: Added profile fatjar +The idea is not to diretly use anything from this library. It is only meant to provide some code which could be a quick start when required inside a project. So simply copy the classes that you need. -**Update**: Added reporting to create a site (html documentation of project) +## Components -**Update**: Java 21 is now fully supported +### core -This projects includes multiple plugins: -- Build of an App-Image using JPackage (Profile: image) -- Build of an fat jar (Profile: fatjar) -- Use of Maven Wrapper -- Static code analysis with PMD and Spotbugs -- Check of dependency updates during build -- JavaFX plugin to start application +This is the core library that does not have special dependencies like JavaFX. -**Requirements** -To use this Template, all you need is a local Java Installation. -My current advice is to use a long term supported (LTS) version of either Java 17 or Java 21. +It contains: +- **inject** Some small, basic Injection Library (Just a quick start) +- **sql** Helper classes to work with SQL in Java -**[Documentation in English](documentation/en/_Index.md)** +### fx +Library that extends JavaFX or helps with it. -**[Dokumentation in Deutsch](documentation/de/_Index.md)** - -**Important: ChatGPT was utilized to generate the documentation based on -predefined content specifications, as it represents the fastest way to produce -comprehensive documentation.** \ No newline at end of file +It contains: +- **component** Just a quick start where I experiment with the idea to have JavaFX components which means that we have a View to display a specific Model. +- **injectfx** Injection inside JavaFX, main idea is to use constructor injection on FXML controller to include required Elements. +- **mvvm** The mvvmFX project seems to get no more updates / is no longer maintained. In this area I am simply playing around with some helper classes to make the use of the mvvm pattern easier through generation of ViewModels. **Currently not really useable** \ No newline at end of file diff --git a/fx-example/pom.xml b/fx-example/pom.xml index 87e3dc5..f5b0b13 100644 --- a/fx-example/pom.xml +++ b/fx-example/pom.xml @@ -16,7 +16,7 @@ ${project.artifactId} ${project.artifactId} ${project.artifactId} - de.neitzel.core.fx.injectfx.example.Main + de.neitzel.fx.injectfx.example.Main ${project.artifactId}-${project.version} diff --git a/fx-example/src/main/java/de/neitzel/core/fx/component/example/Address.java b/fx-example/src/main/java/de/neitzel/fx/component/example/Address.java similarity index 75% rename from fx-example/src/main/java/de/neitzel/core/fx/component/example/Address.java rename to fx-example/src/main/java/de/neitzel/fx/component/example/Address.java index b82b899..9166a04 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/component/example/Address.java +++ b/fx-example/src/main/java/de/neitzel/fx/component/example/Address.java @@ -1,4 +1,4 @@ -package de.neitzel.core.fx.component.example; +package de.neitzel.fx.component.example; import lombok.Getter; import lombok.Setter; diff --git a/fx-example/src/main/java/de/neitzel/core/fx/component/example/ExampleApp.java b/fx-example/src/main/java/de/neitzel/fx/component/example/ExampleApp.java similarity index 90% rename from fx-example/src/main/java/de/neitzel/core/fx/component/example/ExampleApp.java rename to fx-example/src/main/java/de/neitzel/fx/component/example/ExampleApp.java index d39f1f4..d4ef74e 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/component/example/ExampleApp.java +++ b/fx-example/src/main/java/de/neitzel/fx/component/example/ExampleApp.java @@ -1,6 +1,6 @@ -package de.neitzel.core.fx.component.example; +package de.neitzel.fx.component.example; -import de.neitzel.core.fx.component.ComponentLoader; +import de.neitzel.fx.component.ComponentLoader; import javafx.application.Application; import javafx.scene.Parent; import javafx.scene.Scene; diff --git a/fx-example/src/main/java/de/neitzel/core/fx/component/example/Main.java b/fx-example/src/main/java/de/neitzel/fx/component/example/Main.java similarity index 89% rename from fx-example/src/main/java/de/neitzel/core/fx/component/example/Main.java rename to fx-example/src/main/java/de/neitzel/fx/component/example/Main.java index 388db92..80565bb 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/component/example/Main.java +++ b/fx-example/src/main/java/de/neitzel/fx/component/example/Main.java @@ -1,4 +1,4 @@ -package de.neitzel.core.fx.component.example; +package de.neitzel.fx.component.example; /** * Another Main class as workaround when the JavaFX Application ist started without diff --git a/fx-example/src/main/java/de/neitzel/core/fx/component/example/Person.java b/fx-example/src/main/java/de/neitzel/fx/component/example/Person.java similarity index 75% rename from fx-example/src/main/java/de/neitzel/core/fx/component/example/Person.java rename to fx-example/src/main/java/de/neitzel/fx/component/example/Person.java index 76971fa..2078450 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/component/example/Person.java +++ b/fx-example/src/main/java/de/neitzel/fx/component/example/Person.java @@ -1,4 +1,4 @@ -package de.neitzel.core.fx.component.example; +package de.neitzel.fx.component.example; import lombok.Getter; import lombok.Setter; diff --git a/fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/JavaFXApp.java b/fx-example/src/main/java/de/neitzel/fx/injectfx/example/JavaFXApp.java similarity index 93% rename from fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/JavaFXApp.java rename to fx-example/src/main/java/de/neitzel/fx/injectfx/example/JavaFXApp.java index 2a8ceb9..2020ead 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/JavaFXApp.java +++ b/fx-example/src/main/java/de/neitzel/fx/injectfx/example/JavaFXApp.java @@ -1,4 +1,4 @@ -package de.neitzel.core.fx.injectfx.example; +package de.neitzel.fx.injectfx.example; import javafx.application.Application; import javafx.fxml.FXMLLoader; diff --git a/fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/Main.java b/fx-example/src/main/java/de/neitzel/fx/injectfx/example/Main.java similarity index 90% rename from fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/Main.java rename to fx-example/src/main/java/de/neitzel/fx/injectfx/example/Main.java index 4dc8937..63b5774 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/Main.java +++ b/fx-example/src/main/java/de/neitzel/fx/injectfx/example/Main.java @@ -1,4 +1,4 @@ -package de.neitzel.core.fx.injectfx.example; +package de.neitzel.fx.injectfx.example; /** * Another Main class as workaround when the JavaFX Application ist started without diff --git a/fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/MainWindow.java b/fx-example/src/main/java/de/neitzel/fx/injectfx/example/MainWindow.java similarity index 93% rename from fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/MainWindow.java rename to fx-example/src/main/java/de/neitzel/fx/injectfx/example/MainWindow.java index e36126e..07fa5c2 100644 --- a/fx-example/src/main/java/de/neitzel/core/fx/injectfx/example/MainWindow.java +++ b/fx-example/src/main/java/de/neitzel/fx/injectfx/example/MainWindow.java @@ -1,4 +1,4 @@ -package de.neitzel.core.fx.injectfx.example; +package de.neitzel.fx.injectfx.example; import javafx.event.ActionEvent; import javafx.fxml.FXML; diff --git a/fx-example/src/main/resources/address.fxml b/fx-example/src/main/resources/address.fxml index 1839be7..2bc5a08 100644 --- a/fx-example/src/main/resources/address.fxml +++ b/fx-example/src/main/resources/address.fxml @@ -6,7 +6,7 @@ - +