libjava/javax/swing/table/TableColumn.java

   1 /* TableColumn.java --
   2    Copyright (C) 2002, 2004 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
  39 package javax.swing.table;
  40
  41 import java.beans.PropertyChangeListener;
  42 import java.io.Serializable;
  43
  44 import javax.swing.event.SwingPropertyChangeSupport;
  45
  46 /**
  47  * TableColumn
  48  * @author      Andrew Selkirk
  49  * @version     1.0
  50  */
  51 public class TableColumn
  52   implements Serializable
  53 {
  54   static final long serialVersionUID = -6113660025878112608L;
  55
  56   /**
  57    * COLUMN_WIDTH_PROPERTY
  58    */
  59   public static final String COLUMN_WIDTH_PROPERTY = "columWidth";
  60
  61   /**
  62    * HEADER_VALUE_PROPERTY
  63    */
  64   public static final String HEADER_VALUE_PROPERTY = "headerValue";
  65
  66   /**
  67    * HEADER_RENDERER_PROPERTY
  68    */
  69   public static final String HEADER_RENDERER_PROPERTY = "headerRenderer";
  70
  71   /**
  72    * CELL_RENDERER_PROPERTY
  73    */
  74   public static final String CELL_RENDERER_PROPERTY = "cellRenderer";
  75
  76   /**
  77    * modelIndex
  78    */
  79   protected int modelIndex;
  80
  81   /**
  82    * identifier
  83    */
  84   protected Object identifier;
  85
  86   /**
  87    * width
  88    */
  89   protected int width;
  90
  91   /**
  92    * minWidth
  93    */
  94   protected int minWidth = 15;
  95
  96   /**
  97    * preferredWidth
  98    */
  99   private int preferredWidth;
 100
 101   /**
 102    * maxWidth
 103    */
 104   protected int maxWidth = Integer.MAX_VALUE;
 105
 106   /**
 107    * headerRenderer
 108    */
 109   protected TableCellRenderer headerRenderer;
 110
 111   /**
 112    * headerValue
 113    */
 114   protected Object headerValue;
 115
 116   /**
 117    * cellRenderer
 118    */
 119   protected TableCellRenderer cellRenderer;
 120
 121   /**
 122    * cellEditor
 123    */
 124   protected TableCellEditor cellEditor;
 125
 126   /**
 127    * isResizable
 128    */
 129   protected boolean isResizable = true;
 130
 131   /**
 132    * resizedPostingDisableCount
 133    *
 134    * @deprecated 1.3
 135    */
 136   protected transient int resizedPostingDisableCount;
 137
 138   /**
 139    * changeSupport
 140    */
 141   private SwingPropertyChangeSupport changeSupport =
 142     new SwingPropertyChangeSupport(this);
 143
 144   /**
 145    * Constructor TableColumn
 146    */
 147   public TableColumn()
 148   {
 149     this(0, 75, null, null);
 150   }
 151
 152   /**
 153    * Constructor TableColumn
 154    * @param modelIndex TODO
 155    */
 156   public TableColumn(int modelIndex)
 157   {
 158     this(modelIndex, 75, null, null);
 159   }
 160
 161   /**
 162    * Constructor TableColumn
 163    * @param modelIndex TODO
 164    * @param width TODO
 165    */
 166   public TableColumn(int modelIndex, int width)
 167   {
 168     this(modelIndex, width, null, null);
 169   }
 170
 171   /**
 172    * Constructor TableColumn
 173    * @param modelIndex TODO
 174    * @param width TODO
 175    * @param cellRenderer TODO
 176    * @param cellEditor TODO
 177    */
 178   public TableColumn(int modelIndex, int width,
 179                      TableCellRenderer cellRenderer, TableCellEditor cellEditor)
 180   {
 181     this.modelIndex = modelIndex;
 182     this.width = width;
 183     this.preferredWidth = width;
 184     this.cellRenderer = cellRenderer;
 185     this.cellEditor = cellEditor;
 186     this.headerValue = null;
 187     this.identifier = null;
 188   }
 189
 190   /**
 191    * firePropertyChange
 192    * @param property TODO
 193    * @param oldValue TODO
 194    * @param newValue TODO
 195    */
 196   private void firePropertyChange(String property, Object oldValue,
 197                                   Object newValue)
 198   {
 199     changeSupport.firePropertyChange(property, oldValue, newValue);
 200   }
 201
 202   /**
 203    * firePropertyChange
 204    * @param property TODO
 205    * @param oldValue TODO
 206    * @param newValue TODO
 207    */
 208   private void firePropertyChange(String property, int oldValue, int newValue)
 209   {
 210     firePropertyChange(property, new Integer(oldValue), new Integer(newValue));
 211   }
 212
 213   /**
 214    * firePropertyChange
 215    * @param property TODO
 216    * @param oldValue TODO
 217    * @param newValue TODO
 218    */
 219   private void firePropertyChange(String property, boolean oldValue,
 220                                   boolean newValue)
 221   {
 222     firePropertyChange(property, Boolean.valueOf(oldValue),
 223                        Boolean.valueOf(newValue));
 224   }
 225
 226   /**
 227    * setModelIndex
 228    * @param modelIndex TODO
 229    */
 230   public void setModelIndex(int modelIndex)
 231   {
 232     this.modelIndex = modelIndex;
 233   }
 234
 235   /**
 236    * getModelIndex
 237    * @return int
 238    */
 239   public int getModelIndex()
 240   {
 241     return modelIndex;
 242   }
 243
 244   /**
 245    * setIdentifier
 246    * @param identifier TODO
 247    */
 248   public void setIdentifier(Object identifier)
 249   {
 250     this.identifier = identifier;
 251   }
 252
 253   /**
 254    * getIdentifier
 255    * @return Object
 256    */
 257   public Object getIdentifier()
 258   {
 259     if (identifier == null)
 260       return getHeaderValue();
 261     return identifier;
 262   }
 263
 264   /**
 265    * setHeaderValue
 266    * @param headerValue TODO
 267    */
 268   public void setHeaderValue(Object headerValue)
 269   {
 270     // Variables
 271     Object oldValue;
 272
 273     // Get Old Value
 274     oldValue = this.headerValue;
 275
 276     // Set Propeprty
 277     this.headerValue = headerValue;
 278
 279     // Notify Listeners of change
 280     firePropertyChange(HEADER_VALUE_PROPERTY, oldValue, headerValue);
 281   }
 282
 283   /**
 284    * getHeaderValue
 285    * @return Object
 286    */
 287   public Object getHeaderValue()
 288   {
 289     return headerValue;
 290   }
 291
 292   /**
 293    * setHeaderRenderer
 294    * @param headerRenderer TODO
 295    */
 296   public void setHeaderRenderer(TableCellRenderer renderer)
 297   {
 298     if (headerRenderer == renderer)
 299       return;
 300
 301     TableCellRenderer oldRenderer = headerRenderer;
 302     headerRenderer = renderer;
 303     firePropertyChange(HEADER_RENDERER_PROPERTY,
 304                        oldRenderer, headerRenderer);
 305   }
 306
 307   /**
 308    * getHeaderRenderer
 309    * @return TableCellRenderer
 310    */
 311   public TableCellRenderer getHeaderRenderer()
 312   {
 313     return headerRenderer;
 314   }
 315
 316   /**
 317    * setCellRenderer
 318    * @param cellRenderer TODO
 319    */
 320   public void setCellRenderer(TableCellRenderer renderer)
 321   {
 322     if (cellRenderer == renderer)
 323       return;
 324
 325     TableCellRenderer oldRenderer = cellRenderer;
 326     cellRenderer = renderer;
 327     firePropertyChange(CELL_RENDERER_PROPERTY,
 328                        oldRenderer, cellRenderer);
 329   }
 330
 331   /**
 332    * getCellRenderer
 333    * @return TableCellRenderer
 334    */
 335   public TableCellRenderer getCellRenderer()
 336   {
 337     return cellRenderer;
 338   }
 339
 340   /**
 341    * setCellEditor
 342    * @param cellEditor TODO
 343    */
 344   public void setCellEditor(TableCellEditor cellEditor)
 345   {
 346     this.cellEditor = cellEditor;
 347   }
 348
 349   /**
 350    * getCellEditor
 351    * @return TableCellEditor
 352    */
 353   public TableCellEditor getCellEditor()
 354   {
 355     return cellEditor;
 356   }
 357
 358   /**
 359    * setWidth
 360    * @param newWidth TODO
 361    */
 362   public void setWidth(int newWidth)
 363   {
 364     int oldWidth = width;
 365
 366     if (newWidth < minWidth)
 367       width = minWidth;
 368     else if (newWidth > maxWidth)
 369       width = maxWidth;
 370     else
 371       width = newWidth;
 372
 373     if (width == oldWidth)
 374       return;
 375
 376     firePropertyChange(COLUMN_WIDTH_PROPERTY, oldWidth, width);
 377   }
 378
 379   /**
 380    * getWidth
 381    * @return int
 382    */
 383   public int getWidth()
 384   {
 385     return width;
 386   }
 387
 388   /**
 389    * setPreferredWidth
 390    * @param preferredWidth TODO
 391    */
 392   public void setPreferredWidth(int preferredWidth)
 393   {
 394     if (preferredWidth < minWidth)
 395       this.preferredWidth = minWidth;
 396     else if (preferredWidth > maxWidth)
 397       this.preferredWidth = maxWidth;
 398     else
 399       this.preferredWidth = preferredWidth;
 400   }
 401
 402   /**
 403    * getPreferredWidth
 404    * @return int
 405    */
 406   public int getPreferredWidth()
 407   {
 408     return preferredWidth;
 409   }
 410
 411   /**
 412    * setMinWidth
 413    * @param minWidth TODO
 414    */
 415   public void setMinWidth(int minWidth)
 416   {
 417     this.minWidth = minWidth;
 418     setWidth(getWidth());
 419     setPreferredWidth(getPreferredWidth());
 420   }
 421
 422   /**
 423    * getMinWidth
 424    * @return int
 425    */
 426   public int getMinWidth()
 427   {
 428     return minWidth;
 429   }
 430
 431   /**
 432    * setMaxWidth
 433    * @param maxWidth TODO
 434    */
 435   public void setMaxWidth(int maxWidth)
 436   {
 437     this.maxWidth = maxWidth;
 438     setWidth(getWidth());
 439     setPreferredWidth(getPreferredWidth());
 440   }
 441
 442   /**
 443    * getMaxWidth
 444    * @return int
 445    */
 446   public int getMaxWidth()
 447   {
 448     return maxWidth;
 449   }
 450
 451   /**
 452    * setResizable
 453    * @param isResizable TODO
 454    */
 455   public void setResizable(boolean isResizable)
 456   {
 457     this.isResizable = isResizable;
 458   }
 459
 460   /**
 461    * getResizable
 462    * @return boolean
 463    */
 464   public boolean getResizable()
 465   {
 466     return isResizable;
 467   }
 468
 469   /**
 470    * sizeWidthToFit
 471    */
 472   public void sizeWidthToFit()
 473   {
 474     // TODO
 475   }
 476
 477   /**
 478    * disableResizedPosting
 479    *
 480    * @deprecated 1.3
 481    */
 482   public void disableResizedPosting()
 483   {
 484     // Does nothing
 485   }
 486
 487   /**
 488    * enableResizedPosting
 489    *
 490    * @deprecated 1.3
 491    */
 492   public void enableResizedPosting()
 493   {
 494     // Does nothing
 495   }
 496
 497   /**
 498    * addPropertyChangeListener
 499    * @param listener the listener to all
 500    */
 501   public synchronized void addPropertyChangeListener(PropertyChangeListener listener)
 502   {
 503     changeSupport.addPropertyChangeListener(listener);
 504   }
 505
 506   /**
 507    * removePropertyChangeListener
 508    * @param listener the listener to remove
 509    */
 510   public synchronized void removePropertyChangeListener(PropertyChangeListener listener)
 511   {
 512     changeSupport.removePropertyChangeListener(listener);
 513   }
 514
 515   /**
 516    * @since 1.4
 517    */
 518   public PropertyChangeListener[] getPropertyChangeListeners()
 519   {
 520     return changeSupport.getPropertyChangeListeners();
 521   }
 522
 523   /**
 524    * createDefaultHeaderRenderer
 525    * @return TableCellRenderer
 526    */
 527   protected TableCellRenderer createDefaultHeaderRenderer()
 528   {
 529     return new DefaultTableCellRenderer();
 530   }
 531 }