Added in API level 26

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

TextSelection

---

Kotlin |Java

public final class TextSelection
extends Object implements Parcelable

java.lang.Object
↳	android.view.textclassifier.TextSelection

---

Information about where text selection should be.

Summary

Nested classes
class	TextSelection.Builder Builder used to build TextSelection objects.
class	TextSelection.Request A request object for generating TextSelection.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<TextSelection>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
float	getConfidenceScore(String entity) Returns the confidence score for the specified entity.
String	getEntity(int index) Returns the entity at the specified index.
int	getEntityCount() Returns the number of entities found in the classified text.
Bundle	getExtras() Returns the extended data.
String	getId() Returns the id, if one exists, for this object.
int	getSelectionEndIndex() Returns the end index of the text selection.
int	getSelectionStartIndex() Returns the start index of the text selection.
TextClassification	getTextClassification() Returns the text classification result of the suggested selection span.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 28

public static final Creator<TextSelection> CREATOR

Public methods

describeContents

Added in API level 28

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getConfidenceScore

Added in API level 26

public float getConfidenceScore (String entity)

Returns the confidence score for the specified entity. The value ranges from 0 (low confidence) to 1 (high confidence). 0 indicates that the entity was not found for the classified text.

Parameters
entity	String: Value is TextClassifier.TYPE_UNKNOWN, TextClassifier.TYPE_OTHER, TextClassifier.TYPE_EMAIL, TextClassifier.TYPE_PHONE, TextClassifier.TYPE_ADDRESS, TextClassifier.TYPE_URL, TextClassifier.TYPE_DATE, TextClassifier.TYPE_DATE_TIME, TextClassifier.TYPE_FLIGHT_NUMBER, android.view.textclassifier.TextClassifier.TYPE_DICTIONARY, TextClassifier.TYPE_OTP, or TextClassifier.TYPE_SMS_RETRIEVER_OTP

Returns
float	Value is between 0.0f and 1.0f inclusive

getEntity

Added in API level 26

public String getEntity (int index)

Returns the entity at the specified index. Entities are ordered from high confidence to low confidence.

Parameters
index	int

Returns

String

This value cannot be null. Value is TextClassifier.TYPE_UNKNOWN, TextClassifier.TYPE_OTHER, TextClassifier.TYPE_EMAIL, TextClassifier.TYPE_PHONE, TextClassifier.TYPE_ADDRESS, TextClassifier.TYPE_URL, TextClassifier.TYPE_DATE, TextClassifier.TYPE_DATE_TIME, TextClassifier.TYPE_FLIGHT_NUMBER, android.view.textclassifier.TextClassifier.TYPE_DICTIONARY, TextClassifier.TYPE_OTP, or TextClassifier.TYPE_SMS_RETRIEVER_OTP

Throws
IndexOutOfBoundsException	if the specified index is out of range.

See also:

• for the number of entities available.

getEntityCount

Added in API level 26

public int getEntityCount ()

Returns the number of entities found in the classified text.

Returns
int	Value is 0 or greater

getExtras

Added in API level 29

public Bundle getExtras ()

Returns the extended data.

NOTE: Do not modify this bundle.

Returns
Bundle	This value cannot be null.

getId

Added in API level 28

public String getId ()

Returns the id, if one exists, for this object.

Returns
String	This value may be null.

getSelectionEndIndex

Added in API level 26

public int getSelectionEndIndex ()

Returns the end index of the text selection.

Returns
int

getSelectionStartIndex

Added in API level 26

public int getSelectionStartIndex ()

Returns the start index of the text selection.

Returns
int

getTextClassification

Added in API level 31

public TextClassification getTextClassification ()

Returns the text classification result of the suggested selection span. Enables the text classification by calling TextSelection.Request.Builder.setIncludeTextClassification(boolean). If the text classifier does not support it, a null is returned.

Returns
TextClassification

See also:

• TextSelection.Request.Builder.setIncludeTextClassification(boolean)

toString

Added in API level 26

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 28

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES