| <?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>TableRows</title> |
| </properties> |
| <body> |
| |
| <section name="TableRows"> |
| <p> |
| A low level |
| <a href="table.html">Table</a> |
| component that generates the rows of the current page in the table. This component |
| must be wrapped by |
| <a href="tableview.html">TableView</a> |
| . |
| <br /> |
| The component iterates over the rows of the current page in the table. The rows are |
| wrapped in 'tr' tags by default. You can define columns manually within, or you can |
| use |
| <a href="tablevalues.html">TableValues</a> |
| to generate the columns automatically. |
| </p> |
| |
| <p> |
| <strong> |
| See also: |
| <a href="table.html">Table</a> |
| , |
| <a href="tableview.html">TableView</a> |
| , |
| <a href="tablepages.html">TablePages</a> |
| , |
| <a href="tablerows.html">TableRows</a> |
| , |
| <a href="tablevalues.html">TableValues</a> |
| , |
| <a href="tablecolumns.html">TableColumns</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>row</td> |
| <td> |
| <a |
| href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html"> |
| Object |
| </a> |
| </td> |
| <td>no</td> |
| <td> </td> |
| |
| <td>The value object of the current row being rendered.</td> |
| </tr> |
| <tr> |
| <td>index</td> |
| <td> |
| Object |
| </td> |
| <td>no</td> |
| <td></td> |
| <td>If provided, the parameter is updated with the index of the loop on each iteration.</td> |
| </tr> |
| <tr> |
| <td>element</td> |
| <td> |
| <a |
| href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html"> |
| String |
| </a> |
| </td> |
| <td>no</td> |
| <td>tr</td> |
| |
| <td>The tag to use to wrap the rows in.</td> |
| </tr> |
| <tr> |
| <td>keyExpression</td> |
| <td> |
| Object |
| </td> |
| <td>no</td> |
| <td></td> |
| <td> |
| Only active in a form. An OGNL expression that returns the primary key of the iterated value. |
| The primary keys are stored in hidden fields during rendering and are loaded from the form |
| during a rewind to ensure that the iterations remain the same. |
| This is a simpler, but a less efficient alternative of the 'converter' parameter. |
| If needed, please use in conjuction with 'fullSource' to reference objects |
| not currently present in 'source'. |
| Also, use the 'defaultValue' parameter to define the object to be returned if |
| a value corresponding to a particular primary key cannot be found. |
| </td> |
| </tr> |
| <tr> |
| <td>fullSource</td> |
| <td> |
| Object/Collection |
| </td> |
| <td>no</td> |
| <td></td> |
| <td> |
| Only active in a form and in combination with the 'keyExpression' parameter. |
| If an object corresponding to a primary key stored in the form cannot be |
| found in the 'source' parameter, then the objects provided by this parameter |
| are searched for a match next. |
| </td> |
| </tr> |
| <tr> |
| <td>defaultValue</td> |
| <td> |
| Object |
| </td> |
| <td>no</td> |
| <td>null</td> |
| <td> |
| Only active in a form. The value to be used when |
| no match for a given primary key is found. |
| </td> |
| </tr> |
| <tr> |
| <td>converter</td> |
| <td> |
| Object |
| </td> |
| <td>no</td> |
| <td>null</td> |
| <td> |
| Only active in a form. Defines how the items iterated upon |
| will be stored in the form as hidden values and how the stored information will be |
| converted back to objects. |
| This interface allows only the primary key of the items to be stored, |
| rather than the whole item. |
| </td> |
| </tr> |
| <tr> |
| <td>primaryKeys</td> |
| <td> |
| Object |
| </td> |
| <td>no</td> |
| <td></td> |
| <td> |
| Only active in a form. If provided, the parameter is automatically updated |
| before a rewind with the list of primary keys stored in the form. |
| The parameter is updated right before the iterations begin in a rewind and |
| could be used to preload the relevant objects in a provided 'converter'. |
| </td> |
| </tr> |
| <tr> |
| <td>volatile</td> |
| <td> |
| boolean |
| </td> |
| <td>no</td> |
| <td>false</td> |
| <td> |
| Only active in a form. Determines whether to avoid creating hidden fields within a form. |
| Using this parameter may make the form structure different during render and rewind, |
| and cause exceptions as a result. Please use with caution. |
| </td> |
| </tr> |
| </table> |
| |
| <p> |
| Body: |
| <strong>removed</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>allowed</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>none</em> |
| </p> |
| |
| </subsection> |
| |
| <subsection name="Examples"> |
| |
| |
| </subsection> |
| |
| </section> |
| |
| </body> |
| </document> |
