TextSelection.Request

Artifact: androidx.textclassifier:textclassifier

View Source

---

Kotlin |Java

public final class TextSelection.Request

---

A request object for generating TextSelection.

Summary

Nested types
public final class TextSelection.Request.Builder A builder for building TextSelection requests.

Public methods
static @NonNull TextSelection.Request	createFromBundle(@NonNull Bundle bundle) Extracts a Request from a bundle that was added using toBundle.
@Nullable LocaleListCompat	getDefaultLocales()
@IntRange(from = 0) int	getEndIndex() Returns end index of the selected part of text.
@NonNull Bundle	getExtras() Returns the extended, vendor specific data.
@IntRange(from = 0) int	getStartIndex() Returns start index of the selected part of text.
@NonNull CharSequence	getText() Returns the text providing context for the selected text (which is specified by the sub sequence starting at startIndex and ending at endIndex).
@NonNull Bundle	toBundle() Adds this Request to a Bundle that can be read back with the same parameters to createFromBundle.

Public methods

createFromBundle

public static @NonNull TextSelection.Request createFromBundle(@NonNull Bundle bundle)

Extracts a Request from a bundle that was added using toBundle.

getDefaultLocales

public @Nullable LocaleListCompat getDefaultLocales()

Returns
@Nullable LocaleListCompat	ordered list of locale preferences that can be used to disambiguate the provided text.

getEndIndex

public @IntRange(from = 0) int getEndIndex()

Returns end index of the selected part of text.

getExtras

public @NonNull Bundle getExtras()

Returns the extended, vendor specific data.

NOTE: Each call to this method returns a new bundle copy so clients should prefer to hold a reference to the returned bundle rather than frequently calling this method. Avoid updating the content of this bundle. On pre-O devices, the values in the Bundle are not deep copied.

getStartIndex

public @IntRange(from = 0) int getStartIndex()

Returns start index of the selected part of text.

getText

public @NonNull CharSequence getText()

Returns the text providing context for the selected text (which is specified by the sub sequence starting at startIndex and ending at endIndex).

toBundle

public @NonNull Bundle toBundle()

Adds this Request to a Bundle that can be read back with the same parameters to createFromBundle.