Source for javax.swing.colorchooser.AbstractColorChooserPanel

   1: /* AbstractColorChooserPanel.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.colorchooser;
  40: 
  41: import java.awt.Color;
  42: import java.awt.Graphics;
  43: 
  44: import javax.swing.Icon;
  45: import javax.swing.JColorChooser;
  46: import javax.swing.JPanel;
  47: 
  48: /**
  49:  * AbstractColorChooserPanel
  50:  *
  51:  * @author Andrew Selkirk
  52:  * @version 1.0
  53:  */
  54: public abstract class AbstractColorChooserPanel extends JPanel
  55: {
  56:   /** DOCUMENT ME! */
  57:   private static final long serialVersionUID = -977469671210173863L;
  58: 
  59:   /** The chooser associated with this panel. */
  60:   private JColorChooser chooser;
  61: 
  62:   /**
  63:    * This is the constructor for the AbstractColorChooserPanel.
  64:    */
  65:   public AbstractColorChooserPanel()
  66:   {
  67:   } // AbstractColorChooserPanel()
  68: 
  69:   /**
  70:    * This method returns the name displayed in the tab for this chooser panel.
  71:    *
  72:    * @return The name displayed in the JTabbedPane's tabs.
  73:    */
  74:   public abstract String getDisplayName();
  75: 
  76:   /**
  77:    * This method updates the chooser panel when the JColorChooser's color has
  78:    * changed.
  79:    */
  80:   public abstract void updateChooser();
  81: 
  82:   /**
  83:    * This method constructs and does any initialization necessary for the
  84:    * chooser panel.
  85:    */
  86:   protected abstract void buildChooser();
  87: 
  88:   /**
  89:    * This method sets the small icon used in the JTabbedPane for this chooser
  90:    * panel.
  91:    *
  92:    * @return The small icon used in the JTabbedPane.
  93:    */
  94:   public abstract Icon getSmallDisplayIcon();
  95: 
  96:   /**
  97:    * This method sets the large icon useed in the jTabbedPane for this chooser
  98:    * panel.
  99:    *
 100:    * @return The large icon.
 101:    */
 102:   public abstract Icon getLargeDisplayIcon();
 103: 
 104:   /**
 105:    * This method installs the chooser panel for the given JColorChooser.
 106:    *
 107:    * @param chooser The JColorChooser that will have this panel installed.
 108:    */
 109:   public void installChooserPanel(JColorChooser chooser)
 110:   {
 111:     this.chooser = chooser;
 112:     buildChooser();
 113:   } // installChooserPanel()
 114: 
 115:   /**
 116:    * This method removes the chooser panel from the given JColorChooser and
 117:    * does any necessary clean up for the chooser panel.
 118:    *
 119:    * @param chooser The JColorChooser that is having this panel removed.
 120:    */
 121:   public void uninstallChooserPanel(JColorChooser chooser)
 122:   {
 123:     this.chooser = null;
 124:   } // uninstallChooserPanel()
 125: 
 126:   /**
 127:    * This method returns the ColorSelectionModel for the JColorChooser
 128:    * associated with this chooser panel.
 129:    *
 130:    * @return The ColorSelectionModel for the JColorChooser associated with
 131:    *         this chooser panel.
 132:    */
 133:   public ColorSelectionModel getColorSelectionModel()
 134:   {
 135:     if (chooser != null)
 136:       return chooser.getSelectionModel();
 137:     return null;
 138:   } // getColorSelectionModel()
 139: 
 140:   /**
 141:    * This method returns the current color stored in the model for this
 142:    * chooser panel.
 143:    *
 144:    * @return The current color.
 145:    */
 146:   protected Color getColorFromModel()
 147:   {
 148:     if (chooser != null)
 149:       return chooser.getColor();
 150:     return null;
 151:   } // getColorFromModel()
 152: 
 153:   /**
 154:    * This method paints the chooser panel.
 155:    *
 156:    * @param graphics The Graphics object to paint with.
 157:    */
 158:   public void paint(Graphics graphics)
 159:   {
 160:     super.paint(graphics);
 161:   } // paint()
 162: } // AbstractColorChooserPanel