tapestry/tapestry-framework/src/java/org/apache/tapestry/form/Submit.jwc

<?xml version="1.0" encoding="UTF-8"?>
<!-- 
   Copyright 2004, 2005 The Apache Software Foundation

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
-->

<!DOCTYPE component-specification PUBLIC 
  "-//Apache Software Foundation//Tapestry Specification 4.0//EN" 
  "http://tapestry.apache.org/dtd/Tapestry_4_0.dtd">
  
<component-specification class="org.apache.tapestry.form.Submit" allow-body="no">

  <description>
  Creates a labeled submit button within a form.
  </description>

  <parameter name="label" deprecated="true">
    <description>
      Deprecated in 4.0.  An alternate way to specify the value attribute,
      which is the label used on the button in the browser (as well as the
      value supplied in the query parameter on form submit).
    </description>
  </parameter>
  
  <parameter name="disabled">
      <description>
          If true, then the component is disabled, which will be reflected in the
          output submit element. Additionally, the component will not respond
          during the form submission.
      </description>
  </parameter>
  
  <parameter name="selected">
      <description>
          If bound, then this parameter will be updated with the value of the
          tag parameter, if the Submit is triggered.
       </description>
  </parameter>
  
  <parameter name="tag">
      <description>
          A tag value used to identify this Submit as the triggered component.
      </description>
  </parameter>
  
  <parameter name="listener">
      <description>
          A listener that is notified if this component is triggered.
      </description>
  </parameter>
  
  <parameter name="action">
      <description>
          A listener that is notified if this component is triggered
          just before the form's listener, after all components 
          enclosed by the Form have had a chance to update their properties.
      </description>
  </parameter>
  
  <parameter name="parameters">
    <description>
    An object, or list of objects, gathered when the button is triggered and 
    made available as listener parameters in the request cycle, making
    the parameters available to a deferred listener.
    </description>
  </parameter>
  
  <parameter name="submitType" default-value="literal:submit" >
    <description>
        The type of submission this component should cause. Valid values are 
        submit, cancel, and refresh. 
    </description>
  </parameter>
  
  <parameter name="updateComponents" />
  <parameter name="json" default-value="false" />
  <parameter name="async" default-value="false" />
  <parameter name="id" property="idParameter" default-value="id"/>
  
  <reserved-parameter name="name"/>
  <reserved-parameter name="type"/>
  <reserved-parameter name="defer"/>

  <inject property="directService" object="engine-service:direct" />
  <inject property="listenerInvoker" object="infrastructure:listenerInvoker"/>
  
  <inject property="submitScript" type="script" object="SubmitBindings.script"/>
  
</component-specification>