play.data

Class DynamicForm

java.lang.Object

play.data.Form<DynamicForm.Dynamic>

play.data.DynamicForm

public class DynamicForm
extends Form<DynamicForm.Dynamic>

A dynamic form. This form is backed by a simple HashMap<String,String>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DynamicForm.Dynamic Simple data structure used by DynamicForm.

Nested classes/interfaces inherited from class play.data.Form

Form.Display, Form.Field

Constructor Summary

Constructors

Constructor and Description
DynamicForm() Creates a new empty dynamic form.
DynamicForm(java.util.Map<java.lang.String,java.lang.String> data, java.util.Map<java.lang.String,java.util.List<ValidationError>> errors, F.Option<DynamicForm.Dynamic> value) Creates a new dynamic form.

Method Summary

Methods

Modifier and Type	Method and Description
DynamicForm	bind(java.util.Map<java.lang.String,java.lang.String> data) Binds data to this form - that is, handles form submission.
DynamicForm	bindFromRequest() Binds request data to this form - that is, handles form submission.
Form.Field	field(java.lang.String key) Retrieves a field.
java.lang.String	get(java.lang.String key) Gets the concrete value if the submission was a success.

Methods inherited from class play.data.Form

apply, bind, bind, bindFromRequest, data, error, errors, errorsAsJson, errorsAsJson, fill, get, globalError, globalErrors, hasErrors, hasGlobalErrors, name, reject, reject, reject, reject, reject, requestData, toString, value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DynamicForm

public DynamicForm()

Creates a new empty dynamic form.

DynamicForm

public DynamicForm(java.util.Map<java.lang.String,java.lang.String> data,
           java.util.Map<java.lang.String,java.util.List<ValidationError>> errors,
           F.Option<DynamicForm.Dynamic> value)

Creates a new dynamic form.

Parameters:

data - the current form data (used to display the form)

errors - the collection of errors associated with this form

value - optional concrete value if the form submission was successful

Method Detail

get

public java.lang.String get(java.lang.String key)

Gets the concrete value if the submission was a success.

bindFromRequest

public DynamicForm bindFromRequest()

Binds request data to this form - that is, handles form submission.

Returns:

a copy of this form filled with the new data

bind

public DynamicForm bind(java.util.Map<java.lang.String,java.lang.String> data)

Binds data to this form - that is, handles form submission.

Parameters:

data - data to submit

Returns:

a copy of this form filled with the new data

field

public Form.Field field(java.lang.String key)

Retrieves a field.

Overrides:

field in class Form<DynamicForm.Dynamic>

Parameters:

key - field name

Returns:

the field - even if the field does not exist you get a field