Package org.apache.tapestry5

Class 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.String ACTION
      Default client event name, "action", used in most situations.
      static java.lang.String ACTIVATE
      Event triggered when a page is activated (for rendering).
      static java.lang.String ADD_ROW
      Event triggered by AjaxFormLoop to inform the container that a new row has been requested.
      static java.lang.String CANCELED
      Event triggered when a client-side form is canceled.
      static java.lang.String DECORATE_COMPONENT_EVENT_LINK
      Event triggered during component event link generation.
      static java.lang.String DECORATE_PAGE_RENDER_LINK
      Event triggered during page render link generation.
      static java.lang.String FAILURE
      Event type for a notification after the form has been submitted, when there are errors in the validation tracker.
      static java.lang.String HTTP_DELETE
      Event triggered when a page receives an HTTP DELETE request.
      static java.lang.String HTTP_GET
      Event triggered when a page receives an HTTP GET request.
      static java.lang.String HTTP_HEAD
      Event triggered when a page receives an HTTP HEAD request.
      static java.lang.String HTTP_PATCH
      Event triggered when a page receives an HTTP PATCH request.
      static java.lang.String HTTP_POST
      Event triggered when a page receives an HTTP POST request.
      static java.lang.String HTTP_PUT
      Event triggered when a page receives an HTTP PUT request.
      static java.lang.String NODE_SELECTED
      Event triggered by the Tree component when a leaf node is selected.
      static java.lang.String NODE_UNSELECTED
      Event triggered by the Tree component when a leaf node is unselected.
      static java.lang.String PARSE_CLIENT
      Event triggered by some form-related components to parse a value provided by the client.
      static java.lang.String PASSIVATE
      Event triggered when a link for a page is generated.
      static 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.
      static java.lang.String PREPARE
      Invoked to let the containing component(s) prepare for the form rendering or the form submission.
      static java.lang.String PREPARE_FOR_RENDER
      Invoked before PREPARE when rendering out the form.
      static java.lang.String PREPARE_FOR_SUBMIT
      Invoked before PREPARE when the form is submitted.
      static java.lang.String PROGRESSIVE_DISPLAY
      Event triggered by ProgressiveDisplay component to inform its container of what context (if any) is available.
      static java.lang.String PROVIDE_COMPLETIONS
      Event triggered by an Autocomplete mixin to request completions of the current input.
      static java.lang.String REFRESH
      Event triggered by ZoneRefresh to refresh the Zone
      static java.lang.String REMOVE_ROW
      Event triggered by AjaxFormLoop to inform the container about the row removed on the client side.
      static java.lang.String SELECTED
      Event type triggered by the Submit component when it is the cause of the form submission.
      static java.lang.String SUBMIT
      Event type for a notification after the form has submitted.
      static java.lang.String SUCCESS
      Event type for a notification after the form has submitted, when there are no errors in the validation tracker.
      static java.lang.String SYNCHRONIZE_VALUES
      Event triggered by the Loop component to inform its container of all the values that were supplied from the client during a form submission.
      static 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 a Translator.
      static java.lang.String VALIDATE
      Event triggered by form-related components to validate user input.
      static java.lang.String VALUE_CHANGED
      Event triggered by Select component to inform its container that Select's value has changed.

    • Constructor Summary

      Constructors 
      Constructor Description
      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 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

        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 stored ComponentActions 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 the SUBMIT event.
        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 the SUBMIT event.
        See Also:
        Constant Field Values

      • SELECTED

        public static final java.lang.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 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 a Translator.
        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 a Translator.
        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 fires SUCCESS or FAILURE as a chance to perform cross-form validations.
        See Also:
        Constant Field Values

      • REMOVE_ROW

        public static final java.lang.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 java.lang.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 AjaxFormLoop.encoder parameter.
        See Also:
        Constant Field Values

      • SYNCHRONIZE_VALUES

        public static final java.lang.String SYNCHRONIZE_VALUES
        Event triggered by the Loop 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 java.lang.String PROGRESSIVE_DISPLAY
        Event triggered by ProgressiveDisplay 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 java.lang.String PROVIDE_COMPLETIONS
        Event triggered by an Autocomplete 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 the Autocomplete component.
        Since:
        5.1.0.4
        See Also:
        Constant Field Values

      • VALUE_CHANGED

        public static final java.lang.String VALUE_CHANGED
        Event triggered by Select component to inform its container that Select's value has changed.
        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 the Link object, the second is the ComponentEventRequestParameters 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 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. An IdAllocator is passed as the event context.
        Since:
        5.2.0
        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