| <?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>ColumnSortLink</title> |
| </properties> |
| <body> |
| |
| <section name="ColumnSortLink"> |
| |
| <p> |
| Displays a link that will cause the current column to sort. |
| </p> |
| <p> |
| This component should only be used with <a href="table.html">contrib:Table</a> |
| and helps creating custom headers. |
| </p> |
| |
| <subsection name="Parameters"> |
| |
| |
| <table> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Required</th> |
| <th>Default</th> |
| <th>Description</th> |
| </tr> |
| |
| <tr> |
| <td>table</td> |
| <td>Table</td> |
| <td>yes</td> |
| <td></td> |
| <td>The table that will include this sort link.</td> |
| </tr> |
| |
| </table> |
| |
| <p> |
| Body: |
| <strong>allowed</strong> |
| </p> |
| |
| <p> |
| Informal parameters: |
| <strong>allowed</strong> |
| </p> |
| |
| <p> |
| Reserved parameters: |
| <em>none</em> |
| </p> |
| |
| </subsection> |
| |
| <subsection name="Example |
| "> |
| |
| <source xml:space="preserve"><![CDATA[ |
| <table jwcid="tab@contrib:Table" source="ognl:@java.util.Locale@getAvailableLocales()" |
| columns="Locale:toString(), Language, Country"> |
| <tr jwcid="LanguageColumnHeader@Block"> |
| <a jwcid="@contrib:ColumnSortLink" table="component:tab"> |
| <img jwcid="@contrib:ColumnSortImage" table="component:tab"/> Language </a> |
| </tr> |
| </table> |
| ]]></source> |
| |
| </subsection> |
| |
| </section> |
| |
| </body> |
| </document> |
