theming/org.pushingpixels.aurora.theming.colorscheme/AuroraColorSchemeBundle

AuroraColorSchemeBundle

class AuroraColorSchemeBundle(activeColorScheme: AuroraColorScheme, enabledColorScheme: AuroraColorScheme, disabledColorScheme: AuroraColorScheme)

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

Author

Kirill Grouchnikov

Constructors

AuroraColorSchemeBundle

fun AuroraColorSchemeBundle(activeColorScheme: AuroraColorScheme, enabledColorScheme: AuroraColorScheme, disabledColorScheme: AuroraColorScheme)

Functions

getActiveColorScheme

fun getActiveColorScheme(): AuroraColorScheme

Returns the active color scheme of this bundle.

getAlpha

fun getAlpha(componentState: ComponentState): Float

Returns the alpha channel of color schemes for the specified component state.

getColorScheme

fun getColorScheme(componentState: ComponentState): AuroraColorScheme

Returns the color scheme of the specified component in the specified component state.

fun getColorScheme(associationKind: ColorSchemeAssociationKind, componentState: ComponentState, allowFallback: Boolean): AuroraColorScheme?

Returns the color scheme to be used for painting the specified visual area of the component under the specified component state.

getDisabledColorScheme

fun getDisabledColorScheme(): AuroraColorScheme

Returns the disabled color scheme of this bundle.

getEnabledColorScheme

fun getEnabledColorScheme(): AuroraColorScheme

Returns the enabled color scheme of this bundle.

getHighlightAlpha

fun getHighlightAlpha(componentState: ComponentState): Float

Returns the alpha channel of the highlight color schemes for the specified component state.

getStatesWithAlpha

fun getStatesWithAlpha(): Set<ComponentState>

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.

registerAlpha

fun registerAlpha(alpha: Float, vararg states: ComponentState)

Registers an alpha channel value for the specific component states.

registerColorScheme

fun registerColorScheme(scheme: AuroraColorScheme, associationKind: ColorSchemeAssociationKind = ColorSchemeAssociationKind.Fill, vararg states: ComponentState)

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:

registerHighlightAlpha

fun registerHighlightAlpha(alpha: Float, vararg states: ComponentState)

Registers a highlight alpha channel value for the specific component states.

registerHighlightColorScheme

fun registerHighlightColorScheme(stateHighlightScheme: AuroraColorScheme, vararg states: ComponentState)

Registers a highlight color scheme for the specific component state if the component state is not null, or a global highlight color scheme otherwise.

transform

fun transform(transform: (AuroraColorScheme) -> AuroraColorScheme): AuroraColorSchemeBundle

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

AuroraColorSchemeBundle

Author

See also

Constructors

Functions