theming/org.pushingpixels.aurora.theming.colorscheme/AuroraSkinColors

AuroraSkinColors

Functions

getActiveColorScheme

fun getActiveColorScheme(decorationAreaType: DecorationAreaType): AuroraColorScheme

Returns the main active color scheme for the specific decoration area type. Custom painting code that needs to consult the colors of the specific component should use .getColorScheme method and various AuroraColorScheme methods.

getAlpha

fun getAlpha(decorationAreaType: DecorationAreaType, componentState: ComponentState): Float

Returns the alpha channel of the color scheme.

getBackgroundColorScheme

fun getBackgroundColorScheme(decorationAreaType: DecorationAreaType): AuroraColorScheme

Returns the background color scheme for the specified decoration area type. This method is mainly for the internal use of AuroraDecorationPainter.paintDecorationArea but can be used in applications that wish to provide custom overlay background painting.

getColorScheme

fun getColorScheme(decorationAreaType: DecorationAreaType, componentState: ComponentState): AuroraColorScheme

Returns the color scheme that matches the decoration area type and component state.

fun getColorScheme(decorationAreaType: DecorationAreaType, associationKind: ColorSchemeAssociationKind, componentState: ComponentState): AuroraColorScheme

Returns the color scheme to be used for painting the specified visual area of components in the specified decoration area.

getDirectColorScheme

fun getDirectColorScheme(decorationAreaType: DecorationAreaType, associationKind: ColorSchemeAssociationKind, componentState: ComponentState): AuroraColorScheme?

Returns the color scheme to be used for painting the specified visual area of components in the specified decoration area.

getDisabledColorScheme

fun getDisabledColorScheme(decorationAreaType: DecorationAreaType): AuroraColorScheme

Returns the main disabled color scheme for the specific decoration area type. Custom painting code that needs to consult the colors of the specific component should use .getColorScheme method and various AuroraColorScheme methods.

getEnabledColorScheme

fun getEnabledColorScheme(decorationAreaType: DecorationAreaType): AuroraColorScheme

Returns the main enabled color scheme for the specific decoration area type. Custom painting code that needs to consult the colors of the specific component should use .getColorScheme method and various AuroraColorScheme methods.

getHighlightAlpha

fun getHighlightAlpha(decorationAreaType: DecorationAreaType, componentState: ComponentState): Float

Returns the alpha channel of the highlight color scheme.

isRegisteredAsDecorationArea

fun isRegisteredAsDecorationArea(decorationType: DecorationAreaType?): Boolean

Returns indication whether the specified decoration area type should have their background painted by AuroraDecorationPainter.paintDecorationArea instead of a simple background fill.

registerAsDecorationArea

fun registerAsDecorationArea(backgroundColorScheme: AuroraColorScheme, vararg areaTypes: DecorationAreaType)

Registers the specified background color scheme to be used on controls in decoration areas.

fun registerAsDecorationArea(backgroundColorScheme: AuroraColorScheme, noneTransformationOverlay: (AuroraColorSchemeBundle) -> Unit, vararg areaTypes: DecorationAreaType)

Registers the specified background color scheme and a color scheme bundle overlay to be used on controls in decoration areas.

registerDecorationAreaSchemeBundle

fun registerDecorationAreaSchemeBundle(bundle: AuroraColorSchemeBundle, vararg areaTypes: DecorationAreaType)

Registers the specified color scheme bundle to be used on controls in decoration areas.

fun registerDecorationAreaSchemeBundle(bundle: AuroraColorSchemeBundle, backgroundColorScheme: AuroraColorScheme, vararg areaTypes: DecorationAreaType)

Registers the specified color scheme bundle and background color scheme to be used on controls in decoration areas.