DeleteGesture


public final class DeleteGesture
extends PreviewableHandwritingGesture implements Parcelable

java.lang.Object
   ↳ android.view.inputmethod.HandwritingGesture
     ↳ android.view.inputmethod.PreviewableHandwritingGesture
       ↳ android.view.inputmethod.DeleteGesture


A sub-class of HandwritingGesture for deleting an area of text using single rectangle. This class holds the information required for deletion of text in toolkit widgets like TextView.

Note: This deletes all text within the given area. To delete a range between two areas, use DeleteRangeGesture.

Summary

Nested classes

class DeleteGesture.Builder

Builder for DeleteGesture

Inherited constants

Fields

public static final Creator<DeleteGesture> 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.

RectF getDeletionArea()

Returns the deletion area RectF in screen coordinates.

int getGranularity()

Returns Granular level on which text should be operated.

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

Added in API level 34
public static final Creator<DeleteGesture> CREATOR

Used to make this class parcelable.

Public methods

describeContents

Added in API level 34
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

Added in API level 34
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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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.

getDeletionArea

Added in API level 34
public RectF getDeletionArea ()

Returns the deletion area RectF in screen coordinates. Getter for deletion area set with DeleteGesture.Builder#setDeletionArea(RectF).

Returns
RectF This value cannot be null.

getGranularity

Added in API level 34
public int getGranularity ()

Returns Granular level on which text should be operated.

Returns
int Value is HandwritingGesture.GRANULARITY_CHARACTER, or HandwritingGesture.GRANULARITY_WORD

hashCode

Added in API level 34
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 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 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.

Returns
int a hash code value for this object.

writeToParcel

Added in API level 34
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.