tapestry/src/site/xdoc/components/form/linksubmit.xml - tapestry4 - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE document PUBLIC
   "-//Apache Software Foundation//DTD XDOC 1.0//EN"
   "http://maven.apache.org/dtd/xdoc_1_0.dtd">
 <!--
     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.
 -->
 <document>
     <properties>
         <title>LinkSubmit</title>
     </properties>
     <body>

         <section name="LinkSubmit">

             <p>
                 Creates a hyperlink that submits its enclosing form using a JavaScript function.
                 <br />
                 Pages incorporating a LinkSubmit component must also include a
                 <a href="../general/body.html">Body</a>
                 component.
             </p>

             <p>
                 <strong>
                     See also:
                     <a href="../../apidocs/org/apache/tapestry/form/LinkSubmit.html">
                         org.apache.tapestry.form.LinkSubmit
                     </a>
                     ,
                     <a href="form.html">Form</a>
                     ,
                     <a href="imagesubmit.html">ImageSubmit</a>
                     ,
                     <a href="submit.html">Submit</a>
                 </strong>
             </p>

             <subsection name="Parameters">
                 <table>
                     <tr>
                         <th>Name</th>
                         <th>Type</th>
                         <th>Required</th>
                         <th>Default</th>
                         <th>Description</th>
                     </tr>
                     <tr>
                         <td>disabled</td>
                         <td>boolean</td>
                         <td>no</td>
                         <td>false</td>
                         <td>
                             Controls whether the link is produced. If disabled, the portion of the
                             template the link surrounds is still rendered, but not the link itself.
                         </td>
                     </tr>
                     <tr>
                         <td>selected</td>
                         <td>Object</td>
                         <td>no</td>
                         <td></td>
                         <td>
                             This parameter is bound to a property that is updated when the submit
                             button is clicked by the user. The property is updated to match the tag
                             parameter.
                         </td>
                     </tr>
                     <tr>
                         <td>tag</td>
                         <td>Object</td>
                         <td>no</td>
                         <td></td>
                         <td>
                             Tag used with the selected parameter to indicate which Submit button on
                             a form was clicked.
                         </td>
                     </tr>
                     <tr>
                         <td>listener</td>
                         <td>
                             <a
                                 href="../../apidocs/org/apache/tapestry/IActionListener.html">
                                 IActionListener
                             </a>
                         </td>
                         <td>no</td>
                         <td></td>
                         <td>
                             An optional listener (typically specified as the name of a listener
                             method), notified when the Submit is triggered.

                             <p>
                             When invoking listeners invoked within a <a href="../general/for.html">For</a> loop this
                             listener should be used.
                             </p>

                             <p>
                             This parameter should <strong>not</strong> be used in the majority of cases as the
                             listener is notified before all form data has been captured on the server. Only use
                             this when you know you are going to redirect or do some other cancelling sort of action
                             that isn't likely to alter form state. Use <em>action</em> as your preferred listener
                             method parameter.
                             </p>
                         </td>
                     </tr>
                     <tr>
                         <td>action</td>
                         <td>
                             <a
                                 href="../../apidocs/org/apache/tapestry/IActionListener.html">
                                 IActionListener
                             </a>
                         </td>
                         <td>no</td>
                         <td></td>
                         <td>
                             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.

                             <p>
                             If you are going to notify a listener, this is probably the parameter you want
                             to bind to.
                             </p>
                         </td>
                     </tr>
                     <tr>
                         <td>parameters</td>
                         <td>Object</td>
                         <td>no</td>
                         <td></td>
                         <td>
                             Parameter(s) gathered at the time the link is triggered, supplied as
                             listener parameters in the IRequestCycle available to the listener.
                             <p>
                                 If the parameter is a Collection, it will be converted to an Object
                                 array (to match the IRequestCycle getListenerParameters()
                                 signature).
                             </p>
                             <p>
                                 Allows deferred listeners (defer = true) access to any rewind state
                                 not conveniently placed using tag/selected (e.g. when there are
                                 multiple objects to select as might happen with a nested Foreach).
                             </p>
                         </td>
                     </tr>
                     <tr>
                         <td>submitType</td>
                         <td>String - [submit,cancel,refresh]</td>
                         <td>yes</td>
                         <td>submit</td>
                         <td>
                             Controls the type of submission that this component invokes. Using javascript
                             this parameter will cause the invocation of the component to be recognized as
                             a cancel/refresh/normal form submission depending on the value given. If you
                             have a <code>cancel="listener"</code> or <code>refresh="listener"</code>
                             parameter set on your <a href="form.html">Form</a> they will be invoked
                             accordingly.
                         </td>
                     </tr>
                     <tr>
                         <td>updateComponents</td>
                         <td>String[],Collection</td>
                         <td>no</td>
                         <td></td>
                         <td>
                             In an asynchronous request, specifies which components should have their content
                             rendered back to the client. These are expected to be unique component ids.

                             <p>
                             See: <a href="../../apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
                             </p>

                             <br/>
                             <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
                         </td>
                     </tr>
                     <tr>
                         <td>json</td>
                         <td>boolean</td>
                         <td>no</td>
                         <td>false</td>
                         <td>
                             Causes the request to be asynchronous and the response to be captured/rendered via
                             the <a href="../../apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
                             renderer.

                             <br/><br/>
                             <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
                         </td>
                     </tr>
                     <tr>
                         <td>async</td>
                         <td>boolean</td>
                         <td>no</td>
                         <td>false</td>
                         <td>
                             Causes the request to be asynchronous and the response to be captured/rendered via
                             the <a href="../../apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
                             renderer.

                             <br/><br/>
                             <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
                         </td>
                     </tr>
                 </table>

                 <p>
                     Body:
                     <strong>allowed</strong>
                 </p>

                 <p>
                     Informal parameters:
                     <strong>allowed</strong>
                 </p>

                 <p>
                     Reserved parameters:
                     <em>name, href</em>
                 </p>

             </subsection>

         </section>

     </body>
 </document>
	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE document PUBLIC
	"-//Apache Software Foundation//DTD XDOC 1.0//EN"
	"http://maven.apache.org/dtd/xdoc_1_0.dtd">
	<!--
	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.
	-->
	<document>
	<properties>
	<title>LinkSubmit</title>
	</properties>
	<body>

	<section name="LinkSubmit">

	<p>
	Creates a hyperlink that submits its enclosing form using a JavaScript function.
	<br />
	Pages incorporating a LinkSubmit component must also include a
	<a href="../general/body.html">Body</a>
	component.
	</p>

	<p>
	<strong>
	See also:
	<a href="../../apidocs/org/apache/tapestry/form/LinkSubmit.html">
	org.apache.tapestry.form.LinkSubmit
	</a>
	,
	<a href="form.html">Form</a>
	,
	<a href="imagesubmit.html">ImageSubmit</a>
	,
	<a href="submit.html">Submit</a>
	</strong>
	</p>

	<subsection name="Parameters">
	<table>
	<tr>
	<th>Name</th>
	<th>Type</th>
	<th>Required</th>
	<th>Default</th>
	<th>Description</th>
	</tr>
	<tr>
	<td>disabled</td>
	<td>boolean</td>
	<td>no</td>
	<td>false</td>
	<td>
	Controls whether the link is produced. If disabled, the portion of the
	template the link surrounds is still rendered, but not the link itself.
	</td>
	</tr>
	<tr>
	<td>selected</td>
	<td>Object</td>
	<td>no</td>
	<td></td>
	<td>
	This parameter is bound to a property that is updated when the submit
	button is clicked by the user. The property is updated to match the tag
	parameter.
	</td>
	</tr>
	<tr>
	<td>tag</td>
	<td>Object</td>
	<td>no</td>
	<td></td>
	<td>
	Tag used with the selected parameter to indicate which Submit button on
	a form was clicked.
	</td>
	</tr>
	<tr>
	<td>listener</td>
	<td>
	<a
	href="../../apidocs/org/apache/tapestry/IActionListener.html">
	IActionListener
	</a>
	</td>
	<td>no</td>
	<td></td>
	<td>
	An optional listener (typically specified as the name of a listener
	method), notified when the Submit is triggered.

	<p>
	When invoking listeners invoked within a <a href="../general/for.html">For</a> loop this
	listener should be used.
	</p>

	<p>
	This parameter should <strong>not</strong> be used in the majority of cases as the
	listener is notified before all form data has been captured on the server. Only use
	this when you know you are going to redirect or do some other cancelling sort of action
	that isn't likely to alter form state. Use <em>action</em> as your preferred listener
	method parameter.
	</p>
	</td>
	</tr>
	<tr>
	<td>action</td>
	<td>
	<a
	href="../../apidocs/org/apache/tapestry/IActionListener.html">
	IActionListener
	</a>
	</td>
	<td>no</td>
	<td></td>
	<td>
	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.

	<p>
	If you are going to notify a listener, this is probably the parameter you want
	to bind to.
	</p>
	</td>
	</tr>
	<tr>
	<td>parameters</td>
	<td>Object</td>
	<td>no</td>
	<td></td>
	<td>
	Parameter(s) gathered at the time the link is triggered, supplied as
	listener parameters in the IRequestCycle available to the listener.
	<p>
	If the parameter is a Collection, it will be converted to an Object
	array (to match the IRequestCycle getListenerParameters()
	signature).
	</p>
	<p>
	Allows deferred listeners (defer = true) access to any rewind state
	not conveniently placed using tag/selected (e.g. when there are
	multiple objects to select as might happen with a nested Foreach).
	</p>
	</td>
	</tr>
	<tr>
	<td>submitType</td>
	<td>String - [submit,cancel,refresh]</td>
	<td>yes</td>
	<td>submit</td>
	<td>
	Controls the type of submission that this component invokes. Using javascript
	this parameter will cause the invocation of the component to be recognized as
	a cancel/refresh/normal form submission depending on the value given. If you
	have a <code>cancel="listener"</code> or <code>refresh="listener"</code>
	parameter set on your <a href="form.html">Form</a> they will be invoked
	accordingly.
	</td>
	</tr>
	<tr>
	<td>updateComponents</td>
	<td>String[],Collection</td>
	<td>no</td>
	<td></td>
	<td>
	In an asynchronous request, specifies which components should have their content
	rendered back to the client. These are expected to be unique component ids.

	<p>
	See: <a href="../../apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
	</p>

	<br/>
	<strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
	</td>
	</tr>
	<tr>
	<td>json</td>
	<td>boolean</td>
	<td>no</td>
	<td>false</td>
	<td>
	Causes the request to be asynchronous and the response to be captured/rendered via
	the <a href="../../apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
	renderer.

	<br/><br/>
	<strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
	</td>
	</tr>
	<tr>
	<td>async</td>
	<td>boolean</td>
	<td>no</td>
	<td>false</td>
	<td>
	Causes the request to be asynchronous and the response to be captured/rendered via
	the <a href="../../apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
	renderer.

	<br/><br/>
	<strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
	</td>
	</tr>
	</table>

	<p>
	Body:
	<strong>allowed</strong>
	</p>

	<p>
	Informal parameters:
	<strong>allowed</strong>
	</p>

	<p>
	Reserved parameters:
	<em>name, href</em>
	</p>

	</subsection>

	</section>

	</body>
	</document>