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

AuroraColorSchemeBundle

class AuroraColorSchemeBundle(activeColorScheme: AuroraColorScheme, enabledColorScheme: AuroraColorScheme, disabledColorScheme: AuroraColorScheme)
Content copied to clipboard

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

Author

Kirill Grouchnikov

See also

Constructors

Link copied to clipboard
fun AuroraColorSchemeBundle(activeColorScheme: AuroraColorScheme, enabledColorScheme: AuroraColorScheme, disabledColorScheme: AuroraColorScheme)
Content copied to clipboard

Functions

Link copied to clipboard
fun getActiveColorScheme(): AuroraColorScheme
Content copied to clipboard

Returns the active color scheme of this bundle.

Link copied to clipboard
fun getAlpha(componentState: ComponentState): Float
Content copied to clipboard

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

Link copied to clipboard
fun getColorScheme(componentState: ComponentState): AuroraColorScheme
Content copied to clipboard

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

fun getColorScheme(associationKind: ColorSchemeAssociationKind, componentState: ComponentState, allowFallback: Boolean): AuroraColorScheme?
Content copied to clipboard

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

Link copied to clipboard
fun getDisabledColorScheme(): AuroraColorScheme
Content copied to clipboard

Returns the disabled color scheme of this bundle.

Link copied to clipboard
fun getEnabledColorScheme(): AuroraColorScheme
Content copied to clipboard

Returns the enabled color scheme of this bundle.

Link copied to clipboard
fun getHighlightAlpha(componentState: ComponentState): Float
Content copied to clipboard

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

Link copied to clipboard
fun getStatesWithAlpha(): Set<ComponentState>
Content copied to clipboard

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.

Link copied to clipboard
fun registerAlpha(alpha: Float, vararg states: ComponentState)
Content copied to clipboard

Registers an alpha channel value for the specific component states.

Link copied to clipboard
fun registerColorScheme(scheme: AuroraColorScheme, associationKind: ColorSchemeAssociationKind = ColorSchemeAssociationKind.Fill, vararg states: ComponentState)
Content copied to clipboard

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:

Link copied to clipboard
fun registerHighlightAlpha(alpha: Float, vararg states: ComponentState)
Content copied to clipboard

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

Link copied to clipboard
fun registerHighlightColorScheme(stateHighlightScheme: AuroraColorScheme, vararg states: ComponentState)
Content copied to clipboard

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

Link copied to clipboard
fun transform(transform: (AuroraColorScheme) -> AuroraColorScheme): AuroraColorSchemeBundle
Content copied to clipboard

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