SwitchCompat

Artifact: androidx.appcompat:appcompat

View Source

Added in 1.1.0

---

Kotlin |Java

public class SwitchCompat extends CompoundButton implements EmojiCompatConfigurationView

java.lang.Object
↳	android.view.View
	↳	android.widget.TextView
		↳	android.widget.Button
			↳	android.widget.CompoundButton
				↳	androidx.appcompat.widget.SwitchCompat

---

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

The thumb can be tinted with setThumbTintList and setThumbTintMode APIs as well as with the matching XML attributes. The track can be tinted with setTrackTintList and setTrackTintMode APIs as well as with the matching XML attributes.

Supported attributes include:

• textOn
• textOff
• switchMinWidth
• switchPadding
• switchTextAppearance
• thumb
• thumbTextPadding
• track
• thumbTint
• thumbTintMode
• trackTint
• trackTintMode

For more information, see the Toggle Buttons guide.

Summary

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

Public methods
void	draw(@NonNull Canvas c)
void	drawableHotspotChanged(float x, float y)
int	getCompoundPaddingLeft()
int	getCompoundPaddingRight()
@Nullable ActionMode.Callback	getCustomSelectionActionModeCallback()
boolean	@Attribute(value = "androidx.appcompat:showText") getShowText() Indicates whether the on/off text should be displayed.
boolean	@Attribute(value = "androidx.appcompat:splitTrack") getSplitTrack() Returns whether the track should be split by the thumb.
int	@Attribute(value = "androidx.appcompat:switchMinWidth") getSwitchMinWidth() Get the minimum width of the switch in pixels.
int	@Attribute(value = "androidx.appcompat:switchPadding") getSwitchPadding() Get the amount of horizontal padding between the switch and the associated text.
CharSequence	@Attribute(value = "android:textOff") getTextOff() Returns the text displayed when the button is not in the checked state.
CharSequence	@Attribute(value = "android:textOn") getTextOn() Returns the text displayed when the button is in the checked state.
Drawable	@Attribute(value = "android:thumb") getThumbDrawable() Get the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
int	@Attribute(value = "androidx.appcompat:thumbTextPadding") getThumbTextPadding() Get the horizontal padding around the text drawn on the switch itself.
@Nullable ColorStateList	@Attribute(value = "androidx.appcompat:thumbTint") getThumbTintList()
@Nullable PorterDuff.Mode	@Attribute(value = "androidx.appcompat:thumbTintMode") getThumbTintMode()
Drawable	@Attribute(value = "androidx.appcompat:track") getTrackDrawable() Get the drawable used for the track that the switch slides within.
@Nullable ColorStateList	@Attribute(value = "androidx.appcompat:trackTint") getTrackTintList()
@Nullable PorterDuff.Mode	@Attribute(value = "androidx.appcompat:trackTintMode") getTrackTintMode()
boolean	isEmojiCompatEnabled()
void	jumpDrawablesToCurrentState()
void	onInitializeAccessibilityEvent(AccessibilityEvent event)
void	onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info)
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec)
void	onPopulateAccessibilityEvent(AccessibilityEvent event)
boolean	onTouchEvent(MotionEvent ev)
void	setAllCaps(boolean allCaps)
void	setChecked(boolean checked)
void	setCustomSelectionActionModeCallback(     @Nullable ActionMode.Callback actionModeCallback ) See setCustomSelectionActionModeCallback
void	setEmojiCompatEnabled(boolean enabled) Configure emoji fallback behavior using EmojiCompat.
void	setFilters(@NonNull InputFilter[] filters)
void	setShowText(boolean showText) Sets whether the on/off text should be displayed.
void	setSplitTrack(boolean splitTrack) Specifies whether the track should be split by the thumb.
void	setSwitchMinWidth(int pixels) Set the minimum width of the switch in pixels.
void	setSwitchPadding(int pixels) Set the amount of horizontal padding between the switch and the associated text.
void	setSwitchTextAppearance(Context context, int resid) Sets the switch text color, size, style, hint color, and highlight color from the specified TextAppearance resource.
void	setSwitchTypeface(Typeface typeface) Sets the typeface in which the text should be displayed on the switch.
void	setSwitchTypeface(Typeface tf, int style) 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.
void	setTextOff(CharSequence textOff) Sets the text displayed when the button is not in the checked state.
void	setTextOn(CharSequence textOn) Sets the text displayed when the button is in the checked state.
void	setThumbDrawable(Drawable thumb) Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
void	setThumbResource(int resId) Set the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
void	setThumbTextPadding(int pixels) Set the horizontal padding around the text drawn on the switch itself.
void	setThumbTintList(@Nullable ColorStateList tint) Applies a tint to the thumb drawable.
void	setThumbTintMode(@Nullable PorterDuff.Mode tintMode) Specifies the blending mode used to apply the tint specified by setThumbTintList} to the thumb drawable.
void	setTrackDrawable(Drawable track) Set the drawable used for the track that the switch slides within.
void	setTrackResource(int resId) Set the drawable used for the track that the switch slides within.
void	setTrackTintList(@Nullable ColorStateList tint) Applies a tint to the track drawable.
void	setTrackTintMode(@Nullable PorterDuff.Mode tintMode) Specifies the blending mode used to apply the tint specified by setTrackTintList to the track drawable.
void	toggle()

