View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package org.xnap.util;
21  
22  import java.beans.PropertyChangeListener;
23  
24  /***
25   * Defines the requirements for classes that provide preferences support for
26   * tables. The preferences are used to manage column ordering, column sizes
27   * and the maintain sortorder setting.
28   */
29  public interface TablePreferencesProvider extends PreferencesProvider
30  {
31  
32      //--- Constant(s) ---
33  
34      //--- Method(s) ---
35      
36      void addTableListener(String table, PropertyChangeListener l);
37  
38      boolean getTableMaintainSortOrder(String table);
39  
40      /***
41       * Returns an array of visible columns as an array of column keys.
42       */
43      String[] getTableColumns(String table);
44  
45      /***
46       * Sets an array of visible columns as an array of column keys.
47       */
48      void setTableColumns(String table, String[] columns);
49  
50      int[] getTableColumnWidths(String table);
51  
52      void setTableColumnWidths(String table, int[] widths);
53  
54      void setTableMaintainSortOrder(String table, boolean enable);
55  
56      /***
57       * Returns 0, if no column is sorted, otherwise the model index 
58       * of the column + 1. If the return value is < 0 the column is sorted 
59       * descending .
60       */
61      int getTableSortedColumn(String table);
62  
63      void setTableSortedColumn(String table, int column);
64  
65  }