FormsFX Documentation

FormsFX is designed to manipulate data via model classes containing JavaFX properties. You can bind a field directly to a property.

To manage data lifecycle, use:

• persist(): Stores current field values into the bound properties.
• reset(): Reverts field values to the values currently in the properties.

By default, persistence is manual. You can set the BindingMode to CONTINUOUS at the form level to automate this.

StringProperty name = new SimpleStringProperty("Hans");
Field.ofStringType(name);

FormsFX uses a hierarchical semantic structure to organize form elements:

1. Form: The largest entity, acting as the top-level container.
2. Groups and Sections: Containers within a Form that organize related fields.
3. Fields: The primary point of interaction where users input or view data.

This hierarchy allows you to compose complex forms using a fluent API.

Form loginForm = Form.of(
        Group.of(
                Field.ofStringType(model.usernameProperty())
                        .label("Username"),
                Field.ofStringType(model.passwordProperty())
                        .label("Password")
                        .required("This field can’t be empty")
        )
).title("Login");

To display a form, use the FormRenderer. You can add it directly to a JavaFX container like a Pane.

Pane root = new Pane();
root.getChildren().add(new FormRenderer(form));

To use FormsFX in your Maven project, add the formsfx-core dependency to your pom.xml file.

<dependency>
  <groupId>com.dlsc.formsfx</groupId>
  <artifactId>formsfx-core</artifactId>
  <version>11.3.2</version>
</dependency>

Forms are created using the Form.of() method, which accepts Group objects. Groups contain Field objects. You can chain methods to configure field properties like labels, requirements, and more.

Form.of(
        Group.of(
                Field.ofStringType("")
                        .label("Username"),
                Field.ofStringType("")
                        .label("Password")
                        .required("This field can’t be empty")
        ),
        Group.of(…)
).title("Login");

Methods like label() and placeholder() can accept localization keys instead of raw strings. You can provide a ResourceBundleService to the form to handle translations.

private ResourceBundle rbEN = ResourceBundle.getBundle("demo.demo-locale", new Locale("en", "UK"));
private ResourceBundleService rbs = new ResourceBundleService(rbEN);

Form.of(…)
    .i18n(rbs);

Fields are validated automatically when edited. FormsFX provides several built-in validators:

Fields can be customized using several options to define their behavior and appearance: