Package org.pushingpixels.radiance.theming.api

Class ContainerColorTokensBundle

java.lang.Object

org.pushingpixels.radiance.theming.api.ContainerColorTokensBundle

public class ContainerColorTokensBundle
extends java.lang.Object

Color tokens bundle. Defines the visual appearance of a single decoration area of a skin.

See Also:

RadianceThemingSlices.DecorationAreaType, RadianceThemingSlices.ContainerColorTokensAssociationKind, RadianceSkin

Field Summary

Fields

Modifier and Type	Field	Description
private ContainerColorTokens	activeContainerTokens
private java.util.Map<RadianceThemingSlices.ContainerColorTokensAssociationKind,java.util.Map<ComponentState,ContainerColorTokens>>	activeTokenOverrides	Maps from color tokens association kinds to the map of color tokens.
private ContainerColorTokens	inverseSystemErrorContainerTokens
private ContainerColorTokens	inverseSystemInfoContainerTokens
private ContainerColorTokens	inverseSystemSuccessContainerTokens
private ContainerColorTokens	inverseSystemWarningContainerTokens
private ContainerColorTokens	mutedContainerTokens
private java.util.Map<RadianceThemingSlices.ContainerColorTokensAssociationKind,ContainerColorTokens>	mutedTokenOverrides
private ContainerColorTokens	neutralContainerTokens
private java.util.Map<RadianceThemingSlices.ContainerColorTokensAssociationKind,ContainerColorTokens>	neutralTokenOverrides
private ContainerColorTokens	systemErrorContainerTokens
private ContainerColorTokens	systemInfoContainerTokens
private ContainerColorTokens	systemSuccessContainerTokens
private ContainerColorTokens	systemWarningContainerTokens

Constructor Summary

Constructors

Constructor	Description
ContainerColorTokensBundle(ContainerColorTokens activeContainerTokens, ContainerColorTokens mutedContainerTokens, ContainerColorTokens neutralContainerTokens, boolean isSystemDark)	Creates a new color tokens bundle.

Method Summary

Modifier and Type	Method	Description
ContainerColorTokens	getActiveContainerTokens()	Returns active container tokens.
ContainerColorTokens	getActiveContainerTokens(ComponentState componentState)	Returns active container tokens for the specified component state.
ContainerColorTokens	getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind, ComponentState componentState)	Returns active container tokens for the specified visual area of a component in a specified component state.
private ContainerColorTokens	getActiveContainerTokensForState(ComponentState componentState)
ContainerColorTokens	getInverseSystemContainerTokens(RadianceThemingSlices.SystemContainerType systemContainerType)	Returns inverse system container tokens.
ContainerColorTokens	getMutedContainerTokens()	Returns muted container tokens.
ContainerColorTokens	getMutedContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)	Returns muted container tokens for the specified visual area of a component.
ContainerColorTokens	getNeutralContainerTokens()	Returns neutral container tokens.
ContainerColorTokens	getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)	Returns neutral container tokens for the specified visual area of a component.
ContainerColorTokens	getSystemContainerTokens(RadianceThemingSlices.SystemContainerType systemContainerType)	Returns system container tokens.
void	registerActiveContainerTokens(ContainerColorTokens stateContainerTokens, ComponentState... activeStates)	Registers container color tokens for the specific active component states.
void	registerActiveContainerTokens(ContainerColorTokens colorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind, ComponentState... activeStates)	Registers the container color tokens to be used for controls in specified active states.
void	registerMutedContainerTokens(ContainerColorTokens colorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)	Registers muted container color tokens for the specified visual area of a component.
void	registerNeutralContainerTokens(ContainerColorTokens colorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)	Registers neutral container color tokens for the specified visual area of a component.

Methods inherited from class java.lang.Object

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

Field Detail

activeContainerTokens

private final ContainerColorTokens activeContainerTokens

mutedContainerTokens

private final ContainerColorTokens mutedContainerTokens

neutralContainerTokens

private final ContainerColorTokens neutralContainerTokens

