Android APIs
public final class

CursorAnchorInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.view.inputmethod.CursorAnchorInfo

Class Overview

Positional information about the text insertion point and characters in the composition string.

This class encapsulates locations of the text insertion point and the composition string in the screen coordinates so that IMEs can render their UI components near where the text is actually inserted.

Summary

Nested Classes
class CursorAnchorInfo.Builder Builder for CursorAnchorInfo. 
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<CursorAnchorInfo> CREATOR Used to make this class parcelable.
Public Constructors
CursorAnchorInfo(Parcel source)
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object obj)
Compares this instance with the specified object and indicates if they are equal.
RectF getCharacterRect(int index)
Returns a new instance of RectF that indicates the location of the character specified with the index.
String getComposingText()
Returns the entire composing text.
int getComposingTextStart()
Returns the index where the composing text starts.
float getInsertionMarkerBaseline()
Returns the vertical baseline position of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.
float getInsertionMarkerBottom()
Returns the vertical bottom position of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.
float getInsertionMarkerHorizontal()
Returns the horizontal start of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.
float getInsertionMarkerTop()
Returns the vertical top position of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.
Matrix getMatrix()
Returns a new instance of Matrix that indicates the transformation matrix that is to be applied other positional data in this class.
int getSelectionEnd()
Returns the index where the selection ends.
int getSelectionStart()
Returns the index where the selection starts.
int hashCode()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Used to package this object into a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<CursorAnchorInfo> CREATOR

Used to make this class parcelable.

Public Constructors

public CursorAnchorInfo (Parcel source)

Public Methods

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
obj the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public RectF getCharacterRect (int index)

Returns a new instance of RectF that indicates the location of the character specified with the index.

Note that coordinates are not necessarily contiguous or even monotonous, especially when RTL text and LTR text are mixed.

Parameters
index index of the character in a Java chars.
Returns
  • a new instance of RectF that represents the location of the character in local coordinates. null if the character is invisible or the application did not provide the location. Note that the left field can be greater than the right field if the character is in RTL text.

public String getComposingText ()

Returns the entire composing text.

Returns
  • null if there is no composition.

public int getComposingTextStart ()

Returns the index where the composing text starts.

Returns
  • -1 if there is no composing text.

public float getInsertionMarkerBaseline ()

Returns the vertical baseline position of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.

Returns

public float getInsertionMarkerBottom ()

Returns the vertical bottom position of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.

Returns
  • y coordinate that is compatible with getLineBottom(int). java.lang.Float.NaN if not specified.

public float getInsertionMarkerHorizontal ()

Returns the horizontal start of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.

Returns
  • x coordinate that is compatible with getPrimaryHorizontal(int). Pay special care to RTL/LTR handling. java.lang.Float.NaN if not specified.
See Also

public float getInsertionMarkerTop ()

Returns the vertical top position of the insertion marker, in the local coordinates that will be transformed with getMatrix() when rendered on the screen.

Returns
  • y coordinate that is compatible with getLineTop(int). java.lang.Float.NaN if not specified.

public Matrix getMatrix ()

Returns a new instance of Matrix that indicates the transformation matrix that is to be applied other positional data in this class.

Returns
  • a new instance (copy) of the transformation matrix.

public int getSelectionEnd ()

Returns the index where the selection ends.

Returns
  • -1 if there is no selection.

public int getSelectionStart ()

Returns the index where the selection starts.

Returns
  • -1 if there is no selection.

public int hashCode ()

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

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

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Used to package this object into a Parcel.

Parameters
dest The Parcel to be written.
flags The flags used for parceling.