JIDE Common Layer 3.5.3

com.jidesoft.icons
Class ColorFilter

java.lang.Object
  extended by java.awt.image.ImageFilter
      extended by java.awt.image.RGBImageFilter
          extended by com.jidesoft.icons.ColorFilter
All Implemented Interfaces:
ImageConsumer, Cloneable

public class ColorFilter
extends RGBImageFilter

An image filter that brightens or darkens an existing image.


Field Summary
 
Fields inherited from class java.awt.image.RGBImageFilter
canFilterIndexColorModel, newmodel, origmodel
 
Fields inherited from class java.awt.image.ImageFilter
consumer
 
Fields inherited from interface java.awt.image.ImageConsumer
COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT
 
Constructor Summary
ColorFilter(boolean b, int p)
          Constructs a ColorFilter object that filters a color image to a brighter or a darker image.
 
Method Summary
static Image createBrighterImage(Image i)
          Creates a brighter image
static Image createBrighterImage(Image i, int p)
          Creates a brighter image with a given percentage of brightness
static Image createDarkerImage(Image i)
          Creates a darker image
static Image createDarkerImage(Image i, int p)
          Creates a darker image with a given percentage of darkness
 int filterRGB(int x, int y, int rgb)
          Overrides RGBImageFilter.filterRGB.
static ColorFilter getInstance(boolean brighter, int percent)
           
static int getPercent()
           
 void setBrighter(boolean brighter)
           
static void setPercent(int percent)
           
 
Methods inherited from class java.awt.image.RGBImageFilter
filterIndexColorModel, filterRGBPixels, setColorModel, setPixels, setPixels, substituteColorModel
 
Methods inherited from class java.awt.image.ImageFilter
clone, getFilterInstance, imageComplete, resendTopDownLeftRight, setDimensions, setHints, setProperties
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ColorFilter

public ColorFilter(boolean b,
                   int p)
Constructs a ColorFilter object that filters a color image to a brighter or a darker image. Please note, you can also use getInstance(boolean, int) to reuse the same instance of ColorFilter.

Parameters:
b - a boolean -- true if the pixels should be brightened
p - an int in the range 0..100 that determines the percentage of gray, where 100 is the darkest gray, and 0 is the lightest
Method Detail

getInstance

public static ColorFilter getInstance(boolean brighter,
                                      int percent)

setBrighter

public void setBrighter(boolean brighter)

setPercent

public static void setPercent(int percent)

getPercent

public static int getPercent()

createBrighterImage

public static Image createBrighterImage(Image i)
Creates a brighter image

Parameters:
i - the original image
Returns:
a brighter image

createBrighterImage

public static Image createBrighterImage(Image i,
                                        int p)
Creates a brighter image with a given percentage of brightness

Parameters:
i - the original image
p - percentage of brightness
Returns:
a brighter image

createDarkerImage

public static Image createDarkerImage(Image i)
Creates a darker image

Parameters:
i - the original image
Returns:
a darker image.

createDarkerImage

public static Image createDarkerImage(Image i,
                                      int p)
Creates a darker image with a given percentage of darkness

Parameters:
i - the original image
p - percentage of darkness
Returns:
a darker image.

filterRGB

public int filterRGB(int x,
                     int y,
                     int rgb)
Overrides RGBImageFilter.filterRGB.

Specified by:
filterRGB in class RGBImageFilter

JIDE Common Layer 3.5.3