From 6dbcd1f8357fd2587d08b0ecc580aa35e95b5c7b Mon Sep 17 00:00:00 2001 From: joneckenrode Date: Thu, 7 Jul 2022 22:49:59 +0000 Subject: Fixed the reference to the compat version of the widget. Revised the class description. Cherry-picked from CL 19211934 merged on master. See https://googleplex-android-review.git.corp.google.com/c/platform/frameworks/base/+/19211934. Test: Built API documentation Change-Id: If74178eba609346eb7cf9e462bdb3edf40db4d81 --- core/java/android/widget/Switch.java | 38 +++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/core/java/android/widget/Switch.java b/core/java/android/widget/Switch.java index 872e65a3ac55..07dfce780c6c 100644 --- a/core/java/android/widget/Switch.java +++ b/core/java/android/widget/Switch.java @@ -61,22 +61,32 @@ import android.widget.RemoteViews.RemoteView; import com.android.internal.R; /** - * 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 {@link #setText(CharSequence) text} - * property controls the text displayed in the label for the switch, whereas the - * {@link #setTextOff(CharSequence) off} and {@link #setTextOn(CharSequence) on} text - * controls the text on the thumb. Similarly, the - * {@link #setTextAppearance(android.content.Context, int) textAppearance} and the related - * setTypeface() methods control the typeface and style of label text, whereas the - * {@link #setSwitchTextAppearance(android.content.Context, int) switchTextAppearance} and - * the related setSwitchTypeface() methods control that of the thumb. + * A Switch is a two-state toggle widget. Users can drag the switch "thumb" back + * and forth to select either of two options or simply tap the switch to toggle + * between options. * - *

{@link androidx.recyclerview.widget.RecyclerView} is a version of - * the Switch widget which runs on devices back to API 7.

+ *

The {@link #setText(CharSequence) text} property controls + * the text of the switch label. The {@link #setTextOn(CharSequence) textOn} and + * {@link #setTextOff(CharSequence) textOff} properties control the text of the + * thumb. The {@link #setTextAppearance(int) textAppearance} property and the + * related {@link #setTypeface(android.graphics.Typeface) setTypeface()} methods + * control the typeface and style of the switch label. The + * {@link #setSwitchTextAppearance(android.content.Context, int) + * switchTextAppearance} property and the related + * {@link #setSwitchTypeface(android.graphics.Typeface) setSwitchTypeface()} + * methods control the typeface and style of the thumb text.

* - *

See the Toggle Buttons - * guide.

+ *

Note: The thumb text is displayed only if the + * + * showText attribute is set to {@code true}. See also + * {@link #setShowText(boolean)} and {@link #getShowText()}.

+ * + *

{@link androidx.appcompat.widget.SwitchCompat} provides backward + * compatibility down to Android 4.0 (API level 14).

+ * + *

For more information, see the + * + * Toggle Buttons guide.

* * @attr ref android.R.styleable#Switch_textOn * @attr ref android.R.styleable#Switch_textOff -- cgit v1.2.3-59-g8ed1b