Protected methods
void	drawableStateChanged()
final @FloatRange(from = 0.0, to = 1.0) float	getThumbPosition()
int[]	onCreateDrawableState(int extraSpace)
void	onDraw(Canvas canvas)
void	onLayout(boolean changed, int left, int top, int right, int bottom)
final void	setEnforceSwitchWidth(boolean enforceSwitchWidth) Sets true to enforce the switch width being at least twice of the thumb width.
boolean	verifyDrawable(@NonNull Drawable who)

Inherited Constants
From android.widget.TextView static final int AUTO_SIZE_TEXT_TYPE_NONE = 0 static final int AUTO_SIZE_TEXT_TYPE_UNIFORM = 1 static final int FOCUSED_SEARCH_RESULT_INDEX_NONE = -1
From android.view.View static final int ACCESSIBILITY_DATA_SENSITIVE_AUTO = 0 static final int ACCESSIBILITY_DATA_SENSITIVE_NO = 2 static final int ACCESSIBILITY_DATA_SENSITIVE_YES = 1 static final int ACCESSIBILITY_LIVE_REGION_ASSERTIVE = 2 static final int ACCESSIBILITY_LIVE_REGION_NONE = 0 static final int ACCESSIBILITY_LIVE_REGION_POLITE = 1 static final Property<View, Float> ALPHA static final int AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS = 1 static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE = "creditCardExpirationDate" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY = "creditCardExpirationDay" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH = "creditCardExpirationMonth" static final String AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR = "creditCardExpirationYear" static final String AUTOFILL_HINT_CREDIT_CARD_NUMBER = "creditCardNumber" static final String AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE = "creditCardSecurityCode" static final String AUTOFILL_HINT_EMAIL_ADDRESS = "emailAddress" static final String AUTOFILL_HINT_NAME = "name" static final String AUTOFILL_HINT_PASSWORD = "password" static final String AUTOFILL_HINT_PHONE = "phone" static final String AUTOFILL_HINT_POSTAL_ADDRESS = "postalAddress" static final String AUTOFILL_HINT_POSTAL_CODE = "postalCode" static final String AUTOFILL_HINT_USERNAME = "username" static final int AUTOFILL_TYPE_DATE = 4 static final int AUTOFILL_TYPE_LIST = 3 static final int AUTOFILL_TYPE_NONE = 0 static final int AUTOFILL_TYPE_TEXT = 1 static final int AUTOFILL_TYPE_TOGGLE = 2 static final int CONTENT_SENSITIVITY_AUTO = 0 static final int CONTENT_SENSITIVITY_NOT_SENSITIVE = 2 static final int CONTENT_SENSITIVITY_SENSITIVE = 1 static final int DRAG_FLAG_ACCESSIBILITY_ACTION = 1024 static final int DRAG_FLAG_GLOBAL = 256 static final int DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION = 64 static final int DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION = 128 static final int DRAG_FLAG_GLOBAL_SAME_APPLICATION = 4096 static final int DRAG_FLAG_GLOBAL_URI_READ = 1 static final int DRAG_FLAG_GLOBAL_URI_WRITE = 2 static final int DRAG_FLAG_HIDE_CALLING_TASK_ON_DRAG_START = 16384 static final int DRAG_FLAG_OPAQUE = 512 static final int DRAG_FLAG_START_INTENT_SENDER_ON_UNHANDLED_DRAG = 8192 static final int DRAWING_CACHE_QUALITY_AUTO = 0 This field is deprecated. static final int DRAWING_CACHE_QUALITY_HIGH = 1048576 This field is deprecated. static final int DRAWING_CACHE_QUALITY_LOW = 524288 This field is deprecated. static final int[] EMPTY_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_STATE_SET static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_SELECTED_STATE_SET static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] ENABLED_STATE_SET static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 2 static final int FIND_VIEWS_WITH_TEXT = 1 static final int FOCUSABLE = 1 static final int FOCUSABLES_ALL = 0 static final int FOCUSABLES_TOUCH_MODE = 1 static final int FOCUSABLE_AUTO = 16 static final int[] FOCUSED_SELECTED_STATE_SET static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] FOCUSED_STATE_SET static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET static final int FOCUS_BACKWARD = 1 static final int FOCUS_DOWN = 130 static final int FOCUS_FORWARD = 2 static final int FOCUS_LEFT = 17 static final int FOCUS_RIGHT = 66 static final int FOCUS_UP = 33 static final int GONE = 8 static final int HAPTIC_FEEDBACK_ENABLED = 268435456 static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0 static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 2 static final int IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_AUTO = 0 static final int IMPORTANT_FOR_AUTOFILL_NO = 2 static final int IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_AUTOFILL_YES = 1 static final int IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS = 4 static final int IMPORTANT_FOR_CONTENT_CAPTURE_AUTO = 0 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO = 2 static final int IMPORTANT_FOR_CONTENT_CAPTURE_NO_EXCLUDE_DESCENDANTS = 8 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES = 1 static final int IMPORTANT_FOR_CONTENT_CAPTURE_YES_EXCLUDE_DESCENDANTS = 4 static final int INVISIBLE = 4 static final int KEEP_SCREEN_ON = 67108864 static final int LAYER_TYPE_HARDWARE = 2 static final int LAYER_TYPE_NONE = 0 static final int LAYER_TYPE_SOFTWARE = 1 static final int LAYOUT_DIRECTION_INHERIT = 2 static final int LAYOUT_DIRECTION_LOCALE = 3 static final int LAYOUT_DIRECTION_LTR = 0 static final int LAYOUT_DIRECTION_RTL = 1 static final int MEASURED_HEIGHT_STATE_SHIFT = 16 static final int MEASURED_SIZE_MASK = 16777215 static final int MEASURED_STATE_MASK = -16777216 static final int MEASURED_STATE_TOO_SMALL = 16777216 static final int NOT_FOCUSABLE = 0 static final int NO_ID = -1 static final int OVER_SCROLL_ALWAYS = 0 static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1 static final int OVER_SCROLL_NEVER = 2 static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_STATE_SET static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_ENABLED_STATE_SET static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_STATE_SET static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_SELECTED_STATE_SET static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET static final int[] PRESSED_STATE_SET static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET static final float REQUESTED_FRAME_RATE_CATEGORY_DEFAULT static final float REQUESTED_FRAME_RATE_CATEGORY_HIGH = -4.0f static final float REQUESTED_FRAME_RATE_CATEGORY_LOW = -2.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NORMAL = -3.0f static final float REQUESTED_FRAME_RATE_CATEGORY_NO_PREFERENCE = -1.0f static final Property<View, Float> ROTATION static final Property<View, Float> ROTATION_X static final Property<View, Float> ROTATION_Y static final Property<View, Float> SCALE_X static final Property<View, Float> SCALE_Y static final int SCREEN_STATE_OFF = 0 static final int SCREEN_STATE_ON = 1 static final int SCROLLBARS_INSIDE_INSET = 16777216 static final int SCROLLBARS_INSIDE_OVERLAY = 0 static final int SCROLLBARS_OUTSIDE_INSET = 50331648 static final int SCROLLBARS_OUTSIDE_OVERLAY = 33554432 static final int SCROLLBAR_POSITION_DEFAULT = 0 static final int SCROLLBAR_POSITION_LEFT = 1 static final int SCROLLBAR_POSITION_RIGHT = 2 static final int SCROLL_AXIS_HORIZONTAL = 1 static final int SCROLL_AXIS_NONE = 0 static final int SCROLL_AXIS_VERTICAL = 2 static final int SCROLL_CAPTURE_HINT_AUTO = 0 static final int SCROLL_CAPTURE_HINT_EXCLUDE = 1 static final int SCROLL_CAPTURE_HINT_EXCLUDE_DESCENDANTS = 4 static final int SCROLL_CAPTURE_HINT_INCLUDE = 2 static final int SCROLL_INDICATOR_BOTTOM = 2 static final int SCROLL_INDICATOR_END = 32 static final int SCROLL_INDICATOR_LEFT = 4 static final int SCROLL_INDICATOR_RIGHT = 8 static final int SCROLL_INDICATOR_START = 16 static final int SCROLL_INDICATOR_TOP = 1 static final int[] SELECTED_STATE_SET static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET static final int SOUND_EFFECTS_ENABLED = 134217728 static final int STATUS_BAR_HIDDEN = 1 This field is deprecated. static final int STATUS_BAR_VISIBLE = 0 This field is deprecated. static final int SYSTEM_UI_FLAG_FULLSCREEN = 4 This field is deprecated. static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 2 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE = 2048 This field is deprecated. static final int SYSTEM_UI_FLAG_IMMERSIVE_STICKY = 4096 This field is deprecated.