org.pushingpixels.substance.api

Interface SchemeDerivedColorsResolver

All Known Implementing Classes:

DerivedColorsResolverLight

public interface SchemeDerivedColorsResolver

SchemeDerivedColorResolvers must be immutable. The resolvers are passed to derived color schemes to ensure that derived scheme resolve derived colors in the same way as the base scheme.

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getBackgroundFillColor(SubstanceColorScheme colorScheme) Returns the background fill color for this scheme.
java.awt.Color	getFocusRingColor(SubstanceColorScheme colorScheme) Returns the focus ring color for this scheme.
java.awt.Color	getLineColor(SubstanceColorScheme colorScheme) Returns the line color for this scheme.
java.awt.Color	getSelectionBackgroundColor(SubstanceColorScheme colorScheme) Returns the selection background color for this scheme.
java.awt.Color	getSelectionForegroundColor(SubstanceColorScheme colorScheme) Returns the selection foreground color for this scheme.
java.awt.Color	getTextBackgroundFillColor(SubstanceColorScheme colorScheme) Returns the text background fill color for this scheme.
java.awt.Color	getWatermarkDarkColor(SubstanceColorScheme colorScheme) Returns the watermark dark color for this scheme.
java.awt.Color	getWatermarkLightColor(SubstanceColorScheme colorScheme) Returns the watermark light color for this scheme.
java.awt.Color	getWatermarkStampColor(SubstanceColorScheme colorScheme) Resolves a derived color for a given color scheme.
SchemeDerivedColorsResolver	invert() Inverts this resolver, for use with inverted color schemes and switching from light to dark schemes or vice versa.
boolean	isDark() Determines if this resolver is for dark color schemes.

Method Detail

isDark

boolean isDark()

Determines if this resolver is for dark color schemes.

Returns:

true if it should be used in dark schemes

invert

SchemeDerivedColorsResolver invert()

Inverts this resolver, for use with inverted color schemes and switching from light to dark schemes or vice versa.

Some resolvers may not support this option. They may choose to throw an UnsupportedOperationException in that case. Instead of throwing the exception developers may choose to simply return this signifying that the resolver cannot be inverted. Another option would be to use assertions, allowing the developers to discover mistakes during creation, but still being useful for clients:

 public void SchemeDerivedColorsResolver invert() {
     assert false : "this resolver cannot be inverted";
     
     return this;
 }
 

Returns:

an inversion of this resolver

Throws:

java.lang.UnsupportedOperationException - if this resolver cannot be inverted

getWatermarkStampColor

java.awt.Color getWatermarkStampColor(SubstanceColorScheme colorScheme)

Resolves a derived color for a given color scheme.

Returns:

the watermark stamp color for the supplied scheme.

getWatermarkLightColor

java.awt.Color getWatermarkLightColor(SubstanceColorScheme colorScheme)

Returns the watermark light color for this scheme.

Returns:

Watermark light color for this scheme.

getWatermarkDarkColor

java.awt.Color getWatermarkDarkColor(SubstanceColorScheme colorScheme)

Returns the watermark dark color for this scheme.

Returns:

Watermark dark color for this scheme.

getLineColor

java.awt.Color getLineColor(SubstanceColorScheme colorScheme)

Returns the line color for this scheme.

Returns:

The line color for this scheme.

getSelectionBackgroundColor

java.awt.Color getSelectionBackgroundColor(SubstanceColorScheme colorScheme)

Returns the selection background color for this scheme.

Returns:

The selection background color for this scheme.

getSelectionForegroundColor

java.awt.Color getSelectionForegroundColor(SubstanceColorScheme colorScheme)

Returns the selection foreground color for this scheme.

Returns:

The selection foreground color for this scheme.

getBackgroundFillColor

java.awt.Color getBackgroundFillColor(SubstanceColorScheme colorScheme)

Returns the background fill color for this scheme.

Returns:

The background fill color for this scheme.

getTextBackgroundFillColor

java.awt.Color getTextBackgroundFillColor(SubstanceColorScheme colorScheme)

Returns the text background fill color for this scheme.

Returns:

The text background fill color for this scheme.

getFocusRingColor

java.awt.Color getFocusRingColor(SubstanceColorScheme colorScheme)

Returns the focus ring color for this scheme.

Returns:

The focus ring color for this scheme.