Added in API level 34

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

SelectRangeGesture

---

Kotlin |Java

public final class SelectRangeGesture
extends PreviewableHandwritingGesture implements Parcelable

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

---

A subclass of HandwritingGesture for selecting a range of text by defining start and end rectangles. This can be useful when the range cannot be defined with a single rectangle. This class holds the information required for selection of text in toolkit widgets like TextView.

Note: this selects text within a range between two given areas. To select all text within a single area, use SelectGesture

Summary

Nested classes
class	SelectRangeGesture.Builder Builder for SelectRangeGesture.

Inherited constants
From class android.view.inputmethod.HandwritingGesture int GRANULARITY_CHARACTER Operate on text per character basis. int GRANULARITY_WORD Operate text per word basis.
From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<SelectRangeGesture>	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.
int	getGranularity() Returns Granular level on which text should be operated.
RectF	getSelectionEndArea() Returns the Selection end area RectF in screen coordinates.
RectF	getSelectionStartArea() Returns the Selection start area RectF in screen coordinates.
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
From class android.view.inputmethod.HandwritingGesture final String getFallbackText() The fallback text that will be committed at current cursor position if there is no applicable text beneath the area of gesture.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 34

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

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

See also:

• HandwritingGesture.GRANULARITY_CHARACTER
• HandwritingGesture.GRANULARITY_WORD

getSelectionEndArea

Added in API level 34

public RectF getSelectionEndArea ()

Returns the Selection end area RectF in screen coordinates. Getter for selection area set with Builder#setSelectionEndArea(RectF).

Returns
RectF	This value cannot be null.

getSelectionStartArea

Added in API level 34

public RectF getSelectionStartArea ()

Returns the Selection start area RectF in screen coordinates. Getter for selection area set with Builder#setSelectionStartArea(RectF).

Returns
RectF	This value cannot be null.

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.