Stay organized with collections Save and categorize content based on your preferences.

InsertModeGesture

public final class InsertModeGesture
extends HandwritingGesture implements Parcelable

java.lang.Object
   ↳ android.view.inputmethod.HandwritingGesture
     ↳ android.view.inputmethod.InsertModeGesture


A sub-class of HandwritingGesture for starting an insert mode which inserts a space in the editor to let users hand write freely at the designated insertion point. This class holds the information required for insertion of text in toolkit widgets like TextView. Once InsertMode gesture is started, it continues until IME calls CancellationSignal#cancel() and toolkit can receive cancel using CancellationSignal#setOnCancelListener(CancellationSignal.OnCancelListener) obtained from getCancellationSignal().

Summary

Nested classes

class InsertModeGesture.Builder

Builder for InsertModeGesture

Inherited constants

Fields

public static final Creator<InsertModeGesture> CREATOR

Used to make this class parcelable.

Public methods

int describeContents()

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

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

CancellationSignal getCancellationSignal()

Returns the CancellationSignal associated with finishing this gesture.

PointF getInsertionPoint()

Returns the insertion point PointF (in screen coordinates) where space will be created for additional text to be inserted.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Used to package this object into a Parcel.

Inherited methods

Fields

CREATOR

public static final Creator<InsertModeGesture> CREATOR

Used to make this class parcelable.

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

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values 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.
  • For any non-null reference value 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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCancellationSignal

public CancellationSignal getCancellationSignal ()

Returns the CancellationSignal associated with finishing this gesture. Once InsertMode gesture is started, it continues until IME calls CancellationSignal#cancel() and toolkit can receive cancel using CancellationSignal#setOnCancelListener(CancellationSignal.OnCancelListener).

Returns
CancellationSignal This value cannot be null.

getInsertionPoint

public PointF getInsertionPoint ()

Returns the insertion point PointF (in screen coordinates) where space will be created for additional text to be inserted.

Returns
PointF This value cannot be null.

hashCode

public 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:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the 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.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the 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. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Returns
int a hash code value for this object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Used to package this object into a Parcel.

Parameters
dest Parcel: The Parcel to be written. This value cannot be null.

flags int: The flags used for parceling.