Package org.apache.tapestry5
Class EventConstants
- java.lang.Object
-
- org.apache.tapestry5.EventConstants
-
public class EventConstants extends java.lang.Object
Constant values for common event names fired by Tapestry components.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACTIONDefault client event name, "action", used in most situations.static java.lang.StringACTIVATEEvent triggered when a page is activated (for rendering).static java.lang.StringADD_ROWEvent triggered byAjaxFormLoopto inform the container that a new row has been requested.static java.lang.StringCANCELEDEvent triggered when a client-side form is canceled.static java.lang.StringDECORATE_COMPONENT_EVENT_LINKEvent triggered during component event link generation.static java.lang.StringDECORATE_PAGE_RENDER_LINKEvent triggered during page render link generation.static java.lang.StringFAILUREEvent type for a notification after the form has been submitted, when there are errors in the validation tracker.static java.lang.StringHTTP_DELETEEvent triggered when a page receives an HTTP DELETE request.static java.lang.StringHTTP_GETEvent triggered when a page receives an HTTP GET request.static java.lang.StringHTTP_HEADEvent triggered when a page receives an HTTP HEAD request.static java.lang.StringHTTP_PATCHEvent triggered when a page receives an HTTP PATCH request.static java.lang.StringHTTP_POSTEvent triggered when a page receives an HTTP POST request.static java.lang.StringHTTP_PUTEvent triggered when a page receives an HTTP PUT request.static java.lang.StringNODE_SELECTEDEvent triggered by theTreecomponent when a leaf node is selected.static java.lang.StringNODE_UNSELECTEDEvent triggered by theTreecomponent when a leaf node is unselected.static java.lang.StringPARSE_CLIENTEvent triggered by some form-related components to parse a value provided by the client.static java.lang.StringPASSIVATEEvent triggered when a link for a page is generated.static java.lang.StringPREALLOCATE_FORM_CONTROL_NAMESName 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 java.lang.StringPREPAREInvoked to let the containing component(s) prepare for the form rendering or the form submission.static java.lang.StringPREPARE_FOR_RENDERInvoked beforePREPAREwhen rendering out the form.static java.lang.StringPREPARE_FOR_SUBMITInvoked beforePREPAREwhen the form is submitted.static java.lang.StringPROGRESSIVE_DISPLAYEvent triggered byProgressiveDisplaycomponent to inform its container of what context (if any) is available.static java.lang.StringPROVIDE_COMPLETIONSEvent triggered by anAutocompletemixin to request completions of the current input.static java.lang.StringREFRESHEvent triggered byZoneRefreshto refresh theZonestatic java.lang.StringREMOVE_ROWEvent triggered byAjaxFormLoopto inform the container about the row removed on the client side.static java.lang.StringSELECTEDEvent type triggered by theSubmitcomponent when it is the cause of the form submission.static java.lang.StringSUBMITEvent type for a notification after the form has submitted.static java.lang.StringSUCCESSEvent type for a notification after the form has submitted, when there are no errors in the validation tracker.static java.lang.StringSYNCHRONIZE_VALUESEvent triggered by theLoopcomponent to inform its container of all the values that were supplied from the client during a form submission.static java.lang.StringTO_CLIENTEvent triggered by some form-related components to convert a server-side value to a client-side string, as an alternative to aTranslator.static java.lang.StringVALIDATEEvent triggered by form-related components to validate user input.static java.lang.StringVALUE_CHANGEDEvent triggered bySelectcomponent to inform its container that Select's value has changed.
-
Constructor Summary
Constructors Constructor Description EventConstants()
-
-
-
Field Detail
-
ACTION
public static final java.lang.String ACTION
Default client event name, "action", used in most situations.- See Also:
- Constant Field Values
-
ACTIVATE
public static final java.lang.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 java.lang.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 java.lang.String PREPARE_FOR_RENDER
Invoked beforePREPAREwhen rendering out the form.- See Also:
Form, Constant Field Values
-
PREPARE_FOR_SUBMIT
public static final java.lang.String PREPARE_FOR_SUBMIT
Invoked beforePREPAREwhen the form is submitted.- See Also:
Form, Constant Field Values
-
PREPARE
public static final java.lang.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 java.lang.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
-
CANCELED
public static final java.lang.String 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 storedComponentActions for the form are triggered.- Since:
- 5.2.0
- See Also:
SubmitMode.CANCEL, Constant Field Values
-
SUCCESS
public static final java.lang.String SUCCESS
Event type for a notification after the form has submitted, when there are no errors in the validation tracker. This occurs before theSUBMITevent.- See Also:
Form, Constant Field Values
-
FAILURE
public static final java.lang.String FAILURE
Event type for a notification after the form has been submitted, when there are errors in the validation tracker. This occurs before theSUBMITevent.- See Also:
- Constant Field Values
-
SELECTED
public static final java.lang.String SELECTED
Event type triggered by theSubmitcomponent when it is the cause of the form submission.- See Also:
- Constant Field Values
-
PARSE_CLIENT
public static final java.lang.String 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:
- Constant Field Values
-
TO_CLIENT
public static final java.lang.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 aTranslator.- See Also:
- Constant Field Values
-
VALIDATE
public static final java.lang.String VALIDATE
Event triggered by form-related components to validate user input. In addition, the Form component fires a validate event just before it firesSUCCESSorFAILUREas a chance to perform cross-form validations.- See Also:
- Constant Field Values
-
REMOVE_ROW
public static final java.lang.String REMOVE_ROW
Event triggered byAjaxFormLoopto 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 java.lang.String ADD_ROW
Event triggered byAjaxFormLoopto 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.encoderparameter.- See Also:
- Constant Field Values
-
SYNCHRONIZE_VALUES
public static final java.lang.String SYNCHRONIZE_VALUES
Event triggered by theLoopcomponent 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:
- Constant Field Values
-
PROGRESSIVE_DISPLAY
public static final java.lang.String PROGRESSIVE_DISPLAY
Event triggered byProgressiveDisplaycomponent 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:
- Constant Field Values
-
PROVIDE_COMPLETIONS
public static final java.lang.String PROVIDE_COMPLETIONS
Event triggered by anAutocompletemixin to request completions of the current input. The first value in the context is the input string; additional values in the context parameter of theAutocompletecomponent.- Since:
- 5.1.0.4
- See Also:
- Constant Field Values
-
VALUE_CHANGED
public static final java.lang.String VALUE_CHANGED
Event triggered bySelectcomponent to inform its container that Select's value has changed.- Since:
- 5.2.0
- See Also:
- Constant Field Values
-
DECORATE_PAGE_RENDER_LINK
public static final java.lang.String DECORATE_PAGE_RENDER_LINK
Event triggered during page render link generation. The first context parameter is theLinkobject, the second is thePageRenderRequestParametersfrom which the Link was created. The event is triggered on the actively rendering page.- Since:
- 5.2.0
- See Also:
- Constant Field Values
-
DECORATE_COMPONENT_EVENT_LINK
public static final java.lang.String DECORATE_COMPONENT_EVENT_LINK
Event triggered during component event link generation. The first context parameter is theLinkobject, the second is theComponentEventRequestParametersfrom 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:
- Constant Field Values
-
PREALLOCATE_FORM_CONTROL_NAMES
public static final java.lang.String 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. AnIdAllocatoris passed as the event context.- Since:
- 5.2.0
- See Also:
- Constant Field Values
-
NODE_SELECTED
public static final java.lang.String NODE_SELECTED
Event triggered by theTreecomponent when a leaf node is selected.- Since:
- 5.3
- See Also:
- Constant Field Values
-
NODE_UNSELECTED
public static final java.lang.String NODE_UNSELECTED
Event triggered by theTreecomponent when a leaf node is unselected.- Since:
- 5.3
- See Also:
- Constant Field Values
-
REFRESH
public static final java.lang.String REFRESH
Event triggered byZoneRefreshto refresh theZone- Since:
- 5.3
- See Also:
- Constant Field Values
-
HTTP_GET
public static final java.lang.String 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:
- Constant Field Values
-
HTTP_POST
public static final java.lang.String 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:
- Constant Field Values
-
HTTP_DELETE
public static final java.lang.String 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:
- Constant Field Values
-
HTTP_PUT
public static final java.lang.String 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:
- Constant Field Values
-
HTTP_HEAD
public static final java.lang.String 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:
- Constant Field Values
-
HTTP_PATCH
public static final java.lang.String 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:
- Constant Field Values
-
-
Constructor Detail
-
EventConstants
public EventConstants()
-
-