org.apache.tapestry.form
Class FormEventType

java.lang.Object
  org.apache.commons.lang.enum.Enum
      org.apache.tapestry.form.FormEventType

All Implemented Interfaces:

Serializable, Comparable

public class FormEventType
extends org.apache.commons.lang.enum.Enum

Lists different types of JavaScript events that can be associated with a Form via Form.addEventHandler(FormEventType, String).

Since:

1.0.2

Version:

$Id: FormEventType.java 243791 2004-02-19 17:38:13Z hlship $

Author:

Howard Lewis Ship

See Also:

Serialized Form

Field Summary

static FormEventType	RESET Form event triggered when the form is reset; this allows an event handler to deal with any special cases related to resetting.
static FormEventType	SUBMIT Form event triggered when the form is submitted.

Method Summary

boolean	getCombineUsingAnd() Returns true if multiple functions should be combined with the && operator.
String	getPropertyName() Returns the DOM property corresponding to event type (used when generating client-side scripting).

Methods inherited from class org.apache.commons.lang.enum.Enum

compareTo, equals, getEnum, getEnumList, getEnumMap, getName, hashCode, iterator, readResolve, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SUBMIT

public static final FormEventType SUBMIT

Form event triggered when the form is submitted. Allows an event handler to perform any final changes before the results are posted to the server.

The JavaScript method should return true or false. If there are multiple event handlers for the form they will be combined using the binary and operator (&&).

RESET

public static final FormEventType RESET

Form event triggered when the form is reset; this allows an event handler to deal with any special cases related to resetting.

Method Detail

getPropertyName

public String getPropertyName()

Returns the DOM property corresponding to event type (used when generating client-side scripting).

getCombineUsingAnd

public boolean getCombineUsingAnd()

Returns true if multiple functions should be combined with the && operator. Otherwise, the event handler functions are simply invoked sequentially (as a series of JavaScript statements).