SelectRangeGesture.Builder


public static final class SelectRangeGesture.Builder
extends Object

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


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

Summary

Public constructors

Builder()

Public methods

SelectRangeGesture build()
SelectRangeGesture.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.

SelectRangeGesture.Builder setGranularity(int granularity)

Define text selection granularity.

SelectRangeGesture.Builder setSelectionEndArea(RectF endArea)

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

SelectRangeGesture.Builder setSelectionStartArea(RectF startArea)

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

Inherited methods

Public constructors

Builder

public Builder ()

Public methods

build

Added in API level 34
public SelectRangeGesture build ()

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

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

setFallbackText

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

setGranularity

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

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

setSelectionEndArea

Added in API level 34
public SelectRangeGesture.Builder setSelectionEndArea (RectF endArea)

Set rectangular single/multiline end of text selection area intersecting with text. The resulting selection is performed from the start of first word/character in the start rectangle setSelectionStartArea(android.graphics.RectF) to the end of the last word/character in the end rectangle.
Selection strategy using two rectangles
The selection includes the first word/character in the rectangle, the last word/character in the rectangle, and 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 selection rectangle.

Parameters
endArea RectF: RectF (in screen coordinates) for start of selection. This rectangle belongs to the last line where selection should end. This value cannot be null.

Returns
SelectRangeGesture.Builder This value cannot be null.

setSelectionStartArea

Added in API level 34
public SelectRangeGesture.Builder setSelectionStartArea (RectF startArea)

Set rectangular single/multiline start of text selection area intersecting with text. The resulting selection 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 setSelectionEndArea(android.graphics.RectF).
Selection 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 selection rectangle.

Parameters
startArea RectF: RectF (in screen coordinates) for start of selection. This rectangle belongs to first line where selection should start. This value cannot be null.

Returns
SelectRangeGesture.Builder This value cannot be null.