Added in API level 28

Builder

---

Kotlin |Java

class Builder

kotlin.Any
↳	android.text.DynamicLayout.Builder

Builder for dynamic layouts. The builder is the preferred pattern for constructing DynamicLayout objects and should be preferred over the constructors, particularly to access newer features. To build a dynamic layout, first call obtain with the required arguments (base, paint, and width), then call setters for optional parameters, and finally build to build the DynamicLayout object. Parameters not explicitly set will get default values.

Summary

Public methods
DynamicLayout	build() Build the DynamicLayout after options have been set.
static DynamicLayout.Builder	obtain(base: CharSequence, paint: TextPaint, width: Int) Obtain a builder for constructing DynamicLayout objects.
DynamicLayout.Builder	setAlignment(alignment: Layout.Alignment) Set the alignment.
DynamicLayout.Builder	setBreakStrategy(breakStrategy: Int) Set break strategy, useful for selecting high quality or balanced paragraph layout options.
DynamicLayout.Builder	setDisplayText(display: CharSequence) Set the transformed text (password transformation being the primary example of a transformation) that will be updated as the base text is changed.
DynamicLayout.Builder!	setEllipsize(ellipsize: TextUtils.TruncateAt?) Set ellipsizing on the layout.
DynamicLayout.Builder	setEllipsizedWidth(ellipsizedWidth: Int) Set the width as used for ellipsizing purposes, if it differs from the normal layout width.
DynamicLayout.Builder	setHyphenationFrequency(hyphenationFrequency: Int) Set hyphenation frequency, to control the amount of automatic hyphenation used.
DynamicLayout.Builder	setIncludePad(includePad: Boolean) Set whether to include extra space beyond font ascent and descent (which is needed to avoid clipping in some languages, such as Arabic and Kannada).
DynamicLayout.Builder	setJustificationMode(justificationMode: Int) Set paragraph justification mode.
DynamicLayout.Builder	setLineBreakConfig(lineBreakConfig: LineBreakConfig) Set the line break configuration.
DynamicLayout.Builder	setLineSpacing(spacingAdd: Float, spacingMult: Float) Set line spacing parameters.
DynamicLayout.Builder	setMinimumFontMetrics(minimumFontMetrics: Paint.FontMetrics?) Set the minimum font metrics used for line spacing.
DynamicLayout.Builder	setShiftDrawingOffsetForStartOverhang(shiftDrawingOffsetForStartOverhang: Boolean) Set true for shifting the drawing x offset for showing overhang at the start position.
DynamicLayout.Builder	setTextDirection(textDir: TextDirectionHeuristic) Set the text direction heuristic.
DynamicLayout.Builder	setUseBoundsForWidth(useBoundsForWidth: Boolean) Set true for using width of bounding box as a source of automatic line breaking and drawing.
DynamicLayout.Builder	setUseLineSpacingFromFallbacks(useLineSpacingFromFallbacks: Boolean) Set whether to respect the ascent and descent of the fallback fonts that are used in displaying the text (which is needed to avoid text from consecutive lines running into each other).

Public methods

build

Added in API level 28

fun build(): DynamicLayout

Build the DynamicLayout after options have been set.

Note: the builder object must not be reused in any way after calling this method. Setting parameters after calling this method, or calling it a second time on the same builder object, will likely lead to unexpected results.

Return
DynamicLayout	the newly constructed DynamicLayout object This value cannot be null.

obtain

Added in API level 28

static fun obtain(
    base: CharSequence, 
    paint: TextPaint, 
    width: Int
): DynamicLayout.Builder

Obtain a builder for constructing DynamicLayout objects.

Parameters
base	CharSequence: This value cannot be null.
paint	TextPaint: This value cannot be null.
width	Int: Value is 0 or greater

Return
DynamicLayout.Builder	This value cannot be null.

setAlignment

Added in API level 28

fun setAlignment(alignment: Layout.Alignment): DynamicLayout.Builder

Set the alignment. The default is Layout.Alignment#ALIGN_NORMAL.

Parameters
alignment	Layout.Alignment: Alignment for the resulting DynamicLayout This value cannot be null.

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

setBreakStrategy

Added in API level 28

fun setBreakStrategy(breakStrategy: Int): DynamicLayout.Builder

Set break strategy, useful for selecting high quality or balanced paragraph layout options. The default is Layout#BREAK_STRATEGY_SIMPLE.

Parameters
breakStrategy	Int: break strategy for paragraph layout Value is android.graphics.text.LineBreaker#BREAK_STRATEGY_SIMPLE, android.graphics.text.LineBreaker#BREAK_STRATEGY_HIGH_QUALITY, or android.graphics.text.LineBreaker#BREAK_STRATEGY_BALANCED

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

