Class FormSupportAdapter

java.lang.Object
org.apache.tapestry5.corelib.internal.FormSupportAdapter
All Implemented Interfaces:
ClientElement, FormSupport

public class FormSupportAdapter extends Object implements FormSupport
An implementation of FormSupport that delegates all behavior to another instance of FormSupport. This allows some of the behavior to be overridden easily.
  • Constructor Details

  • Method Details

    • allocateControlName

      Description copied from interface: FormSupport
      Allocates a unique (within the form) control name for some enclosed component, based on the component's id.
      Specified by:
      allocateControlName in interface FormSupport
      Parameters:
      id - the component's id
      Returns:
      a unique string, usually the component's id, but sometime extended with a unique number or string
    • store

      public <T> void store(T component, ComponentAction<T> action)
      Description copied from interface: FormSupport
      Stores an action for execution during a later request. If the action contains any mutable state, it should be in its final state before invoking this method and its internal state should not be changed subsequently.
      Specified by:
      store in interface FormSupport
    • storeAndExecute

      public <T> void storeAndExecute(T component, ComponentAction<T> action)
      Description copied from interface: FormSupport
      As with FormSupport.store(Object, org.apache.tapestry5.ComponentAction)}, but the action is also invoked immediately. This is useful for defining an action that should occur symmetrically in both the render request and the form submission's action request.
      Specified by:
      storeAndExecute in interface FormSupport
      Parameters:
      component - component against which to trigger the action
      action - the action that will be triggered (and passed the component)
    • defer

      public void defer(Runnable command)
      Description copied from interface: FormSupport
      Defers a command until the end of the form submission. The command will be executed before the Form's validate notification, but after all other submit actions for the form have been processed. This is used, primarily, to coordinate validations or other operations that involve multiple components, when the order of the components can not be determined. During a form render, runnables are executed after the body of the form has rendered.
      Specified by:
      defer in interface FormSupport
      Parameters:
      command - to be executed
    • setEncodingType

      public void setEncodingType(String encodingType)
      Description copied from interface: FormSupport
      Sets the encoding type for the Form. This should only be set once, and if
      Specified by:
      setEncodingType in interface FormSupport
      Parameters:
      encodingType - MIME type indicating type of encoding for the form
    • addValidation

      public void addValidation(Field field, String validationName, String message, Object constraint)
      Description copied from interface: FormSupport
      Collects field validation information. A Form may turn off client-side validation, in which case these calls will be ignored.
      Specified by:
      addValidation in interface FormSupport
      Parameters:
      field - for which validation is being generated
      validationName - name of validation method (see Tapestry.Validation in tapestry.js)
      message - the error message to display if the field is invalid
      constraint - additional constraint value, or null for validations that don't require a constraint
    • getClientId

      public String getClientId()
      Specified by:
      getClientId in interface ClientElement
      Returns:
      a unique id for the element. This value will be unique for any given rendering of a page. This value is intended for use as the id attribute of the client-side element, and will be used with any DHTML/Ajax related JavaScript.
    • isClientValidationEnabled

      public boolean isClientValidationEnabled()
      Description copied from interface: FormSupport
      Return true if client validation is enabled for this form, false otherwise.
      Specified by:
      isClientValidationEnabled in interface FormSupport
    • getFormComponentId

      Description copied from interface: FormSupport
      Returns the complete id of the underlying Form component.
      Specified by:
      getFormComponentId in interface FormSupport
    • getFormValidationId

      Description copied from interface: FormSupport
      Id used as a prefix when searching Messages for validation messages and constraints. This is normally the simple id of the form.
      Specified by:
      getFormValidationId in interface FormSupport
      Returns:
      validation id string
      See Also:
    • storeCancel

      public <T> void storeCancel(T component, ComponentAction<T> action)
      Description copied from interface: FormSupport
      Stores an action for execution in a later request when the containing form is canceled. Cancel actions are triggered before the form fires its EventConstants.CANCELED event.
      Specified by:
      storeCancel in interface FormSupport