Class 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 by AjaxFormLoop 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 the Tree component when a leaf node is selected.
      static NODE_UNSELECTED
      Event triggered by the Tree 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 before PREPARE when rendering out the form.
      static PREPARE_FOR_SUBMIT
      Invoked before PREPARE when the form is submitted.
      static PROGRESSIVE_DISPLAY
      Event triggered by ProgressiveDisplay component to inform its container of what context (if any) is available.
      static PROVIDE_COMPLETIONS
      Event triggered by an Autocomplete mixin to request completions of the current input.
      static REFRESH
      Event triggered by ZoneRefresh to refresh the Zone
      static REMOVE_ROW
      Event triggered by AjaxFormLoop to inform the container about the row removed on the client side.
      static SELECTED
      Event type triggered by the Submit 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 the Loop 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 a Translator.
      static VALIDATE
      Event triggered by form-related components to validate user input.
      static 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.

        , , , , , , , , , ,
    • Field Detail

      • 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

        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
      • 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 the SUBMIT 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 the SUBMIT event.
        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 a Translator.
        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 fires SUCCESS or FAILURE as a chance to perform cross-form validations.
        See Also:
        Constant Field Values
      • REMOVE_ROW

        public static final  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  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  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  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  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
      • 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. An IdAllocator is passed as the event context.
        Since:
        5.2.0
        See Also:
        Constant Field Values