org.jvnet.substance.color
Class ShiftColorScheme

java.lang.Object
  extended by org.jvnet.substance.color.BaseColorScheme
      extended by org.jvnet.substance.color.ShiftColorScheme
All Implemented Interfaces:
ColorScheme
Direct Known Subclasses:
ShadeColorScheme, TintColorScheme, ToneColorScheme

public class ShiftColorScheme
extends BaseColorScheme

Base class for shifted color schemes. A shifted color scheme is based on some original color scheme, a shift color and a shift factor. All colors of the original color scheme are shifted towards the shift color based on the shift factor. The closer the shift factor value is to 1.0, the closer the colors of the shifted color scheme will be to the shift color.

Author:
Kirill Grouchnikov

Field Summary
 
Fields inherited from class org.jvnet.substance.color.BaseColorScheme
id
 
Constructor Summary
ShiftColorScheme(ColorScheme origScheme, java.awt.Color shiftColor, double shiftFactor)
          Creates a new shifted color scheme.
 
Method Summary
 java.awt.Color getDarkColor()
          Retrieves the dark color.
 java.awt.Color getExtraLightColor()
          Retrieves the extra color.
 java.awt.Color getForegroundColor()
          Retrieves the foreground color.
 java.awt.Color getLightColor()
          Retrieves the light color.
 java.awt.Color getMidColor()
          Retrieves the medium color.
 ColorScheme getOrigScheme()
          Returns the original color scheme.
 double getShiftFactor()
          Returns the shift factor.
 java.awt.Color getUltraDarkColor()
          Retrieves the ultra-dark color.
 java.awt.Color getUltraLightColor()
          Retrieves the ultra-light color.
 
Methods inherited from class org.jvnet.substance.color.BaseColorScheme
getId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ShiftColorScheme

public ShiftColorScheme(ColorScheme origScheme,
                        java.awt.Color shiftColor,
                        double shiftFactor)
Creates a new shifted color scheme.

Parameters:
origScheme - The original color scheme.
shiftColor - Shift color.
shiftFactor - Shift factor. Should be in 0.0-1.0 range.
Method Detail

getForegroundColor

public java.awt.Color getForegroundColor()
Description copied from interface: ColorScheme
Retrieves the foreground color. This method is part of officially supported API.

Returns:
Foreground color.

getUltraLightColor

public java.awt.Color getUltraLightColor()
Description copied from interface: ColorScheme
Retrieves the ultra-light color. This method is part of officially supported API.

Returns:
Ultra-light color.

getExtraLightColor

public java.awt.Color getExtraLightColor()
Description copied from interface: ColorScheme
Retrieves the extra color. This method is part of officially supported API.

Returns:
Extra color.

getLightColor

public java.awt.Color getLightColor()
Description copied from interface: ColorScheme
Retrieves the light color. This method is part of officially supported API.

Returns:
Light color.

getMidColor

public java.awt.Color getMidColor()
Description copied from interface: ColorScheme
Retrieves the medium color. This method is part of officially supported API.

Returns:
Medium color.

getDarkColor

public java.awt.Color getDarkColor()
Description copied from interface: ColorScheme
Retrieves the dark color. This method is part of officially supported API.

Returns:
Dark color.

getUltraDarkColor

public java.awt.Color getUltraDarkColor()
Description copied from interface: ColorScheme
Retrieves the ultra-dark color. This method is part of officially supported API.

Returns:
Ultra-dark color.

getOrigScheme

public ColorScheme getOrigScheme()
Returns the original color scheme.

Returns:
The original color scheme.

getShiftFactor

public double getShiftFactor()
Returns the shift factor.

Returns:
Shift factor.