Source for javax.swing.DefaultListCellRenderer

   1: /* DefaultListCellRenderer.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., 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;
  40: 
  41: import java.awt.Component;
  42: import java.awt.Rectangle;
  43: import java.io.Serializable;
  44: 
  45: import javax.swing.border.Border;
  46: import javax.swing.border.EmptyBorder;
  47: 
  48: /**
  49:  * The default implementation {@link ListCellRenderer}. It provides a standard
  50:  * renderer for data objects of all types via {@link Object#toString()}.
  51:  *
  52:  * @author Andrew Selkirk
  53:  */
  54: public class DefaultListCellRenderer extends JLabel
  55:   implements ListCellRenderer, Serializable
  56: {
  57:   private static final long serialVersionUID = 7708947179685189462L;
  58: 
  59:   /**
  60:    * Subclasses <code>DefaultListCellRenderers</code> and implements
  61:    * {@link javax.swing.plaf.UIResource}. This is used by
  62:    * {@link javax.swing.plaf.ListUI} subclasses to provide a default for
  63:    * the <code>List.cellRenderer</code> property. If you want to override
  64:    * this property, use <code>DefaultListCellRenderer</code> or a subclass.
  65:    */
  66:   public static class UIResource extends DefaultListCellRenderer
  67:     implements javax.swing.plaf.UIResource
  68:   {
  69:     public UIResource()
  70:     {
  71:       super();
  72:     }
  73:   }
  74: 
  75:   /**
  76:    * This border is used whenever renderer doesn't have a focus.
  77:    */
  78:   protected static Border noFocusBorder = new EmptyBorder(1, 1, 1, 1);
  79: 
  80:   /**
  81:    * getListCellRendererComponent
  82:    *
  83:    * @param list JList list for the 'value'
  84:    * @param value object that should be rendered in the cell
  85:    * @param index index of the cell
  86:    * @param isSelected draw cell highlighted if isSelected is true
  87:    * @param cellHasFocus draw focus rectangle around cell if the cell has
  88:    *        focus
  89:    *
  90:    * @return Component that will be painted to the desired cell.
  91:    */
  92:   public Component getListCellRendererComponent(JList list, Object value,
  93:                                                 int index, boolean isSelected,
  94:                                                 boolean cellHasFocus)
  95:   {
  96:     String s = value != null ? value.toString() : "";
  97:     setText(s);
  98:     setOpaque(true);
  99:     setHorizontalAlignment(LEFT);
 100: 
 101:     if (isSelected)
 102:       {
 103:         setBackground(list.getSelectionBackground());
 104:         setForeground(list.getSelectionForeground());
 105:       }
 106:     else
 107:       {
 108:         setBackground(list.getBackground());
 109:         setForeground(list.getForeground());
 110:       }
 111: 
 112:     setEnabled(list.isEnabled());
 113:     setFont(list.getFont());
 114: 
 115:     // Use focusCellHighlightBorder when renderer has focus and
 116:     // noFocusBorder otherwise
 117: 
 118:     if (cellHasFocus)
 119:       setBorder(UIManager.getBorder("List.focusCellHighlightBorder"));
 120:     else
 121:       setBorder(noFocusBorder);
 122: 
 123:     return this;
 124:   }
 125: 
 126:   public void validate()
 127:   {
 128:     // Overridden to do nothing.
 129:   }
 130: 
 131:   public void revalidate()
 132:   {
 133:     // Overridden to do nothing.
 134:   }
 135: 
 136:   public void repaint(long tm, int x, int y, int w, int h)
 137:   {
 138:     // Overridden to do nothing.
 139:   }
 140: 
 141:   public void repaint(Rectangle rect)
 142:   {
 143:     // Overridden to do nothing.
 144:   }
 145: 
 146:   protected void firePropertyChange(String propertyName, Object oldValue,
 147:                                     Object newValue)
 148:   {
 149:     // Overridden to do nothing.
 150:   }
 151: 
 152:   public void firePropertyChange(String propertyName, byte oldValue,
 153:                                  byte newValue)
 154:   {
 155:     // Overridden to do nothing.
 156:   }
 157: 
 158:   public void firePropertyChange(String propertyName, char oldValue,
 159:                                  char newValue)
 160:   {
 161:     // Overridden to do nothing.
 162:   }
 163: 
 164:   public void firePropertyChange(String propertyName, short oldValue,
 165:                                  short newValue)
 166:   {
 167:     // Overridden to do nothing.
 168:   }
 169: 
 170:   public void firePropertyChange(String propertyName, int oldValue,
 171:                                  int newValue)
 172:   {
 173:     // Overridden to do nothing.
 174:   }
 175: 
 176:   public void firePropertyChange(String propertyName, long oldValue,
 177:                                  long newValue)
 178:   {
 179:     // Overridden to do nothing.
 180:   }
 181: 
 182:   public void firePropertyChange(String propertyName, float oldValue,
 183:                                  float newValue)
 184:   {
 185:     // Overridden to do nothing.
 186:   }
 187: 
 188:   public void firePropertyChange(String propertyName, double oldValue,
 189:                                  double newValue)
 190:   {
 191:     // Overridden to do nothing.
 192:   }
 193: 
 194:   public void firePropertyChange(String propertyName, boolean oldValue,
 195:                                  boolean newValue)
 196:   {
 197:     // Overridden to do nothing.
 198:   }
 199: }