| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Copyright 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>InvokeListener</title> |
| </properties> |
| <body> |
| |
| <section name="InvokeListener"> |
| |
| <p> |
| Invoke a listener during the render of the page. Parameters may be passed to the |
| listener. |
| </p> |
| |
| <p> |
| <strong> |
| See also: |
| <a |
| href="../../apidocs/org/apache/tapestry/components/InvokeListener.html"> |
| org.apache.tapestry.components.InvokeListener |
| </a> |
| , |
| <a href="delegator.html">Delegator</a> |
| </strong> |
| </p> |
| |
| <section name="Parameters"> |
| <table> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| |
| <tr> |
| <td>listener</td> |
| <td> |
| <a |
| href="../../apidocs/org/apache/tapestry/IActionListener.html"> |
| IActionListener |
| </a> |
| </td> |
| <td>no</td> |
| <td></td> |
| <td>The listener to invoke. If this parameter is not provided, |
| Tapestry will attempt to find a listener with the capitalized id of the |
| component, prefixed by "do". For example, jwcid="clear@InvokeListener" would |
| expect a listener called doClear().</td> |
| </tr> |
| |
| <tr> |
| <td>parameters</td> |
| <td>Object</td> |
| <td>no</td> |
| <td></td> |
| <td> |
| Parameter(s) gathered at the time the listener is invoked, 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 <code>IRequestCycle getListenerParameters()</code> |
| signature). |
| </p> |
| </td> |
| </tr> |
| </table> |
| |
| <p> |
| Body: |
| <strong>removed</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>forbidden</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>none</em> |
| </p> |
| |
| <p> |
| This component does not render any output at all. The component is a placeholder |
| within the page or component template that marks a point where logic within the |
| Java class should be executed. A typical use of this is to setup properties |
| needed by components within the template, for example, to fetch an object from a |
| database so that other components may read or update its properties. |
| </p> |
| |
| </section> |
| |
| </section> |
| |
| </body> |
| </document> |
