Skip to content

Most visited

Recently visited

navigation

TextSelection

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.Options

Optional input parameters for generating TextSelection. 

Inherited constants

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.

int getSelectionEndIndex()

Returns the end index of the text selection.

int getSelectionStartIndex()

Returns the start index of the text selection.

String getSignature()

Returns the signature for this object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

Public methods

describeContents

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(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.

getConfidenceScore

added in API level 26
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 TYPE_UNKNOWN, TYPE_OTHER, TYPE_EMAIL, TYPE_PHONE, TYPE_ADDRESS, TYPE_URL, TYPE_DATE, TYPE_DATE_TIME or TYPE_FLIGHT_NUMBER.

Returns
float

Value is between 0.0 and 1.0 inclusive.

getEntity

added in API level 26
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 will never be null.

Value is TYPE_UNKNOWN, TYPE_OTHER, TYPE_EMAIL, TYPE_PHONE, TYPE_ADDRESS, TYPE_URL, TYPE_DATE, TYPE_DATE_TIME or TYPE_FLIGHT_NUMBER.

Throws
IndexOutOfBoundsException if the specified index is out of range.

getEntityCount

added in API level 26
int getEntityCount ()

Returns the number of entities found in the classified text.

Returns
int

getSelectionEndIndex

added in API level 26
int getSelectionEndIndex ()

Returns the end index of the text selection.

Returns
int

getSelectionStartIndex

added in API level 26
int getSelectionStartIndex ()

Returns the start index of the text selection.

Returns
int

getSignature

String getSignature ()

Returns the signature for this object. The TextClassifier that generates this object may use it as a way to internally identify this object.

Returns
String

This value will never be null.

toString

added in API level 26
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

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.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (April 2018 — Developer Survey)