CheckboxColors


Represents the colors used by the three different sections (checkmark, box, and border) of a Checkbox or TriStateCheckbox in different states.

Summary

Public constructors

CheckboxColors(
    checkedCheckmarkColor: Color,
    uncheckedCheckmarkColor: Color,
    checkedBoxColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedBoxColor: Color,
    disabledUncheckedBoxColor: Color,
    disabledIndeterminateBoxColor: Color,
    checkedBorderColor: Color,
    uncheckedBorderColor: Color,
    disabledBorderColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledIndeterminateBorderColor: Color
)

create an instance with arbitrary colors, see CheckboxDefaults.colors for the default implementation that follows Material specifications.

Cmn

Public functions

CheckboxColors
copy(
    checkedCheckmarkColor: Color,
    uncheckedCheckmarkColor: Color,
    checkedBoxColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedBoxColor: Color,
    disabledUncheckedBoxColor: Color,
    disabledIndeterminateBoxColor: Color,
    checkedBorderColor: Color,
    uncheckedBorderColor: Color,
    disabledBorderColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledIndeterminateBorderColor: Color
)

Returns a copy of this CheckboxColors, optionally overriding some of the values.

Cmn
open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn

Public properties

Color

color that will be used for the border when checked

Cmn
Color

the color that will be used for the box when checked

Cmn
Color

color that will be used for the checkmark when checked

Cmn
Color

color that will be used for the border when disabled and checked

Cmn
Color

color that will be used for the box when disabled and checked

Cmn
Color

color that will be used for the border when disabled and in an ToggleableState.Indeterminate state.

Cmn
Color

color that will be used for the box and border in a TriStateCheckbox when disabled AND in an ToggleableState.Indeterminate state.

Cmn
Color

color that will be used for the border when disabled and unchecked

Cmn
Color

color that will be used for the box when disabled and unchecked

Cmn
Color

color that will be used for the border when unchecked

Cmn
Color

color that will be used for the box when unchecked

Cmn
Color

color that will be used for the checkmark when unchecked

Cmn

Public constructors

CheckboxColors

CheckboxColors(
    checkedCheckmarkColor: Color,
    uncheckedCheckmarkColor: Color,
    checkedBoxColor: Color,
    uncheckedBoxColor: Color,
    disabledCheckedBoxColor: Color,
    disabledUncheckedBoxColor: Color,
    disabledIndeterminateBoxColor: Color,
    checkedBorderColor: Color,
    uncheckedBorderColor: Color,
    disabledBorderColor: Color,
    disabledUncheckedBorderColor: Color,
    disabledIndeterminateBorderColor: Color
)

create an instance with arbitrary colors, see CheckboxDefaults.colors for the default implementation that follows Material specifications.

Parameters
checkedCheckmarkColor: Color

color that will be used for the checkmark when checked

uncheckedCheckmarkColor: Color

color that will be used for the checkmark when unchecked

checkedBoxColor: Color

the color that will be used for the box when checked

uncheckedBoxColor: Color

color that will be used for the box when unchecked

disabledCheckedBoxColor: Color

color that will be used for the box when disabled and checked

disabledUncheckedBoxColor: Color

color that will be used for the box when disabled and unchecked

disabledIndeterminateBoxColor: Color

color that will be used for the box and border in a TriStateCheckbox when disabled AND in an ToggleableState.Indeterminate state.

checkedBorderColor: Color

color that will be used for the border when checked

uncheckedBorderColor: Color

color that will be used for the border when unchecked

disabledBorderColor: Color

color that will be used for the border when disabled and checked

disabledUncheckedBorderColor: Color

color that will be used for the border when disabled and unchecked

disabledIndeterminateBorderColor: Color

color that will be used for the border when disabled and in an ToggleableState.Indeterminate state.

Public functions

copy

fun copy(
    checkedCheckmarkColor: Color = this.checkedCheckmarkColor,
    uncheckedCheckmarkColor: Color = this.uncheckedCheckmarkColor,
    checkedBoxColor: Color = this.checkedBoxColor,
    uncheckedBoxColor: Color = this.uncheckedBoxColor,
    disabledCheckedBoxColor: Color = this.disabledCheckedBoxColor,
    disabledUncheckedBoxColor: Color = this.disabledUncheckedBoxColor,
    disabledIndeterminateBoxColor: Color = this.disabledIndeterminateBoxColor,
    checkedBorderColor: Color = this.checkedBorderColor,
    uncheckedBorderColor: Color = this.uncheckedBorderColor,
    disabledBorderColor: Color = this.disabledBorderColor,
    disabledUncheckedBorderColor: Color = this.disabledUncheckedBorderColor,
    disabledIndeterminateBorderColor: Color = this.disabledIndeterminateBorderColor
): CheckboxColors

Returns a copy of this CheckboxColors, optionally overriding some of the values. This uses the Color.Unspecified to mean “use the value from the source”

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

checkedBorderColor

val checkedBorderColorColor

color that will be used for the border when checked

checkedBoxColor

val checkedBoxColorColor

the color that will be used for the box when checked

checkedCheckmarkColor

val checkedCheckmarkColorColor

color that will be used for the checkmark when checked

disabledBorderColor

val disabledBorderColorColor

color that will be used for the border when disabled and checked

disabledCheckedBoxColor

val disabledCheckedBoxColorColor

color that will be used for the box when disabled and checked

disabledIndeterminateBorderColor

val disabledIndeterminateBorderColorColor

color that will be used for the border when disabled and in an ToggleableState.Indeterminate state.

disabledIndeterminateBoxColor

val disabledIndeterminateBoxColorColor

color that will be used for the box and border in a TriStateCheckbox when disabled AND in an ToggleableState.Indeterminate state.

disabledUncheckedBorderColor

val disabledUncheckedBorderColorColor

color that will be used for the border when disabled and unchecked

disabledUncheckedBoxColor

val disabledUncheckedBoxColorColor

color that will be used for the box when disabled and unchecked

uncheckedBorderColor

val uncheckedBorderColorColor

color that will be used for the border when unchecked

uncheckedBoxColor

val uncheckedBoxColorColor

color that will be used for the box when unchecked

uncheckedCheckmarkColor

val uncheckedCheckmarkColorColor

color that will be used for the checkmark when unchecked