Class symantec.itools.awt.image.FadeFilter
All Packages  Class Hierarchy  This Package  Previous  Next  Index
  Class symantec.itools.awt.image.FadeFilter
Object
   |
   +----ImageFilter
           |
           +----RGBImageFilter
                   |
                   +----symantec.itools.awt.image.FadeFilter
  -  public class FadeFilter
  
-  extends RGBImageFilter
  
An Image filter to use for fading an Image towards a specified Color by a specified percent.
  -  Version:
  
 -  1.1, July 8, 1997
  
 -  Author:
  
 -  Symantec
 
  
  -  
	errors
   -   Error strings.
  
 -  
	percent
   -   The percentage to fade when filtering.
  
 -  
	to_b
   -   The blue value of the color to fade to when filtering.
  
 -  
	to_g
   -   The green value of the color to fade to when filtering.
  
 -  
	to_r
   -   The red value of the color to fade to when filtering.
 
  
  -  
	symantec.itools.awt.image.FadeFilter()
   -   Constructs a default FadeFilter.
  
 -  
	symantec.itools.awt.image.FadeFilter(double)
   -   Constructs a FadeFilter.
  
 -  
	symantec.itools.awt.image.FadeFilter(Color)
   -   Constructs a FadeFilter.
  
 -  
	symantec.itools.awt.image.FadeFilter(double, Color)
   -   Constructs a FadeFilter.
 
  
  -  
	filterRGB(int, int, int)
   -   Filters an RGB value using the current fade settings.
  
 -  
	getFadeToColor()
   -   Gets the color used to fade to when filtering.
  
 -  
	getPercent()
   -   Gets the percentage to fade when filtering.
  
 -  
	setFadeToColor(Color)
   -   Sets the color to fade to when filtering.
  
 -  
	setPercent(double)
   -   Sets the percentage to fade when filtering.
 
  
errors
protected transient java.util.ResourceBundle errors
  -  Error strings.
 
percent
protected double percent
  -  The percentage to fade when filtering.
 
 
    -  See Also:
    
 -  getPercent, setPercent
  
 
 
 
to_b
protected int to_b
  -  The blue value of the color to fade to when filtering.
 
 
    -  See Also:
    
 -  getFadeToColor, setFadeToColor
  
 
 
 
to_g
protected int to_g
  -  The green value of the color to fade to when filtering.
 
 
    -  See Also:
    
 -  getFadeToColor, setFadeToColor
  
 
 
 
to_r
protected int to_r
  -  The red value of the color to fade to when filtering.
 
 
    -  See Also:
    
 -  getFadeToColor, setFadeToColor
  
 
 
 
  
FadeFilter
public FadeFilter()
  -  Constructs a default FadeFilter.
 By default the Image is faded 50% towards Color.lightGray.
  
 
 
    -  See Also:
    
 -  FadeFilter(double), FadeFilter(java.awt.Color), FadeFilter(double, java.awt.Color), setPercent, setFadeToColor
  
 
 
 
FadeFilter
public FadeFilter(double percent)
  -  Constructs a FadeFilter.
 By default the Image is faded towards Color.lightGray.
  
 
 
    -  Parameters:
    
 -  percent - the percent to fade towards the specified color
    
 -  See Also:
    
 -  FadeFilter(), FadeFilter(java.awt.Color), FadeFilter(double, java.awt.Color), setFadeToColor
  
 
 
 
FadeFilter
public FadeFilter(Color fadeToColor)
  -  Constructs a FadeFilter.
 By default the Image is faded 50%.
  
 
 
    -  Parameters:
    
 -  fadeToColor - the color to fade to
    
 -  See Also:
    
 -  FadeFilter(), FadeFilter(double), FadeFilter(double, java.awt.Color), setPercent
  
 
 
 
FadeFilter
public FadeFilter(double percent,
                  Color fadeToColor)
  -  Constructs a FadeFilter.
  
 
 
    -  Parameters:
    
 -  percent - the percent to fade towards the specified color
    
-  fadeToColor - the color to fade to
    
  -  See Also:
    
 -  FadeFilter(), FadeFilter(double), FadeFilter(java.awt.Color)
  
 
 
 
  
filterRGB
public int filterRGB(int x,
                     int y,
                     int rgb)
  -  Filters an RGB value using the current fade settings.
  
 
 
    -  Parameters:
    
 -  x - unused
    
-  y - unused
    
-  rgb - the rgb value to fade
    
   -  Returns:
    
 -  the faded rgb value
    
 -  Overrides:
    
 -  filterRGB in class RGBImageFilter
  
 
 
 
getFadeToColor
public java.awt.Color getFadeToColor()
  -  Gets the color used to fade to when filtering.
  
 
 
    -  Returns:
    
 -  the color used to fade to
    
 -  See Also:
    
 -  setFadeToColor
  
 
 
 
getPercent
public double getPercent()
  -  Gets the percentage to fade when filtering.
  
 
 
    -  Returns:
    
 -  the percentage to fade
    
 -  See Also:
    
 -  setPercent
  
 
 
 
setFadeToColor
public void setFadeToColor(Color fadeTo)
  -  Sets the color to fade to when filtering.
  
 
 
    -  Parameters:
    
 -  fadeTo - the color to fade to
    
 -  See Also:
    
 -  getFadeToColor
  
 
 
 
setPercent
public void setPercent(double percent) throws IllegalArgumentException
  -  Sets the percentage to fade when filtering.
  
 
 
    -  Parameters:
    
 -  percent - the percentage to fade
    
 -  Throws: IllegalArgumentException
    
 -   if the specified percentage value is unacceptable
    
 -  See Also:
    
 -  getPercent
  
 
 
 
All Packages  Class Hierarchy  This Package  Previous  Next  Index