systemInfoContainerTokens

private final ContainerColorTokens systemInfoContainerTokens

inverseSystemInfoContainerTokens

private final ContainerColorTokens inverseSystemInfoContainerTokens

systemWarningContainerTokens

private final ContainerColorTokens systemWarningContainerTokens

inverseSystemWarningContainerTokens

private final ContainerColorTokens inverseSystemWarningContainerTokens

systemErrorContainerTokens

private final ContainerColorTokens systemErrorContainerTokens

inverseSystemErrorContainerTokens

private final ContainerColorTokens inverseSystemErrorContainerTokens

systemSuccessContainerTokens

private final ContainerColorTokens systemSuccessContainerTokens

inverseSystemSuccessContainerTokens

private final ContainerColorTokens inverseSystemSuccessContainerTokens

activeTokenOverrides

private final java.util.Map<RadianceThemingSlices.ContainerColorTokensAssociationKind,java.util.Map<ComponentState,ContainerColorTokens>> activeTokenOverrides

Maps from color tokens association kinds to the map of color tokens. Controls in the specific decoration area can use different colors for different active states, for example yellow for rollover and deep orange for pressed. In this case, this map will have an entry with RadianceThemingSlices.ContainerColorTokensAssociationKind.DEFAULT key and a value map with two entries:

• A map entry with key ComponentState.ROLLOVER_UNSELECTED and value that points to the yellow color tokens.
• A map entry with key ComponentState.PRESSED_UNSELECTED and value that points to the deep orange color tokens.

mutedTokenOverrides

private final java.util.Map<RadianceThemingSlices.ContainerColorTokensAssociationKind,ContainerColorTokens> mutedTokenOverrides

neutralTokenOverrides

private final java.util.Map<RadianceThemingSlices.ContainerColorTokensAssociationKind,ContainerColorTokens> neutralTokenOverrides

Constructor Detail

ContainerColorTokensBundle

public ContainerColorTokensBundle(ContainerColorTokens activeContainerTokens,
                                  ContainerColorTokens mutedContainerTokens,
                                  ContainerColorTokens neutralContainerTokens,
                                  boolean isSystemDark)

Creates a new color tokens bundle.

Parameters:

activeContainerTokens - Active color tokens of this bundle.

mutedContainerTokens - Muted color tokens of this bundle.

neutralContainerTokens - Neutral color tokens of this bundle.

isSystemDark - true if the system tokens should be created in dark mode.

Method Detail

registerActiveContainerTokens

public void registerActiveContainerTokens(ContainerColorTokens stateContainerTokens,
                                          ComponentState... activeStates)

Registers container color tokens for the specific active component states.

Parameters:

stateContainerTokens - Container color tokens for the specified active component states.

activeStates - Component states.

See Also:

registerNeutralContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind), registerMutedContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind), registerActiveContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState...), getActiveContainerTokens(), getActiveContainerTokens(ComponentState), getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)

registerActiveContainerTokens

public void registerActiveContainerTokens(ContainerColorTokens colorTokens,
                                          RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind,
                                          ComponentState... activeStates)

Registers the container color tokens to be used for controls in specified active states. For example, if light orange color tokens are to be used for rollover selected and rollover controls in highlights, the parameters would be:

• stateContainerTokens=light orange color tokens
• associationKind=RadianceThemingSlices.ContainerColorTokensAssociationKind.HIGHLIGHT
• states=ComponentState.ROLLOVER_SELECTED, ComponentState.ROLLOVER_UNSELECTED

Parameters:

colorTokens - Container color tokens for the specified active component states.

associationKind - Color tokens association kind that specifies the visual areas of controls to be painted with this color tokens.

activeStates - Component states that further restrict the usage of the specified color tokens.

See Also:

registerNeutralContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind), registerMutedContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind), registerActiveContainerTokens(ContainerColorTokens, ComponentState...), getActiveContainerTokens(), getActiveContainerTokens(ComponentState), getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState)

registerMutedContainerTokens

