KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > netui > databinding > datagrid > api > DataGridState


1 /*
2  * Copyright 2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  * $Header:$
17  */
18 package org.apache.beehive.netui.databinding.datagrid.api;
19
20 import org.apache.beehive.netui.databinding.datagrid.api.filter.FilterModel;
21 import org.apache.beehive.netui.databinding.datagrid.api.sort.SortModel;
22 import org.apache.beehive.netui.databinding.datagrid.api.pager.PagerModel;
23
24 /**
25  * <p>
26  * A class used to encapsulate the default state information for a data grid. All grids are
27  * capable of supporting sorting, filtering, and paging. This class holds the JavaBean model
28  * objects that maintain the sort, filter, and page state of a data grid.
29  * </p>
30  * <p>
31  * Instances of DataGridState can live longer than a single request. As a result, DataGridState
32  * objects are serializable, so subclasses should avoid non-transient references to objects
33  * like the {@link javax.servlet.http.HttpServletRequest}.
34  * </p>
35  */
36 public class DataGridState
37     implements java.io.Serializable JavaDoc {
38
39     private FilterModel _filterModel;
40     private SortModel _sortModel;
41     private PagerModel _pagerModel;
42
43     /**
44      * Get the {@link SortModel} for a data grid.
45      *
46      * @return the {@link SortModel}
47      */
48     public SortModel getSortModel() {
49         return _sortModel;
50     }
51
52     /**
53      * Set the {@link SortModel} for a data grid.
54      *
55      * @param sortModel the new {@link SortModel}
56      */
57     public void setSortModel(SortModel sortModel) {
58         _sortModel = sortModel;
59     }
60
61     /**
62      * Set the {@link FilterModel} for the data grid
63      *
64      * @return the {@link FilterModel}
65      */
66     public FilterModel getFilterModel() {
67         return _filterModel;
68     }
69
70     /**
71      * Set the {@link FilterModel} for the data grid
72      *
73      * @param filterModel the new {@link FilterModel}
74      */
75     public void setFilterModel(FilterModel filterModel) {
76         _filterModel = filterModel;
77     }
78
79     /**
80      * Get the {@link PagerModel} for the data grid
81      *
82      * @return the {@link PagerModel}
83      */
84     public PagerModel getPagerModel() {
85         return _pagerModel;
86     }
87
88     /**
89      * Set the {@link PagerModel} for the data grid
90      *
91      * @param pagerModel the new {@link PagerModel}
92      */
93     public void setPagerModel(PagerModel pagerModel) {
94         _pagerModel = pagerModel;
95     }
96 }
97
Popular Tags