libjava/javax/swing/plaf/ColorUIResource.java

   1 /* ColorUIResource.java
   2    Copyright (C) 2002, 2003 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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;
  40
  41 import java.awt.Color;
  42
  43
  44 /**
  45  * A Color that is marked as <code>UIResource</code>, which indicates that
  46  * the color has been installed by a pluggable LookAndFeel. Such colors
  47  * are replaced when the LookAndFeel changes.
  48  *
  49  * @see java.awt.Color
  50  *
  51  * @author Sascha Brawer (brawer@dandelis.ch)
  52  */
  53 public class ColorUIResource
  54   extends Color
  55   implements UIResource
  56 {
  57   /**
  58    * Constructs a <code>ColorUIResource</code> using the specified
  59    * red, green, and blue values, which must be given as integers in
  60    * the range of 0-255. The alpha channel value will default to 255,
  61    * meaning that the color is fully opaque.
  62    *
  63    * @param r the red intensity, which must be in the range [0 .. 255].
  64    * @param g the green intensity, which must be in the range [0 .. 255].
  65    * @param b the blue intensity, which must be in the range [0 .. 255].
  66    */
  67   public ColorUIResource(int r, int g, int b)
  68   {
  69     super(r, g, b);
  70   }
  71
  72
  73   /**
  74    * Consructs a <code>ColorUIResource</code> using the specified
  75    * RGB value. The blue value is in bits 0-7, green in bits 8-15, and
  76    * red in bits 16-23. The other bits are ignored. The alpha value is set
  77    * to 255, meaning that the color is fully opaque.
  78    *
  79    * @param rgb the rgb value, as discussed above.
  80    */
  81   public ColorUIResource(int rgb)
  82   {
  83     super(rgb);
  84   }
  85
  86
  87   /**
  88    * Constructs a <code>ColorUIResource</code> using the specified
  89    * red, green, and blue intensities, which must be given as floats in
  90    * the range of 0-1. The alpha channel value will default to 1.0f,
  91    * meaning that the color is fully opaque.
  92    *
  93    * @param r the red intensity, which must be in the range [0.0 .. 1.0].
  94    * @param g the green intensity, which must be in the range [0.0 .. 1.0].
  95    * @param b the blue intensity, which must be in the range [0.0 .. 1.0].
  96    */
  97   public ColorUIResource(float r, float g, float b)
  98   {
  99     super(r, g, b);
 100   }
 101
 102
 103   /**
 104    * Constructs a <code>ColorUIResource</code>, using the intensities
 105    * of another color.
 106    *
 107    * @param c the color whose intensities will be considered when
 108    *        constructing this <code>ColorUIResource</code>.
 109    */
 110   public ColorUIResource(Color c)
 111   {
 112     super(c.getRGB());
 113   }
 114 }