Added in API level 34

Builder


class Builder
kotlin.Any
   ↳ android.view.inputmethod.DeleteGesture.Builder

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

Summary

Public constructors

Public methods
DeleteGesture

DeleteGesture.Builder

Set rectangular single/multiline text deletion area intersecting with text.

DeleteGesture.Builder
setFallbackText(fallbackText: String?)

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(granularity: Int)

Set text deletion granularity.

Public constructors

Builder

Builder()

Public methods

build

Added in API level 34
fun build(): DeleteGesture
Return
DeleteGesture DeleteGesture using parameters in this DeleteGesture.Builder. This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if one or more positional parameters are not specified.

setDeletionArea

Added in API level 34
fun setDeletionArea(area: RectF): DeleteGesture.Builder

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.
Return
DeleteGesture.Builder This value cannot be null.

setFallbackText

Added in API level 34
fun setFallbackText(fallbackText: String?): DeleteGesture.Builder

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.
Return
DeleteGesture.Builder This value cannot be null.

setGranularity

Added in API level 34
fun setGranularity(granularity: Int): DeleteGesture.Builder

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 android.view.inputmethod.HandwritingGesture#GRANULARITY_CHARACTER, or android.view.inputmethod.HandwritingGesture#GRANULARITY_WORD
Return
DeleteGesture.Builder Builder. This value cannot be null.