TextLayoutBuilder (TextLayoutBuilder API)

java.lang.Object
- com.facebook.fbui.textlayoutbuilder.TextLayoutBuilder

```
public class TextLayoutBuilder
extends Object
```
An utility class to create text Layouts easily.
This class uses a Builder pattern to allow re-using the same object to create text Layouts with similar properties.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface TextLayoutBuilder.MeasureMode
Measure mode constants similar to View.MeasureSpec

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TextLayoutBuilder.MeasureMode` Measure mode constants similar to `View.MeasureSpec`

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_MAX_LINES

static int MEASURE_MODE_AT_MOST

static int MEASURE_MODE_EXACTLY

static int MEASURE_MODE_UNSPECIFIED

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_LINES`
`static int`	`MEASURE_MODE_AT_MOST`
`static int`	`MEASURE_MODE_EXACTLY`
`static int`	`MEASURE_MODE_UNSPECIFIED`

Constructor Summary

Constructors
Constructor and Description

TextLayoutBuilder()

Constructors
Constructor and Description
`TextLayoutBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Layout`	`build()` Builds and returns a `Layout`.
`Layout.Alignment`	`getAlignment()` Returns the text alignment for this TextLayoutBuilder.
`int`	`getBreakStrategy()` Returns the break strategy for this TextLayoutBuilder.
`float`	`getDensity()`
`int[]`	`getDrawableState()` Returns the drawable state for this TextLayoutBuilder.
`TextUtils.TruncateAt`	`getEllipsize()` Returns the text ellipsize for this TextLayoutBuilder.
`GlyphWarmer`	`getGlyphWarmer()` Returns the GlyphWarmer used by the TextLayoutBuilder.
`int`	`getHyphenationFrequency()` Returns the hyphenation frequency for this TextLayoutBuilder.
`boolean`	`getIncludeFontPadding()` Returns whether this TextLayoutBuilder should include font padding.
`int[]`	`getLeftIndents()` Returns the left indents set on this TextLayoutBuilder.
`int`	`getLinkColor()` Returns the link color for this TextLayoutBuilder.
`int`	`getMaxEms()` Returns the max width expressed in ems.
`int`	`getMaxLines()` Returns the number of max lines used by this TextLayoutBuilder.
`int`	`getMaxWidth()` Returns the max width expressed in pixels.
`int`	`getMinEms()` Returns the min width expressed in ems.
`int`	`getMinWidth()` Returns the min width expressed in pixels.
`int[]`	`getRightIndents()` Returns the right indents set on this TextLayoutBuilder.
`boolean`	`getShouldCacheLayout()` Returns whether the TextLayoutBuilder should cache the layout.
`boolean`	`getShouldWarmText()` Returns whether the TextLayoutBuilder should warm the layout.
`boolean`	`getSingleLine()` Returns whether the TextLayoutBuilder should show a single line.
`CharSequence`	`getText()` Returns the text that would be packed in a layout by this TextLayoutBuilder.
`int`	`getTextColor()` Returns the text color for this TextLayoutBuilder.
`TextDirectionHeuristicCompat`	`getTextDirection()` Returns the text direction for this TextLayoutBuilder.
`float`	`getTextSize()` Returns the text size for this TextLayoutBuilder.
`float`	`getTextSpacingExtra()` Returns the text spacing extra for this TextLayoutBuilder.
`float`	`getTextSpacingMultiplier()` Returns the text spacing multiplier for this TextLayoutBuilder.
`Typeface`	`getTypeface()` Returns the typeface for this TextLayoutBuilder.
`TextLayoutBuilder`	`setAlignment(Layout.Alignment alignment)` Sets text alignment for the layout.
`TextLayoutBuilder`	`setBreakStrategy(int breakStrategy)` Sets a break strategy breaking paragraphs into lines.
`TextLayoutBuilder`	`setDensity(float density)` Sets the density of this layout.
`TextLayoutBuilder`	`setDrawableState(int[] drawableState)` Updates the text colors based on the drawable state.
`TextLayoutBuilder`	`setEllipsize(TextUtils.TruncateAt ellipsize)` Sets the ellipsis location for the layout.
`TextLayoutBuilder`	`setGlyphWarmer(GlyphWarmer glyphWarmer)` Sets the glyph warmer to use.
`TextLayoutBuilder`	`setHyphenationFrequency(int hyphenationFrequency)` Sets the frequency of automatic hyphenation to use when determining word breaks.
`TextLayoutBuilder`	`setIncludeFontPadding(boolean shouldInclude)` Set whether the text Layout includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.
`TextLayoutBuilder`	`setIndents(int[] leftIndents, int[] rightIndents)` Sets the left and right indents for this TextLayoutBuilder.
`TextLayoutBuilder`	`setLinkColor(int linkColor)` Sets the link color for the text in the layout.
`TextLayoutBuilder`	`setMaxEms(int maxEms)` Sets the max width expressed in ems.
`TextLayoutBuilder`	`setMaxLines(int maxLines)` Sets a maximum number of lines to be shown by the Layout.
`TextLayoutBuilder`	`setMaxWidth(int maxWidth)` Sets the max width expressed in pixels.
`TextLayoutBuilder`	`setMinEms(int minEms)` Sets the min width expressed in ems.
`TextLayoutBuilder`	`setMinWidth(int minWidth)` Sets the min width expressed in pixels.
`TextLayoutBuilder`	`setShadowLayer(float radius, float dx, float dy, int color)` Sets the shadow layer for the layout.
`TextLayoutBuilder`	`setShouldCacheLayout(boolean shouldCacheLayout)` Sets whether the text layout should be cached or not.
`TextLayoutBuilder`	`setShouldWarmText(boolean shouldWarmText)` Sets whether the text should be warmed or not.
`TextLayoutBuilder`	`setSingleLine(boolean singleLine)` Sets whether the text should be in a single line or not.
`TextLayoutBuilder`	`setText(CharSequence text)` Sets the text for the layout.
`TextLayoutBuilder`	`setTextColor(ColorStateList colorStateList)` Sets the text color for the layout.
`TextLayoutBuilder`	`setTextColor(int color)` Sets the text color for the layout.
`TextLayoutBuilder`	`setTextDirection(TextDirectionHeuristicCompat textDirection)` Sets the text direction heuristic for the layout.
`TextLayoutBuilder`	`setTextSize(int size)` Sets the text size for the layout.
`TextLayoutBuilder`	`setTextSpacingExtra(float spacingExtra)` Sets the text extra spacing for the layout.
`TextLayoutBuilder`	`setTextSpacingMultiplier(float spacingMultiplier)` Sets the line spacing multiplier for the layout.
`TextLayoutBuilder`	`setTextStyle(int style)` Sets a text style for the layout.
`TextLayoutBuilder`	`setTypeface(Typeface typeface)` Sets the typeface used by this TextLayoutBuilder.
`TextLayoutBuilder`	`setWidth(int width)` Sets the intended width of the text layout.
`TextLayoutBuilder`	`setWidth(int width, int measureMode)` Sets the intended width of the text layout while respecting the measure mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MEASURE_MODE_UNSPECIFIED
```
public static final int MEASURE_MODE_UNSPECIFIED
```
    See Also:
    
    Constant Field Values
  - MEASURE_MODE_EXACTLY
