DeleteGesture.Builder

Kotlin |Java

public static final class DeleteGesture.Builder
extends Object

java.lang.Object
↳	android.view.inputmethod.DeleteGesture.Builder

Builder for DeleteGesture. This class is not designed to be thread-safe.

Summary

Public constructors
`Builder()`

Public methods
`DeleteGesture`	`build()`
`DeleteGesture.Builder`	`setDeletionArea(RectF area)` Set rectangular single/multiline text deletion area intersecting with text.
`DeleteGesture.Builder`	`setFallbackText(String fallbackText)` Set fallback text that will be committed at current cursor position if there is no applicable text beneath the area of gesture.
`DeleteGesture.Builder`	`setGranularity(int granularity)` Set text deletion granularity.

Inherited methods

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.

Public constructors

Builder

public Builder ()

Public methods

build

Added in API level 34

public DeleteGesture build ()

Returns
`DeleteGesture`	`DeleteGesture` using parameters in this `DeleteGesture.Builder`. This value cannot be `null`.

Throws
`IllegalArgumentException`	if one or more positional parameters are not specified.

setDeletionArea

Added in API level 34

public DeleteGesture.Builder setDeletionArea (RectF area)

Set rectangular single/multiline text deletion area intersecting with text. The resulting deletion would be performed for all text intersecting rectangle. The deletion includes the first word/character in the rectangle, and the last word/character in the rectangle, and includes everything in between even if it's not in the rectangle. Intersection is determined using setGranularity(int). e.g. HandwritingGesture.GRANULARITY_WORD includes all the words with their width/height center included in the deletion rectangle.

Parameters
`area`	`RectF`: `RectF` (in screen coordinates) for which text will be deleted. This value cannot be `null`.

Returns
`DeleteGesture.Builder`	This value cannot be `null`.

See also:

setFallbackText

Added in API level 34

public DeleteGesture.Builder setFallbackText (String fallbackText)

Set fallback text that will be committed at current cursor position if there is no applicable text beneath the area of gesture.

Parameters
`fallbackText`	`String`: text to set. This value may be `null`.

Returns
`DeleteGesture.Builder`	This value cannot be `null`.

setGranularity

Added in API level 34

public DeleteGesture.Builder setGranularity (int granularity)

Set text deletion granularity. Intersecting words/characters will be included in the operation.

Parameters
`granularity`	`int`: `HandwritingGesture.GRANULARITY_WORD` or `HandwritingGesture.GRANULARITY_CHARACTER`. Value is one of the following: `HandwritingGesture.GRANULARITY_CHARACTER` `HandwritingGesture.GRANULARITY_WORD`

Returns
`DeleteGesture.Builder`	`Builder`. This value cannot be `null`.