Source for javax.swing.table.DefaultTableCellRenderer

   1: /* DefaultTableCellRenderer.java --
   2:    Copyright (C) 2002, 2004, 2005  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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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.awt.Color;
  42: import java.awt.Component;
  43: import java.awt.Rectangle;
  44: import java.io.Serializable;
  45: 
  46: import javax.swing.BorderFactory;
  47: import javax.swing.JLabel;
  48: import javax.swing.JTable;
  49: import javax.swing.UIManager;
  50: import javax.swing.border.Border;
  51: import javax.swing.border.EmptyBorder;
  52: import javax.swing.JTextField;
  53: 
  54: /**
  55:  * Class to display every cells.
  56:  */
  57: public class DefaultTableCellRenderer extends JLabel
  58:   implements TableCellRenderer, Serializable
  59: {
  60:   static final long serialVersionUID = 7878911414715528324L;
  61: 
  62:   protected static Border noFocusBorder = new EmptyBorder(0, 0, 0, 0);
  63: 
  64:   public static class UIResource extends DefaultTableCellRenderer
  65:     implements javax.swing.plaf.UIResource
  66:   {
  67:     public UIResource()
  68:     {
  69:       super();
  70:     }
  71:   }
  72: 
  73:   /**
  74:    * Stores the color set by setForeground().
  75:    */
  76:   Color foreground;
  77: 
  78:   /**
  79:    * Stores the color set by setBackground().
  80:    */
  81:   Color background;
  82: 
  83:   /**
  84:    * Creates a default table cell renderer with an empty border.
  85:    */
  86:   public DefaultTableCellRenderer()
  87:   {
  88:     super();
  89:   }
  90: 
  91:   /**
  92:    * Assign the unselected-foreground.
  93:    *
  94:    * @param c the color to assign
  95:    */
  96:   public void setForeground(Color c)
  97:   {
  98:     super.setForeground(c);
  99:     foreground = c;
 100:   }
 101: 
 102:   /**
 103:    * Assign the unselected-background.
 104:    *
 105:    * @param c the color to assign
 106:    */
 107:   public void setBackground(Color c)
 108:   {
 109:     super.setBackground(c);
 110:     background = c;
 111:   }
 112: 
 113:   /**
 114:    * Look and feel has changed.
 115:    *
 116:    * <p>Replaces the current UI object with the  latest version from
 117:    * the UIManager.</p>
 118:    */
 119:   public void updateUI()
 120:   {
 121:     super.updateUI();
 122:     background = null;
 123:     foreground = null;
 124:   }
 125: 
 126:   /**
 127:    * Get the string value of the object and pass it to setText().
 128:    *
 129:    * @param table the JTable
 130:    * @param value the value of the object
 131:    * @param isSelected is the cell selected?
 132:    * @param hasFocus has the cell the focus?
 133:    * @param row the row to render
 134:    * @param column the cell to render
 135:    * 
 136:    * @return this component (the default table cell renderer)
 137:    */
 138:   public Component getTableCellRendererComponent(JTable table, Object value,
 139:                                                  boolean isSelected,
 140:                                                  boolean hasFocus,
 141:                                                  int row, int column)
 142:   {
 143:     if (value != null)
 144:       {
 145:         if (value instanceof JTextField)
 146:           return new JTextField(((JTextField)value).getText());
 147:         super.setText(value.toString());
 148:       }
 149: 
 150:     setOpaque(true);
 151: 
 152:     if (table == null)
 153:       return this;
 154: 
 155:     if (isSelected)
 156:       {
 157:         super.setBackground(table.getSelectionBackground());
 158:         super.setForeground(table.getSelectionForeground());
 159:       }
 160:     else
 161:       {
 162:         if (background != null)
 163:           super.setBackground(background);
 164:         else
 165:           super.setBackground(table.getBackground());
 166:         if (foreground != null)
 167:           super.setForeground(foreground);
 168:         else
 169:           super.setForeground(table.getForeground());
 170:       }
 171: 
 172:     if (hasFocus)
 173:       {
 174:         setBorder(UIManager.getBorder("Table.focusCellHighlightBorder"));
 175:         if (table.isCellEditable(row, column))
 176:           {
 177:             super.setBackground(UIManager.getColor("Table.focusCellBackground"));
 178:             super.setForeground(UIManager.getColor("Table.focusCellForeground"));
 179:           }
 180:       }
 181:     else
 182:       setBorder(BorderFactory.createEmptyBorder(1, 1, 1, 1));
 183: 
 184:     setFont(table.getFont());
 185: 
 186:     // If the current background is equal to the table's background, then we
 187:     // can avoid filling the background by setting the renderer opaque.
 188:     Color back = getBackground();
 189:     setOpaque(back != null && back.equals(table.getBackground()));
 190:     
 191:     return this;    
 192:   }
 193: 
 194:   /**
 195:    * Overriden for performance.
 196:    *
 197:    * <p>This method needs to be overridden in a subclass to actually
 198:    * do something.</p>
 199:    *
 200:    * @return always true
 201:    */
 202:   public boolean isOpaque()
 203:   {
 204:     return true;
 205:   }
 206: 
 207:   /**
 208:    * Overriden for performance.
 209:    *
 210:    * <p>This method needs to be overridden in a subclass to actually
 211:    * do something.</p>
 212:    */
 213:   public void validate()
 214:   {
 215:     // Does nothing.
 216:   }
 217: 
 218:   public void revalidate()
 219:   {
 220:     // Does nothing.
 221:   }
 222: 
 223:   /**
 224:    * Overriden for performance.
 225:    *
 226:    * <p>This method needs to be overridden in a subclass to actually
 227:    * do something.</p>
 228:    */
 229:   public void repaint(long tm, int x, int y, int width, int height)
 230:   {
 231:     // Does nothing.
 232:   }
 233: 
 234:   /**
 235:    * Overriden for performance.
 236:    *
 237:    * <p>This method needs to be overridden in a subclass to actually
 238:    * do something.</p>
 239:    */
 240:   public void repaint(Rectangle r)
 241:   {
 242:     // Does nothing.
 243:   }
 244: 
 245:   /**
 246:    * Overriden for performance.
 247:    *
 248:    * <p>This method needs to be overridden in a subclass to actually
 249:    * do something.</p>
 250:    */
 251:   protected void firePropertyChange(String propertyName, Object oldValue,
 252:                                     Object newValue)
 253:   {
 254:     // Does nothing.
 255:   }
 256: 
 257:   /**
 258:    * Overriden for performance.
 259:    *
 260:    * <p>This method needs to be overridden in a subclass to actually
 261:    * do something.</p>
 262:    */
 263:   public void firePropertyChange(String propertyName, boolean oldValue,
 264:                          boolean newValue)
 265:   {
 266:     // Does nothing.
 267:   }
 268: 
 269:   /**
 270:    * Sets the String for this cell.
 271:    * 
 272:    * @param value the string value for this cell; if value is null it
 273:    * sets the text value to an empty string
 274:    */
 275:   protected void setValue(Object value)
 276:   {
 277:     super.setText((value!=null) ? value.toString() : "");
 278:   }
 279: }