Form (Tapestry 5 Project 5.0.11 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.tapestry.corelib.components
Class Form

java.lang.Object
  org.apache.tapestry.corelib.components.Form

All Implemented Interfaces:: ClientElement, FormValidationControl

public class Form
extends Object
implements ClientElement, FormValidationControl
extends Object
implements ClientElement, FormValidationControl

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 PREPARE_FOR_RENDER notification, followed by a PREPARE notification.

When the form is submitted, the component emits several notifications: first a PREPARE_FOR_SUBMIT, then a 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 VALIDATE_FORMevent is emitted, to allow for cross-form validation. After that, either a SUCCESS OR FAILURE event (depending on whether the ValidationTracker has recorded any errors). Lastly, a 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).

Field Summary
`static String`	`FAILURE` Event type for a notification after the form has been submitted, when there are errors in the validation tracker.
`static String`	`FORM_DATA` Query parameter name storing form data (the serialized commands needed to process a form submission).
`static String`	`PREPARE` Invoked to let the containing component(s) prepare for the form rendering or the form submission.
`static String`	`PREPARE_FOR_RENDER` Invoked before `PREPARE` when rendering out the form.
`static String`	`PREPARE_FOR_SUBMIT` Invoked before `PREPARE` when the form is submitted.
`static String`	`SUBMIT` Event type for a notification after the form has submitted.
`static String`	`SUCCESS` Event type for a notification after the form has submitted, when there are no errors in the validation tracker.
`static String`	`VALIDATE_FORM` Event type for a notification to perform validation of submitted data.

Constructor Summary
`Form()`

Method Summary
`void`	`clearErrors()` Invokes `ValidationTracker.clear()`.
`String`	`getClientId()` Forms use the same value for their name and their id attribute.
`ValidationTracker`	`getDefaultTracker()`
`boolean`	`getHasErrors()` Returns true if the form's `ValidationTracker` contains any `errors`.
`boolean`	`isValid()` Returns true if the form's `ValidationTracker` does not contain any `errors`.
`void`	`recordError(Field field, String errorMessage)` A convienience for invoking `ValidationTracker.recordError(Field, String)`.
`void`	`recordError(String errorMessage)` A convienience for invoking `ValidationTracker.recordError(String)`.
`void`	`setDefaultTracker(ValidationTracker defaultTracker)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

PREPARE_FOR_RENDER

public static final String PREPARE_FOR_RENDER

Invoked before PREPARE when rendering out the form.

See Also:: Constant Field Values

PREPARE_FOR_SUBMIT

public static final String PREPARE_FOR_SUBMIT

Invoked before PREPARE when the form is submitted.

See Also:: Constant Field Values

PREPARE

public static final String PREPARE

Invoked to let the containing component(s) prepare for the form rendering or the form submission.

See Also:: Constant Field Values

SUBMIT

public static final String SUBMIT

Event type for a notification after the form has submitted. This event notification occurs on any form submit, without respect to "success" or "failure".

See Also:: Constant Field Values

VALIDATE_FORM

public static final String VALIDATE_FORM

Event type for a notification to perform validation of submitted data. This allows a listener to perform cross-field validation. This occurs before the SUCCESS or FAILURE notification.

See Also:: Constant Field Values

SUCCESS

public static final String SUCCESS

Event type for a notification after the form has submitted, when there are no errors in the validation tracker. This occurs before the SUBMIT event.

See Also:: Constant Field Values

FAILURE

public static final String FAILURE

Event type for a notification after the form has been submitted, when there are errors in the validation tracker. This occurs before the SUBMIT event.

See Also:: Constant Field Values

FORM_DATA

public static final String FORM_DATA

Query parameter name storing form data (the serialized commands needed to process a form submission).

See Also:: Constant Field Values

Constructor Detail

Form

public Form()

Method Detail

getDefaultTracker

public ValidationTracker getDefaultTracker()