Class RadianceSkin

java.lang.Object

org.pushingpixels.radiance.theming.api.RadianceSkin

All Implemented Interfaces:

RadianceTrait

Direct Known Subclasses:

AutumnSkin, CeruleanSkin, FieldOfWheatSkin, GeminiSkin, GreenMagicSkin, HarvestSkin, MagellanSkin, MagmaSkin, MarinerSkin, ModerateSkin, NightShadeSkin, OfficeBlack2007Skin, OfficeBlue2007Skin, OfficeSilver2007Skin, RadianceSkin.Accented, RavenSkin, SaharaSkin, SentinelSkin, StreetlightsSkin, TwilightSkin

public abstract class RadianceSkin
extends Object
implements RadianceTrait

Base abstract class for Radiance skins.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RadianceSkin.Accented	Base class for skins that can be configured with accent color tokens.

Field Summary

Fields

Modifier and Type	Field	Description
protected RadianceButtonShaper	buttonShaper	The button shaper of this skin.
private final Map<RadianceThemingSlices.DecorationAreaType, ContainerColorTokensBundle>	colorTokensBundleMap	Maps decoration area type to the color token bundles.
private final Set<RadianceThemingSlices.DecorationAreaType>	decoratedAreaSet	Set of all decoration area types that are not explicitly registered in colorTokensBundleMap but still are considered as decoration areas in this skin.
protected RadianceDecorationPainter	decorationPainter	The decoration painter of this skin.
protected RadianceOutlinePainter	highlightOutlinePainter	The highlight outline painter of this skin.
protected RadianceSurfacePainter	highlightSurfacePainter	The highlight surface painter of this skin.
private final Map<RadianceThemingSlices.DecorationAreaType, ContainerColorTokens>	neutralColorTokensOverrideMap	Maps decoration area type to the neutral color tokens overrides.
protected RadianceOutlinePainter	outlinePainter	The outline painter of this skin.
private final Map<RadianceThemingSlices.DecorationAreaType, List<RadianceOverlayPainter>>	overlayPaintersMap	Maps decoration area type to the registered overlay painters.
protected RadianceSurfacePainter	surfacePainter	The surface painter of this skin.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	RadianceSkin()	Constructs the basic data structures for a skin.

Method Summary

Modifier and Type	Method	Description
(package private) void	addCustomEntriesToTable(UIDefaults table)	Adds skin-specific entries to the UI defaults table.
void	addOverlayPainter(RadianceOverlayPainter overlayPainter, RadianceThemingSlices.DecorationAreaType... areaTypes)	Adds the specified overlay painter to the end of the list of overlay painters associated with the specified decoration area types.
void	clearOverlayPainters(RadianceThemingSlices.DecorationAreaType... areaTypes)	Removes all overlay painters associated with the specified decoration area types.
final ContainerColorTokens	getActiveContainerTokens(Component comp)	Returns active container tokens for the specified component.
final ContainerColorTokens	getActiveContainerTokens(Component comp, ComponentState componentState)	Returns active container tokens for the specified component in the specific state.
final ContainerColorTokens	getActiveContainerTokens(Component comp, RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind, ComponentState componentState)	Returns active container tokens for the specified visual area of a component in the specific state.
final ContainerColorTokens	getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType decorationAreaType)	Returns active container tokens for the specified decoration area type.
final RadianceButtonShaper	getButtonShaper()	Returns the button shaper of this skin.
final RadianceDecorationPainter	getDecorationPainter()	Returns the decoration painter of this skin.
final RadianceOutlinePainter	getHighlightOutlinePainter()	Returns the highlight outline painter of this skin.
final RadianceSurfacePainter	getHighlightSurfacePainter()	Returns the highlight painter of this skin.
final ContainerColorTokens	getInverseSystemContainerTokens(Component comp, RadianceThemingSlices.SystemContainerType systemContainerType)	Returns inverse system container tokens for the specified component.
final ContainerColorTokens	getMutedContainerTokens(Component comp)	Returns muted container tokens for the specified component.
final ContainerColorTokens	getMutedContainerTokens(Component comp, RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)	Returns muted container tokens for the specified visual area of a component.
final ContainerColorTokens	getMutedContainerTokens(RadianceThemingSlices.DecorationAreaType decorationAreaType)	Returns muted container tokens for the specified decoration area type.
final ContainerColorTokens	getNeutralContainerTokens(Component comp)	Returns neutral container tokens for the specified component.
final ContainerColorTokens	getNeutralContainerTokens(Component comp, RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)	Returns neutral container tokens for the specified visual area of a component.
final ContainerColorTokens	getNeutralContainerTokens(RadianceThemingSlices.DecorationAreaType decorationAreaType)	Returns neutral container tokens for the specified decoration area type.
final RadianceOutlinePainter	getOutlinePainter()	Returns the outline painter of this skin.
List<RadianceOverlayPainter>	getOverlayPainters(RadianceThemingSlices.DecorationAreaType decorationAreaType)	Returns a non-null, non-modifiable list of overlay painters associated with the specified decoration area type.
final RadianceSurfacePainter	getSurfacePainter()	Returns the surface painter of this skin.
final ContainerColorTokens	getSystemContainerTokens(Component comp, RadianceThemingSlices.SystemContainerType systemContainerType)	Returns system container tokens for the specified component.
boolean	isRegisteredAsDecorationArea(RadianceThemingSlices.DecorationAreaType decorationType)	Returns indication whether the specified decoration area type should have their background painted by RadianceDecorationPainter.paintDecorationArea(Graphics2D, Component, RadianceThemingSlices.DecorationAreaType, int, int, RadianceSkin) instead of a simple background fill.
boolean	isValid()	Checks whether this skin is valid.
void	registerAsDecorationArea(ContainerColorTokens neutralContainerTokens, RadianceThemingSlices.DecorationAreaType... areaTypes)	Registers the specified neutral color tokens to be used on controls in decoration areas.
void	registerDecorationAreaTokensBundle(ContainerColorTokensBundle bundle, RadianceThemingSlices.DecorationAreaType... areaTypes)	Registers the specified color tokens bundle to be used on controls in decoration areas.
void	removeOverlayPainter(RadianceOverlayPainter overlayPainter, RadianceThemingSlices.DecorationAreaType... areaTypes)	Removes the specified overlay painter from the list of overlay painters associated with the specified decoration area types.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface RadianceTrait

