Tapestry Core

org.apache.tapestry5.corelib.components.Form

An HTML form, which will enclose other components to render out the various types of fields. A Form emits many notification events. When it renders, it fires a EventConstants#PREPARE_FOR_RENDER notification, followed by a EventConstants#PREPARE notification. When the form is submitted, the component emits several notifications: first a EventConstants#PREPARE_FOR_SUBMIT, then a EventConstants#PREPARE: these allow the page to update its state as necessary to prepare for the form submission, then (after components enclosed by the form have operated), a EventConstants#VALIDATE_FORM event is emitted, to allow for cross-form validation. After that, either a EventConstants#SUCCESS OR EventConstants#FAILURE event (depending on whether the ValidationTracker has recorded any errors). Lastly, a EventConstants#SUBMIT event, for any listeners that care only about form submission, regardless of success or failure. For all of these notifications, the event context is derived from the context parameter. This context is encoded into the form's action URI (the parameter is not read when the form is submitted, instead the values encoded into the form are used).

[JavaDoc]

Component Parameters

Name	Type	Flags	Default	Default Prefix	Description
autofocus	boolean	NOT Allow Null		prop	If true (the default), then the JavaScript will be added to position the cursor into the form. The field to receive focus is the first rendered field that is in error, or required, or present (in that order of priority).
clientValidation	boolean	NOT Allow Null		prop	If true (the default) then client validation is enabled for the form, and the default set of JavaScript libraries (Prototype, Scriptaculous and the Tapestry library) will be added to the rendered page, and the form will register itself for validation. This may be turned off when client validation is not desired; for example, when many validations are used that do not operate on the client side at all.
context	Object	NOT Allow Null		prop	The context for the link (optional parameter). This list of values will be converted into strings and included in the URI. The strings will be coerced back to whatever their values are and made available to event handler methods.
tracker	ValidationTracker	NOT Allow Null	defaultTracker	prop	The object which will record user input and validation errors. The object must be persistent between requests (since the form submission and validation occurs in an component event request and the subsequent render occurs in a render request). The default is a persistent property of the Form component and this is sufficient for nearly all purposes (except when a Form is rendered inside a loop).
validationId	String	NOT Allow Null		prop	Prefix value used when searching for validation messages and constraints. The default is the Form component's id. This is overriden by BeanEditForm.
zone	String	NOT Allow Null		literal	Binding the zone parameter will cause the form submission to be handled as an Ajax request that updates the indicated zone. Often a Form will update the same zone that contains it.

Component Events

failure
prepare
prepareForRender
prepareForSubmit
submit
success
validateForm

Related Components

Form Control Element Components

The following components are Tapestry wrappers around client-side HTML form elements:

Examples

Examples of the Form component are provided in the many other pages that discuss specific form control element components, such as Radio andTextField.

Notes

The Form component generates a seemingly bewildering number of events, designed to address a wide range of needs. The goal is to give you as the developer the tools necessary to effeciently manage state. All of the events that are triggered will pass along the values defined by the context parameter. Most often, there is no context, or the context is a single value (a primary key used to identify the object being updated by the form).

Render Events

Render event handler methods should not return a value, doing so will be an error. The methods are intended to allow the page to convert a primary key stored in the context back into an object ready to have its properties updated by the Form. The context passed to component event handler methods is provided by reading the context parameter.

prepareForRender
prepare

Submit Events

Submit events may return a navigational value, which will abort any remaining processing of the form submission. The context provided to component event handler methods originates in the form submission (it is stored in hidden form fields); the context parameter is not read during a form submission.

prepareForSubmit
prepare
validateForm
failure or success
submit

The validateForm event is to allow the page to perform cross-field validation. The failure or success event is fired based on whether there are or are not any validation errors.

Form Ids

It is considered a best practice to give explicit ids to Form components, and form control element components. These ids propogate down to the client side as element names and/or ids, and eventually show up as query parameters when the form is submitted. To achieve a more RESTful URL scheme, give the form component an id based on what it does rather than what data it updates, thus <t:form t:id="search"/> rather than <t:form t:id="searchData"/> or <t:form t:id="searchForm"/>.

Parent Project

Project Documentation