Scout/Concepts/WrappedFormField

Scout

Wiki Home

Website

Download • Git

Community

Forums • Blog • Twitter • G+

Bugzilla

Bugzilla

Type of field to display a form.

• implements: IWrappedFormField
• extends: AbstractWrappedFormField

Description

A WrappedFormField is to show another form in this form.

Two methods are useful to handle the AbstractForm that will be embedded:

• getInnerForm()
• setInnerForm()

When you choose to embed a form in another form, you are responsible of the lifecycle of the inner-form. This mean that you need to initialize, import/export the data, validate the form manually. Depending on your use case, you might want to reuse some of the existing function.

Here is a snippet showing how you can set a form on a WrappedFormField:

MyForm form = new MyForm();
 
//formfield is the WrappedFormField field.
formfield.setInnerForm(form);
form.setHandler(new NullFormHandler());
form.initForm(); // Must initialize inner form for fields to be initialized
 
//additionally it is possible import data from an MyFormData formdata:
form.importFormData(formData);

Properties

Defined with getConfiguredXxxxxx() methods.

See also Field for the properties that all fields have in common.

Events

Defined with execXxxxxx() methods.

See also Field for the events that all fields have in common.

See Also

• Field