# DeleteGesture.Builder

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Builder

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/view/inputmethod/DeleteGesture.Builder "View this page in Java")  

```
class Builder
```

|---|--------------------------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                                   ||
| ↳ | [android.view.inputmethod.DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) |

Builder for[DeleteGesture](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture). This class is not designed to be thread-safe.

## Summary

|                                                       Public constructors                                                        ||
|-------------------------------------------------------------------------------------------------------------------------------|---|
| [Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#Builder())`()` <br /> |

|                                                                                                                                                                                                                                                 Public methods                                                                                                                                                                                                                                                  ||
|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [DeleteGesture](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture)                  | [build](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#build())`()` <br />                                                                                                                                                                                                                                                              |
| [DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) | [setDeletionArea](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#setDeletionArea(android.graphics.RectF))`(`area:` `[RectF](https://developer.android.com/reference/kotlin/android/graphics/RectF.html#)`)` Set rectangular single/multiline text deletion area intersecting with text.                                                 |
| [DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) | [setFallbackText](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#setFallbackText(kotlin.String))`(`fallbackText:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?`)` Set fallback text that will be committed at current cursor position if there is no applicable text beneath the area of gesture. |
| [DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) | [setGranularity](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#setGranularity(kotlin.Int))`(`granularity:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` Set text deletion granularity.                                                                                                               |

## Public constructors

### Builder

```
Builder()
```

## Public methods

### build

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun build(): DeleteGesture
```

|                                                                                                                                                                                           Return                                                                                                                                                                                           ||
|--------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [DeleteGesture](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture) | [DeleteGesture](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture)using parameters in this[DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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)](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#setGranularity(kotlin.Int)). e.g.[HandwritingGesture.GRANULARITY_WORD](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_WORD:kotlin.Int)includes all the words with their width/height center included in the deletion rectangle.

|                                                                                                                              Parameters                                                                                                                              ||
|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `area` | [RectF](https://developer.android.com/reference/kotlin/android/graphics/RectF.html#):[RectF](https://developer.android.com/reference/kotlin/android/graphics/RectF.html#)(in screen coordinates) for which text will be deleted. This value cannot be`null`. |

|                                                                        Return                                                                        ||
|-------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) | This value cannot be`null`. |

**See Also**

- [android.view.inputmethod.HandwritingGesture#GRANULARITY_WORD](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_WORD:kotlin.Int)
- [android.view.inputmethod.HandwritingGesture#GRANULARITY_CHARACTER](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_CHARACTER:kotlin.Int)  

### setFallbackText

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?:text to set This value may be`null`. |

|                                                                        Return                                                                        ||
|-------------------------------------------------------------------------------------------------------------------------|-----------------------------|
| [DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) | This value cannot be`null`. |

### setGranularity

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun setGranularity(granularity: Int): DeleteGesture.Builder
```

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

|                                                                                                                                                                                                                                                                                                                                                                                                              Parameters                                                                                                                                                                                                                                                                                                                                                                                                              ||
|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `granularity` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):[HandwritingGesture.GRANULARITY_WORD](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_WORD:kotlin.Int)or[HandwritingGesture.GRANULARITY_CHARACTER](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_CHARACTER:kotlin.Int). Value is[android.view.inputmethod.HandwritingGesture#GRANULARITY_CHARACTER](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_CHARACTER:kotlin.Int), or[android.view.inputmethod.HandwritingGesture#GRANULARITY_WORD](https://developer.android.com/reference/kotlin/android/view/inputmethod/HandwritingGesture#GRANULARITY_WORD:kotlin.Int) |

|                                                                                                                             Return                                                                                                                              ||
|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| [DeleteGesture.Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#) | [Builder](https://developer.android.com/reference/kotlin/android/view/inputmethod/DeleteGesture.Builder#). This value cannot be`null`. |