libjava/javax/swing/table/TableColumnModel.java

   1 /* TableColumnModel.java --
   2    Copyright (C) 2002 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath 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; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.swing.table;
  39
  40 // Imports
  41 import java.util.Enumeration;
  42 import javax.swing.ListSelectionModel;
  43 import javax.swing.event.TableColumnModelListener;
  44
  45 /**
  46  * TableColumnModel public interface
  47  * @author Andrew Selkirk
  48  */
  49 public interface TableColumnModel {
  50
  51         /**
  52          * addColumn
  53          * @param column TableColumn
  54          */
  55         void addColumn(TableColumn column);
  56
  57         /**
  58          * removeColumn
  59          * @param column TableColumn
  60          */
  61         void removeColumn(TableColumn column);
  62
  63         /**
  64          * moveColumn
  65          * @param columnIndex Index of column to move
  66          * @param newIndex New index of column
  67          */
  68         void moveColumn(int columnIndex, int newIndex);
  69
  70         /**
  71          * setColumnMargin
  72          * @param margin Margin of column
  73          */
  74         void setColumnMargin(int margin);
  75
  76         /**
  77          * getColumnCount
  78          * @returns Column count
  79          */
  80         int getColumnCount();
  81
  82         /**
  83          * getColumns
  84          * @returns Enumeration of columns
  85          */
  86         Enumeration getColumns();
  87
  88         /**
  89          * getColumnIndex
  90          * @param columnIdentifier Column id
  91          */
  92         int getColumnIndex(Object columnIdentifier);
  93
  94         /**
  95          * getColumn
  96          * @param columnIndex Index of column
  97          */
  98         TableColumn getColumn(int columnIndex);
  99
 100         /**
 101          * getColumnMargin
 102          * @returns Column margin
 103          */
 104         int getColumnMargin();
 105
 106         /**
 107          * getColumnIndexAtX
 108          * @returns Column index as position x
 109          */
 110         int getColumnIndexAtX(int xPosition);
 111
 112         /**
 113          * getTotalColumnWidth
 114          * @returns Total column width
 115          */
 116         int getTotalColumnWidth();
 117
 118         /**
 119          * setColumnSelectionAllowed
 120          * @param value Set column selection
 121          */
 122         void setColumnSelectionAllowed(boolean value);
 123
 124         /**
 125          * getColumnSelectionAllowed
 126          * @returns true if column selection allowed, false otherwise
 127          */
 128         boolean getColumnSelectionAllowed();
 129
 130         /**
 131          * getSelectedColumns
 132          * @returns Selected columns
 133          */
 134         int[] getSelectedColumns();
 135
 136         /**
 137          * getSelectedColumnCount
 138          * @returns Count of selected columns
 139          */
 140         int getSelectedColumnCount();
 141
 142         /**
 143          * setSelectionModel
 144          * @param model ListSelectionModel
 145          */
 146         void setSelectionModel(ListSelectionModel model);
 147
 148         /**
 149          * getSelectionModel
 150          * @param column TableColumn
 151          */
 152         ListSelectionModel getSelectionModel();
 153
 154         /**
 155          * addColumnModelListener
 156          * @param listener TableColumnModelListener
 157          */
 158         void addColumnModelListener(TableColumnModelListener listener);
 159
 160         /**
 161          * removeColumnModelListener
 162          * @param listener TableColumnModelListener
 163          */
 164         void removeColumnModelListener(TableColumnModelListener listener);
 165
 166
 167 } // TableColumnModel