SwitchCompat

Kotlin |Java

open class SwitchCompat : CompoundButton

kotlin.Any
↳	android.view.View
	↳	android.widget.TextView
		↳	android.widget.Button
			↳	android.widget.CompoundButton
				↳	androidx.appcompat.widget.SwitchCompat

SwitchCompat is a complete backport of the core android.widget.Switch widget that brings the visuals and the functionality of that widget to older versions of the platform. Unlike other widgets in this package, SwitchCompat is not automatically used in layouts that use the <Switch> element. Instead, you need to explicitly use <androidx.appcompat.widget.SwitchCompat> and the matching attributes in your layouts.

A Switch is a two-state toggle switch widget that can be used to select one of the two available options. The user may drag the "thumb" back and forth to choose the selected option, or simply tap to toggle as if it were a checkbox. The text property controls the text displayed in the label for the switch, whereas the off and on text controls the text on the thumb. Similarly, the textAppearance and the related setTypeface() methods control the typeface and style of label text, whereas the switchTextAppearance and the related setSwitchTypeface() methods control that of the thumb.

The thumb can be tinted with setThumbTintList(ColorStateList) and setThumbTintMode(PorterDuff.Mode) APIs, as well as with the matching XML attributes. The track can be tinted with setTrackTintList(ColorStateList) and setTrackTintMode(PorterDuff.Mode) APIs, as well as with the matching XML attributes.

See the Toggle Buttons guide.

android.R.attr#textOn android.R.attr#textOff androidx.appcompat.R.attr#switchMinWidth androidx.appcompat.R.attr#switchPadding androidx.appcompat.R.attr#switchTextAppearance android.R.attr#thumb androidx.appcompat.R.attr#thumbTextPadding androidx.appcompat.R.attr#track androidx.appcompat.R.attr#thumbTint androidx.appcompat.R.attr#thumbTintMode androidx.appcompat.R.attr#trackTint androidx.appcompat.R.attr#trackTintMode

Summary

Public constructors
<init>(@NonNull context: Context) Construct a new Switch with default styling.
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?) Construct a new Switch with default styling, overriding specific style attributes as requested.
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?, defStyleAttr: Int) Construct a new Switch with a default style determined by the given theme attribute, overriding specific style attributes as requested.

Public methods
open Unit	draw(c: Canvas!)
open Unit	drawableHotspotChanged(x: Float, y: Float)
open Int	getCompoundPaddingLeft()
open Int	getCompoundPaddingRight()
open Boolean	getShowText()
open Boolean	getSplitTrack() Returns whether the track should be split by the thumb.
open Int	getSwitchMinWidth() Get the minimum width of the switch in pixels.
open Int	getSwitchPadding() Get the amount of horizontal padding between the switch and the associated text.
open CharSequence!	getTextOff() Returns the text displayed when the button is not in the checked state.
open CharSequence!	getTextOn() Returns the text displayed when the button is in the checked state.
open Drawable!	getThumbDrawable() Get the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
open Int	getThumbTextPadding() Get the horizontal padding around the text drawn on the switch itself.
open ColorStateList?	getThumbTintList()
open Mode?	getThumbTintMode()
open Drawable!	getTrackDrawable() Get the drawable used for the track that the switch slides within.
open ColorStateList?	getTrackTintList()
open Mode?	getTrackTintMode()
open Unit	jumpDrawablesToCurrentState()
open Unit	onInitializeAccessibilityEvent(event: AccessibilityEvent!)
open Unit	onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo!)
open Unit	onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int)
open Unit	onPopulateAccessibilityEvent(event: AccessibilityEvent!)
open Boolean	onTouchEvent(ev: MotionEvent!)
open Unit	setChecked(checked: Boolean)
open Unit	setCustomSelectionActionModeCallback(actionModeCallback: Callback!) See TextViewCompat#setCustomSelectionActionModeCallback(TextView, ActionMode.Callback)
open Unit	setShowText(showText: Boolean) Sets whether the on/off text should be displayed.
open Unit	setSplitTrack(splitTrack: Boolean) Specifies whether the track should be split by the thumb.
open Unit	setSwitchMinWidth(pixels: Int) Set the minimum width of the switch in pixels.
open Unit	setSwitchPadding(pixels: Int) Set the amount of horizontal padding between the switch and the associated text.
open Unit	setSwitchTextAppearance(context: Context!, resid: Int) Sets the switch text color, size, style, hint color, and highlight color from the specified TextAppearance resource.
open Unit	setSwitchTypeface(tf: Typeface!, style: Int) Sets the typeface and style in which the text should be displayed on the switch, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
open Unit	setSwitchTypeface(typeface: Typeface!) Sets the typeface in which the text should be displayed on the switch.
open Unit	setTextOff(textOff: CharSequence!) Sets the text displayed when the button is not in the checked state.
open Unit	setTextOn(textOn: CharSequence!) Sets the text displayed when the button is in the checked state.
open Unit	setThumbDrawable(thumb: Drawable!) Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
open Unit	setThumbResource(resId: Int) Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
open Unit	setThumbTextPadding(pixels: Int) Set the horizontal padding around the text drawn on the switch itself.
open Unit	setThumbTintList(@Nullable tint: ColorStateList?) Applies a tint to the thumb drawable.
open Unit	setThumbTintMode(@Nullable tintMode: Mode?) Specifies the blending mode used to apply the tint specified by setThumbTintList(ColorStateList)} to the thumb drawable.
open Unit	setTrackDrawable(track: Drawable!) Set the drawable used for the track that the switch slides within.
open Unit	setTrackResource(resId: Int) Set the drawable used for the track that the switch slides within.
open Unit	setTrackTintList(@Nullable tint: ColorStateList?) Applies a tint to the track drawable.
open Unit	setTrackTintMode(@Nullable tintMode: Mode?) Specifies the blending mode used to apply the tint specified by setTrackTintList(ColorStateList)} to the track drawable.
open Unit	toggle()

