added in version 25.1.0
belongs to Maven artifact com.android.support:appcompat-v7:28.0.0-alpha1

SwitchCompat

public class SwitchCompat
extends CompoundButton

java.lang.Object
↳	android.view.View
	↳	android.widget.TextView
		↳	android.widget.Button
			↳	android.widget.CompoundButton
				↳	android.support.v7.widget.SwitchCompat

SwitchCompat is a version of the Switch widget which on devices back to API v7. It does not make any attempt to use the platform provided widget on those devices which it is available normally.

A Switch is a two-state toggle switch widget that can select between two 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.

See the Toggle Buttons guide.

Summary

XML attributes
`SwitchCompat_android_textOff`
`SwitchCompat_android_textOn`
`SwitchCompat_android_thumb`
`SwitchCompat_showText`
`SwitchCompat_splitTrack`
`SwitchCompat_switchMinWidth`
`SwitchCompat_switchPadding`
`SwitchCompat_switchTextAppearance`
`SwitchCompat_thumbTextPadding`
`SwitchCompat_thumbTint`
`SwitchCompat_thumbTintMode`
`SwitchCompat_track`
`SwitchCompat_trackTint`
`SwitchCompat_trackTintMode`

Inherited constants

From class


    android.widget.TextView

From class


    android.view.View

