Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcin-chwedczuk/javafx-validation
Application that demonstrate how you can implement validation in JavaFX from scratch.
https://github.com/marcin-chwedczuk/javafx-validation
javafx javafx-application javafx-gui validation
Last synced: about 1 month ago
JSON representation
Application that demonstrate how you can implement validation in JavaFX from scratch.
- Host: GitHub
- URL: https://github.com/marcin-chwedczuk/javafx-validation
- Owner: marcin-chwedczuk
- License: mit
- Created: 2021-04-29T19:14:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-03T11:27:18.000Z (over 3 years ago)
- Last Synced: 2024-09-29T03:40:29.766Z (about 1 month ago)
- Topics: javafx, javafx-application, javafx-gui, validation
- Language: Java
- Homepage:
- Size: 1.58 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavaFX Validation Demo
This application shows how to implement simple validation in JavaFX from scratch.
By "simple", I mean that both debouncing and async-validators are not supported.
Support for them can be added with a bit of effort,
but if you need them, then you will
probably be better
of using more advanced validation frameworks. In that case I can recommend checking out
[controlsfx](https://github.com/jinghai/controlsfx/blob/master/controlsfx-samples/src/main/java/org/controlsfx/samples/HelloValidation.java)
and [mvvmFX](https://github.com/sialcasa/mvvmFX/wiki/Validation) libraries.
This application comes in two parts. First we have of course the validation
library itself. Then we have three simple forms, with the most common
validation patterns, that demonstrate how to use
the library:
## Contributors Guide
### How to?
Project is build and tested using JDK 11.
#### Run application
```
./mvnw javafx:run -pl demo
```
#### Regenerate scss styles
```
./mvnw nl.geodienstencentrum.maven:sass-maven-plugin:update-stylesheets -pl demo
```
#### Watch for SCSS changes and regenerate them
```
fswatch --exclude='.*' --include='.*[.]scss$' --print0 . | while read -d "" event; do
./mvnw nl.geodienstencentrum.maven:sass-maven-plugin:update-stylesheets -pl demo
done
```
You need to install `fswatch` command for this to work.
#### Generate `jlink` image (in `demo/target` directory):
```
./mvnw javafx:jlink -pl demo
./demo/target/validation-demo/bin/validation-demo
```
You can now send `./demo/target/validation-demo.zip` to your friends :tada:
#### Generate code quality reports
```
./mvnw clean verify site -Pstatic-analysis
```
Then open `./target/site/index.html` to see full report, e.g.
```
pushd ./target/site/
python -m SimpleHTTPServer
# When you are done
popd
```
#### Run integration tests (TestFX)
```
./mvnw verify -Dskip.integration.tests=false -Dskip.unit.tests=true
```
Run single test:
```
./mvnw clean verify -Dskip.integration.tests=false -Dskip.unit.tests=true \
-pl demo -Dit.test=NumberRangeIT
```
Run in the headless mode (with screenshots):
```
_JAVA_OPTIONS="-Djava.awt.headless=true \
-Dtestfx.robot=glass \
-Dtestfx.headless=true \
-Dprism.order=sw \
-Dprism.verbose=true" ./mvnw verify -Dskip.integration.tests=false -pl demo
```
On macOS you must allow IntelliJ or the terminal app that you are using
to "take over your computer":
#### Generate aggregated Javadoc and Sources Jars
```
./mvnw clean package -Prelease-build
```
#### Publish artifact to MavenCentral
Set version:
```
mvn versions:set -DnewVersion=0.1-alpha-1
```
TODO: Create a branch and a tag.
Deploy:
```
./mvnw clean package deploy -Prelease-build
```
You can also publish snapshot versions of the components (skip set versions step).
GPG Signing requires that you generated a GPG key and published it.
For more details see: https://central.sonatype.org/publish/requirements/gpg/.
I used the following `~/.m2/settings.xml` configuration:
```xml
ossrh
sonatype-jira-user
sonatype-jira-pass
default
true
/usr/local/bin/gpg
keyId
keyPass
```