Builder

build

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.

obtain

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

Obtain a builder for constructing DynamicLayout objects.

setAlignment

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

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

setBreakStrategy

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.

setDisplayText

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.

setEllipsize

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.

setEllipsizedWidth

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.

setHyphenationFrequency

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.

setIncludePad

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.

setJustificationMode

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.

setLineBreakConfig

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

setLineSpacing

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.

setMinimumFontMetrics

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.

setShiftDrawingOffsetForStartOverhang

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.

setTextDirection

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.

setUseBoundsForWidth

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.

setUseLineSpacingFromFallbacks

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.