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 |
class |
TextSelection.Request
A request object 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. |
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 | |
---|---|
Fields
Public methods
describeContents
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
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 , or android.view.textclassifier.TextClassifier.TYPE_DICTIONARY |
Returns | |
---|---|
float |
Value is between 0.0 and 1.0 inclusive |
getEntity
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 , or android.view.textclassifier.TextClassifier.TYPE_DICTIONARY |
Throws | |
---|---|
IndexOutOfBoundsException |
if the specified index is out of range. |
See also:
getEntityCount
public int getEntityCount ()
Returns the number of entities found in the classified text.
Returns | |
---|---|
int |
Value is 0 or greater |
getExtras
public Bundle getExtras ()
Returns the extended data.
NOTE: Do not modify this bundle.
Returns | |
---|---|
Bundle |
This value cannot be null . |
getId
public String getId ()
Returns the id, if one exists, for this object.
Returns | |
---|---|
String |
This value may be null . |
getSelectionEndIndex
public int getSelectionEndIndex ()
Returns the end index of the text selection.
Returns | |
---|---|
int |
getSelectionStartIndex
public int getSelectionStartIndex ()
Returns the start index of the text selection.
Returns | |
---|---|
int |
getTextClassification
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 |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
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 |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-05-15 UTC.