1.12.0+1.0.31-sesl8+rev1

SESL Material/com.google.android.material.checkbox/MaterialCheckBox

MaterialCheckBox

open class MaterialCheckBox : AppCompatCheckBox

A class that creates a Material Themed CheckBox.

This class uses attributes from the Material Theme to style a CheckBox. It behaves similarly to AppCompatCheckBox, but with color changes and the support of the indeterminate state, and an independent error state.

The checkbox is composed of an app:buttonCompat button drawable (the squared icon) and an app:buttonIcon icon drawable (the checkmark icon) layered on top of it. Their colors can be customized via app:buttonTint and app:buttonIconTint respectively.

If setting a custom app:buttonCompat, make sure to also set app:buttonIcon if an icon is desired. The checkbox does not support having a custom app:buttonCompat and preserving the default app:buttonIcon checkmark at the same time.

For more information, see the component developer guidance and design guidelines.

Constructors

MaterialCheckBox

constructor(context: Context)

constructor(context: Context, @Nullable attrs: AttributeSet)

constructor(context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

Types

@RestrictTo(value = LIBRARY_GROUP)

@Retention(value = RetentionPolicy.SOURCE)

annotation class CheckedState

Values for the state of the checkbox.

OnCheckedStateChangedListener

interface OnCheckedStateChangedListener

Callback interface invoked when one of three independent checkbox states change.

OnErrorChangedListener

interface OnErrorChangedListener

Callback interface invoked when the checkbox error state changes.

Properties

open var buttonDrawable: Drawable

buttonIconDrawable

open var buttonIconDrawable: Drawable

buttonIconTintList

open var buttonIconTintList: ColorStateList

buttonIconTintMode

open var buttonIconTintMode: PorterDuff.Mode

open var buttonTintList: ColorStateList

open var checkedState: Int

errorAccessibilityLabel

open var errorAccessibilityLabel: CharSequence

val STATE_CHECKED: Int = 1

The checked state of the checkbox.

STATE_INDETERMINATE

val STATE_INDETERMINATE: Int = 2

The indeterminate state of the checkbox.

STATE_UNCHECKED

val STATE_UNCHECKED: Int = 0

The unchecked state of the checkbox.

Functions

addOnCheckedStateChangedListener

open fun addOnCheckedStateChangedListener(@NonNull listener: MaterialCheckBox.OnCheckedStateChangedListener)

Adds a OnCheckedStateChangedListener that will be invoked when the checkbox state changes.

addOnErrorChangedListener

open fun addOnErrorChangedListener(@NonNull listener: MaterialCheckBox.OnErrorChangedListener)

Adds a OnErrorChangedListener that will be invoked when the checkbox error state changes.

clearOnCheckedStateChangedListeners

open fun clearOnCheckedStateChangedListeners()

Removes all previously added OnCheckedStateChangedListeners.

clearOnErrorChangedListeners

open fun clearOnErrorChangedListeners()

Remove all previously added OnErrorChangedListeners.

isCenterIfNoTextEnabled

open fun isCenterIfNoTextEnabled(): Boolean

Returns true if this MaterialCheckBox will center the checkbox icon when there is no text.

open fun isChecked(): Boolean

open fun isErrorShown(): Boolean

Returns whether the checkbox is on error state.

isUseMaterialThemeColors

open fun isUseMaterialThemeColors(): Boolean

Returns true if this MaterialCheckBox defaults to colors from a Material Theme.

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(@Nullable info: AccessibilityNodeInfo)

onRestoreInstanceState

open fun onRestoreInstanceState(@Nullable state: Parcelable)

onSaveInstanceState

open fun onSaveInstanceState(): Parcelable

removeOnCheckedStateChangedListener

open fun removeOnCheckedStateChangedListener(@NonNull listener: MaterialCheckBox.OnCheckedStateChangedListener)

Removes a listener that was previously added via addOnCheckedStateChangedListener

removeOnErrorChangedListener

open fun removeOnErrorChangedListener(@NonNull listener: MaterialCheckBox.OnErrorChangedListener)

Remove a listener that was previously added via addOnErrorChangedListener

setButtonDrawable

open fun setButtonDrawable(@DrawableRes resId: Int)

setButtonIconDrawableResource

open fun setButtonIconDrawableResource(@DrawableRes resId: Int)

Sets the button icon drawable of the checkbox.

setButtonTintMode

open fun setButtonTintMode(@Nullable tintMode: PorterDuff.Mode)

setCenterIfNoTextEnabled

open fun setCenterIfNoTextEnabled(centerIfNoTextEnabled: Boolean)

Sets whether this MaterialCheckBox should center the checkbox icon when there is no text.

open fun setChecked(checked: Boolean)

open fun setEnabled(enabled: Boolean)

setErrorAccessibilityLabelResource

open fun setErrorAccessibilityLabelResource(@StringRes resId: Int)

Sets the accessibility label to be used for the error state announcement by screen readers.

open fun setErrorShown(errorShown: Boolean)

Sets whether the checkbox should be on error state.

setOnCheckedChangeListener

open fun setOnCheckedChangeListener(@Nullable listener: CompoundButton.OnCheckedChangeListener)

setStateDescription

@RequiresApi(value = VERSION_CODES.R)

open fun setStateDescription(@Nullable stateDescription: CharSequence)

setUseMaterialThemeColors

open fun setUseMaterialThemeColors(useMaterialThemeColors: Boolean)

Forces the MaterialCheckBox to use colors from a Material Theme.

open fun toggle()