getDisplayName

Field Details

colorTokensBundleMap

private final Map<RadianceThemingSlices.DecorationAreaType, ContainerColorTokensBundle> colorTokensBundleMap

Maps decoration area type to the color token bundles. Must contain an entry for RadianceThemingSlices.DecorationAreaType.NONE.

neutralColorTokensOverrideMap

private final Map<RadianceThemingSlices.DecorationAreaType, ContainerColorTokens> neutralColorTokensOverrideMap

Maps decoration area type to the neutral color tokens overrides.

overlayPaintersMap

private final Map<RadianceThemingSlices.DecorationAreaType, List<RadianceOverlayPainter>> overlayPaintersMap

Maps decoration area type to the registered overlay painters. Each decoration area type can have more than one overlay painter.

buttonShaper

protected RadianceButtonShaper buttonShaper

The button shaper of this skin. Must be non-null.

surfacePainter

protected RadianceSurfacePainter surfacePainter

The surface painter of this skin. Must be non-null.

highlightSurfacePainter

protected RadianceSurfacePainter highlightSurfacePainter

The highlight surface painter of this skin. Must be non-null.

outlinePainter

protected RadianceOutlinePainter outlinePainter

The outline painter of this skin. Must be non-null.

highlightOutlinePainter

protected RadianceOutlinePainter highlightOutlinePainter

The highlight outline painter of this skin. Can be null.

decorationPainter

protected RadianceDecorationPainter decorationPainter

The decoration painter of this skin. Must be non-null.

decoratedAreaSet

private final Set<RadianceThemingSlices.DecorationAreaType> decoratedAreaSet

Set of all decoration area types that are not explicitly registered in colorTokensBundleMap but still are considered as decoration areas in this skin. Controls in such areas will have their background painted by RadianceDecorationPainter.paintDecorationArea(Graphics2D, Component, RadianceThemingSlices.DecorationAreaType, int, int, RadianceSkin) instead of a simple background fill.

Constructor Details

RadianceSkin

protected RadianceSkin()

Constructs the basic data structures for a skin.

Method Details

getOutlinePainter

public final RadianceOutlinePainter getOutlinePainter()

Returns the outline painter of this skin.

Returns:

The outline painter of this skin. A valid skin cannot have a null value returned from this method. Call isValid() to verify that the skin is valid.

See Also:

• isValid()

getHighlightOutlinePainter

public final RadianceOutlinePainter getHighlightOutlinePainter()

Returns the highlight outline painter of this skin.

Returns:

The highlight outline painter of this skin. The return value of this method may be null. In this case, call getOutlinePainter().

getButtonShaper

public final RadianceButtonShaper getButtonShaper()

Returns the button shaper of this skin.

Returns:

The button shaper of this skin. A valid skin cannot have a null value returned from this method. Call isValid() to verify that the skin is valid.

See Also:

• isValid()

getSurfacePainter

public final RadianceSurfacePainter getSurfacePainter()

Returns the surface painter of this skin.

Returns:

The surface painter of this skin. A valid skin cannot have a null value returned from this method. Call isValid() to verify that the skin is valid.