```
public static final int MEASURE_MODE_EXACTLY
```
    See Also:
    
    Constant Field Values
  - MEASURE_MODE_AT_MOST
```
public static final int MEASURE_MODE_AT_MOST
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_LINES
```
public static final int DEFAULT_MAX_LINES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TextLayoutBuilder
```
public TextLayoutBuilder()
```
- Method Detail
  - setWidth
```
public TextLayoutBuilder setWidth(int width)
```
    Sets the intended width of the text layout.
    
    Parameters:
    
    width - The width of the text layout
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setWidth(int, int)
  - setWidth
```
public TextLayoutBuilder setWidth(int width,
                                  int measureMode)
```
    Sets the intended width of the text layout while respecting the measure mode.
    
    Parameters:
    
    width - The width of the text layout
    
    measureMode - The mode with which to treat the given width
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setWidth(int)
  - getText
```
public CharSequence getText()
```
    Returns the text that would be packed in a layout by this TextLayoutBuilder.
    
    Returns:
    
    The text used by this TextLayoutBuilder
  - setText
```
public TextLayoutBuilder setText(CharSequence text)
```
    Sets the text for the layout.
    
    Parameters:
    
    text - The text for the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - getTextSize
```
public float getTextSize()
```
    Returns the text size for this TextLayoutBuilder.
    
    Returns:
    
    The text size used by this TextLayoutBuilder
  - setTextSize
