Class RGBGrayFilter

All Implemented Interfaces:
ImageConsumer, Cloneable

public final class RGBGrayFilter extends RGBImageFilter
An image filter that turns an icon into a grayscale icon. Used by the JGoodies Windows and Plastic L&Fs to create a disabled icon.

The high-resolution gray filter can be disabled globally using Options.setHiResGrayFilterEnabled(boolean); it is enabled by default. The global setting can be overridden per component by setting the client property key Options.HI_RES_DISABLED_ICON_CLIENT_KEY to Boolean.FALSE.

Thanks to Andrej Golovnin for suggesting a simpler filter formula.

Version:
$Revision: 1.13 $
  • Constructor Details

    • RGBGrayFilter

      private RGBGrayFilter()
      Overrides default constructor; prevents instantiation.
  • Method Details

    • getDisabledIcon

      public static Icon getDisabledIcon(JComponent component, Icon icon)
      Returns an icon with a disabled appearance. This method is used to generate a disabled icon when one has not been specified.
      Parameters:
      component - the component that will display the icon, may be null.
      icon - the icon to generate disabled icon from.
      Returns:
      disabled icon, or null if a suitable icon can not be generated.
    • filterRGB

      public int filterRGB(int x, int y, int rgb)
      Converts a single input pixel in the default RGB ColorModel to a single gray pixel.
      Specified by:
      filterRGB in class RGBImageFilter
      Parameters:
      x - the horizontal pixel coordinate
      y - the vertical pixel coordinate
      rgb - the integer pixel representation in the default RGB color model
      Returns:
      a gray pixel in the default RGB color model.
      See Also: