gomp-20050608-branch/libjava/classpath/javax/swing/colorchooser/AbstractColorChooserPanel.java

   1 /* AbstractColorChooserPanel.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.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     // Nothing to do here.
  68   }
  69
  70   /**
  71    * This method returns the name displayed in the tab for this chooser panel.
  72    *
  73    * @return The name displayed in the JTabbedPane's tabs.
  74    */
  75   public abstract String getDisplayName();
  76
  77   /**
  78    * Returns the key code for the mnemonic for this panel.  This method returns
  79    * zero to indicate no mnemonic, subclasses can override this.
  80    *
  81    * @return <code>0</code>, to indicate no mnemonic key code.
  82    *
  83    * @see #getDisplayedMnemonicIndex()
  84    * @since 1.4
  85    */
  86   public int getMnemonic()
  87   {
  88     return 0;
  89   }
  90
  91   /**
  92    * Returns the index of the character in the display name that is the
  93    * mnemonic.  This method returns <code>-1</code> to indicate no mnemonic,
  94    * subclasses can override.
  95    *
  96    * @return <code>-1</code>, to indicate no mnemonic.
  97    *
  98    * @see #getDisplayName()
  99    * @see #getMnemonic()
 100    * @since 1.4
 101    */
 102   public int getDisplayedMnemonicIndex()
 103   {
 104     return -1;
 105   }
 106
 107   /**
 108    * This method updates the chooser panel when the JColorChooser's color has
 109    * changed.
 110    */
 111   public abstract void updateChooser();
 112
 113   /**
 114    * This method constructs and does any initialization necessary for the
 115    * chooser panel.
 116    */
 117   protected abstract void buildChooser();
 118
 119   /**
 120    * This method sets the small icon used in the JTabbedPane for this chooser
 121    * panel.
 122    *
 123    * @return The small icon used in the JTabbedPane.
 124    */
 125   public abstract Icon getSmallDisplayIcon();
 126
 127   /**
 128    * This method sets the large icon useed in the jTabbedPane for this chooser
 129    * panel.
 130    *
 131    * @return The large icon.
 132    */
 133   public abstract Icon getLargeDisplayIcon();
 134
 135   /**
 136    * This method installs the chooser panel for the given JColorChooser.
 137    *
 138    * @param chooser The JColorChooser that will have this panel installed.
 139    */
 140   public void installChooserPanel(JColorChooser chooser)
 141   {
 142     this.chooser = chooser;
 143     buildChooser();
 144   } // installChooserPanel()
 145
 146   /**
 147    * This method removes the chooser panel from the given JColorChooser and
 148    * does any necessary clean up for the chooser panel.
 149    *
 150    * @param chooser The JColorChooser that is having this panel removed.
 151    */
 152   public void uninstallChooserPanel(JColorChooser chooser)
 153   {
 154     this.chooser = null;
 155   } // uninstallChooserPanel()
 156
 157   /**
 158    * This method returns the ColorSelectionModel for the JColorChooser
 159    * associated with this chooser panel.
 160    *
 161    * @return The ColorSelectionModel for the JColorChooser associated with
 162    *         this chooser panel.
 163    */
 164   public ColorSelectionModel getColorSelectionModel()
 165   {
 166     if (chooser != null)
 167       return chooser.getSelectionModel();
 168     return null;
 169   } // getColorSelectionModel()
 170
 171   /**
 172    * This method returns the current color stored in the model for this
 173    * chooser panel.
 174    *
 175    * @return The current color.
 176    */
 177   protected Color getColorFromModel()
 178   {
 179     if (chooser != null)
 180       return chooser.getColor();
 181     return null;
 182   } // getColorFromModel()
 183
 184   /**
 185    * This method paints the chooser panel.
 186    *
 187    * @param graphics The Graphics object to paint with.
 188    */
 189   public void paint(Graphics graphics)
 190   {
 191     super.paint(graphics);
 192   } // paint()
 193 } // AbstractColorChooserPanel