Protected methods
open Unit	drawableStateChanged()
open IntArray!	onCreateDrawableState(extraSpace: Int)
open Unit	onDraw(canvas: Canvas!)
open Unit	onLayout(changed: Boolean, left: Int, top: Int, right: Int, bottom: Int)
open Boolean	verifyDrawable(who: Drawable)

Public constructors

<init>

SwitchCompat(@NonNull context: Context)

Construct a new Switch with default styling.

Parameters
context	Context: The Context that will determine this widget's theming.

<init>

SwitchCompat(
    @NonNull context: Context, 
    @Nullable attrs: AttributeSet?)

Construct a new Switch with default styling, overriding specific style attributes as requested.

Parameters
context	Context: The Context that will determine this widget's theming.
attrs	AttributeSet?: Specification of attributes that should deviate from default styling.

<init>

SwitchCompat(
    @NonNull context: Context, 
    @Nullable attrs: AttributeSet?, 
    defStyleAttr: Int)

Construct a new Switch with a default style determined by the given theme attribute, overriding specific style attributes as requested.

Parameters
context	Context: The Context that will determine this widget's theming.
attrs	AttributeSet?: Specification of attributes that should deviate from the default styling.
defStyleAttr	Int: An attribute in the current theme that contains a reference to a style resource that supplies default values for the view. Can be 0 to not look for defaults.

Public methods

draw

open fun draw(c: Canvas!): Unit

drawableHotspotChanged

open fun drawableHotspotChanged(
    x: Float, 
    y: Float
): Unit

getCompoundPaddingLeft

open fun getCompoundPaddingLeft(): Int

getCompoundPaddingRight

open fun getCompoundPaddingRight(): Int

getShowText

open fun getShowText(): Boolean

Return
Boolean	whether the on/off text should be displayed androidx.appcompat.R.attr#showText

getSplitTrack

open fun getSplitTrack(): Boolean

Returns whether the track should be split by the thumb. androidx.appcompat.R.attr#splitTrack

getSwitchMinWidth

open fun getSwitchMinWidth(): Int

Get the minimum width of the switch in pixels. The switch's width will be the maximum of this value and its measured width as determined by the switch drawables and text used.

Return
Int	Minimum width of the switch in pixels androidx.appcompat.R.attr#switchMinWidth

getSwitchPadding

open fun getSwitchPadding(): Int

Get the amount of horizontal padding between the switch and the associated text.

Return
Int	Amount of padding in pixels androidx.appcompat.R.attr#switchPadding

getTextOff

open fun getTextOff(): CharSequence!

Returns the text displayed when the button is not in the checked state. android.R.attr#textOff

getTextOn

open fun getTextOn(): CharSequence!

Returns the text displayed when the button is in the checked state. android.R.attr#textOn

getThumbDrawable

open fun getThumbDrawable(): Drawable!

Get the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.

Return
Drawable!	Thumb drawable android.R.attr#thumb

getThumbTextPadding

open fun getThumbTextPadding(): Int

Get the horizontal padding around the text drawn on the switch itself.

Return
Int	Horizontal padding for switch thumb text in pixels androidx.appcompat.R.attr#thumbTextPadding

getThumbTintList

@Nullable open fun getThumbTintList(): ColorStateList?

Return
ColorStateList?	the tint applied to the thumb drawable androidx.appcompat.R.attr#thumbTint

See Also

• #setThumbTintList(ColorStateList)

getThumbTintMode

@Nullable open fun getThumbTintMode(): Mode?

Return
Mode?	the blending mode used to apply the tint to the thumb drawable androidx.appcompat.R.attr#thumbTintMode

See Also

• #setThumbTintMode(PorterDuff.Mode)

getTrackDrawable

open fun getTrackDrawable(): Drawable!

Get the drawable used for the track that the switch slides within.

Return
Drawable!	Track drawable androidx.appcompat.R.attr#track

getTrackTintList

@Nullable open fun getTrackTintList(): ColorStateList?

Return
ColorStateList?	the tint applied to the track drawable androidx.appcompat.R.attr#trackTint

See Also

• #setTrackTintList(ColorStateList)

getTrackTintMode

@Nullable open fun getTrackTintMode(): Mode?

Return
Mode?	the blending mode used to apply the tint to the track drawable androidx.appcompat.R.attr#trackTintMode

