AjaxForm

Body: rendered

Informal parameters: allowed

Reserved parameters: action, name, onsubmit, onreset, enctype

This example does a simple submit of an input field in a form.

HTML template

          
<span jwcid="step1@If" condition="ognl:!country" >
<div class="note" >
<h2>Step <i>1</i> - Choose Country</h2>
  <form jwcid="countryForm@tacos:AjaxForm"
        clientValidationEnabled="ognl:true"
        listener="listener:chooseCountry"
        updateComponents="ognl:{'wizard'}"
        processScripts="ognl:true" backLink="component:clearLink" >
    <span class="auto_complete" jwcid="autoCompleterFlag" />
    <input jwcid="choose@Submit" value="Select"
          onClick="javascript: return postcountryFormForm(this);"/>
  </form>
</div>
</span>
          
        

Page specification

          
<page-specification class="net.sf.tacos.demo.pages.forms.FormEffectsExample">

<description>Example of using multiple effects/components.</description>

<property name="countryValue" persist="session" />
<property name="country" persist="session" />
<property name="searchList" initial-value="ognl:new java.util.ArrayList()" />
<property name="localeList" initial-value="ognl:new java.util.ArrayList()" />
<property name="regionDate" />
<property name="regionValue" initial-value="literal:some region.." />

<component id="autoCompleterFlag" type="tacos:Autocompleter" >
  <binding name="displayName" value="literal:Country" />
  <binding name="value" value="ognl:countryValue"/>
  <binding name="validators" value="validators:required,minLength=4" />
  <binding name="listSource" value="ognl:localeList" />
  <binding name="listener" value="listener:searchCountries" />
  <binding name="listItemRenderer" value="ognl:listRenderer" />
  <binding name="direct" value="ognl:true" />
</component>

<component id="regionForm" type="tacos:AjaxForm" >
  <binding name="listener" value="listener:chooseRegion" />
  <binding name="updateComponents" value="ognl:{'wizard'}" />
</component>

<component id="clearLink" type="tacos:AjaxDirectLink" >
  <binding name="listener" value="listener:clearCountry" />
  <binding name="updateComponents" value="ognl:{'wizard'}" />
</component>

</page-specification>
          
        

Java sources

          
public abstract class FormEffects extends BasePage {

  /** Logger */
  private static final Log log = LogFactory.getLog(FormEffects.class);
  /** List html renderer */
  private static final ListItemRenderer FLAG_RENDERER = new CountryFlagRenderer();

  public ListItemRenderer getListRenderer()
  {
      return FLAG_RENDERER;
  }

  /**
   * Invoked by ajax request to perform autocomplete search.
   *
   * @param search The value to search on
   */
  public void searchCountries(String search)
  {
      //Performs country name search
      search = search.toUpperCase();
      Locale[] locales = Locale.getAvailableLocales();
      ArrayList searchList = new ArrayList();
      ArrayList localeList = new ArrayList();
      for (int i = 0; i < locales.length; i++) {
          if (locales[i].getDisplayCountry().toUpperCase().indexOf(search) > -1) {
              searchList.add(locales[i].getDisplayCountry());
              localeList.add(locales[i]);
          }
      }

      setSearchList(searchList);
      setLocaleList(localeList);
  }

  /**
   * Invoked by form
   * @param cycle
   */
  public void chooseCountry(IRequestCycle cycle)
  {
      String country = (String)cycle.getParameter("autoCompleterFlag");
      if (country == null)
          return;

      Locale[] locales = Locale.getAvailableLocales();
      for (int i = 0; i < locales.length; i++) {
          if (locales[i].getDisplayCountry().toUpperCase().equals(country.toUpperCase())) {
              setCountry(locales[i]);
              break;
          }
      }

      String submitName = (String)cycle.getParameter("choose");
      if (submitName != null) {
          log.debug("chooseCountry() found choose button submit with value:" + submitName);
      }
  }

  /**
   * Invoked to clear the chosen country.
   * @param cycle
   */
  public void clearCountry(IRequestCycle cycle)
  {
      setCountry(null);
  }

  /**
   * Does nothing
   * @param cycle
   */
  public void chooseRegion(IRequestCycle cycle)
  {
      IValidationDelegate delegate = getDelegate();
      delegate.setFormComponent((IFormComponent) getComponent("regionField"));
      delegate.recordFieldInputValue(getRegionValue());
      delegate.record("You suck, this doesn't look right at all",ValidationConstraint.CONSISTENCY);
      return;

      //setCountry(null);
  }

  /** Set by invocation of {@link #searchCountries(String)} */
  public abstract Collection getSearchList();
  /** Sets the search list return */
  public abstract void setSearchList(Collection values);
  /** Set by invocation of {@link #searchCountries(String)} */
  public abstract Collection getLocaleList();
  /** Sets the search list return */
  public abstract void setLocaleList(Collection values);
  /** Sets the chosen country */
  public abstract void setCountry(Locale country);
  /** From region form */
  public abstract Date getRegionDate();
  /** Validation delegate */
  public abstract IValidationDelegate getDelegate();
  /** Region value */
  public abstract String getRegionValue();
}