{"id":18548993,"url":"https://github.com/danthe1st/compile-time-fxml-parser","last_synced_at":"2025-05-15T08:14:46.502Z","repository":{"id":45790301,"uuid":"513670572","full_name":"danthe1st/compile-time-fxml-parser","owner":"danthe1st","description":"Compile-time FXML-parser is an annotation processor that parses FXML files at compile-time.","archived":false,"fork":false,"pushed_at":"2023-05-07T19:47:36.000Z","size":306,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T09:45:08.705Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danthe1st.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-13T21:03:17.000Z","updated_at":"2022-07-28T14:09:54.000Z","dependencies_parsed_at":"2024-11-06T20:46:06.566Z","dependency_job_id":null,"html_url":"https://github.com/danthe1st/compile-time-fxml-parser","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danthe1st%2Fcompile-time-fxml-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danthe1st%2Fcompile-time-fxml-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danthe1st%2Fcompile-time-fxml-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danthe1st%2Fcompile-time-fxml-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danthe1st","download_url":"https://codeload.github.com/danthe1st/compile-time-fxml-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254301620,"owners_count":22047907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T20:36:24.213Z","updated_at":"2025-05-15T08:14:46.481Z","avatar_url":"https://github.com/danthe1st.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compile-time FXML-parser\n\n[![Release](https://jitpack.io/v/danthe1st/compile-time-fxml-parser.svg)](https://jitpack.io/#danthe1st/compile-time-fxml-parser)\n\nCompile-time FXML-parser is an annotation processor that parses FXML files at compile-time.\n\n## User Setup\n\n* Make sure a JDK \u003e= 17 is installed and the `PATH` and `JAVA_HOME` environment variables point to it\n* [Download](https://maven.apache.org/download.cgi) and [install](https://maven.apache.org/install.html) [Maven](https://maven.apache.org/)\n* [Create a JavaFX project with Maven](https://openjfx.io/openjfx-docs/#maven)\n* Add the [Jitpack repository](https://jitpack.io) to the `\u003crepositories\u003e` section of your `pom.xml`:\n```xml\n\u003crepositories\u003e\n\t\u003crepository\u003e\n\t\t\u003cid\u003ejitpack.io\u003c/id\u003e\n\t\t\u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n\t\u003c/repository\u003e\n\u003c/repositories\u003e\n```\n* 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`)\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.danthe1st\u003c/groupId\u003e\n    \u003cartifactId\u003ecompile-time-fxml-parser\u003c/artifactId\u003e\n    \u003cversion\u003e-SNAPSHOT\u003c/version\u003e\n\u003c/dependency\u003e\n```\n* 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\n```xml\n\u003cplugin\u003e\n\t\u003cartifactId\u003emaven-compiler-plugin\u003c/artifactId\u003e\n\t\u003cversion\u003e3.8.1\u003c/version\u003e\n\t\u003cconfiguration\u003e\n\t\t\u003crelease\u003e11\u003c/release\u003e\n\t\t\u003cannotationProcessorPaths\u003e\n\t\t\t\u003cannotationProcessorPath\u003e\n\t\t\t\t\u003cgroupId\u003eio.github.danthe1st\u003c/groupId\u003e\n\t\t\t\t\u003cartifactId\u003ecompile-time-fxml-parser\u003c/artifactId\u003e\n\t\t\t\t\u003cversion\u003e-SNAPSHOT\u003c/version\u003e\n\t\t\t\u003c/annotationProcessorPath\u003e\n\t\t\u003c/annotationProcessorPaths\u003e\n\t\u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n* Enable annotation processing for your project in your IDE\n\n### Developer Setup\n* Make sure a JDK \u003e= 17 is installed and the `PATH` and `JAVA_HOME` environment variables point to it\n* [Download](https://maven.apache.org/download.cgi) and [install](https://maven.apache.org/install.html) [Maven](https://maven.apache.org/)\n* Download the source code of this repository\n* Run `mvn clean install` in the directory of Compile-time FXML-parser\n* [Create a JavaFX project with Maven](https://openjfx.io/openjfx-docs/#maven)\n* 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)\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.danthe1st\u003c/groupId\u003e\n    \u003cartifactId\u003ecompile-time-fxml-parser\u003c/artifactId\u003e\n    \u003cversion\u003eVERSION\u003c/version\u003e\n\u003c/dependency\u003e\n```\n* If you wish to use JPMS, also add the annotation processor to the `maven-compiler-plugin`\n```xml\n\u003cplugin\u003e\n\t\u003cartifactId\u003emaven-compiler-plugin\u003c/artifactId\u003e\n\t\u003cversion\u003e3.8.1\u003c/version\u003e\n\t\u003cconfiguration\u003e\n\t\t\u003crelease\u003e11\u003c/release\u003e\n\t\t\u003cannotationProcessorPaths\u003e\n\t\t\t\u003cannotationProcessorPath\u003e\n\t\t\t\t\u003cgroupId\u003eio.github.danthe1st\u003c/groupId\u003e\n\t\t\t\t\u003cartifactId\u003ecompile-time-fxml-parser\u003c/artifactId\u003e\n\t\t\t\t\u003cversion\u003eVERSION\u003c/version\u003e\n\t\t\t\u003c/annotationProcessorPath\u003e\n\t\t\u003c/annotationProcessorPaths\u003e\n\t\u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n* Enable annotation processing for your project in your IDE\n\n### Usage\nIn order to parse an FXML file,\nannotate a class with `@ParseFXML`\nand specify the path of the FXML file in paranthesis.\n\nThe FXML file is resolved relative to the resource root.\n\nThis 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()`.\nThis method loads the UI elements specified in the FXML file and returns the root element.\n\nAn example can be found in [examples/maven-example](examples/maven-example).\n\n### Limitations\n\nThis project is not finished and is therefore missing functionality.\n- Default Properties, Define Blocks, Location Resolution, Resource Resolution, Variable Resolution, Escape Sequences and Expression Binding are not (yet) supported.\n\nFurthermore, the following things needed to be left out because of Compile-time FXML-parser's static nature:\n\n- Builders (using `javafx.util.Builder`) are not supported because they require looking up attributes of arbitary subclasses in unsupported packages.\n- Scripts (using `fx:script`) are not supported because of the static nature of Compile-time FXML-parser.\n\nOther limitations include:\n\n- 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`.\n- `fx:id`s can only be accessed after being declared.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanthe1st%2Fcompile-time-fxml-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanthe1st%2Fcompile-time-fxml-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanthe1st%2Fcompile-time-fxml-parser/lists"}