```
public TextLayoutBuilder setTextSize(int size)
```
    Sets the text size for the layout.
    
    Parameters:
    
    size - The text size in pixels
    
    Returns:
    
    This TextLayoutBuilder instance
  - getTextColor
```
public int getTextColor()
```
    Returns the text color for this TextLayoutBuilder.
    
    Returns:
    
    The text color used by this TextLayoutBuilder
  - setTextColor
```
public TextLayoutBuilder setTextColor(int color)
```
    Sets the text color for the layout.
    
    Parameters:
    
    color - The text color for the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - setTextColor
```
public TextLayoutBuilder setTextColor(ColorStateList colorStateList)
```
    Sets the text color for the layout.
    
    Parameters:
    
    colorStateList - The text color state list for the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - getLinkColor
```
public int getLinkColor()
```
    Returns the link color for this TextLayoutBuilder.
    
    Returns:
    
    The link color used by this TextLayoutBuilder
  - setLinkColor
```
public TextLayoutBuilder setLinkColor(int linkColor)
```
    Sets the link color for the text in the layout.
    
    Parameters:
    
    linkColor - The link color
    
    Returns:
    
    This TextLayoutBuilder instance
  - getTextSpacingExtra
```
public float getTextSpacingExtra()
```
    Returns the text spacing extra for this TextLayoutBuilder.
    
    Returns:
    
    The text spacing extra used by this TextLayoutBuilder
  - setTextSpacingExtra
```
public TextLayoutBuilder setTextSpacingExtra(float spacingExtra)
```
    Sets the text extra spacing for the layout.
    
    Parameters:
    
    spacingExtra - the extra space that is added to the height of each line
    
    Returns:
    
    This TextLayoutBuilder instance
  - getTextSpacingMultiplier
```
public float getTextSpacingMultiplier()
```
    Returns the text spacing multiplier for this TextLayoutBuilder.
    
    Returns:
    
    The text spacing multiplier used by this TextLayoutBuilder
  - setTextSpacingMultiplier
```
public TextLayoutBuilder setTextSpacingMultiplier(float spacingMultiplier)
```
    Sets the line spacing multiplier for the layout.
    
    Parameters:
    
    spacingMultiplier - the value by which each line's height is multiplied
    
    Returns:
    
    This TextLayoutBuilder instance
  - getIncludeFontPadding
```
public boolean getIncludeFontPadding()
```
    Returns whether this TextLayoutBuilder should include font padding.
    
    Returns:
    
    Whether this TextLayoutBuilder should include font padding
  - setIncludeFontPadding
```
public TextLayoutBuilder setIncludeFontPadding(boolean shouldInclude)
```
    Set whether the text Layout includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.
    The default is true.
    
    Parameters:
    
    shouldInclude - Whether to include font padding or not
    
    Returns:
    
    This TextLayoutBuilder instance
  - getAlignment
