TextAttribute.Builder | API reference

Summary: Ctors | Methods | Inherited Methods

public static final class TextAttribute.Builder
extends Object

Builder for creating a TextAttribute.

Summary

Public constructors
`Builder()`

Public methods
`TextAttribute`	`build()`
`TextAttribute.Builder`	`setExtras(PersistableBundle extras)` Sets extras data.
`TextAttribute.Builder`	`setTextConversionSuggestions(List<String> textConversionSuggestions)` Sets text conversion suggestions.
`TextAttribute.Builder`	`setTextSuggestionSelected(boolean textSuggestionSelected)` Sets whether a text conversion suggestion is currently being selected.

Inherited methods

From class java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

public Builder ()

Public methods

setExtras

public TextAttribute.Builder setExtras (PersistableBundle extras)

Sets extras data.

Any extra data to supply to the applications. This field is for extended communication with IME if there is data not defined in framework.

Parameters
`extras`	`PersistableBundle`: This value cannot be `null`.

Returns
`TextAttribute.Builder`	This builder. This value cannot be `null`.

setTextConversionSuggestions

public TextAttribute.Builder setTextConversionSuggestions (List<String> textConversionSuggestions)

Sets text conversion suggestions.

Text conversion suggestion is for some transliteration languages which has pronunciation characters and target characters. When the user is typing the pronunciation characters, the input method can insert possible target characters into this list so that the editor authors can provide suggestion before the user enters the complete pronunciation characters.

Parameters
`textConversionSuggestions`	`List`: The list of text conversion suggestions. This value cannot be `null`.

Returns
`TextAttribute.Builder`	This builder. This value cannot be `null`.

setTextSuggestionSelected

public TextAttribute.Builder setTextSuggestionSelected (boolean textSuggestionSelected)

Sets whether a text conversion suggestion is currently being selected.

In some transliteration languages, this describes the state which the user is currently selecting a text conversion suggestion. In other words, if set to True the user is in an ephemeral state of selecting which text will replace the current composition text.

Parameters
`textSuggestionSelected`	`boolean`: Whether if the current text is undergoing text suggestion selection

Returns
`TextAttribute.Builder`	This builder. This value cannot be `null`.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.