org.jvnet.substance.colorscheme
public abstract class BaseColorScheme extends java.lang.Object implements SubstanceColorScheme
Modifier and Type | Field and Description |
---|---|
protected SchemeDerivedColors |
derivedColorsResolver
Resolver for the derived colors.
|
protected java.lang.String |
displayName
Display name of this color scheme.
|
protected boolean |
isDark
Indicates whether this color scheme is dark.
|
Modifier | Constructor and Description |
---|---|
protected |
BaseColorScheme(java.lang.String displayName,
boolean isDark)
Constructs the basic functionality of a color scheme.
|
Modifier and Type | Method and Description |
---|---|
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 |
getTextBackgroundFillColor()
Returns the text background fill color for
this scheme. |
java.awt.Color |
getWatermarkDarkColor()
Returns the watermark dark color for
this scheme. |
java.awt.Color |
getWatermarkLightColor()
Returns the watermark light color for
this scheme. |
java.awt.Color |
getWatermarkStampColor()
Returns the watermark stamp 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() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDarkColor, getExtraLightColor, getForegroundColor, getLightColor, getMidColor, getUltraDarkColor, getUltraLightColor
protected boolean isDark
protected java.lang.String displayName
protected SchemeDerivedColors derivedColorsResolver
protected BaseColorScheme(java.lang.String displayName, boolean isDark)
displayName
- Display name.isDark
- Indication whether the color scheme is dark.public java.lang.String getDisplayName()
SubstanceTrait
this
trait. This method is part
of officially supported API.getDisplayName
in interface SubstanceTrait
this
trait.public boolean isDark()
SubstanceColorScheme
isDark
in interface SubstanceColorScheme
true
if this color scheme uses dark colors,
false
otherwise.public SubstanceColorScheme shift(java.awt.Color backgroundShiftColor, double backgroundShiftFactor, java.awt.Color foregroundShiftColor, double foregroundShiftFactor)
SubstanceColorScheme
this
scheme.shift
in interface SubstanceColorScheme
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.this
scheme.public SubstanceColorScheme shiftBackground(java.awt.Color backgroundShiftColor, double backgroundShiftFactor)
SubstanceColorScheme
this
scheme.shiftBackground
in interface SubstanceColorScheme
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.this
scheme that does not change
the foreground color.public SubstanceColorScheme tint(double tintFactor)
SubstanceColorScheme
this
color scheme.tint
in interface SubstanceColorScheme
tintFactor
- Value in 0.0...1.0 range. Larger values shift more towards
white color.this
scheme.public SubstanceColorScheme tone(double toneFactor)
SubstanceColorScheme
this
color
scheme.tone
in interface SubstanceColorScheme
toneFactor
- Value in 0.0...1.0 range. Larger values shift more towards
gray color.this
scheme.public SubstanceColorScheme shade(double shadeFactor)
SubstanceColorScheme
this
color scheme.shade
in interface SubstanceColorScheme
shadeFactor
- Value in 0.0...1.0 range. Larger values shift more towards
black color.this
scheme.public SubstanceColorScheme saturate(double saturateFactor)
SubstanceColorScheme
this
scheme.
The value and brightness stay the same.saturate
in interface SubstanceColorScheme
saturateFactor
- Value in -1.0...1.0 range. Positive values create more
saturated colors. Negative values create more desaturated
colors.this
scheme.public SubstanceColorScheme invert()
SubstanceColorScheme
this
scheme.invert
in interface SubstanceColorScheme
this
scheme.public SubstanceColorScheme negate()
SubstanceColorScheme
this
scheme.negate
in interface SubstanceColorScheme
this
scheme.public SubstanceColorScheme hueShift(double hueShiftFactor)
SubstanceColorScheme
this
color
scheme.hueShift
in interface SubstanceColorScheme
hueShiftFactor
- Value in -1.0...1.0 range.this
scheme.public java.awt.Color getBackgroundFillColor()
SchemeDerivedColors
this
scheme.getBackgroundFillColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getFocusRingColor()
SchemeDerivedColors
this
scheme.getFocusRingColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getLineColor()
SchemeDerivedColors
this
scheme.getLineColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getSelectionForegroundColor()
SchemeDerivedColors
this
scheme.getSelectionForegroundColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getSelectionBackgroundColor()
SchemeDerivedColors
this
scheme.getSelectionBackgroundColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getWatermarkDarkColor()
SchemeDerivedColors
this
scheme.getWatermarkDarkColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getWatermarkLightColor()
SchemeDerivedColors
this
scheme.getWatermarkLightColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getWatermarkStampColor()
SchemeDerivedColors
this
scheme.getWatermarkStampColor
in interface SchemeDerivedColors
this
scheme.public java.awt.Color getTextBackgroundFillColor()
SchemeDerivedColors
this
scheme.getTextBackgroundFillColor
in interface SchemeDerivedColors
this
scheme.public SubstanceColorScheme named(java.lang.String colorSchemeDisplayName)
SubstanceColorScheme
this
instance.named
in interface SubstanceColorScheme
colorSchemeDisplayName
- New display name for this color scheme.public java.lang.String toString()
toString
in class java.lang.Object