Package org.apache.tapestry5
Class EventConstants
-
- org.apache.tapestry5.EventConstants
-
public class EventConstants extends
Constant values for common event names fired by Tapestry components.
-
-
Field Summary
Fields Modifier and Type Field Description static
ACTION
Default client event name, "action", used in most situations.static
ACTIVATE
Event triggered when a page is activated (for rendering).static
ADD_ROW
Event triggered byAjaxFormLoop
to inform the container that a new row has been requested.static
CANCELED
Event triggered when a client-side form is canceled.static
DECORATE_COMPONENT_EVENT_LINK
Event triggered during component event link generation.static
DECORATE_PAGE_RENDER_LINK
Event triggered during page render link generation.static
FAILURE
Event type for a notification after the form has been submitted, when there are errors in the validation tracker.static
NODE_SELECTED
Event triggered by theTree
component when a leaf node is selected.static
NODE_UNSELECTED
Event triggered by theTree
component when a leaf node is unselected.static
PARSE_CLIENT
Event triggered by some form-related components to parse a value provided by the client.static
PASSIVATE
Event triggered when a link for a page is generated.static
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.static
PREPARE
Invoked to let the containing component(s) prepare for the form rendering or the form submission.static
PREPARE_FOR_RENDER
Invoked beforePREPARE
when rendering out the form.static
PREPARE_FOR_SUBMIT
Invoked beforePREPARE
when the form is submitted.static
PROGRESSIVE_DISPLAY
Event triggered byProgressiveDisplay
component to inform its container of what context (if any) is available.static
PROVIDE_COMPLETIONS
Event triggered by anAutocomplete
mixin to request completions of the current input.static
REFRESH
Event triggered byZoneRefresh
to refresh theZone
static
REMOVE_ROW
Event triggered byAjaxFormLoop
to inform the container about the row removed on the client side.static
SELECTED
Event type triggered by theSubmit
component when it is the cause of the form submission.static
SUBMIT
Event type for a notification after the form has submitted.static
SUCCESS
Event type for a notification after the form has submitted, when there are no errors in the validation tracker.static
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.static
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
.static
VALIDATE
Event triggered by form-related components to validate user input.static
VALUE_CHANGED
Event triggered bySelect
component to inform its container that Select's value has changed.
-
Constructor Summary
Constructors Constructor Description EventConstants()
-
-
-
Field Detail
-
ACTION
public static final ACTION
Default client event name, "action", used in most situations.- See Also:
- Constant Field Values
-
ACTIVATE
public static final 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 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 PREPARE_FOR_RENDER
Invoked beforePREPARE
when rendering out the form.- See Also:
Form
, Constant Field Values
-
PREPARE_FOR_SUBMIT
public static final PREPARE_FOR_SUBMIT
Invoked beforePREPARE
when the form is submitted.- See Also:
Form
, Constant Field Values
-
PREPARE
public static final 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 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 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:
SubmitMode.CANCEL
, Constant Field Values
-
SUCCESS
public static final 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:
Form
, Constant Field Values
-
FAILURE
public static final 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:
- Constant Field Values
-
SELECTED
public static final SELECTED
Event type triggered by theSubmit
component when it is the cause of the form submission.- See Also:
- Constant Field Values
-
PARSE_CLIENT
public static final 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 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 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:
- Constant Field Values
-
REMOVE_ROW
public static final 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:
- Constant Field Values
-
ADD_ROW
public static final 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:
- Constant Field Values
-
SYNCHRONIZE_VALUES
public static final 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:
- Constant Field Values
-
PROGRESSIVE_DISPLAY
public static final 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:
- Constant Field Values
-
PROVIDE_COMPLETIONS
public static final 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:
- Constant Field Values
-
VALUE_CHANGED
public static final VALUE_CHANGED
Event triggered bySelect
component 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 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:
- Constant Field Values
-
DECORATE_COMPONENT_EVENT_LINK
public static final 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:
- Constant Field Values
-
PREALLOCATE_FORM_CONTROL_NAMES
public static final 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:
- Constant Field Values
-
NODE_SELECTED
public static final NODE_SELECTED
Event triggered by theTree
component when a leaf node is selected.- Since:
- 5.3
- See Also:
- Constant Field Values
-
NODE_UNSELECTED
public static final NODE_UNSELECTED
Event triggered by theTree
component when a leaf node is unselected.- Since:
- 5.3
- See Also:
- Constant Field Values
-
REFRESH
public static final REFRESH
Event triggered byZoneRefresh
to refresh theZone
- Since:
- 5.3
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EventConstants
public EventConstants()
-
-