001 /* ColorType.java -- En enumeration of color types
002 Copyright (C) 2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.swing.plaf.synth;
040
041 /**
042 * A typesafe enumeration of color types.
043 *
044 * @author Roman Kennke (kennke@aicas.com)
045 *
046 * @since 1.5
047 */
048 public class ColorType
049 {
050
051 /**
052 * A constant used to identify the foreground color of a component.
053 */
054 public static final ColorType FOREGROUND = new ColorType("Foreground");
055
056 /**
057 * A constant used to identify the background color of a component.
058 */
059 public static final ColorType BACKGROUND = new ColorType("Background");
060
061 /**
062 * A constant used to identify the foreground color of text of a component.
063 */
064 public static final ColorType TEXT_FOREGROUND
065 = new ColorType("TextForeground");
066
067 /**
068 * A constant used to identify the background color of text of a component.
069 */
070 public static final ColorType TEXT_BACKGROUND
071 = new ColorType("TextBackground");
072
073 /**
074 * A constant used to identify the focus color of a component.
075 */
076 public static final ColorType FOCUS = new ColorType("Focus");
077
078 /**
079 * The maximum number of color types.
080 */
081 public static final int MAX_COUNT;
082 static
083 {
084 // This is not a constant in the JDK.
085 MAX_COUNT = 5;
086 }
087
088 /**
089 * A counter used to assign an ID to the created color types.
090 */
091 private static int count = 0;
092
093 /**
094 * The ID of the color type.
095 */
096 private int id;
097
098 /**
099 * 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 }