Class ShiftColorScheme
java.lang.Object
org.pushingpixels.substance.api.colorscheme.BaseColorScheme
org.pushingpixels.substance.internal.colorscheme.ShiftColorScheme
- All Implemented Interfaces:
SchemeBaseColors
,SchemeDerivedColors
,SubstanceColorScheme
,SubstanceTrait
- Direct Known Subclasses:
ShadeColorScheme
,TintColorScheme
,ToneColorScheme
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final LazyResettableHashMap
<SubstanceColorScheme> Cache of shifted schemes.Fields inherited from class org.pushingpixels.substance.api.colorscheme.BaseColorScheme
derivedColorsResolver, displayName, isDark
-
Constructor Summary
ConstructorsConstructorDescriptionShiftColorScheme
(SubstanceColorScheme origScheme, Color shiftColor, double shiftFactor) Creates a new shifted color scheme.ShiftColorScheme
(SubstanceColorScheme origScheme, Color backgroundShiftColor, double backgroundShiftFactor, Color foregroundShiftColor, double foregroundShiftFactor, boolean shiftByBrightness) Creates a new shifted color scheme. -
Method Summary
Modifier and TypeMethodDescriptionRetrieves the dark color.Retrieves the extra color.Retrieves the foreground color.Retrieves the light color.Retrieves the medium color.Returns the original color scheme.static SubstanceColorScheme
getShiftedScheme
(SubstanceColorScheme orig, Color backgroundShiftColor, double backgroundShiftFactor, Color foregroundShiftColor, double foregroundShiftFactor) Returns a shifted color scheme.double
Returns the shift factor.Retrieves the ultra-dark color.Retrieves the ultra-light color.Methods inherited from class org.pushingpixels.substance.api.colorscheme.BaseColorScheme
getBackgroundFillColor, getDisplayName, getFocusRingColor, getLineColor, getResolver, getSelectionBackgroundColor, getSelectionForegroundColor, getTextBackgroundFillColor, getWatermarkDarkColor, getWatermarkLightColor, getWatermarkStampColor, hueShift, invert, isDark, named, negate, saturate, shade, shift, shiftBackground, tint, tone, toString
-
Field Details
-
shiftedCache
Cache of shifted schemes.
-
-
Constructor Details
-
ShiftColorScheme
Creates a new shifted color scheme.- Parameters:
origScheme
- The original color scheme.shiftColor
- Shift color for the colors.shiftFactor
- Shift factor for the colors. Should be in 0.0-1.0 range.
-
ShiftColorScheme
public ShiftColorScheme(SubstanceColorScheme origScheme, Color backgroundShiftColor, double backgroundShiftFactor, Color foregroundShiftColor, double foregroundShiftFactor, boolean shiftByBrightness) Creates a new shifted color scheme.- Parameters:
origScheme
- The original color scheme.backgroundShiftColor
- Shift color for the background colors.backgroundShiftFactor
- Shift factor for the background colors. Should be in 0.0-1.0 range.foregroundShiftColor
- Shift color for the foreground colors.foregroundShiftFactor
- Shift factor for the foreground colors. Should be in 0.0-1.0 range.shiftByBrightness
- Iftrue
, the shift will account for the brightness of the original color scheme colors.
-
-
Method Details
-
getForegroundColor
Description copied from interface:SchemeBaseColors
Retrieves the foreground color.- Returns:
- Foreground color.
-
getUltraLightColor
Description copied from interface:SchemeBaseColors
Retrieves the ultra-light color.- Returns:
- Ultra-light color.
-
getExtraLightColor
Description copied from interface:SchemeBaseColors
Retrieves the extra color.- Returns:
- Extra color.
-
getLightColor
Description copied from interface:SchemeBaseColors
Retrieves the light color.- Returns:
- Light color.
-
getMidColor
Description copied from interface:SchemeBaseColors
Retrieves the medium color.- Returns:
- Medium color.
-
getDarkColor
Description copied from interface:SchemeBaseColors
Retrieves the dark color.- Returns:
- Dark color.
-
getUltraDarkColor
Description copied from interface:SchemeBaseColors
Retrieves the ultra-dark color.- Returns:
- Ultra-dark color.
-
getOrigScheme
Returns the original color scheme.- Returns:
- The original color scheme.
-
getShiftFactor
public double getShiftFactor()Returns the shift factor.- Returns:
- Shift factor.
-
getShiftedScheme
public static SubstanceColorScheme getShiftedScheme(SubstanceColorScheme orig, Color backgroundShiftColor, double backgroundShiftFactor, Color foregroundShiftColor, double foregroundShiftFactor) Returns a shifted color scheme. This method is for internal use only.- Parameters:
orig
- The original color scheme.backgroundShiftColor
- Shift color for the background color scheme colors. May benull
- in this case, the background color scheme colors will not be shifted.backgroundShiftFactor
- Shift factor for the background color scheme colors. If the shift color for the background color scheme colors isnull
, this value is ignored.foregroundShiftColor
- Shift color for the foreground color scheme colors. May benull
- in this case, the foreground color scheme colors will not be shifted.foregroundShiftFactor
- Shift factor for the foreground color scheme colors. If the shift color for the foreground color scheme colors isnull
, this value is ignored.- Returns:
- Shifted scheme.
-