`int`	`ACCESSIBILITY_LIVE_REGION_ASSERTIVE`
`int`	`ACCESSIBILITY_LIVE_REGION_NONE`
`int`	`ACCESSIBILITY_LIVE_REGION_POLITE`
`int`	`AUTOFILL_FLAG_INCLUDE_NOT_IMPORTANT_VIEWS`
`String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DATE`
`String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_DAY`
`String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_MONTH`
`String`	`AUTOFILL_HINT_CREDIT_CARD_EXPIRATION_YEAR`
`String`	`AUTOFILL_HINT_CREDIT_CARD_NUMBER`
`String`	`AUTOFILL_HINT_CREDIT_CARD_SECURITY_CODE`
`String`	`AUTOFILL_HINT_EMAIL_ADDRESS`
`String`	`AUTOFILL_HINT_NAME`
`String`	`AUTOFILL_HINT_PASSWORD`
`String`	`AUTOFILL_HINT_PHONE`
`String`	`AUTOFILL_HINT_POSTAL_ADDRESS`
`String`	`AUTOFILL_HINT_POSTAL_CODE`
`String`	`AUTOFILL_HINT_USERNAME`
`int`	`AUTOFILL_TYPE_DATE`
`int`	`AUTOFILL_TYPE_LIST`
`int`	`AUTOFILL_TYPE_NONE`
`int`	`AUTOFILL_TYPE_TEXT`
`int`	`AUTOFILL_TYPE_TOGGLE`
`int`	`DRAG_FLAG_GLOBAL`
`int`	`DRAG_FLAG_GLOBAL_PERSISTABLE_URI_PERMISSION`
`int`	`DRAG_FLAG_GLOBAL_PREFIX_URI_PERMISSION`
`int`	`DRAG_FLAG_GLOBAL_URI_READ`
`int`	`DRAG_FLAG_GLOBAL_URI_WRITE`
`int`	`DRAG_FLAG_OPAQUE`
`int`	`DRAWING_CACHE_QUALITY_AUTO`
`int`	`DRAWING_CACHE_QUALITY_HIGH`
`int`	`DRAWING_CACHE_QUALITY_LOW`
`int`	`FIND_VIEWS_WITH_CONTENT_DESCRIPTION`
`int`	`FIND_VIEWS_WITH_TEXT`
`int`	`FOCUSABLE`
`int`	`FOCUSABLES_ALL`
`int`	`FOCUSABLES_TOUCH_MODE`
`int`	`FOCUSABLE_AUTO`
`int`	`FOCUS_BACKWARD`
`int`	`FOCUS_DOWN`
`int`	`FOCUS_FORWARD`
`int`	`FOCUS_LEFT`
`int`	`FOCUS_RIGHT`
`int`	`FOCUS_UP`
`int`	`GONE`
`int`	`HAPTIC_FEEDBACK_ENABLED`
`int`	`IMPORTANT_FOR_ACCESSIBILITY_AUTO`
`int`	`IMPORTANT_FOR_ACCESSIBILITY_NO`
`int`	`IMPORTANT_FOR_ACCESSIBILITY_NO_HIDE_DESCENDANTS`
`int`	`IMPORTANT_FOR_ACCESSIBILITY_YES`
`int`	`IMPORTANT_FOR_AUTOFILL_AUTO`
`int`	`IMPORTANT_FOR_AUTOFILL_NO`
`int`	`IMPORTANT_FOR_AUTOFILL_NO_EXCLUDE_DESCENDANTS`
`int`	`IMPORTANT_FOR_AUTOFILL_YES`
`int`	`IMPORTANT_FOR_AUTOFILL_YES_EXCLUDE_DESCENDANTS`
`int`	`INVISIBLE`
`int`	`KEEP_SCREEN_ON`
`int`	`LAYER_TYPE_HARDWARE`
`int`	`LAYER_TYPE_NONE`
`int`	`LAYER_TYPE_SOFTWARE`
`int`	`LAYOUT_DIRECTION_INHERIT`
`int`	`LAYOUT_DIRECTION_LOCALE`
`int`	`LAYOUT_DIRECTION_LTR`
`int`	`LAYOUT_DIRECTION_RTL`
`int`	`MEASURED_HEIGHT_STATE_SHIFT`
`int`	`MEASURED_SIZE_MASK`
`int`	`MEASURED_STATE_MASK`
`int`	`MEASURED_STATE_TOO_SMALL`
`int`	`NOT_FOCUSABLE`
`int`	`NO_ID`
`int`	`OVER_SCROLL_ALWAYS`
`int`	`OVER_SCROLL_IF_CONTENT_SCROLLS`
`int`	`OVER_SCROLL_NEVER`
`int`	`SCREEN_STATE_OFF`
`int`	`SCREEN_STATE_ON`
`int`	`SCROLLBARS_INSIDE_INSET`
`int`	`SCROLLBARS_INSIDE_OVERLAY`
`int`	`SCROLLBARS_OUTSIDE_INSET`
`int`	`SCROLLBARS_OUTSIDE_OVERLAY`
`int`	`SCROLLBAR_POSITION_DEFAULT`
`int`	`SCROLLBAR_POSITION_LEFT`
`int`	`SCROLLBAR_POSITION_RIGHT`
`int`	`SCROLL_AXIS_HORIZONTAL`
`int`	`SCROLL_AXIS_NONE`
`int`	`SCROLL_AXIS_VERTICAL`
`int`	`SCROLL_INDICATOR_BOTTOM`
`int`	`SCROLL_INDICATOR_END`
`int`	`SCROLL_INDICATOR_LEFT`
`int`	`SCROLL_INDICATOR_RIGHT`
`int`	`SCROLL_INDICATOR_START`
`int`	`SCROLL_INDICATOR_TOP`
`int`	`SOUND_EFFECTS_ENABLED`
`int`	`STATUS_BAR_HIDDEN`
`int`	`STATUS_BAR_VISIBLE`
`int`	`SYSTEM_UI_FLAG_FULLSCREEN`
`int`	`SYSTEM_UI_FLAG_HIDE_NAVIGATION`
`int`	`SYSTEM_UI_FLAG_IMMERSIVE`
`int`	`SYSTEM_UI_FLAG_IMMERSIVE_STICKY`
`int`	`SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN`
`int`	`SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION`
`int`	`SYSTEM_UI_FLAG_LAYOUT_STABLE`
`int`	`SYSTEM_UI_FLAG_LIGHT_NAVIGATION_BAR`
`int`	`SYSTEM_UI_FLAG_LIGHT_STATUS_BAR`
`int`	`SYSTEM_UI_FLAG_LOW_PROFILE`
`int`	`SYSTEM_UI_FLAG_VISIBLE`
`int`	`SYSTEM_UI_LAYOUT_FLAGS`
`int`	`TEXT_ALIGNMENT_CENTER`
`int`	`TEXT_ALIGNMENT_GRAVITY`
`int`	`TEXT_ALIGNMENT_INHERIT`
`int`	`TEXT_ALIGNMENT_TEXT_END`
`int`	`TEXT_ALIGNMENT_TEXT_START`
`int`	`TEXT_ALIGNMENT_VIEW_END`
`int`	`TEXT_ALIGNMENT_VIEW_START`
`int`	`TEXT_DIRECTION_ANY_RTL`
`int`	`TEXT_DIRECTION_FIRST_STRONG`
`int`	`TEXT_DIRECTION_FIRST_STRONG_LTR`
`int`	`TEXT_DIRECTION_FIRST_STRONG_RTL`
`int`	`TEXT_DIRECTION_INHERIT`
`int`	`TEXT_DIRECTION_LOCALE`
`int`	`TEXT_DIRECTION_LTR`
`int`	`TEXT_DIRECTION_RTL`
`String`	`VIEW_LOG_TAG`
`int`	`VISIBLE`

