BaseColorScheme (substance 3.5.0 API)

java.lang.Object
- org.pushingpixels.substance.api.colorscheme.BaseColorScheme

All Implemented Interfaces:

SchemeBaseColors, SchemeDerivedColors, SubstanceColorScheme, SubstanceTrait

Direct Known Subclasses:

BaseDarkColorScheme, BaseLightColorScheme
```
public abstract class BaseColorScheme
extends java.lang.Object
implements SubstanceColorScheme
```
Base class for Substance color schemes.

Field Summary

Fields
Modifier and Type Field Description

protected java.lang.String displayName
Display name of this color scheme.

protected boolean isDark
Indicates whether this color scheme is dark.

Fields
Modifier and Type	Field	Description
`protected java.lang.String`	`displayName`	Display name of this color scheme.
`protected boolean`	`isDark`	Indicates whether this color scheme is dark.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`BaseColorScheme(java.lang.String displayName, boolean isDark)`	Constructs the basic functionality of a color scheme.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SubstanceColorScheme`	`blendWith(SubstanceColorScheme otherScheme, double likenessToThisScheme)`	Creates a blended version of `this` color scheme based on another color scheme.
`java.awt.Color`	`getBackgroundFillColor()`	Returns the background fill color for `this` scheme.
`java.lang.String`	`getDisplayName()`	Returns the display name of `this` trait.
`java.awt.Color`	`getFocusRingColor()`	Returns the focus ring color for `this` scheme.
`java.awt.Color`	`getLineColor()`	Returns the line color for `this` scheme.
`java.awt.Color`	`getSelectionBackgroundColor()`	Returns the selection background color for `this` scheme.
`java.awt.Color`	`getSelectionForegroundColor()`	Returns the selection foreground color for `this` scheme.
`java.awt.Color`	`getSeparatorDarkColor()`	Returns the dark separator color for `this` scheme.
`java.awt.Color`	`getSeparatorLightColor()`	Returns the light separator color for `this` scheme.
`java.awt.Color`	`getSeparatorShadowColor()`	Returns the shadow separator color for `this` scheme.
`java.awt.Color`	`getTextBackgroundFillColor()`	Returns the text background fill color for `this` scheme.
`SubstanceColorScheme`	`hueShift(double hueShiftFactor)`	Creates a hue-shifted (in HSB space) version of `this` color scheme.
`SubstanceColorScheme`	`invert()`	Creates an inverted version of `this` scheme.
`boolean`	`isDark()`	Returns indication whether this color scheme uses dark colors.
`SubstanceColorScheme`	`named(java.lang.String colorSchemeDisplayName)`	This method is a fluent-interface builder utility for setting the display name for this color scheme.
`SubstanceColorScheme`	`negate()`	Creates a negated version of `this` scheme.
`SubstanceColorScheme`	`saturate(double saturateFactor)`	Creates a saturated or desaturated version of `this` scheme.
`SubstanceColorScheme`	`shade(double shadeFactor)`	Creates a shaded (shifted towards black) version of `this` color scheme.
`SubstanceColorScheme`	`shift(java.awt.Color backgroundShiftColor, double backgroundShiftFactor, java.awt.Color foregroundShiftColor, double foregroundShiftFactor)`	Creates a shift version of `this` scheme.
`SubstanceColorScheme`	`shiftBackground(java.awt.Color backgroundShiftColor, double backgroundShiftFactor)`	Creates a shift version of `this` scheme.
`SubstanceColorScheme`	`tint(double tintFactor)`	Creates a tinted (shifted towards white) version of `this` color scheme.
`SubstanceColorScheme`	`tone(double toneFactor)`	Creates a toned (shifted towards gray) version of `this` color scheme.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pushingpixels.substance.api.colorscheme.SchemeBaseColors
getDarkColor, getExtraLightColor, getForegroundColor, getLightColor, getMidColor, getUltraDarkColor, getUltraLightColor, toImage

- Field Detail
  - isDark
```
protected boolean isDark
```
    Indicates whether this color scheme is dark.
  - displayName
```
protected java.lang.String displayName
```
    Display name of this color scheme.
- Constructor Detail
  - BaseColorScheme
```
protected BaseColorScheme(java.lang.String displayName,
                          boolean isDark)
