Package org.pushingpixels.substance.api
Class SubstanceColorSchemeBundle
java.lang.Object
org.pushingpixels.substance.api.SubstanceColorSchemeBundle
Color scheme bundle. Defines the visual appearance of a single decoration
area of a skin.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected SubstanceColorScheme
The active color scheme of this bundle.protected Map<ColorSchemeAssociationKind,
Map<ComponentState, ComponentState>> Maps from color scheme association kinds to the map of color schemes.protected SubstanceColorScheme
The disabled color scheme of this bundle.protected SubstanceColorScheme
If there is no explicitly registered color scheme for the disabled selected component state, this field will contain a synthesized color scheme for the disabled selected state.protected SubstanceColorScheme
The enabled color scheme of this bundle.protected SubstanceColorScheme
If there is no explicitly registered color scheme for pressed component state, this field will contain a synthesized color scheme for a pressed state.protected SubstanceColorScheme
If there is no explicitly registered color scheme for the rollover selected component state, this field will contain a synthesized color scheme for the rollover selected state.protected SubstanceColorScheme
If there is no explicitly registered color scheme for the selected component state, this field will contain a synthesized color scheme for the selected state.protected Map<ComponentState,
Float> Maps from component state to the alpha channel applied on color scheme.protected Map<ComponentState,
Float> Maps from component state to the alpha channel applied on highlight color scheme. -
Constructor Summary
ConstructorsConstructorDescriptionSubstanceColorSchemeBundle
(SubstanceColorScheme activeColorScheme, SubstanceColorScheme enabledColorScheme, SubstanceColorScheme disabledColorScheme) Creates a new color scheme bundle. -
Method Summary
Modifier and TypeMethodDescriptionReturns the active color scheme of this bundle.float
getAlpha
(Component comp, ComponentState componentState) Returns the alpha channel of the color scheme of the component.getColorScheme
(ColorSchemeAssociationKind associationKind, ComponentState componentState) Returns the color scheme to be used for painting the specified visual area of the component under the specified component state.getColorScheme
(ComponentState componentState) Returns the color scheme of the specified component in the specified component state.Returns the disabled color scheme of this bundle.Returns the enabled color scheme of this bundle.float
getHighlightAlpha
(Component comp, ComponentState componentState) Returns the alpha channel of the highlight color scheme of the component.void
registerColorScheme
(SubstanceColorScheme stateColorScheme, float alpha, ComponentState... states) Registers a color scheme for the specific component state.void
registerColorScheme
(SubstanceColorScheme scheme, ColorSchemeAssociationKind associationKind, ComponentState... states) Registers the color scheme to be used for the specified visual area of controls under the specified states.void
registerColorScheme
(SubstanceColorScheme stateColorScheme, ComponentState... states) Registers a color scheme for the specific component state.void
registerHighlightColorScheme
(SubstanceColorScheme highlightScheme, float alpha, ComponentState... states) Registers a highlight color scheme for the specific component state if the component state is notnull
, or a global highlight color scheme otherwise.void
registerHighlightColorScheme
(SubstanceColorScheme stateHighlightScheme, ComponentState... states) Registers a highlight color scheme for the specific component state if the component state is notnull
, or a global highlight color scheme otherwise.
-
Field Details
-
activeColorScheme
The active color scheme of this bundle. -
enabledColorScheme
The enabled color scheme of this bundle. -
disabledColorScheme
The disabled color scheme of this bundle. -
stateAlphaMap
Maps from component state to the alpha channel applied on color scheme. This map doesn't have to contain entries for allComponentState
instances. -
stateHighlightSchemeAlphaMap
Maps from component state to the alpha channel applied on highlight color scheme. This map doesn't have to contain entries for allComponentState
instances. -
pressedScheme
If there is no explicitly registered color scheme for pressed component state, this field will contain a synthesized color scheme for a pressed state. -
disabledSelectedScheme
If there is no explicitly registered color scheme for the disabled selected component state, this field will contain a synthesized color scheme for the disabled selected state. -
selectedScheme
If there is no explicitly registered color scheme for the selected component state, this field will contain a synthesized color scheme for the selected state. -
rolloverSelectedScheme
If there is no explicitly registered color scheme for the rollover selected component state, this field will contain a synthesized color scheme for the rollover selected state. -
colorSchemeMap
Maps from color scheme association kinds to the map of color schemes. Different visual parts of controls in the specific decoration are can be painted with different color schemes. For example, a rollover button can use a light orange scheme for the gradient fill and a dark gray scheme for the border. In this case, this map will have:- An entry with key
ColorSchemeAssociationKind.FILL
. This entry has a map entry with keyComponentState.SELECTED
and value that points to the light orange scheme. - An entry with key
ColorSchemeAssociationKind.BORDER
. This entry has a map entry with keyComponentState.SELECTED
and value that points to the dark gray scheme.
- An entry with key
-
bestFillMap
-
-
Constructor Details
-
SubstanceColorSchemeBundle
public SubstanceColorSchemeBundle(SubstanceColorScheme activeColorScheme, SubstanceColorScheme enabledColorScheme, SubstanceColorScheme disabledColorScheme) Creates a new color scheme bundle.- Parameters:
activeColorScheme
- The active color scheme of this bundle.enabledColorScheme
- The enabled color scheme of this bundle.disabledColorScheme
- The disabled color scheme of this bundle.
-
-
Method Details
-
registerColorScheme
public void registerColorScheme(SubstanceColorScheme stateColorScheme, float alpha, ComponentState... states) Registers a color scheme for the specific component state.- Parameters:
stateColorScheme
- Color scheme for the specified component state.alpha
- Alpha channel for the color scheme.states
- Component states.
-
registerColorScheme
Registers a color scheme for the specific component state.- Parameters:
stateColorScheme
- Color scheme for the specified component state.states
- Component states.
-
registerHighlightColorScheme
public void registerHighlightColorScheme(SubstanceColorScheme stateHighlightScheme, ComponentState... states) Registers a highlight color scheme for the specific component state if the component state is notnull
, or a global highlight color scheme otherwise.- Parameters:
stateHighlightScheme
- Highlight color scheme for the specified component state.states
- Component states. Ifnull
, the specified color scheme will be applied for all states left unspecified.
-
registerHighlightColorScheme
public void registerHighlightColorScheme(SubstanceColorScheme highlightScheme, float alpha, ComponentState... states) Registers a highlight color scheme for the specific component state if the component state is notnull
, or a global highlight color scheme otherwise.- Parameters:
highlightScheme
- Highlight color scheme for the specified component states.alpha
- Alpha channel for the highlight color scheme.states
- Component states. Ifnull
, the specified color scheme will be applied for all states left unspecified.
-
getColorScheme
Returns the color scheme of the specified component in the specified component state.- Parameters:
componentState
- Component state.- Returns:
- The color scheme of the component in the specified component state.
-
getHighlightAlpha
Returns the alpha channel of the highlight color scheme of the component.- Parameters:
comp
- Component.componentState
- Component state.- Returns:
- Highlight color scheme alpha channel.
-
getAlpha
Returns the alpha channel of the color scheme of the component.- Parameters:
comp
- Component.componentState
- Component state.- Returns:
- Color scheme alpha channel.
-
getActiveColorScheme
Returns the active color scheme of this bundle.- Returns:
- The active color scheme of this bundle.
-
getEnabledColorScheme
Returns the enabled color scheme of this bundle.- Returns:
- The enabled color scheme of this bundle.
-
getDisabledColorScheme
Returns the disabled color scheme of this bundle.- Returns:
- The disabled color scheme of this bundle.
-
registerColorScheme
public void registerColorScheme(SubstanceColorScheme scheme, ColorSchemeAssociationKind associationKind, ComponentState... states) Registers the color scheme to be used for the specified visual area of controls under the specified states. For example, if the light orange scheme has to be used for gradient fill of rollover selected and rollover controls, the parameters would be:scheme
=light orange scheme-
associationKind
=ColorSchemeAssociationKind.FILL
-
states
=ComponentState.ROLLOVER_SELECTED
,ComponentState.ROLLOVER_UNSELECTED
- Parameters:
scheme
- Color scheme.associationKind
- Color scheme association kind that specifies the visual areas of controls to be painted with this color scheme.states
- Component states that further restrict the usage of the specified color scheme.- Since:
- version 5.1
-
getColorScheme
public SubstanceColorScheme getColorScheme(ColorSchemeAssociationKind associationKind, ComponentState componentState) Returns the color scheme to be used for painting the specified visual area of the component under the specified component state.- Parameters:
associationKind
- Color scheme association kind.componentState
- Component state.- Returns:
- Color scheme to be used for painting the specified visual area of the component under the specified component state.
- Since:
- version 5.1
- See Also:
-