Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danthe1st/compile-time-fxml-parser
Compile-time FXML-parser is an annotation processor that parses FXML files at compile-time.
https://github.com/danthe1st/compile-time-fxml-parser
Last synced: 13 days ago
JSON representation
Compile-time FXML-parser is an annotation processor that parses FXML files at compile-time.
- Host: GitHub
- URL: https://github.com/danthe1st/compile-time-fxml-parser
- Owner: danthe1st
- License: mit
- Created: 2022-07-13T21:03:17.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T19:47:36.000Z (over 1 year ago)
- Last Synced: 2024-04-24T06:29:37.647Z (7 months ago)
- Language: Java
- Size: 299 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Compile-time FXML-parser
[](https://jitpack.io/#danthe1st/compile-time-fxml-parser)
Compile-time FXML-parser is an annotation processor that parses FXML files at compile-time.
## User Setup
* Make sure a JDK >= 17 is installed and the `PATH` and `JAVA_HOME` environment variables point to it
* [Download](https://maven.apache.org/download.cgi) and [install](https://maven.apache.org/install.html) [Maven](https://maven.apache.org/)
* [Create a JavaFX project with Maven](https://openjfx.io/openjfx-docs/#maven)
* Add the [Jitpack repository](https://jitpack.io) to the `` section of your `pom.xml`:
```xml
jitpack.io
https://jitpack.io
```
* Add the following dependency to the `pom.xml` of the project where you want to use Compile-time FXML-parser (If you want to use a specific version, you can specify any commit hash instead of `-SNAPSHOT`)
```xml
com.github.danthe1st
compile-time-fxml-parser
-SNAPSHOT
```
* If you wish to use JPMS, also add the annotation processor to the `maven-compiler-plugin`. Note that the versions of Compile-time FXML-parser need to match
```xml
maven-compiler-plugin
3.8.1
11
io.github.danthe1st
compile-time-fxml-parser
-SNAPSHOT
```
* Enable annotation processing for your project in your IDE
### Developer Setup
* Make sure a JDK >= 17 is installed and the `PATH` and `JAVA_HOME` environment variables point to it
* [Download](https://maven.apache.org/download.cgi) and [install](https://maven.apache.org/install.html) [Maven](https://maven.apache.org/)
* Download the source code of this repository
* Run `mvn clean install` in the directory of Compile-time FXML-parser
* [Create a JavaFX project with Maven](https://openjfx.io/openjfx-docs/#maven)
* Add the following dependency to the `pom.xml` of the project where you want to use Compile-time FXML-parser (replace `VERSION` with the version from the [`pom.xml` of Compile-time FXML-parser](pom.xml)
```xml
io.github.danthe1st
compile-time-fxml-parser
VERSION
```
* If you wish to use JPMS, also add the annotation processor to the `maven-compiler-plugin`
```xml
maven-compiler-plugin
3.8.1
11
io.github.danthe1st
compile-time-fxml-parser
VERSION
```
* Enable annotation processing for your project in your IDE
### Usage
In order to parse an FXML file,
annotate a class with `@ParseFXML`
and specify the path of the FXML file in paranthesis.
The FXML file is resolved relative to the resource root.
This should automatically create a class with the name of the annotated class + "FXMLRepresentation" (the class name can be overwritten by specifying `className` in the annotation) with a method `createNode()`.
This method loads the UI elements specified in the FXML file and returns the root element.
An example can be found in [examples/maven-example](examples/maven-example).
### Limitations
This project is not finished and is therefore missing functionality.
- Default Properties, Define Blocks, Location Resolution, Resource Resolution, Variable Resolution, Escape Sequences and Expression Binding are not (yet) supported.
Furthermore, the following things needed to be left out because of Compile-time FXML-parser's static nature:
- Builders (using `javafx.util.Builder`) are not supported because they require looking up attributes of arbitary subclasses in unsupported packages.
- Scripts (using `fx:script`) are not supported because of the static nature of Compile-time FXML-parser.
Other limitations include:
- Big FXML files may fail compilation because of too many local variables. In that case, one split up the FXML file into multiple files using `fx:include`.
- `fx:id`s can only be accessed after being declared.