SelectGesture.Builder


public static final class SelectGesture.Builder
extends Object

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


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

Summary

Public constructors

Builder()

Public methods

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

SelectGesture.Builder setGranularity(int granularity)

Define text selection granularity.

SelectGesture.Builder setSelectionArea(RectF area)

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

Inherited methods

Public constructors

Builder

public Builder ()

Public methods

build

Added in API level 34
public SelectGesture build ()

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

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

setFallbackText

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

setGranularity

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

setSelectionArea

Added in API level 34
public SelectGesture.Builder setSelectionArea (RectF area)

Set rectangular single/multiline text selection area intersecting with text. The resulting selection would be performed for all text intersecting rectangle. The selection 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 selection rectangle.

Parameters
area RectF: RectF (in screen coordinates) for which text will be selection. This value cannot be null.

Returns
SelectGesture.Builder This value cannot be null.