Builder

Builder

Builder(
    text: CharSequence, 
    start: Int, 
    end: Int, 
    paint: TextPaint, 
    width: Int)

Construct a builder class.

build

fun build(): Layout

Build a Layout object.

setAlignment

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

Set the text alignment. The default value is Layout.Alignment.ALIGN_NORMAL.

setBreakStrategy

fun setBreakStrategy(breakStrategy: Int): Layout.Builder

Set the line break strategy. The default value is Layout.BREAK_STRATEGY_SIMPLE.

setEllipsize

fun setEllipsize(ellipsize: TextUtils.TruncateAt?): Layout.Builder

Set the ellipsizing type. By setting null, the ellipsize is disabled. The default value is null.

setEllipsizedWidth

fun setEllipsizedWidth(ellipsizeWidth: Int): Layout.Builder

Set the width as used for ellipsizing purpose in pixels. The passed value is ignored and forced to set to the value of width constraint passed in constructor if no ellipsize option is set. The default value is the width constraint.

setFallbackLineSpacingEnabled

fun setFallbackLineSpacingEnabled(fallbackLineSpacing: Boolean): Layout.Builder

Set whether to respect the ascent and descent of the fallback fonts. 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. The default value is false

setFontPaddingIncluded

fun setFontPaddingIncluded(includeFontPadding: Boolean): Layout.Builder

Set whether including extra padding into the first and the last line height. By setting true, the first line of the text and the last line of the text will have extra vertical space for avoiding clipping. The default value is true.

setHyphenationFrequency

fun setHyphenationFrequency(hyphenationFrequency: Int): Layout.Builder

Set the hyphenation frequency. The default value is Layout.HYPHENATION_FREQUENCY_NONE.

setJustificationMode

fun setJustificationMode(justificationMode: Int): Layout.Builder

Set justification mode. When justification mode is Layout.JUSTIFICATION_MODE_INTER_WORD, the word spacing on the given Paint passed to the constructor will be ignored. This behavior also affects spans which change the word spacing. The default value is Layout.JUSTIFICATION_MODE_NONE.

setLeftIndents

fun setLeftIndents(leftIndents: IntArray?): Layout.Builder

Set visually left indents in pixels per lines. For the lines past the last element in the array, the last element repeats. Passing null for disabling indents. Note that even with the RTL layout, this method reserve spacing at the visually left of the line. The default value is null.

setLineBreakConfig

fun setLineBreakConfig(lineBreakConfig: LineBreakConfig): Layout.Builder

Set the line break configuration. The default value is a LinebreakConfig instance that has LineBreakConfig.LINE_BREAK_STYLE_NONE and LineBreakConfig.LINE_BREAK_WORD_STYLE_NONE.

setLineSpacingAmount

fun setLineSpacingAmount(amount: Float): Layout.Builder

Set the line spacing amount. The specified amount of pixels will be added to each line. The default value is 0. The negative value is allowed for squeezing lines.

setLineSpacingMultiplier

fun setLineSpacingMultiplier(multiplier: Float): Layout.Builder

Set the line spacing multiplier. The specified value will be multiplied to each line. The default value is 1.

setMaxLines

fun setMaxLines(maxLines: Int): Layout.Builder

Set the maximum number of lines. The default value is unlimited.

setMinimumFontMetrics

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

Set the minimum font metrics used for line spacing.

null is the default value. If null is set or left it 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.

setRightIndents

fun setRightIndents(rightIndents: IntArray?): Layout.Builder

Set visually right indents in pixels per lines. For the lines past the last element in the array, the last element repeats. Passing null for disabling indents. Note that even with the RTL layout, this method reserve spacing at the visually right of the line. The default value is null.

setShiftDrawingOffsetForStartOverhang

fun setShiftDrawingOffsetForStartOverhang(shiftDrawingOffsetForStartOverhang: Boolean): Layout.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.

setTextDirectionHeuristic

fun setTextDirectionHeuristic(textDirection: TextDirectionHeuristic): Layout.Builder

Set the text direction heuristics. The text direction heuristics is used to resolve text direction on the text. The default value is TextDirectionHeuristics.FIRSTSTRONG_LTR

setUseBoundsForWidth

fun setUseBoundsForWidth(useBoundsForWidth: Boolean): Layout.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.