```
public Layout.Alignment getAlignment()
```
    Returns the text alignment for this TextLayoutBuilder.
    
    Returns:
    
    The text alignment used by this TextLayoutBuilder
  - setAlignment
```
public TextLayoutBuilder setAlignment(Layout.Alignment alignment)
```
    Sets text alignment for the layout.
    
    Parameters:
    
    alignment - The text alignment for the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - getTextDirection
```
public TextDirectionHeuristicCompat getTextDirection()
```
    Returns the text direction for this TextLayoutBuilder.
    
    Returns:
    
    The text direction used by this TextLayoutBuilder
  - setTextDirection
```
public TextLayoutBuilder setTextDirection(TextDirectionHeuristicCompat textDirection)
```
    Sets the text direction heuristic for the layout.
    TextDirectionHeuristicCompat describes how to evaluate the text of this Layout to know whether to use RTL or LTR text direction
    
    Parameters:
    
    textDirection - The text direction heuristic for the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - setShadowLayer
```
public TextLayoutBuilder setShadowLayer(float radius,
                                        float dx,
                                        float dy,
                                        int color)
```
    Sets the shadow layer for the layout.
    
    Parameters:
    
    radius - The radius of the blur for shadow
    
    dx - The horizontal translation of the origin
    
    dy - The vertical translation of the origin
    
    color - The shadow color
    
    Returns:
    
    This TextLayoutBuilder instance
  - setTextStyle
```
public TextLayoutBuilder setTextStyle(int style)
```
    Sets a text style for the layout.
    
    Parameters:
    
    style - The text style for the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - getTypeface
```
public Typeface getTypeface()
```
    Returns the typeface for this TextLayoutBuilder.
    
    Returns:
    
    The typeface used by this TextLayoutBuilder
  - setTypeface
```
public TextLayoutBuilder setTypeface(Typeface typeface)
```
    Sets the typeface used by this TextLayoutBuilder.
    
    Parameters:
    
    typeface - The typeface for this TextLayoutBuilder
    
    Returns:
    
    This TextLayoutBuilder instance
  - getDrawableState
```
public int[] getDrawableState()
```
    Returns the drawable state for this TextLayoutBuilder.
    
    Returns:
    
    The drawable state used by this TextLayoutBuilder
  - setDrawableState
```
public TextLayoutBuilder setDrawableState(int[] drawableState)
```
    Updates the text colors based on the drawable state.
    
    Parameters:
    
    drawableState - The current drawable state of the View holding this layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - getEllipsize
```
public TextUtils.TruncateAt getEllipsize()
```
    Returns the text ellipsize for this TextLayoutBuilder.
    
    Returns:
    
    The text ellipsize used by this TextLayoutBuilder
  - setEllipsize
```
public TextLayoutBuilder setEllipsize(TextUtils.TruncateAt ellipsize)
```
    Sets the ellipsis location for the layout.
    
    Parameters:
    
    ellipsize - The ellipsis location in the layout
    
    Returns:
    
    This TextLayoutBuilder instance
  - getSingleLine
```
public boolean getSingleLine()
```
    Returns whether the TextLayoutBuilder should show a single line.
    
    Returns:
    
    Whether the TextLayoutBuilder should show a single line or not
  - setSingleLine
```
public TextLayoutBuilder setSingleLine(boolean singleLine)
```
    Sets whether the text should be in a single line or not.
    
    Parameters:
    
    singleLine - Whether the text should be in a single line or not
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setMaxLines(int)
  - getMaxLines
```
public int getMaxLines()
```
    Returns the number of max lines used by this TextLayoutBuilder.
    
    Returns:
    
    The number of max lines for this TextLayoutBuilder
  - setMaxLines
```
public TextLayoutBuilder setMaxLines(int maxLines)
```
    Sets a maximum number of lines to be shown by the Layout.
    Note: Gingerbread always default to two lines max when ellipsized. This cannot be changed. Use a TextView if you want more control over the number of lines.
    
    Parameters:
    
    maxLines - The number of maxLines to show in this Layout
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setSingleLine(boolean)
  - getBreakStrategy