See Also:

• isValid()

getHighlightSurfacePainter

public final RadianceSurfacePainter getHighlightSurfacePainter()

Returns the highlight painter of this skin.

Returns:

The highlight painter of this skin. A valid skin cannot have a null value returned from this method. Call isValid() to verify that the skin is valid.

See Also:

• isValid()

getDecorationPainter

public final RadianceDecorationPainter getDecorationPainter()

Returns the decoration painter of this skin.

Returns:

The decoration painter of this skin. A valid skin cannot have a null value returned from this method. Call isValid() to verify that the skin is valid.

See Also:

• isValid()

addCustomEntriesToTable

void addCustomEntriesToTable(UIDefaults table)

Adds skin-specific entries to the UI defaults table.

Parameters:

table - UI defaults table.

getNeutralContainerTokens

public final ContainerColorTokens getNeutralContainerTokens(Component comp)

Returns neutral container tokens for the specified component.

Parameters:

comp - Component.

Returns:

Neutral container tokens for the component.

See Also:

• getNeutralContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getNeutralContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getMutedContainerTokens(Component)
• getActiveContainerTokens(Component)

getMutedContainerTokens

public final ContainerColorTokens getMutedContainerTokens(Component comp)

Returns muted container tokens for the specified component.

Parameters:

comp - Component.

Returns:

Muted container tokens for the component.

See Also:

• getMutedContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getMutedContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getNeutralContainerTokens(Component)
• getActiveContainerTokens(Component)

getActiveContainerTokens

public final ContainerColorTokens getActiveContainerTokens(Component comp)

Returns active container tokens for the specified component.

Parameters:

comp - Component.

Returns:

Active container tokens for the component.

See Also:

• getActiveContainerTokens(Component, ComponentState)
• getActiveContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)
• getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getNeutralContainerTokens(Component)
• getMutedContainerTokens(Component)

getActiveContainerTokens

public final ContainerColorTokens getActiveContainerTokens(Component comp,
 ComponentState componentState)

Returns active container tokens for the specified component in the specific state.

Parameters:

comp - Component.

componentState - Component state.

Returns:

Active container tokens for the component.

See Also:

• getActiveContainerTokens(Component)
• getActiveContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)
• getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType)

getSystemContainerTokens

public final ContainerColorTokens getSystemContainerTokens(Component comp,
 RadianceThemingSlices.SystemContainerType systemContainerType)

Returns system container tokens for the specified component.

Parameters:

comp - Component.

systemContainerType - System container type.

Returns:

System container tokens for the component.

See Also:

• getInverseSystemContainerTokens(Component, RadianceThemingSlices.SystemContainerType)

getInverseSystemContainerTokens

public final ContainerColorTokens getInverseSystemContainerTokens(Component comp,
 RadianceThemingSlices.SystemContainerType systemContainerType)

Returns inverse system container tokens for the specified component.

Parameters:

comp - Component.

systemContainerType - System container type.

Returns:

Inverse system container tokens for the component.

See Also:

• getSystemContainerTokens(Component, RadianceThemingSlices.SystemContainerType)

registerDecorationAreaTokensBundle

public void registerDecorationAreaTokensBundle(ContainerColorTokensBundle bundle,
 RadianceThemingSlices.DecorationAreaType... areaTypes)

Registers the specified color tokens bundle to be used on controls in decoration areas.

Parameters:

bundle - The color tokens bundle to use on controls in decoration areas.

areaTypes - Enumerates the area types that are affected by the parameters.

registerAsDecorationArea

public void registerAsDecorationArea(ContainerColorTokens neutralContainerTokens,
 RadianceThemingSlices.DecorationAreaType... areaTypes)

Registers the specified neutral color tokens to be used on controls in decoration areas.

Parameters:

neutralContainerTokens - The neutral tokens to use in specified decoration areas.

areaTypes - Enumerates the area types that are affected by the parameters. Each decoration area type will be painted by RadianceDecorationPainter.paintDecorationArea(Graphics2D, Component, RadianceThemingSlices.DecorationAreaType, int, int, RadianceSkin)

isRegisteredAsDecorationArea

public boolean isRegisteredAsDecorationArea(RadianceThemingSlices.DecorationAreaType decorationType)

Returns indication whether the specified decoration area type should have their background painted by RadianceDecorationPainter.paintDecorationArea(Graphics2D, Component, RadianceThemingSlices.DecorationAreaType, int, int, RadianceSkin) instead of a simple background fill.

Parameters:

decorationType - Decoration area type.

Returns:

true if specified decoration area type should have their background painted by RadianceDecorationPainter.paintDecorationArea(Graphics2D, Component, RadianceThemingSlices.DecorationAreaType, int, int, RadianceSkin) , false otherwise.

getNeutralContainerTokens

public final ContainerColorTokens getNeutralContainerTokens(RadianceThemingSlices.DecorationAreaType decorationAreaType)

Returns neutral container tokens for the specified decoration area type.

Parameters:

decorationAreaType - Decoration area type.

Returns:

Neutral container tokens for the decoration area type.

See Also:

• getNeutralContainerTokens(Component)
• getNeutralContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getMutedContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType)

getMutedContainerTokens

public final ContainerColorTokens getMutedContainerTokens(RadianceThemingSlices.DecorationAreaType decorationAreaType)

Returns muted container tokens for the specified decoration area type.

Parameters:

decorationAreaType - Decoration area type.

Returns:

Muted container tokens for the decoration area type.

See Also:

• getMutedContainerTokens(Component)
• getMutedContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getNeutralContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType)

getActiveContainerTokens

public final ContainerColorTokens getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType decorationAreaType)

Returns active container tokens for the specified decoration area type.

Parameters:

decorationAreaType - Decoration area type.

Returns:

Active container tokens for the decoration area type.

See Also:

• getActiveContainerTokens(Component)
• getActiveContainerTokens(Component, ComponentState)
• getActiveContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)
• getMutedContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getNeutralContainerTokens(RadianceThemingSlices.DecorationAreaType)

addOverlayPainter

public void addOverlayPainter(RadianceOverlayPainter overlayPainter,
 RadianceThemingSlices.DecorationAreaType... areaTypes)

Adds the specified overlay painter to the end of the list of overlay painters associated with the specified decoration area types.

Parameters:

overlayPainter - Overlay painter to add to the end of the list of overlay painters associated with the specified decoration area types.

areaTypes - Decoration area types.

removeOverlayPainter

public void removeOverlayPainter(RadianceOverlayPainter overlayPainter,
 RadianceThemingSlices.DecorationAreaType... areaTypes)

Removes the specified overlay painter from the list of overlay painters associated with the specified decoration area types.

Parameters:

overlayPainter - Overlay painter to remove from the list of overlay painters associated with the specified decoration area types.

areaTypes - Decoration area types.

clearOverlayPainters

public void clearOverlayPainters(RadianceThemingSlices.DecorationAreaType... areaTypes)

Removes all overlay painters associated with the specified decoration area types.

Parameters:

areaTypes - Decoration area types.

getOverlayPainters

public List<RadianceOverlayPainter> getOverlayPainters(RadianceThemingSlices.DecorationAreaType decorationAreaType)

Returns a non-null, non-modifiable list of overlay painters associated with the specified decoration area type.

Parameters:

decorationAreaType - Decoration area type.

Returns:

A non-null, non-modifiable list of overlay painters associated with the specified decoration area type.

getActiveContainerTokens

public final ContainerColorTokens getActiveContainerTokens(Component comp,
 RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind,
 ComponentState componentState)

Returns active container tokens for the specified visual area of a component in the specific state.

Parameters:

comp - Component.

associationKind - Color tokens association kind.

componentState - Component state.

Returns:

Active container tokens for the component.

See Also:

• getActiveContainerTokens(Component)
• getActiveContainerTokens(Component, ComponentState)
• getActiveContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getNeutralContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getMutedContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)

getMutedContainerTokens

public final ContainerColorTokens getMutedContainerTokens(Component comp,
 RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)

Returns muted container tokens for the specified visual area of a component.

Parameters:

comp - Component.

associationKind - Color tokens association kind.

Returns:

Muted container tokens for the component.

See Also:

• getMutedContainerTokens(Component)
• getMutedContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getNeutralContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getActiveContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)

getNeutralContainerTokens

public final ContainerColorTokens getNeutralContainerTokens(Component comp,
 RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)

Returns neutral container tokens for the specified visual area of a component.

Parameters:

comp - Component.

associationKind - Color tokens association kind.

Returns:

Neutral container tokens for the component.

See Also:

• getNeutralContainerTokens(Component)
• getNeutralContainerTokens(RadianceThemingSlices.DecorationAreaType)
• getMutedContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind)
• getActiveContainerTokens(Component, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)

isValid

public boolean isValid()

Checks whether this skin is valid. A skins is considered valid if it has a color tokens bundle for RadianceThemingSlices.DecorationAreaType.NONE, as well as non-null button shaper, surface painter, outline painter, highlight surface painter and decoration painter. If call to RadianceThemingCortex.GlobalScope.setSkin(String) or RadianceThemingCortex.GlobalScope.setSkin(RadianceSkin) does not seem to have any visible effect (returning false), call this method to verify that your skin is valid.

Returns:

true if this skin is valid, false otherwise.