| <?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>TableColumns</title> |
| </properties> |
| <body> |
| |
| <section name="TableColumns"> |
| |
| <p> |
| A low level |
| <a href="table.html">Table</a> |
| component that renders the column headers in the table. This component must be |
| wrapped by |
| <a href="tableview.html">TableView</a> |
| . |
| </p> |
| <p> |
| The component iterates over all column objects in the |
| <a |
| href="../../tapestry-contrib/apidocs/org/apache/tapestry/contrib/table/model/ITableColumnModel.html"> |
| ITableColumnModel |
| </a> |
| and renders a header for each one of them using the renderer provided by the |
| <code>getColumnRender()</code> |
| method in |
| <a |
| href="../../tapestry-contrib/apidocs/org/apache/tapestry/contrib/table/model/ITableColumn.html"> |
| ITableColumn |
| </a> |
| . The headers are wrapped in 'th' tags by default. |
| </p> |
| |
| <span class="info"> |
| <strong>Note:</strong> |
| <p> |
| The table header rendered by this component has two main css class definitions. The |
| embedded table html markup within each |
| <code>th</code> |
| element has the class |
| <code>tableHeaderImage</code> |
| . The image used to sort table columns has an embedded style class definition for |
| <code>tableHeaderImage</code> |
| that defines |
| <code>align:center</code> |
| . |
| <br /> |
| You may override these definitions with your own css rules. |
| </p> |
| </span> |
| |
| <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> |
| </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>element</td> |
| <td>String</td> |
| <td>no</td> |
| <td>th</td> |
| <td>The tag to use to wrap the column headers.</td> |
| </tr> |
| |
| <tr> |
| <td>column</td> |
| <td> |
| <a |
| href="../../tapestry-contrib/apidocs/org/apache/tapestry/contrib/table/model/ITableColumn.html"> |
| ITableColumn |
| </a> |
| </td> |
| <td>no</td> |
| <td> </td> |
| <td>The column currently being rendered [out]</td> |
| </tr> |
| |
| <tr> |
| <td>arrowUpAsset</td> |
| <td> |
| <a href="../../apidocs/org/apache/tapestry/IAsset.html"> |
| IAsset |
| </a> |
| </td> |
| <td>no</td> |
| <td> </td> |
| |
| <td>The image to use to describe a column sorted in an ascending order.</td> |
| </tr> |
| |
| <tr> |
| <td>arrowDownAsset</td> |
| <td> |
| <a href="../../apidocs/org/apache/tapestry/IAsset.html"> |
| IAsset |
| </a> |
| </td> |
| <td>no</td> |
| <td> </td> |
| <td>The image to use to describe a column sorted in a descending order.</td> |
| </tr> |
| |
| <tr> |
| <td>class</td> |
| <td> |
| String |
| </td> |
| <td>no</td> |
| <td> </td> |
| |
| <td>The css class name to apply to each th element.</td> |
| </tr> |
| </table> |
| |
| <p> |
| Body: |
| <strong>removed</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>allowed,inherited</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>none</em> |
| </p> |
| |
| </subsection> |
| |
| <subsection name="Examples"> |
| |
| |
| </subsection> |
| |
| </section> |
| |
| </body> |
| </document> |
