org.apache.tapestry5
Class EventConstants

java.lang.Object
  org.apache.tapestry5.EventConstants

public class EventConstants
extends Object

Constant values for common event names fired by Tapestry components.

Field Summary

static String	ACTION Default client event name, "action", used in most situations.
static String	ACTIVATE Event triggered when a page is activated (for rendering).
static String	ADD_ROW Event triggered by AjaxFormLoop to inform the container that a new row has been requested.
static String	FAILURE Event type for a notification after the form has been submitted, when there are errors in the validation tracker.
static String	PARSE_CLIENT Event triggered by some form-related cmponents to parse a value provided by the client.
static String	PASSIVATE Event triggered when a link for a page is generated.
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	REMOVE_ROW Event triggered by AjaxFormLoop to inform the container about the row removed on the client side.
static String	SELECTED Event type triggered by the Submit component when it is the cause of the form submission.
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	TO_CLIENT Event triggered by some form-related components to convert a server-side value to a client-side string, as an alternative to a Translator.
static String	VALIDATE Event triggered by form-related components to validate user input.
static String	VALIDATE_FORM Event type for a notification to perform validation of submitted data.

Constructor Summary

EventConstants()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ACTION

public static final String ACTION

Default client event name, "action", used in most situations.

See Also:

Constant Field Values

ACTIVATE

public static final String ACTIVATE

Event triggered when a page is activated (for rendering). The component event handler will be passed the context provided by the passivate event.

See Also:

Constant Field Values

PASSIVATE

public static final String PASSIVATE

Event triggered when a link for a page is generated. The event handler for the page may provide an object, or an array of objects, as the context for the page. These values will become part of the page's context, and will be provided back when the page is activated.

See Also:

Constant Field Values

PREPARE_FOR_RENDER

public static final String PREPARE_FOR_RENDER

Invoked before PREPARE when rendering out the form.

See Also:

Form, Constant Field Values

PREPARE_FOR_SUBMIT

public static final String PREPARE_FOR_SUBMIT

Invoked before PREPARE when the form is submitted.

See Also:

Form, 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:

Form, 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:

Form, 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:

Form, 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:

Form, 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

SELECTED

public static final String SELECTED

Event type triggered by the Submit component when it is the cause of the form submission.

See Also:

Constant Field Values

PARSE_CLIENT

public static final String PARSE_CLIENT

Event triggered by some form-related cmponents to parse a value provided by the client. This takes the place of a Translator.

See Also:

Constant Field Values

TO_CLIENT

public static final String TO_CLIENT

Event triggered by some form-related components to convert a server-side value to a client-side string, as an alternative to a Translator.

See Also:

Constant Field Values

VALIDATE

public static final String VALIDATE

Event triggered by form-related components to validate user input.

See Also:

Constant Field Values

REMOVE_ROW

public static final String REMOVE_ROW

Event triggered by AjaxFormLoop to inform the container about the row removed on the client side. The event context is the object that was removed.

See Also:

Constant Field Values

ADD_ROW

public static final String ADD_ROW

Event triggered by AjaxFormLoop to inform the container that a new row has been requested. The return value from the event handler must be the newly created object, which must also be visible in the encoder parameter.

See Also:

Constant Field Values

Constructor Detail

EventConstants

public EventConstants()