Inherited fields

From class


    android.view.View

`public static final Property<View, Float>`	`ALPHA`
`protected static final int[]`	`EMPTY_STATE_SET`
`protected static final int[]`	`ENABLED_FOCUSED_SELECTED_STATE_SET`
`protected static final int[]`	`ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`ENABLED_FOCUSED_STATE_SET`
`protected static final int[]`	`ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`ENABLED_SELECTED_STATE_SET`
`protected static final int[]`	`ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`ENABLED_STATE_SET`
`protected static final int[]`	`ENABLED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`FOCUSED_SELECTED_STATE_SET`
`protected static final int[]`	`FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`FOCUSED_STATE_SET`
`protected static final int[]`	`FOCUSED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_SELECTED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_STATE_SET`
`protected static final int[]`	`PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_FOCUSED_SELECTED_STATE_SET`
`protected static final int[]`	`PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_SELECTED_STATE_SET`
`protected static final int[]`	`PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET`
`protected static final int[]`	`PRESSED_STATE_SET`
`protected static final int[]`	`PRESSED_WINDOW_FOCUSED_STATE_SET`
`public static final Property<View, Float>`	`ROTATION`
`public static final Property<View, Float>`	`ROTATION_X`
`public static final Property<View, Float>`	`ROTATION_Y`
`public static final Property<View, Float>`	`SCALE_X`
`public static final Property<View, Float>`	`SCALE_Y`
`protected static final int[]`	`SELECTED_STATE_SET`
`protected static final int[]`	`SELECTED_WINDOW_FOCUSED_STATE_SET`
`public static final Property<View, Float>`	`TRANSLATION_X`
`public static final Property<View, Float>`	`TRANSLATION_Y`
`public static final Property<View, Float>`	`TRANSLATION_Z`
`protected static final int[]`	`WINDOW_FOCUSED_STATE_SET`
`public static final Property<View, Float>`	`X`
`public static final Property<View, Float>`	`Y`
`public static final Property<View, Float>`	`Z`

Public constructors
`SwitchCompat(Context context)` Construct a new Switch with default styling.
`SwitchCompat(Context context, AttributeSet attrs)` Construct a new Switch with default styling, overriding specific style attributes as requested.
`SwitchCompat(Context context, 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(Canvas c)`
`void`	`drawableHotspotChanged(float x, float y)`
`int`	`getCompoundPaddingLeft()`
`int`	`getCompoundPaddingRight()`
`boolean`	`getShowText()`
`boolean`	`getSplitTrack()` Returns whether the track should be split by the thumb.
`int`	`getSwitchMinWidth()` Get the minimum width of the switch in pixels.
`int`	`getSwitchPadding()` Get the amount of horizontal padding between the switch and the associated text.
`CharSequence`	`getTextOff()` Returns the text displayed when the button is not in the checked state.
`CharSequence`	`getTextOn()` Returns the text displayed when the button is in the checked state.
`Drawable`	`getThumbDrawable()` Get the drawable used for the switch "thumb" - the piece that the user can physically touch and drag along the track.
`int`	`getThumbTextPadding()` Get the horizontal padding around the text drawn on the switch itself.
`ColorStateList`	`getThumbTintList()`
`PorterDuff.Mode`	`getThumbTintMode()`
`Drawable`	`getTrackDrawable()` Get the drawable used for the track that the switch slides within.
`ColorStateList`	`getTrackTintList()`
`PorterDuff.Mode`	`getTrackTintMode()`
`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`	`setChecked(boolean checked)`
`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.

SwitchCompat

Summary

XML attributes

Inherited constants

Inherited fields

Public constructors

Public methods