Added in API level 34

Builder


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

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

Summary

Public constructors

Public methods
DeleteRangeGesture

DeleteRangeGesture.Builder

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

DeleteRangeGesture.Builder

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

DeleteRangeGesture.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.

DeleteRangeGesture.Builder
setGranularity(granularity: Int)

Define text deletion granularity.

Public constructors

Builder

Builder()

Public methods

build

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

setDeletionEndArea

Added in API level 34
fun setDeletionEndArea(endArea: RectF): DeleteRangeGesture.Builder

Set rectangular single/multiline end of text deletion area intersecting with text. The resulting deletion is performed from the start of first word/character in the start rectangle setDeletionStartArea(android.graphics.RectF) to the end of the last word/character in the end 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
endArea RectF: RectF (in screen coordinates) for start of deletion. This rectangle belongs to the last line where deletion should end. This value cannot be null.
Return
DeleteRangeGesture.Builder This value cannot be null.

setDeletionStartArea

Added in API level 34
fun setDeletionStartArea(startArea: RectF): DeleteRangeGesture.Builder

Set rectangular single/multiline start of text deletion area intersecting with text. The resulting deletion is performed from the start of first word/character in the start rectangle to the end of the last word/character in the end rectangle setDeletionEndArea(android.graphics.RectF).

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
startArea RectF: RectF (in screen coordinates) for start of deletion. This rectangle belongs to first line where deletion should start. This value cannot be null.
Return
DeleteRangeGesture.Builder This value cannot be null.

setFallbackText

Added in API level 34
fun setFallbackText(fallbackText: String?): DeleteRangeGesture.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
DeleteRangeGesture.Builder This value cannot be null.

setGranularity

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

Define 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
DeleteRangeGesture.Builder Builder. This value cannot be null.