```
    Constructs the basic functionality of a color scheme.
    
    Parameters:
    
    displayName - Display name.
    
    isDark - Indication whether the color scheme is dark.
- Method Detail
  - getDisplayName
```
public final java.lang.String getDisplayName()
```
    Description copied from interface: SubstanceTrait
    
    Returns the display name of this trait. This method is part of officially supported API.
    
    Specified by:
    
    getDisplayName in interface SubstanceTrait
    
    Returns:
    
    The display name of this trait.
  - isDark
```
public final boolean isDark()
```
    Description copied from interface: SubstanceColorScheme
    
    Returns indication whether this color scheme uses dark colors. Note that this method may be removed in the future.
    
    Specified by:
    
    isDark in interface SubstanceColorScheme
    
    Returns:
    
    true if this color scheme uses dark colors, false otherwise.
  - shift
```
public final SubstanceColorScheme shift(java.awt.Color backgroundShiftColor,
                                        double backgroundShiftFactor,
                                        java.awt.Color foregroundShiftColor,
                                        double foregroundShiftFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a shift version of this scheme.
    
    Specified by:
    
    shift in interface SubstanceColorScheme
    
    Parameters:
    
    backgroundShiftColor - Shift color for background colors. Should have full opacity.
    
    backgroundShiftFactor - Value in 0.0...1.0 range. Larger values shift more towards the specified color.
    
    foregroundShiftColor - Shift color for foreground colors. Should have full opacity.
    
    foregroundShiftFactor - Value in 0.0...1.0 range. Larger values shift more towards the specified color.
    
    Returns:
    
    Shift version of this scheme.
  - shiftBackground
```
public final SubstanceColorScheme shiftBackground(java.awt.Color backgroundShiftColor,
                                                  double backgroundShiftFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a shift version of this scheme.
    
    Specified by:
    
    shiftBackground in interface SubstanceColorScheme
    
    Parameters:
    
    backgroundShiftColor - Shift color for background colors. Should have full opacity.
    
    backgroundShiftFactor - Value in 0.0...1.0 range. Larger values shift more towards the specified color.
    
    Returns:
    
    Shift version of this scheme that does not change the foreground color.
  - tint
```
public SubstanceColorScheme tint(double tintFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a tinted (shifted towards white) version of this color scheme.
    
    Specified by:
    
    tint in interface SubstanceColorScheme
    
    Parameters:
    
    tintFactor - Value in 0.0...1.0 range. Larger values shift more towards white color.
    
    Returns:
    
    Tinted version of this scheme.
  - tone
```
public SubstanceColorScheme tone(double toneFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a toned (shifted towards gray) version of this color scheme.
    
    Specified by:
    
    tone in interface SubstanceColorScheme
    
    Parameters:
    
    toneFactor - Value in 0.0...1.0 range. Larger values shift more towards gray color.
    
    Returns:
    
    Toned version of this scheme.
  - shade
```
public SubstanceColorScheme shade(double shadeFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a shaded (shifted towards black) version of this color scheme.
    
    Specified by:
    
    shade in interface SubstanceColorScheme
    
    Parameters:
    
    shadeFactor - Value in 0.0...1.0 range. Larger values shift more towards black color.
    
    Returns:
    
    Shaded version of this scheme.
  - saturate
```
public SubstanceColorScheme saturate(double saturateFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a saturated or desaturated version of this scheme. The value and brightness stay the same.
    
    Specified by:
    
    saturate in interface SubstanceColorScheme
    
    Parameters:
    
    saturateFactor - Value in -1.0...1.0 range. Positive values create more saturated colors. Negative values create more desaturated colors.
    
    Returns:
    
    Saturated version of this scheme.
  - invert
```
public SubstanceColorScheme invert()
```
    Description copied from interface: SubstanceColorScheme
    
    Creates an inverted version of this scheme.
    
    Specified by:
    
    invert in interface SubstanceColorScheme
    
    Returns:
    
    Inverted version of this scheme.
  - negate
```
public SubstanceColorScheme negate()
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a negated version of this scheme.
    
    Specified by:
    
    negate in interface SubstanceColorScheme
    
    Returns:
    
    Negated version of this scheme.
  - hueShift
```
public SubstanceColorScheme hueShift(double hueShiftFactor)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a hue-shifted (in HSB space) version of this color scheme.
    
    Specified by:
    
    hueShift in interface SubstanceColorScheme
    
    Parameters:
    
    hueShiftFactor - Value in -1.0...1.0 range.
    
    Returns:
    
    Hue-shifted version of this scheme.
  - blendWith
```
public SubstanceColorScheme blendWith(SubstanceColorScheme otherScheme,
                                      double likenessToThisScheme)
```
    Description copied from interface: SubstanceColorScheme
    
    Creates a blended version of this color scheme based on another color scheme.
    
    Specified by:
    
    blendWith in interface SubstanceColorScheme
    
    Parameters:
    
    otherScheme - The other color scheme for blending colors.
    
    likenessToThisScheme - Defines how close the colors of the resulting color scheme are to this scheme. Value of 1.0 returns a color scheme with the exact colors of this color scheme. Value of 0.0 returns a color scheme with the exact colors of the other color scheme.
    
    Returns:
    
    Blended color scheme.
  - getBackgroundFillColor
```
public java.awt.Color getBackgroundFillColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the background fill color for this scheme.
    
    Specified by:
    
    getBackgroundFillColor in interface SchemeDerivedColors
    
    Returns:
    
    The background fill color for this scheme.
  - getFocusRingColor
```
public java.awt.Color getFocusRingColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the focus ring color for this scheme.
    
    Specified by:
    
    getFocusRingColor in interface SchemeDerivedColors
    
    Returns:
    
    The focus ring color for this scheme.
    
    See Also:
    
    SubstanceSkin.getOverlayColor(SubstanceSlices.ColorOverlayType, SubstanceSlices.DecorationAreaType, ComponentState)
  - getLineColor
```
public java.awt.Color getLineColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the line color for this scheme.
    
    Specified by:
    
    getLineColor in interface SchemeDerivedColors
    
    Returns:
    
    The line color for this scheme.
    
    See Also:
    
    SubstanceSkin.getOverlayColor(SubstanceSlices.ColorOverlayType, SubstanceSlices.DecorationAreaType, ComponentState)
  - getSelectionForegroundColor
```
public java.awt.Color getSelectionForegroundColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the selection foreground color for this scheme.
    
    Specified by:
    
    getSelectionForegroundColor in interface SchemeDerivedColors
    
    Returns:
    
    The selection foreground color for this scheme.
  - getSelectionBackgroundColor
```
public java.awt.Color getSelectionBackgroundColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the selection background color for this scheme.
    
    Specified by:
    
    getSelectionBackgroundColor in interface SchemeDerivedColors
    
    Returns:
    
    The selection background color for this scheme.
  - getTextBackgroundFillColor
```
public java.awt.Color getTextBackgroundFillColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the text background fill color for this scheme.
    
    Specified by:
    
    getTextBackgroundFillColor in interface SchemeDerivedColors
    
    Returns:
    
    The text background fill color for this scheme.
  - getSeparatorLightColor
```
public java.awt.Color getSeparatorLightColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the light separator color for this scheme.
    
    Specified by:
    
    getSeparatorLightColor in interface SchemeDerivedColors
    
    Returns:
    
    The light separator color for this scheme.
  - getSeparatorDarkColor
```
public java.awt.Color getSeparatorDarkColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the dark separator color for this scheme.
    
    Specified by:
    
    getSeparatorDarkColor in interface SchemeDerivedColors
    
    Returns:
    
    The dark separator color for this scheme.
  - getSeparatorShadowColor
```
public java.awt.Color getSeparatorShadowColor()
```
    Description copied from interface: SchemeDerivedColors
    
    Returns the shadow separator color for this scheme.
    
    Specified by:
    
    getSeparatorShadowColor in interface SchemeDerivedColors
    
    Returns:
    
    The shadow separator color for this scheme.
  - named
```
public final SubstanceColorScheme named(java.lang.String colorSchemeDisplayName)
```
    Description copied from interface: SubstanceColorScheme
    
    This method is a fluent-interface builder utility for setting the display name for this color scheme. The implementation must return the same this instance.
    
    Specified by:
    
    named in interface SubstanceColorScheme
    
    Parameters:
    
    colorSchemeDisplayName - New display name for this color scheme.
    
    Returns:
    
    This color scheme.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BaseColorScheme

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.pushingpixels.substance.api.colorscheme.SchemeBaseColors

Field Detail

isDark

displayName

Constructor Detail

BaseColorScheme

Method Detail

getDisplayName

isDark

shift

shiftBackground

tint

tone

shade

saturate

invert

negate

hueShift

blendWith

getBackgroundFillColor

getFocusRingColor

getLineColor

getSelectionForegroundColor

getSelectionBackgroundColor

getTextBackgroundFillColor

getSeparatorLightColor

getSeparatorDarkColor

getSeparatorShadowColor

named

toString