KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > contrib > table > model > ITableSortingState


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     static final boolean SORT_ASCENDING = false;
25     static final boolean SORT_DESCENDING = true;
26
27     /**
28      * Method getSortColumn defines the column that the table should be sorted upon
29      * @return String the name of the sorting column or null if the table is not sorted
30      */
31     String JavaDoc getSortColumn();
32
33     /**
34      * Method getSortOrder defines the direction of the table sorting
35      * @return boolean the sorting order (see constants)
36      */
37     boolean getSortOrder();
38
39     /**
40      * Method setSortColumn updates the table sorting column and order
41      * @param strName the name of the column to sort by
42      * @param bOrder the sorting order (see constants)
43      */
44     void setSortColumn(String JavaDoc strName, boolean bOrder);
45 }
46
Popular Tags