Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ITableSortingState |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.contrib.table.model; | |
16 | ||
17 | /** | |
18 | * An interface defining the management of the table's sorting state. | |
19 | * | |
20 | * @author mindbridge | |
21 | */ | |
22 | public interface ITableSortingState | |
23 | { | |
24 | ||
25 | boolean SORT_ASCENDING = false; | |
26 | boolean SORT_DESCENDING = true; | |
27 | ||
28 | /** | |
29 | * Method getSortColumn defines the column that the table should be sorted | |
30 | * upon. | |
31 | * | |
32 | * @return String the name of the sorting column or null if the table is not | |
33 | * sorted | |
34 | */ | |
35 | String getSortColumn(); | |
36 | ||
37 | /** | |
38 | * Method getSortOrder defines the direction of the table sorting . | |
39 | * | |
40 | * @return boolean the sorting order (see constants) | |
41 | */ | |
42 | boolean getSortOrder(); | |
43 | ||
44 | /** | |
45 | * Method setSortColumn updates the table sorting column and order. | |
46 | * | |
47 | * @param strName | |
48 | * the name of the column to sort by | |
49 | * @param bOrder | |
50 | * the sorting order (see constants) | |
51 | */ | |
52 | void setSortColumn(String strName, boolean bOrder); | |
53 | } |