Class RadianceColorSchemeBundle

java.lang.Object
org.pushingpixels.radiance.theming.api.RadianceColorSchemeBundle

public class RadianceColorSchemeBundle extends Object
Color scheme bundle. Defines the visual appearance of a single decoration area of a skin.
See Also:
  • Field Details

  • Constructor Details

    • RadianceColorSchemeBundle

      public RadianceColorSchemeBundle(RadianceColorScheme activeColorScheme, RadianceColorScheme enabledColorScheme, RadianceColorScheme 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

    • registerAlpha

      public void registerAlpha(float alpha, ComponentState... states)
      Registers an alpha channel value for the specific component states.
      Parameters:
      alpha - Alpha channel value.
      states - Component states.
    • registerColorScheme

      public void registerColorScheme(RadianceColorScheme stateColorScheme, ComponentState... states)
      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(RadianceColorScheme stateHighlightScheme, ComponentState... states)
      Registers a highlight color scheme for the specific component state if the component state is not null, or a global highlight color scheme otherwise.
      Parameters:
      stateHighlightScheme - Highlight color scheme for the specified component state.
      states - Component states. If null, the specified color scheme will be applied for all states left unspecified.
    • registerHighlightAlpha

      public void registerHighlightAlpha(float alpha, ComponentState... states)
      Registers a highlight alpha channel value for the specific component states.
      Parameters:
      alpha - Highlight alpha channel value.
      states - Component states.
    • getColorScheme

      public RadianceColorScheme getColorScheme(ComponentState componentState)
      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.
    • hasHighlightAlphaFor

      public boolean hasHighlightAlphaFor(ComponentState componentState)
    • getHighlightAlpha

      public float getHighlightAlpha(ComponentState componentState)
      Returns the alpha channel of the highlight color schemes for the specified component state. Before calling this API, call hasHighlightAlphaFor(ComponentState). This API returns 1.0f for states that do not have an explicitly registered alpha channel value.
      Parameters:
      componentState - Component state.
      Returns:
      Highlight color scheme alpha channel.
    • hasAlphaFor

      public boolean hasAlphaFor(ComponentState componentState)
    • getAlpha

      public float getAlpha(ComponentState componentState)
      Returns the alpha channel of color schemes for the specified component state. Before calling this API, call hasAlphaFor(ComponentState). This API returns 1.0f for states that do not have an explicitly registered alpha channel value.
      Parameters:
      componentState - Component state.
      Returns:
      Color scheme alpha channel.
    • getActiveColorScheme

      public RadianceColorScheme getActiveColorScheme()
      Returns the active color scheme of this bundle.
      Returns:
      The active color scheme of this bundle.
    • getEnabledColorScheme

      public RadianceColorScheme getEnabledColorScheme()
      Returns the enabled color scheme of this bundle.
      Returns:
      The enabled color scheme of this bundle.
    • getDisabledColorScheme

      public RadianceColorScheme getDisabledColorScheme()
      Returns the disabled color scheme of this bundle.
      Returns:
      The disabled color scheme of this bundle.
    • registerColorScheme

      public void registerColorScheme(RadianceColorScheme scheme, RadianceThemingSlices.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 for rollover selected and rollover controls, the parameters would be:
      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.
    • getColorScheme

      public RadianceColorScheme getColorScheme(RadianceThemingSlices.ColorSchemeAssociationKind associationKind, ComponentState componentState, boolean allowFallback)
      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.
      allowFallback - If true, this method will return a color scheme for the fallback association kind.
      Returns:
      Color scheme to be used for painting the specified visual area of the component under the specified component state.
      See Also:
    • transform

      Creates a new color scheme bundle that has the same settings as this color scheme bundle with the addition of applying the specified color scheme transformation on all the relevant color schemes
      Parameters:
      transform - Color scheme transformation.
      Returns:
      The new color scheme bundle.
    • getStatesWithAlpha

      Set<ComponentState> getStatesWithAlpha()
      Returns the set of all component states that have non-trivial alpha associated with them. Non-trivial alpha is a value that is strictly less than 1.0.
      Returns:
      All component states that have associated non-trivial alpha values.