See Also

• android.widget.TextView#setBreakStrategy

setDisplayText

Added in API level 28

fun setDisplayText(display: CharSequence): DynamicLayout.Builder

Set the transformed text (password transformation being the primary example of a transformation) that will be updated as the base text is changed. The default is the 'base' text passed to the builder's constructor.

Parameters
display	CharSequence: the transformed text This value cannot be null.

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

setEllipsize

Added in API level 28

fun setEllipsize(ellipsize: TextUtils.TruncateAt?): DynamicLayout.Builder!

Set ellipsizing on the layout. Causes words that are longer than the view is wide, or exceeding the number of lines (see #setMaxLines) in the case of android.text.TextUtils.TruncateAt#END or android.text.TextUtils.TruncateAt#MARQUEE, to be ellipsized instead of broken. The default is null, indicating no ellipsis is to be applied.

Parameters
ellipsize	TextUtils.TruncateAt?: type of ellipsis behavior This value may be null.

Return
DynamicLayout.Builder!	this builder, useful for chaining

See Also

• android.widget.TextView#setEllipsize

setEllipsizedWidth

Added in API level 28

fun setEllipsizedWidth(ellipsizedWidth: Int): DynamicLayout.Builder

Set the width as used for ellipsizing purposes, if it differs from the normal layout width. The default is the width passed to obtain.

Parameters
ellipsizedWidth	Int: width used for ellipsizing, in pixels Value is 0 or greater

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

See Also

• android.widget.TextView#setEllipsize

setHyphenationFrequency

Added in API level 28

fun setHyphenationFrequency(hyphenationFrequency: Int): DynamicLayout.Builder

Set hyphenation frequency, to control the amount of automatic hyphenation used. The possible values are defined in Layout, by constants named with the pattern HYPHENATION_FREQUENCY_*. The default is Layout#HYPHENATION_FREQUENCY_NONE.

Parameters
hyphenationFrequency	Int: hyphenation frequency for the paragraph Value is android.text.Layout#HYPHENATION_FREQUENCY_NORMAL, android.text.Layout#HYPHENATION_FREQUENCY_NORMAL_FAST, android.text.Layout#HYPHENATION_FREQUENCY_FULL, android.text.Layout#HYPHENATION_FREQUENCY_FULL_FAST, or android.text.Layout#HYPHENATION_FREQUENCY_NONE

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

See Also

• android.widget.TextView#setHyphenationFrequency

setIncludePad

Added in API level 28

fun setIncludePad(includePad: Boolean): DynamicLayout.Builder

Set whether to include extra space beyond font ascent and descent (which is needed to avoid clipping in some languages, such as Arabic and Kannada). The default is true.

Parameters
includePad	Boolean: whether to include padding

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

See Also

• android.widget.TextView#setIncludeFontPadding

setJustificationMode

Added in API level 28

fun setJustificationMode(justificationMode: Int): DynamicLayout.Builder

Set paragraph justification mode. The default value is Layout#JUSTIFICATION_MODE_NONE. If the last line is too short for justification, the last line will be displayed with the alignment set by setAlignment.

Parameters
justificationMode	Int: justification mode for the paragraph. Value is android.graphics.text.LineBreaker#JUSTIFICATION_MODE_NONE, android.graphics.text.LineBreaker#JUSTIFICATION_MODE_INTER_WORD, or android.graphics.text.LineBreaker#JUSTIFICATION_MODE_INTER_CHARACTER

Return
DynamicLayout.Builder	this builder, useful for chaining. This value cannot be null.

setLineBreakConfig

Added in API level 35

fun setLineBreakConfig(lineBreakConfig: LineBreakConfig): DynamicLayout.Builder

Set the line break configuration. The line break will be passed to native used for calculating the text wrapping. The default value of the line break style is LineBreakConfig#LINE_BREAK_STYLE_NONE

Parameters
lineBreakConfig	LineBreakConfig: the line break configuration for text wrapping. This value cannot be null.

Return
DynamicLayout.Builder	this builder, useful for chaining. This value cannot be null.

See Also

• android.widget.TextView#setLineBreakStyle
• android.widget.TextView#setLineBreakWordStyle

setLineSpacing

Added in API level 28

fun setLineSpacing(
    spacingAdd: Float, 
    spacingMult: Float
): DynamicLayout.Builder

Set line spacing parameters. Each line will have its line spacing multiplied by spacingMult and then increased by spacingAdd. The default is 0.0 for spacingAdd and 1.0 for spacingMult.

Parameters
spacingAdd	Float: the amount of line spacing addition
spacingMult	Float: the line spacing multiplier Value is 0.0 or greater

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

See Also

• android.widget.TextView#setLineSpacing

setMinimumFontMetrics

Added in API level 35

fun setMinimumFontMetrics(minimumFontMetrics: Paint.FontMetrics?): DynamicLayout.Builder

Set the minimum font metrics used for line spacing.

null is the default value. If null is set or left as default, the font metrics obtained by Paint#getFontMetricsForLocale(Paint.FontMetrics) is used.

The minimum meaning here is the minimum value of line spacing: maximum value of Paint#ascent(), minimum value of Paint#descent().

By setting this value, each line will have minimum line spacing regardless of the text rendered. For example, usually Japanese script has larger vertical metrics than Latin script. By setting the metrics obtained by Paint#getFontMetricsForLocale(Paint.FontMetrics) for Japanese or leave it null if the Paint's locale is Japanese, the line spacing for Japanese is reserved if the text is an English text. If the vertical metrics of the text is larger than Japanese, for example Burmese, the bigger font metrics is used.

Parameters
minimumFontMetrics	Paint.FontMetrics?: A minimum font metrics. Passing null for using the value obtained by Paint#getFontMetricsForLocale(Paint.FontMetrics)

See Also

• android.widget.TextView#setMinimumFontMetrics(Paint.FontMetrics)
• android.widget.TextView#getMinimumFontMetrics()
• android.text.Layout#getMinimumFontMetrics()
• android.text.Layout.Builder#setMinimumFontMetrics(Paint.FontMetrics)
• android.text.StaticLayout.Builder#setMinimumFontMetrics(Paint.FontMetrics)

setShiftDrawingOffsetForStartOverhang

Added in API level 35

fun setShiftDrawingOffsetForStartOverhang(shiftDrawingOffsetForStartOverhang: Boolean): DynamicLayout.Builder

Set true for shifting the drawing x offset for showing overhang at the start position. This flag is ignored if the getUseBoundsForWidth() is false. If this value is false, the Layout draws text from the zero even if there is a glyph stroke in a region where the x coordinate is negative. If this value is true, the Layout draws text with shifting the x coordinate of the drawing bounding box. This value is false by default.

Parameters
shiftDrawingOffsetForStartOverhang	Boolean: true for shifting the drawing offset for showing the stroke that is in the region where the x coordinate is negative.

Return
DynamicLayout.Builder	This value cannot be null.

See Also

• #setUseBoundsForWidth(boolean)
• #getUseBoundsForWidth()

setTextDirection

Added in API level 28

fun setTextDirection(textDir: TextDirectionHeuristic): DynamicLayout.Builder

Set the text direction heuristic. The text direction heuristic is used to resolve text direction per-paragraph based on the input text. The default is TextDirectionHeuristics#FIRSTSTRONG_LTR.

Parameters
textDir	TextDirectionHeuristic: text direction heuristic for resolving bidi behavior. This value cannot be null.

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.

setUseBoundsForWidth

Added in API level 35

fun setUseBoundsForWidth(useBoundsForWidth: Boolean): DynamicLayout.Builder

Set true for using width of bounding box as a source of automatic line breaking and drawing. If this value is false, the Layout determines the drawing offset and automatic line breaking based on total advances. By setting true, use all joined glyph's bounding boxes as a source of text width. If the font has glyphs that have negative bearing X or its xMax is greater than advance, the glyph clipping can happen because the drawing area may be bigger. By setting this to true, the Layout will reserve more spaces for drawing.

Parameters
useBoundsForWidth	Boolean: True for using bounding box, false for advances.

Return
DynamicLayout.Builder	this builder instance This value cannot be null.

See Also

• android.text.Layout#getUseBoundsForWidth()
• android.text.Layout.Builder#setUseBoundsForWidth(boolean)

setUseLineSpacingFromFallbacks

Added in API level 28

fun setUseLineSpacingFromFallbacks(useLineSpacingFromFallbacks: Boolean): DynamicLayout.Builder

Set whether to respect the ascent and descent of the fallback fonts that are used in displaying the text (which is needed to avoid text from consecutive lines running into each other). If set, fallback fonts that end up getting used can increase the ascent and descent of the lines that they are used on.

For backward compatibility reasons, the default is false, but setting this to true is strongly recommended. It is required to be true if text could be in languages like Burmese or Tibetan where text is typically much taller or deeper than Latin text.

Parameters
useLineSpacingFromFallbacks	Boolean: whether to expand linespacing based on fallback fonts

Return
DynamicLayout.Builder	this builder, useful for chaining This value cannot be null.