public
final
class
CursorAnchorInfo
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.view.inputmethod.CursorAnchorInfo |
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.
Nested classes | |
---|---|
class |
CursorAnchorInfo.Builder
Builder for |
Constants | |
---|---|
int |
FLAG_HAS_INVISIBLE_REGION
Flag for |
int |
FLAG_HAS_VISIBLE_REGION
Flag for |
int |
FLAG_IS_RTL
Flag for |
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 instance's marshaled representation. |
boolean
|
equals(Object obj)
Indicates whether some other object is "equal to" this one. |
RectF
|
getCharacterBounds(int index)
Returns a new instance of |
int
|
getCharacterBoundsFlags(int index)
Returns the flags associated with the character bounds specified with the index. |
CharSequence
|
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 |
float
|
getInsertionMarkerBottom()
Returns the vertical bottom position of the insertion marker, in the local coordinates
that will be transformed with |
int
|
getInsertionMarkerFlags()
Returns the flag of the insertion marker. |
float
|
getInsertionMarkerHorizontal()
Returns the horizontal start of the insertion marker, in the local coordinates that will
be transformed with |
float
|
getInsertionMarkerTop()
Returns the vertical top position of the insertion marker, in the local coordinates that
will be transformed with |
Matrix
|
getMatrix()
Returns a new instance of |
int
|
getSelectionEnd()
Returns the index where the selection ends. |
int
|
getSelectionStart()
Returns the index where the selection starts. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Used to package this object into a |
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
|
int FLAG_HAS_INVISIBLE_REGION
Flag for getInsertionMarkerFlags()
and getCharacterBoundsFlags(int)
: the
insertion marker or character bounds have at least one invisible (clipped) region.
Constant Value: 2 (0x00000002)
int FLAG_HAS_VISIBLE_REGION
Flag for getInsertionMarkerFlags()
and getCharacterBoundsFlags(int)
: the
insertion marker or character bounds have at least one visible region.
Constant Value: 1 (0x00000001)
int FLAG_IS_RTL
Flag for getInsertionMarkerFlags()
and getCharacterBoundsFlags(int)
: the
insertion marker or character bounds is placed at right-to-left (RTL) character.
Constant Value: 4 (0x00000004)
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. |
boolean equals (Object obj)
Indicates whether some other object is "equal to" this one.
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
x
and y
, multiple invocations of
x.equals(y)
consistently return true
or consistently return false
, provided no
information used in equals
comparisons on the
objects is modified.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
Parameters | |
---|---|
obj |
Object :
the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
RectF getCharacterBounds (int index)
Returns a new instance of RectF
that indicates the location of the character
specified with the index.
Parameters | |
---|---|
index |
int :
index of the character in a Java chars. |
Returns | |
---|---|
RectF |
the character bounds in local coordinates as a new instance of RectF .
|
int getCharacterBoundsFlags (int index)
Returns the flags associated with the character bounds specified with the index.
Parameters | |
---|---|
index |
int :
index of the character in a Java chars. |
Returns | |
---|---|
int |
0 if no flag is specified.
|
CharSequence getComposingText ()
Returns the entire composing text.
Returns | |
---|---|
CharSequence |
null if there is no composition.
|
int getComposingTextStart ()
Returns the index where the composing text starts.
Returns | |
---|---|
int |
-1 if there is no composing text.
|
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 | |
---|---|
float |
y coordinate that is compatible with getLineBaseline(int) .
java.lang.Float.NaN if not specified.
|
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 | |
---|---|
float |
y coordinate that is compatible with getLineBottom(int) .
java.lang.Float.NaN if not specified.
|
int getInsertionMarkerFlags ()
Returns the flag of the insertion marker.
Returns | |
---|---|
int |
the flag of the insertion marker. 0 if no flag is specified.
|
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 | |
---|---|
float |
x coordinate that is compatible with getPrimaryHorizontal(int) .
Pay special care to RTL/LTR handling.
java.lang.Float.NaN if not specified. |
See also:
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 | |
---|---|
float |
y coordinate that is compatible with getLineTop(int) .
java.lang.Float.NaN if not specified.
|
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 | |
---|---|
Matrix |
a new instance (copy) of the transformation matrix. |
int getSelectionEnd ()
Returns the index where the selection ends.
Returns | |
---|---|
int |
-1 if there is no selection.
|
int getSelectionStart ()
Returns the index where the selection starts.
Returns | |
---|---|
int |
-1 if there is no selection.
|
int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
HashMap
.
The general contract of hashCode
is:
hashCode
method
must consistently return the same integer, provided no information
used in equals
comparisons on the object is modified.
This integer need not remain consistent from one execution of an
application to another execution of the same application.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
method, then calling the hashCode
method on each of the
two objects must produce distinct integer results. However, the
programmer should be aware that producing distinct integer results
for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
JavaTM programming language.)
Returns | |
---|---|
int |
a hash code value for this object. |
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. |
void writeToParcel (Parcel dest, int flags)
Used to package this object into a Parcel
.
Parameters | |
---|---|
dest |
Parcel :
The Parcel to be written. |
flags |
int :
The flags used for parceling.
|