```
public int getBreakStrategy()
```
    Returns the break strategy for this TextLayoutBuilder.
    
    Returns:
    
    The break strategy for this TextLayoutBuilder
  - setBreakStrategy
```
public TextLayoutBuilder setBreakStrategy(int breakStrategy)
```
    Sets a break strategy breaking paragraphs into lines.
    
    Parameters:
    
    breakStrategy - The break strategy for breaking paragraphs into lines
    
    Returns:
    
    This TextLayoutBuilder instance
  - getHyphenationFrequency
```
public int getHyphenationFrequency()
```
    Returns the hyphenation frequency for this TextLayoutBuilder.
    
    Returns:
    
    The hyphenation frequency for this TextLayoutBuilder
  - setHyphenationFrequency
```
public TextLayoutBuilder setHyphenationFrequency(int hyphenationFrequency)
```
    Sets the frequency of automatic hyphenation to use when determining word breaks.
    
    Parameters:
    
    hyphenationFrequency - The frequency of automatic hyphenation to use for word breaks
    
    Returns:
    
    This TextLayoutBuilder instance
  - getLeftIndents
```
public int[] getLeftIndents()
```
    Returns the left indents set on this TextLayoutBuilder.
    
    Returns:
    
    The left indents set on this TextLayoutBuilder
  - getRightIndents
```
public int[] getRightIndents()
```
    Returns the right indents set on this TextLayoutBuilder.
    
    Returns:
    
    The right indents set on this TextLayoutBuilder
  - setIndents
```
public TextLayoutBuilder setIndents(int[] leftIndents,
                                    int[] rightIndents)
```
    Sets the left and right indents for this TextLayoutBuilder.
    The arrays hold an indent amount, one per line, measured in pixels. For lines past the last element in the array, the last element repeats.
    
    Parameters:
    
    leftIndents - The left indents for the paragraph
    
    rightIndents - The left indents for the paragraph
    
    Returns:
    
    This TextLayoutBuilder instance
  - getShouldCacheLayout
```
public boolean getShouldCacheLayout()
```
    Returns whether the TextLayoutBuilder should cache the layout.
    
    Returns:
    
    Whether the TextLayoutBuilder should cache the layout
  - setShouldCacheLayout
```
public TextLayoutBuilder setShouldCacheLayout(boolean shouldCacheLayout)
```
    Sets whether the text layout should be cached or not.
    Note: If the Layout contains ClickableSpans, the layout will not be cached.
    
    Parameters:
    
    shouldCacheLayout - True to cache the text layout, false otherwise
    
    Returns:
    
    This TextLayoutBuilder instance
  - getShouldWarmText
```
public boolean getShouldWarmText()
```
    Returns whether the TextLayoutBuilder should warm the layout.
    
    Returns:
    
    Whether the TextLayoutBuilder should warm the layout
  - setShouldWarmText
```
public TextLayoutBuilder setShouldWarmText(boolean shouldWarmText)
```
    Sets whether the text should be warmed or not.
    Note: Setting this true is highly effective for large blurbs of text. This method has to be called before the draw pass.
    
    Parameters:
    
    shouldWarmText - True to warm the text layout, false otherwise
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setGlyphWarmer(GlyphWarmer)
  - getGlyphWarmer
```
public GlyphWarmer getGlyphWarmer()
```
    Returns the GlyphWarmer used by the TextLayoutBuilder.
    
    Returns:
    
    The GlyphWarmer for this TextLayoutBuilder
  - setGlyphWarmer
```
public TextLayoutBuilder setGlyphWarmer(GlyphWarmer glyphWarmer)
```
    Sets the glyph warmer to use.
    
    Parameters:
    
    glyphWarmer - GlyphWarmer to use to warm the text layout
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setShouldWarmText(boolean)
  - getMinEms