public void registerMutedContainerTokens(ContainerColorTokens colorTokens,
                                         RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)

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

Parameters:

colorTokens - Muted container color tokens for the specified visual area.

associationKind - Color tokens association kind.

See Also:

registerNeutralContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind), registerActiveContainerTokens(ContainerColorTokens, ComponentState...), registerActiveContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState...), getMutedContainerTokens(), getMutedContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind)

registerNeutralContainerTokens

public void registerNeutralContainerTokens(ContainerColorTokens colorTokens,
                                           RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)

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

Parameters:

colorTokens - Neutral container color tokens for the specified visual area.

associationKind - Color tokens association kind.

See Also:

registerMutedContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind), registerActiveContainerTokens(ContainerColorTokens, ComponentState...), registerActiveContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState...), getNeutralContainerTokens(), getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind)

getActiveContainerTokens

public ContainerColorTokens getActiveContainerTokens(ComponentState componentState)

Returns active container tokens for the specified component state.

Parameters:

componentState - Component state.

Returns:

Active container tokens for the component state.

See Also:

getActiveContainerTokens(), getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState), getNeutralContainerTokens(), getMutedContainerTokens()

getSystemContainerTokens

public ContainerColorTokens getSystemContainerTokens(RadianceThemingSlices.SystemContainerType systemContainerType)

Returns system container tokens.

Parameters:

systemContainerType - System container type.

Returns:

System container tokens.

See Also:

getInverseSystemContainerTokens(RadianceThemingSlices.SystemContainerType)

getInverseSystemContainerTokens

public ContainerColorTokens getInverseSystemContainerTokens(RadianceThemingSlices.SystemContainerType systemContainerType)

Returns inverse system container tokens.

Parameters:

systemContainerType - System container type.

Returns:

Inverse system container tokens.

See Also:

getSystemContainerTokens(RadianceThemingSlices.SystemContainerType)

getActiveContainerTokens

public ContainerColorTokens getActiveContainerTokens()

Returns active container tokens.

Returns:

Active container tokens.

See Also:

getActiveContainerTokens(ComponentState), getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState), getNeutralContainerTokens(), getMutedContainerTokens(), registerActiveContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState...), registerActiveContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState...)

getNeutralContainerTokens

public ContainerColorTokens getNeutralContainerTokens()

Returns neutral container tokens.

Returns:

Neutral container tokens.

See Also:

getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), getActiveContainerTokens(), getMutedContainerTokens(), registerNeutralContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind)

getMutedContainerTokens

public ContainerColorTokens getMutedContainerTokens()

Returns muted container tokens.

Returns:

Muted container tokens.

See Also:

getMutedContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), getActiveContainerTokens(), getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), registerMutedContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind)

getActiveContainerTokensForState

private ContainerColorTokens getActiveContainerTokensForState(ComponentState componentState)

getActiveContainerTokens

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

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

Parameters:

associationKind - Color tokens association kind.

componentState - Component state.

Returns:

Active container tokens.

See Also:

getActiveContainerTokens(), getActiveContainerTokens(ComponentState), getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), getMutedContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), registerActiveContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState...), registerActiveContainerTokens(ContainerColorTokens, ComponentState...)

getMutedContainerTokens

public ContainerColorTokens getMutedContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)

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

Parameters:

associationKind - Color tokens association kind.

Returns:

Muted container tokens.

See Also:

getMutedContainerTokens(), getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState), getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), registerMutedContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind)

getNeutralContainerTokens

public ContainerColorTokens getNeutralContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind associationKind)

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

Parameters:

associationKind - Color tokens association kind.

Returns:

Neutral container tokens.

See Also:

getNeutralContainerTokens(), getActiveContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind, ComponentState), getMutedContainerTokens(RadianceThemingSlices.ContainerColorTokensAssociationKind), registerNeutralContainerTokens(ContainerColorTokens, RadianceThemingSlices.ContainerColorTokensAssociationKind)