DeleteRangeGesture.Builder


public static final class DeleteRangeGesture.Builder
extends Object

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


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

Summary

Public constructors

Builder()

Public methods

DeleteRangeGesture build()
DeleteRangeGesture.Builder setDeletionEndArea(RectF endArea)

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

DeleteRangeGesture.Builder setDeletionStartArea(RectF startArea)

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

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

DeleteRangeGesture.Builder setGranularity(int granularity)

Define text deletion granularity.

Inherited methods

Public constructors

Builder

public Builder ()

Public methods

build

Added in API level 34
public DeleteRangeGesture build ()

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

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

setDeletionEndArea

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

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.
Deletion strategy using two rectangles 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.

Returns
DeleteRangeGesture.Builder This value cannot be null.

setDeletionStartArea

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

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).
Deletion strategy using two rectangles
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.

Returns
DeleteRangeGesture.Builder This value cannot be null.

setFallbackText

Added in API level 34
public DeleteRangeGesture.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
DeleteRangeGesture.Builder This value cannot be null.

setGranularity

Added in API level 34
public DeleteRangeGesture.Builder setGranularity (int granularity)

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 HandwritingGesture.GRANULARITY_CHARACTER, or HandwritingGesture.GRANULARITY_WORD

Returns
DeleteRangeGesture.Builder Builder. This value cannot be null.