See Also

• #setTrackTintMode(PorterDuff.Mode)

jumpDrawablesToCurrentState

open fun jumpDrawablesToCurrentState(): Unit

onInitializeAccessibilityEvent

open fun onInitializeAccessibilityEvent(event: AccessibilityEvent!): Unit

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo!): Unit

onMeasure

open fun onMeasure(
    widthMeasureSpec: Int, 
    heightMeasureSpec: Int
): Unit

onPopulateAccessibilityEvent

open fun onPopulateAccessibilityEvent(event: AccessibilityEvent!): Unit

onTouchEvent

open fun onTouchEvent(ev: MotionEvent!): Boolean

setChecked

open fun setChecked(checked: Boolean): Unit

setCustomSelectionActionModeCallback

open fun setCustomSelectionActionModeCallback(actionModeCallback: Callback!): Unit

See TextViewCompat#setCustomSelectionActionModeCallback(TextView, ActionMode.Callback)

setShowText

open fun setShowText(showText: Boolean): Unit

Sets whether the on/off text should be displayed.

Parameters
showText	Boolean: true to display on/off text androidx.appcompat.R.attr#showText

setSplitTrack

open fun setSplitTrack(splitTrack: Boolean): Unit

Specifies whether the track should be split by the thumb. When true, the thumb's optical bounds will be clipped out of the track drawable, then the thumb will be drawn into the resulting gap.

Parameters
splitTrack	Boolean: Whether the track should be split by the thumb androidx.appcompat.R.attr#splitTrack

setSwitchMinWidth

open fun setSwitchMinWidth(pixels: Int): Unit

Set the minimum width of the switch in pixels. The switch's width will be the maximum of this value and its measured width as determined by the switch drawables and text used.

Parameters
pixels	Int: Minimum width of the switch in pixels androidx.appcompat.R.attr#switchMinWidth

setSwitchPadding

open fun setSwitchPadding(pixels: Int): Unit

Set the amount of horizontal padding between the switch and the associated text.

Parameters
pixels	Int: Amount of padding in pixels androidx.appcompat.R.attr#switchPadding

setSwitchTextAppearance

open fun setSwitchTextAppearance(
    context: Context!, 
    resid: Int
): Unit

Sets the switch text color, size, style, hint color, and highlight color from the specified TextAppearance resource. androidx.appcompat.R.attr#switchTextAppearance

setSwitchTypeface

open fun setSwitchTypeface(
    tf: Typeface!, 
    style: Int
): Unit

Sets the typeface and style in which the text should be displayed on the switch, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.

setSwitchTypeface

open fun setSwitchTypeface(typeface: Typeface!): Unit

Sets the typeface in which the text should be displayed on the switch. Note that not all Typeface families actually have bold and italic variants, so you may need to use setSwitchTypeface(Typeface, int) to get the appearance that you actually want.

setTextOff

open fun setTextOff(textOff: CharSequence!): Unit

Sets the text displayed when the button is not in the checked state. android.R.attr#textOff

setTextOn

open fun setTextOn(textOn: CharSequence!): Unit

Sets the text displayed when the button is in the checked state. android.R.attr#textOn

setThumbDrawable

open fun setThumbDrawable(thumb: Drawable!): Unit

Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.

Parameters
thumb	Drawable!: Thumb drawable android.R.attr#thumb

setThumbResource

open fun setThumbResource(resId: Int): Unit

Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.

Parameters
resId	Int: Resource ID of a thumb drawable android.R.attr#thumb

setThumbTextPadding

open fun setThumbTextPadding(pixels: Int): Unit

Set the horizontal padding around the text drawn on the switch itself.

Parameters
pixels	Int: Horizontal padding for switch thumb text in pixels androidx.appcompat.R.attr#thumbTextPadding

setThumbTintList

open fun setThumbTintList(@Nullable tint: ColorStateList?): Unit

Applies a tint to the thumb drawable. Does not modify the current tint mode, which is PorterDuff.Mode#SRC_IN by default.

Subsequent calls to setThumbDrawable(Drawable) will automatically mutate the drawable and apply the specified tint and tint mode using DrawableCompat#setTintList(Drawable, ColorStateList).

Parameters
tint	ColorStateList?: the tint to apply, may be null to clear tint androidx.appcompat.R.attr#thumbTint

See Also

• #getThumbTintList()
• Drawable#setTintList(ColorStateList)

setThumbTintMode

open fun setThumbTintMode(@Nullable tintMode: Mode?): Unit

Specifies the blending mode used to apply the tint specified by setThumbTintList(ColorStateList)} to the thumb drawable. The default mode is PorterDuff.Mode#SRC_IN.

Parameters
tintMode	Mode?: the blending mode used to apply the tint, may be null to clear tint androidx.appcompat.R.attr#thumbTintMode

See Also

• #getThumbTintMode()
• Drawable#setTintMode(PorterDuff.Mode)

setTrackDrawable

open fun setTrackDrawable(track: Drawable!): Unit

Set the drawable used for the track that the switch slides within.

Parameters
track	Drawable!: Track drawable androidx.appcompat.R.attr#track