LineBreakConfig.Builder

Kotlin |Java

public static final class LineBreakConfig.Builder
extends Object

java.lang.Object
↳	android.graphics.text.LineBreakConfig.Builder

A builder for creating a LineBreakConfig instance.

Summary

Public constructors
`Builder()` Builder constructor.

Public methods
`LineBreakConfig`	`build()` Builds a `LineBreakConfig` instance.
`LineBreakConfig.Builder`	`merge(LineBreakConfig config)` Merges line break config with other config Update the internal configurations with passed `config`.
`LineBreakConfig.Builder`	`setHyphenation(int hyphenation)` Sets the hyphenation preference Note: Even if the `LineBreakConfig.HYPHENATION_ENABLED` is specified, the hyphenation will not be performed if the `TextView` or underlying `StaticLayout`, `LineBreaker` are configured with `LineBreaker.HYPHENATION_FREQUENCY_NONE`.
`LineBreakConfig.Builder`	`setLineBreakStyle(int lineBreakStyle)` Sets the line-break style.
`LineBreakConfig.Builder`	`setLineBreakWordStyle(int lineBreakWordStyle)` Sets the line-break word style.

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

Added in API level 33

public Builder ()

Builder constructor.

Public methods

build

Added in API level 33

public LineBreakConfig build ()

Builds a LineBreakConfig instance. This method can be called multiple times for generating multiple LineBreakConfig instances.

Returns
`LineBreakConfig`	The `LineBreakConfig` instance. This value cannot be `null`.

merge

Added in API level 35

public LineBreakConfig.Builder merge (LineBreakConfig config)

Merges line break config with other config Update the internal configurations with passed config. If the config values of passed config are unspecified, the original config values are kept. For example, the following code passes config that has LineBreakConfig.LINE_BREAK_STYLE_UNSPECIFIED. This code generates LineBreakConfig that has line break config LineBreakConfig.LINE_BREAK_STYLE_STRICT.

     val override = LineBreakConfig.Builder()
          .setLineBreakWordStyle(LineBreakConfig.LINE_BREAK_WORD_STYLE_PHRASE)
          .build();  // UNSPECIFIED if no setLineBreakStyle is called.
     val config = LineBreakConfig.Builder()
          .setLineBreakStyle(LineBreakConfig.LINE_BREAK_STYLE_STRICT)
          .merge(override)
          .build()
     // Here, config has LINE_BREAK_STYLE_STRICT of line break config and
     // LINE_BREAK_WORD_STYLE_PHRASE of line break word style.

Parameters
`config`	`LineBreakConfig`: an override line break config This value cannot be `null`.

Returns
`LineBreakConfig.Builder`	This `Builder`. This value cannot be `null`.

See also:

setHyphenation

Added in API level 35

public LineBreakConfig.Builder setHyphenation (int hyphenation)

Sets the hyphenation preference Note: Even if the LineBreakConfig.HYPHENATION_ENABLED is specified, the hyphenation will not be performed if the TextView or underlying StaticLayout, LineBreaker are configured with LineBreaker.HYPHENATION_FREQUENCY_NONE. Note: Even if the hyphenation is enabled with a line break strategy LineBreaker.BREAK_STRATEGY_SIMPLE, the hyphenation will not be performed unless a single word cannot meet width constraints.

Parameters
`hyphenation`	`int`: The hyphenation preference. Value is `LineBreakConfig.HYPHENATION_UNSPECIFIED`, `LineBreakConfig.HYPHENATION_ENABLED`, or `LineBreakConfig.HYPHENATION_DISABLED`

Returns
`LineBreakConfig.Builder`	This `Builder`. This value cannot be `null`.

setLineBreakStyle

Added in API level 33

public LineBreakConfig.Builder setLineBreakStyle (int lineBreakStyle)

Sets the line-break style.

Parameters
`lineBreakStyle`	`int`: The new line-break style. Value is `LineBreakConfig.LINE_BREAK_STYLE_NONE`, `LineBreakConfig.LINE_BREAK_STYLE_LOOSE`, `LineBreakConfig.LINE_BREAK_STYLE_NORMAL`, `LineBreakConfig.LINE_BREAK_STYLE_STRICT`, `LineBreakConfig.LINE_BREAK_STYLE_UNSPECIFIED`, `LineBreakConfig.LINE_BREAK_STYLE_NO_BREAK`, or `LineBreakConfig.LINE_BREAK_STYLE_AUTO`

Returns
`LineBreakConfig.Builder`	This `Builder`. This value cannot be `null`.

See also:

setLineBreakWordStyle

Added in API level 33

public LineBreakConfig.Builder setLineBreakWordStyle (int lineBreakWordStyle)

Sets the line-break word style.

Parameters
`lineBreakWordStyle`	`int`: The new line-break word style. Value is `LineBreakConfig.LINE_BREAK_WORD_STYLE_NONE`, `LineBreakConfig.LINE_BREAK_WORD_STYLE_PHRASE`, `LineBreakConfig.LINE_BREAK_WORD_STYLE_UNSPECIFIED`, or `LineBreakConfig.LINE_BREAK_WORD_STYLE_AUTO`

Returns
`LineBreakConfig.Builder`	This `Builder`. This value cannot be `null`.

See also: