quickstart.md

Quickstart

Add dependency

Add this dependency to your project:

...
<dependency>
    <groupId>de.cyclon-softworx</groupId>
    <artifactId>jwebform</artifactId>
    <version>0.0.15</version> <!-- Please check for the latest version on maven central or in the changelog! -->
</dependency>
...

Define a form

Fill a Form object with your Form-fields:

    private Form buildForm() {
      return FormBuilder.simple().typeBuilder(
        text("firstname").
          label("Firstname"), 
        text("email").
          label("Email").
          criteria(Criteria.required(), Criteria.email())
        ).build();
    }
    

Or define your form as a Java POJO: (see jwebform-integration project)

    public class MyForm {
  
      @UseDecoration(label="Firstname")
      String firstname;
      
      @UseDecoration(label="Email")
      @NotEmpty
      @Email(message = "Email should be valid")
      String email;
            
    }
    

Controller

Write a controller, that uses this form: (Here Spring MVC)

  Form form = buildForm(); // See "Define a form"

  @RequestMapping("/form")
  public void index(HttpServletRequest request, Model model) {
   
    FormResult formResult = form.run( key -> request.getParameter(key)); // pass the request-params via lambda 
    
    model.addAttribute("form", formResult); 
    
    if (formResult.isValid()) {   // check if the form was submitted and is valid
      log.debug("Valid firstname from form:"  + formResult.getStringValue("firstname"));   // if everything was okay, we can get the values from the form
    }
    
  }

See spring-boot integration for even more compact version of usage.

Template

Output the form within your template. (index.html)

<h1>The form</h1>

<!-- start the form -->
{{ render(form) }} <!-- use a macro to render the form or use the theme project to render the html in java --> 
<!-- end form -->

Output

Go on

Documentation

Read about the concepts

Read the changelog