Package org.apache.tapestry5
Class EventConstants
java.lang.Object
org.apache.tapestry5.EventConstants
Constant values for common event names fired by Tapestry components.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Default client event name, "action", used in most situations.static final String
Event triggered when a page is activated (for rendering).static final String
Event triggered byAjaxFormLoop
to inform the container that a new row has been requested.static final String
Event triggered when a client-side form is canceled.static final String
Event triggered during component event link generation.static final String
Event triggered during page render link generation.static final String
Event type for a notification after the form has been submitted, when there are errors in the validation tracker.static final String
Event triggered when a page receives an HTTP DELETE request.static final String
Event triggered when a page receives an HTTP GET request.static final String
Event triggered when a page receives an HTTP HEAD request.static final String
Event triggered when a page receives an HTTP PATCH request.static final String
Event triggered when a page receives an HTTP POST request.static final String
Event triggered when a page receives an HTTP PUT request.static final String
Event triggered by theTree
component when a leaf node is selected.static final String
Event triggered by theTree
component when a leaf node is unselected.static final String
Event triggered by some form-related components to parse a value provided by the client.static final String
Event triggered when a link for a page is generated.static final String
Name of a event triggered by the form component on the active page to allow it to pre-allocate the names of any query parameters that might be used by the page for its own purposes and should not be allocated to components.static final String
Invoked to let the containing component(s) prepare for the form rendering or the form submission.static final String
Invoked beforePREPARE
when rendering out the form.static final String
Invoked beforePREPARE
when the form is submitted.static final String
Event triggered byProgressiveDisplay
component to inform its container of what context (if any) is available.static final String
Event triggered by anAutocomplete
mixin to request completions of the current input.static final String
Event triggered byZoneRefresh
to refresh theZone
static final String
Event triggered byAjaxFormLoop
to inform the container about the row removed on the client side.static final String
Event type triggered by theSubmit
component when it is the cause of the form submission.static final String
Event type for a notification after the form has submitted.static final String
Event type for a notification after the form has submitted, when there are no errors in the validation tracker.static final String
Event triggered by theLoop
component to inform its container of all the values that were supplied from the client during a form submission.static final String
Event triggered by some form-related components to convert a server-side value to a client-side string, as an alternative to aTranslator
.static final String
Event triggered by form-related components to validate user input.static final String
Event triggered bySelect
component to inform its container that Select's value has changed. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
ACTION
Default client event name, "action", used in most situations.- See Also:
-
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:
-
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:
-
PREPARE_FOR_RENDER
Invoked beforePREPARE
when rendering out the form.- See Also:
-
PREPARE_FOR_SUBMIT
Invoked beforePREPARE
when the form is submitted.- See Also:
-
PREPARE
Invoked to let the containing component(s) prepare for the form rendering or the form submission.- See Also:
-
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:
-
CANCELED
Event triggered when a client-side form is canceled. This occurs after page activation, and after the prepare events for the form, but before any storedComponentAction
s for the form are triggered.- Since:
- 5.2.0
- See Also:
-
SUCCESS
Event type for a notification after the form has submitted, when there are no errors in the validation tracker. This occurs before theSUBMIT
event.- See Also:
-
FAILURE
Event type for a notification after the form has been submitted, when there are errors in the validation tracker. This occurs before theSUBMIT
event.- See Also:
-
SELECTED
Event type triggered by theSubmit
component when it is the cause of the form submission.- See Also:
-
PARSE_CLIENT
Event triggered by some form-related components to parse a value provided by the client. This takes the place of aTranslator
.- See Also:
-
TO_CLIENT
Event triggered by some form-related components to convert a server-side value to a client-side string, as an alternative to aTranslator
.- See Also:
-
VALIDATE
Event triggered by form-related components to validate user input. In addition, the Form component fires a validate event just before it firesSUCCESS
orFAILURE
as a chance to perform cross-form validations.- See Also:
-
REMOVE_ROW
Event triggered byAjaxFormLoop
to inform the container about the row removed on the client side. The event context is the object that was removed.- See Also:
-
ADD_ROW
Event triggered byAjaxFormLoop
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 theAjaxFormLoop.encoder
parameter.- See Also:
-
SYNCHRONIZE_VALUES
Event triggered by theLoop
component to inform its container of all the values that were supplied from the client during a form submission. The event handler method should have a single parameter, of type Object[] or type List, to receive the values.- Since:
- 5.1.0.0
- See Also:
-
PROGRESSIVE_DISPLAY
Event triggered byProgressiveDisplay
component to inform its container of what context (if any) is available. The event handler may return a renderable object or null. If null is returned, the component renders its own body as the partial markup response.- Since:
- 5.1.0.1
- See Also:
-
PROVIDE_COMPLETIONS
Event triggered by anAutocomplete
mixin to request completions of the current input. The first value in the context is the input string; additional values in the context parameter of theAutocomplete
component.- Since:
- 5.1.0.4
- See Also:
-
VALUE_CHANGED
Event triggered bySelect
component to inform its container that Select's value has changed.- Since:
- 5.2.0
- See Also:
-
DECORATE_PAGE_RENDER_LINK
Event triggered during page render link generation. The first context parameter is theLink
object, the second is thePageRenderRequestParameters
from which the Link was created. The event is triggered on the actively rendering page.- Since:
- 5.2.0
- See Also:
-
DECORATE_COMPONENT_EVENT_LINK
Event triggered during component event link generation. The first context parameter is theLink
object, the second is theComponentEventRequestParameters
from which the Link was created. The event is triggered on the actively rendering page, not necessarily the page containing the component.- Since:
- 5.2.0
- See Also:
-
PREALLOCATE_FORM_CONTROL_NAMES
Name of a event triggered by the form component on the active page to allow it to pre-allocate the names of any query parameters that might be used by the page for its own purposes and should not be allocated to components. AnIdAllocator
is passed as the event context.- Since:
- 5.2.0
- See Also:
-
NODE_SELECTED
Event triggered by theTree
component when a leaf node is selected.- Since:
- 5.3
- See Also:
-
NODE_UNSELECTED
Event triggered by theTree
component when a leaf node is unselected.- Since:
- 5.3
- See Also:
-
REFRESH
Event triggered byZoneRefresh
to refresh theZone
- Since:
- 5.3
- See Also:
-
HTTP_GET
Event triggered when a page receives an HTTP GET request. Handling this event creates a REST endpoint.- Since:
- 5.8.0
- See Also:
-
HTTP_POST
Event triggered when a page receives an HTTP POST request. Handling this event creates a REST endpoint.- Since:
- 5.8.0
- See Also:
-
HTTP_DELETE
Event triggered when a page receives an HTTP DELETE request. Handling this event creates a REST endpoint.- Since:
- 5.8.0
- See Also:
-
HTTP_PUT
Event triggered when a page receives an HTTP PUT request. Handling this event creates a REST endpoint.- Since:
- 5.8.0
- See Also:
-
HTTP_HEAD
Event triggered when a page receives an HTTP HEAD request. Handling this event creates a REST endpoint.- Since:
- 5.8.0
- See Also:
-
HTTP_PATCH
Event triggered when a page receives an HTTP PATCH request. Handling this event creates a REST endpoint.- Since:
- 5.8.0
- See Also:
-
-
Constructor Details
-
EventConstants
public EventConstants()
-