Source for javax.swing.plaf.synth.ColorType

   1: /* ColorType.java -- En enumeration of color types
   2:    Copyright (C) 2006 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.plaf.synth;
  40: 
  41: /**
  42:  * A typesafe enumeration of color types.
  43:  *
  44:  * @author Roman Kennke (kennke@aicas.com)
  45:  *
  46:  * @since 1.5
  47:  */
  48: public class ColorType
  49: {
  50: 
  51:   /**
  52:    * A constant used to identify the foreground color of a component.
  53:    */
  54:   public static final ColorType FOREGROUND = new ColorType("Foreground");
  55: 
  56:   /**
  57:    * A constant used to identify the background color of a component.
  58:    */
  59:   public static final ColorType BACKGROUND = new ColorType("Background");
  60: 
  61:   /**
  62:    * A constant used to identify the foreground color of text of a component.
  63:    */
  64:   public static final ColorType TEXT_FOREGROUND
  65:                                            = new ColorType("TextForeground");
  66: 
  67:   /**
  68:    * A constant used to identify the background color of text of a component.
  69:    */
  70:   public static final ColorType TEXT_BACKGROUND
  71:                                            = new ColorType("TextBackground");
  72: 
  73:   /**
  74:    * A constant used to identify the focus color of a component.
  75:    */
  76:   public static final ColorType FOCUS = new ColorType("Focus");
  77: 
  78:   /**
  79:    * The maximum number of color types.
  80:    */
  81:   public static final int MAX_COUNT;
  82:   static
  83:   {
  84:     // This is not a constant in the JDK.
  85:     MAX_COUNT = 5;
  86:   }
  87: 
  88:   /**
  89:    * A counter used to assign an ID to the created color types.
  90:    */
  91:   private static int count = 0;
  92: 
  93:   /**
  94:    * The ID of the color type.
  95:    */
  96:   private int id;
  97: 
  98:   /**
  99:    * The description of the color type.
 100:    */
 101:   private String description;
 102: 
 103:   /**
 104:    * Creates a new <code>Color</code> color type with the specified
 105:    * description.
 106:    *
 107:    * @param desc the textual description of the color type
 108:    */
 109:   protected ColorType(String desc)
 110:   {
 111:     description = desc;
 112:     id = count;
 113:     count++;
 114:   }
 115: 
 116:   /**
 117:    * Returns the unique ID of the color type.
 118:    *
 119:    * @return the unique ID of the color type
 120:    */
 121:   public final int getID()
 122:   {
 123:     return id;
 124:   }
 125: 
 126:   /**
 127:    * Returns the textual description of the color type.
 128:    *
 129:    * @return the textual description of the color type
 130:    */
 131:   public String toString()
 132:   {
 133:     return description;
 134:   }
 135: }