```
public int getMinEms()
```
    Returns the min width expressed in ems.
    
    Returns:
    
    the min width expressed in ems or -1
    
    See Also:
    
    setMinEms(int)
  - setMinEms
```
public TextLayoutBuilder setMinEms(int minEms)
```
    Sets the min width expressed in ems.
    
    Parameters:
    
    minEms - min width expressed in ems
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setMaxEms(int), setMinWidth(int)
  - getMinWidth
```
public int getMinWidth()
```
    Returns the min width expressed in pixels.
    
    Returns:
    
    the min width expressed in pixels or -1, if the min width was set in ems instead
    
    See Also:
    
    setMinWidth(int)
  - setMinWidth
```
public TextLayoutBuilder setMinWidth(int minWidth)
```
    Sets the min width expressed in pixels.
    
    Parameters:
    
    minWidth - min width expressed in pixels.
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setMaxWidth(int), setMinEms(int)
  - getMaxEms
```
public int getMaxEms()
```
    Returns the max width expressed in ems.
    
    Returns:
    
    the max width expressed in ems or -1, if max width is set in pixels instead
    
    See Also:
    
    setMaxEms(int)
  - setMaxEms
```
public TextLayoutBuilder setMaxEms(int maxEms)
```
    Sets the max width expressed in ems.
    
    Parameters:
    
    maxEms - max width expressed in ems
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setMaxWidth(int), setMinEms(int)
  - getMaxWidth
```
public int getMaxWidth()
```
    Returns the max width expressed in pixels.
    
    Returns:
    
    the max width expressed in pixels or -1, if the max width was set in ems instead
    
    See Also:
    
    setMaxWidth(int)
  - setMaxWidth
```
public TextLayoutBuilder setMaxWidth(int maxWidth)
```
    Sets the max width expressed in pixels.
    
    Parameters:
    
    maxWidth - max width expressed in pixels
    
    Returns:
    
    This TextLayoutBuilder instance
    
    See Also:
    
    setMaxEms(int), setMinWidth(int)
  - getDensity
```
public float getDensity()
```
    Returns:
    
    The density of this layout. If unset, defaults to 1.0
  - setDensity
```
public TextLayoutBuilder setDensity(float density)
```
    Sets the density of this layout. This should typically be set to your current display's density
    
    Parameters:
    
    density - The density desired
    
    Returns:
    
    This TextLayoutBuilder
  - build
```
public Layout build()
```
    Builds and returns a Layout.
    
    Returns:
    
    A Layout based on the parameters set

Class TextLayoutBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MEASURE_MODE_UNSPECIFIED

MEASURE_MODE_EXACTLY

MEASURE_MODE_AT_MOST

DEFAULT_MAX_LINES

Constructor Detail

TextLayoutBuilder

Method Detail

setWidth

setWidth

getText

setText

getTextSize

setTextSize

getTextColor

setTextColor

setTextColor

getLinkColor

setLinkColor

getTextSpacingExtra

setTextSpacingExtra

getTextSpacingMultiplier

setTextSpacingMultiplier

getIncludeFontPadding

setIncludeFontPadding

getAlignment

setAlignment

getTextDirection

setTextDirection

setShadowLayer

setTextStyle

getTypeface

setTypeface

getDrawableState

setDrawableState

getEllipsize

setEllipsize

getSingleLine

setSingleLine

getMaxLines

setMaxLines

getBreakStrategy

setBreakStrategy

getHyphenationFrequency

setHyphenationFrequency

getLeftIndents

getRightIndents

setIndents

getShouldCacheLayout

setShouldCacheLayout

getShouldWarmText

setShouldWarmText

getGlyphWarmer

setGlyphWarmer

getMinEms

setMinEms

getMinWidth

setMinWidth

getMaxEms

setMaxEms

getMaxWidth

setMaxWidth

getDensity

setDensity

build