Added in API level 1

Layout

Kotlin |Java

public abstract class Layout
extends Object

java.lang.Object
↳	android.text.Layout

Known direct subclasses

BoringLayout, DynamicLayout, StaticLayout

BoringLayout	A BoringLayout is a very simple Layout implementation for text that fits on a single line and is all left-to-right characters.
DynamicLayout	DynamicLayout is a text layout that updates itself as the text is edited.
StaticLayout	StaticLayout is a Layout for text that will not be edited after it is laid out.

A base class that manages text layout in visual elements on the screen.

For text that will be edited, use a DynamicLayout, which will be updated as the text changes. For text that will not change, use a StaticLayout.

Summary

Nested classes
`class`	`Layout.Builder` A builder class for Layout object.
`class`	`Layout.Directions` Stores information about bidirectional (left-to-right or right-to-left) text within the layout of a line.
`interface`	`Layout.TextInclusionStrategy` Strategy for determining whether a text segment is inside a rectangle area.

Constants
`int`	`BREAK_STRATEGY_BALANCED` Value for break strategy indicating balanced line breaking.
`int`	`BREAK_STRATEGY_HIGH_QUALITY` Value for break strategy indicating high quality line breaking, including automatic hyphenation and doing whole-paragraph optimization of line breaks.
`int`	`BREAK_STRATEGY_SIMPLE` Value for break strategy indicating simple line breaking.
`float`	`DEFAULT_LINESPACING_ADDITION`
`float`	`DEFAULT_LINESPACING_MULTIPLIER`
`int`	`DIR_LEFT_TO_RIGHT`
`int`	`DIR_RIGHT_TO_LEFT`
`int`	`HYPHENATION_FREQUENCY_FULL` Value for hyphenation frequency indicating the full amount of automatic hyphenation, typical in typography.
`int`	`HYPHENATION_FREQUENCY_FULL_FAST` Value for hyphenation frequency indicating the full amount of automatic hyphenation with using faster algorithm.
`int`	`HYPHENATION_FREQUENCY_NONE` Value for hyphenation frequency indicating no automatic hyphenation.
`int`	`HYPHENATION_FREQUENCY_NORMAL` Value for hyphenation frequency indicating a light amount of automatic hyphenation, which is a conservative default.
`int`	`HYPHENATION_FREQUENCY_NORMAL_FAST` Value for hyphenation frequency indicating a light amount of automatic hyphenation with using faster algorithm.
`int`	`JUSTIFICATION_MODE_INTER_CHARACTER` Value for justification mode indicating the text is justified by stretching letter spacing.
`int`	`JUSTIFICATION_MODE_INTER_WORD` Value for justification mode indicating the text is justified by stretching word spacing.
`int`	`JUSTIFICATION_MODE_NONE` Value for justification mode indicating no justification.

Fields
`public static final Layout.TextInclusionStrategy`	`INCLUSION_STRATEGY_ANY_OVERLAP` Strategy which considers a text segment to be inside a rectangle area if the segment bounds intersect the rectangle.
`public static final Layout.TextInclusionStrategy`	`INCLUSION_STRATEGY_CONTAINS_ALL` Strategy which considers a text segment to be inside a rectangle area if the segment bounds are completely contained within the rectangle.
`public static final Layout.TextInclusionStrategy`	`INCLUSION_STRATEGY_CONTAINS_CENTER` Strategy which considers a text segment to be inside a rectangle area if the center of the segment bounds is inside the rectangle.

Protected constructors
`Layout(CharSequence text, TextPaint paint, int width, Layout.Alignment align, float spacingMult, float spacingAdd)` Subclasses of Layout use this constructor to set the display text, width, and other standard properties.

Public methods
`RectF`	`computeDrawingBoundingBox()` Get an actual bounding box that draws text content.
`void`	`draw(Canvas c)` Draw this Layout on the specified Canvas.
`void`	`draw(Canvas canvas, Path selectionHighlight, Paint selectionHighlightPaint, int cursorOffsetVertical)` Draw this Layout on the specified canvas, with the highlight path drawn between the background and the text.
`void`	`draw(Canvas canvas, List<Path> highlightPaths, List<Paint> highlightPaints, Path selectionPath, Paint selectionPaint, int cursorOffsetVertical)` Draw this layout on the specified canvas.
`void`	`drawBackground(Canvas canvas)` Draw background of this layout.
`void`	`drawText(Canvas canvas)` Draw text part of this layout.
`void`	`fillCharacterBounds(int start, int end, float[] bounds, int boundsStart)` Return the characters' bounds in the given range.
`final Layout.Alignment`	`getAlignment()` Returns the alignment used for creating this layout in pixels.
`abstract int`	`getBottomPadding()` Returns the number of extra pixels of descent padding in the bottom line of the Layout.
`final int`	`getBreakStrategy()` Return the break strategy used for creating this layout.
`void`	`getCursorPath(int point, Path dest, CharSequence editingBuffer)` Fills in the specified Path with a representation of a cursor at the specified offset.
`static float`	`getDesiredWidth(CharSequence source, TextPaint paint)` Return how wide a layout must be in order to display the specified text with one line per paragraph.
`static float`	`getDesiredWidth(CharSequence source, int start, int end, TextPaint paint)` Return how wide a layout must be in order to display the specified text slice with one line per paragraph.
`abstract int`	`getEllipsisCount(int line)` Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.
`abstract int`	`getEllipsisStart(int line)` Return the offset of the first character to be ellipsized away, relative to the start of the line.
`final TextUtils.TruncateAt`	`getEllipsize()` Return the ellipsize option used for creating this layout.
`int`	`getEllipsizedWidth()` Return the width to which this layout is ellipsized.
`int`	`getHeight()` Return the total height of this layout.
`final int`	`getHyphenationFrequency()` Return the hyphenation frequency used for creating this layout.
`final int`	`getJustificationMode()` Return the justification mode used for creating this layout.
`final int[]`	`getLeftIndents()` Return a copy of the left indents used for this layout.
`final int`	`getLineAscent(int line)` Get the ascent of the text on the specified line.
`final int`	`getLineBaseline(int line)` Return the vertical position of the baseline of the specified line.
`int`	`getLineBottom(int line, boolean includeLineSpacing)` Return the vertical position of the bottom of the specified line.
`final int`	`getLineBottom(int line)` Return the vertical position of the bottom of the specified line.
`int`	`getLineBounds(int line, Rect bounds)` Return the baseline for the specified line (0…getLineCount() - 1) If bounds is not null, return the top, left, right, bottom extents of the specified line in it.
`LineBreakConfig`	`getLineBreakConfig()` Gets the `LineBreakConfig` used for creating this layout.
`abstract boolean`	`getLineContainsTab(int line)` Returns whether the specified line contains one or more characters that need to be handled specially, like tabs.
`abstract int`	`getLineCount()` Return the number of lines of text in this layout.
`abstract int`	`getLineDescent(int line)` Return the descent of the specified line(0…getLineCount() - 1).
`abstract Layout.Directions`	`getLineDirections(int line)` Returns the directional run information for the specified line.
`final int`	`getLineEnd(int line)` Return the text offset after the last character on the specified line.
`int`	`getLineForOffset(int offset)` Get the line number on which the specified text offset appears.
`int`	`getLineForVertical(int vertical)` Get the line number corresponding to the specified vertical position.
`float`	`getLineLeft(int line)` Get the leftmost position that should be exposed for horizontal scrolling on the specified line.
`int`	`getLineLetterSpacingUnitCount(int line, boolean includeTrailingWhitespace)` Returns the number of letter spacing unit in the line.
`float`	`getLineMax(int line)` Gets the unsigned horizontal extent of the specified line, including leading margin indent, but excluding trailing whitespace.
`float`	`getLineRight(int line)` Get the rightmost position that should be exposed for horizontal scrolling on the specified line.
`final float`	`getLineSpacingAmount()` Returns the amount added to the line height.
`final float`	`getLineSpacingMultiplier()` Returns the multiplier applied to the line height.
`abstract int`	`getLineStart(int line)` Return the text offset of the beginning of the specified line ( 0…getLineCount()).
`abstract int`	`getLineTop(int line)` Return the vertical position of the top of the specified line (0…getLineCount()).
`int`	`getLineVisibleEnd(int line)` Return the text offset after the last visible character (so whitespace is not counted) on the specified line.
`float`	`getLineWidth(int line)` Gets the unsigned horizontal extent of the specified line, including leading margin indent and trailing whitespace.
`final int`	`getMaxLines()` Return the maximum lines allowed used for creating this layout.
`Paint.FontMetrics`	`getMinimumFontMetrics()` Get the minimum font metrics used for line spacing.
`int`	`getOffsetForHorizontal(int line, float horiz)` Get the character offset on the specified line whose position is closest to the specified horizontal position.
`int`	`getOffsetToLeftOf(int offset)`
`int`	`getOffsetToRightOf(int offset)`
`final TextPaint`	`getPaint()` Return the paint used for creating this layout.
`final Layout.Alignment`	`getParagraphAlignment(int line)` Get the alignment of the specified paragraph, taking into account markup attached to it.
`abstract int`	`getParagraphDirection(int line)` Returns the primary directionality of the paragraph containing the specified line, either 1 for left-to-right lines, or -1 for right-to-left lines (see `DIR_LEFT_TO_RIGHT`, `DIR_RIGHT_TO_LEFT`).
`final int`	`getParagraphLeft(int line)` Get the left edge of the specified paragraph, inset by left margins.
`final int`	`getParagraphRight(int line)` Get the right edge of the specified paragraph, inset by right margins.
`float`	`getPrimaryHorizontal(int offset)` Get the primary horizontal position for the specified text offset.
`int[]`	`getRangeForRect(RectF area, SegmentFinder segmentFinder, Layout.TextInclusionStrategy inclusionStrategy)` Finds the range of text which is inside the specified rectangle area.
`final int[]`	`getRightIndents()` Return a copy of the right indents used for this layout.
`float`	`getSecondaryHorizontal(int offset)` Get the secondary horizontal position for the specified text offset.
`void`	`getSelectionPath(int start, int end, Path dest)` Fills in the specified Path with a representation of a highlight between the specified offsets.
`boolean`	`getShiftDrawingOffsetForStartOverhang()` Returns true if shifting drawing offset for start overhang.
`final float`	`getSpacingAdd()` Returns the amount added to the line height.
`final float`	`getSpacingMultiplier()` Returns the multiplier applied to the line height.
`final CharSequence`	`getText()` Return the text used for creating this layout.
`final TextDirectionHeuristic`	`getTextDirectionHeuristic()` Returns the text direction heuristic used for creating this layout.
`abstract int`	`getTopPadding()` Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
`boolean`	`getUseBoundsForWidth()` Returns true if using bounding box as a width, false for using advance as a width.
`final int`	`getWidth()` Return the width used for creating this layout in pixels.
`final void`	`increaseWidthTo(int wid)` Increase the width of this layout to the specified width.
`boolean`	`isFallbackLineSpacingEnabled()` Return true if the fallback line space is enabled in this Layout.
`final boolean`	`isFontPaddingIncluded()` Returns true if this layout is created with increased line height.
`boolean`	`isRtlCharAt(int offset)` Returns true if the character at offset is right to left (RTL).

Protected methods
`final boolean`	`isSpanned()`

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.

Constants

BREAK_STRATEGY_BALANCED

Added in API level 23

public static final int BREAK_STRATEGY_BALANCED

Value for break strategy indicating balanced line breaking. The breaks are chosen to make all lines as close to the same length as possible, including automatic hyphenation.

Constant Value: 2 (0x00000002)

BREAK_STRATEGY_HIGH_QUALITY

Added in API level 23

public static final int BREAK_STRATEGY_HIGH_QUALITY

Value for break strategy indicating high quality line breaking, including automatic hyphenation and doing whole-paragraph optimization of line breaks.

Constant Value: 1 (0x00000001)

BREAK_STRATEGY_SIMPLE

Added in API level 23

public static final int BREAK_STRATEGY_SIMPLE

Value for break strategy indicating simple line breaking. Automatic hyphens are not added (though soft hyphens are respected), and modifying text generally doesn't affect the layout before it (which yields a more consistent user experience when editing), but layout may not be the highest quality.

Constant Value: 0 (0x00000000)

DEFAULT_LINESPACING_ADDITION

Added in API level 28

public static final float DEFAULT_LINESPACING_ADDITION

Constant Value: 0.0

DEFAULT_LINESPACING_MULTIPLIER

Added in API level 28

public static final float DEFAULT_LINESPACING_MULTIPLIER

Constant Value: 1.0

DIR_LEFT_TO_RIGHT

Added in API level 1

public static final int DIR_LEFT_TO_RIGHT

Constant Value: 1 (0x00000001)

DIR_RIGHT_TO_LEFT

Added in API level 1

public static final int DIR_RIGHT_TO_LEFT

Constant Value: -1 (0xffffffff)

HYPHENATION_FREQUENCY_FULL

Added in API level 23

public static final int HYPHENATION_FREQUENCY_FULL

Value for hyphenation frequency indicating the full amount of automatic hyphenation, typical in typography. Useful for running text and where it's important to put the maximum amount of text in a screen with limited space.

Constant Value: 2 (0x00000002)

HYPHENATION_FREQUENCY_FULL_FAST

Added in API level 33

public static final int HYPHENATION_FREQUENCY_FULL_FAST

Value for hyphenation frequency indicating the full amount of automatic hyphenation with using faster algorithm. This option is useful for running text and where it's important to put the maximum amount of text in a screen with limited space. To make text rendering faster with hyphenation, this algorithm ignores some hyphen character related typographic features, e.g. kerning.

Constant Value: 4 (0x00000004)

HYPHENATION_FREQUENCY_NONE

Added in API level 23

public static final int HYPHENATION_FREQUENCY_NONE

Value for hyphenation frequency indicating no automatic hyphenation. Useful for backward compatibility, and for cases where the automatic hyphenation algorithm results in incorrect hyphenation. Mid-word breaks may still happen when a word is wider than the layout and there is otherwise no valid break. Soft hyphens are ignored and will not be used as suggestions for potential line breaks.

Constant Value: 0 (0x00000000)

HYPHENATION_FREQUENCY_NORMAL

Added in API level 23

public static final int HYPHENATION_FREQUENCY_NORMAL

Value for hyphenation frequency indicating a light amount of automatic hyphenation, which is a conservative default. Useful for informal cases, such as short sentences or chat messages.

Constant Value: 1 (0x00000001)

HYPHENATION_FREQUENCY_NORMAL_FAST

Added in API level 33

public static final int HYPHENATION_FREQUENCY_NORMAL_FAST

Value for hyphenation frequency indicating a light amount of automatic hyphenation with using faster algorithm. This option is useful for informal cases, such as short sentences or chat messages. To make text rendering faster with hyphenation, this algorithm ignores some hyphen character related typographic features, e.g. kerning.

Constant Value: 3 (0x00000003)

JUSTIFICATION_MODE_INTER_CHARACTER

Added in API level 35

public static final int JUSTIFICATION_MODE_INTER_CHARACTER

Value for justification mode indicating the text is justified by stretching letter spacing.

Constant Value: 2 (0x00000002)

JUSTIFICATION_MODE_INTER_WORD

Added in API level 26

public static final int JUSTIFICATION_MODE_INTER_WORD

Value for justification mode indicating the text is justified by stretching word spacing.

Constant Value: 1 (0x00000001)

JUSTIFICATION_MODE_NONE

Added in API level 26

public static final int JUSTIFICATION_MODE_NONE

Value for justification mode indicating no justification.

Constant Value: 0 (0x00000000)

Fields

INCLUSION_STRATEGY_ANY_OVERLAP

Added in API level 34

public static final Layout.TextInclusionStrategy INCLUSION_STRATEGY_ANY_OVERLAP

Strategy which considers a text segment to be inside a rectangle area if the segment bounds intersect the rectangle.

INCLUSION_STRATEGY_CONTAINS_ALL

Added in API level 34

public static final Layout.TextInclusionStrategy INCLUSION_STRATEGY_CONTAINS_ALL

Strategy which considers a text segment to be inside a rectangle area if the segment bounds are completely contained within the rectangle.

INCLUSION_STRATEGY_CONTAINS_CENTER

Added in API level 34

public static final Layout.TextInclusionStrategy INCLUSION_STRATEGY_CONTAINS_CENTER

Strategy which considers a text segment to be inside a rectangle area if the center of the segment bounds is inside the rectangle.

Protected constructors

Layout

Added in API level 1

protected Layout (CharSequence text, 
                TextPaint paint, 
                int width, 
                Layout.Alignment align, 
                float spacingMult, 
                float spacingAdd)

Subclasses of Layout use this constructor to set the display text, width, and other standard properties.

Parameters
`text`	`CharSequence`: the text to render
`paint`	`TextPaint`: the default paint for the layout. Styles can override various attributes of the paint.
`width`	`int`: the wrapping width for the text.
`align`	`Layout.Alignment`: whether to left, right, or center the text. Styles can override the alignment.
`spacingMult`	`float`: factor by which to scale the font size to get the default line spacing
`spacingAdd`	`float`: amount to add to the default line spacing

Public methods

computeDrawingBoundingBox

Added in API level 35

public RectF computeDrawingBoundingBox ()

Get an actual bounding box that draws text content. Note that the RectF#top and RectF#bottom may be different from the Layout#getLineTop(int) of the first line and Layout#getLineBottom(int) of the last line. The line top and line bottom are calculated based on yMin/yMax or ascent/descent value of font file. On the other hand, the drawing bounding boxes are calculated based on actual glyphs used there.

Returns
`RectF`	bounding rectangle This value cannot be `null`.

draw

Added in API level 1

public void draw (Canvas c)

Draw this Layout on the specified Canvas. This API draws background first, then draws text on top of it.

Parameters
`c`	`Canvas`

See also:

draw(Canvas, List, List, Path, Paint, int)

draw

Added in API level 1

public void draw (Canvas canvas, 
                Path selectionHighlight, 
                Paint selectionHighlightPaint, 
                int cursorOffsetVertical)

Draw this Layout on the specified canvas, with the highlight path drawn between the background and the text.

Parameters
`canvas`	`Canvas`: the canvas
`selectionHighlight`	`Path`: the path of the selection highlight or cursor; can be null
`selectionHighlightPaint`	`Paint`: the paint for the selection highlight
`cursorOffsetVertical`	`int`: the amount to temporarily translate the canvas while rendering the highlight

See also:

draw(Canvas, List, List, Path, Paint, int)

draw

Added in API level 34

public void draw (Canvas canvas, 
                List<Path> highlightPaths, 
                List<Paint> highlightPaints, 
                Path selectionPath, 
                Paint selectionPaint, 
                int cursorOffsetVertical)

Draw this layout on the specified canvas. This API draws background first, then draws highlight paths on top of it, then draws selection or cursor, then finally draws text on top of it.

Parameters
`canvas`	`Canvas`: the canvas This value cannot be `null`.
`highlightPaths`	`List`: the path of the highlights. The highlightPaths and highlightPaints must have the same length and aligned in the same order. For example, the paint of the n-th of the highlightPaths should be stored at the n-th of highlightPaints. This value may be `null`.
`highlightPaints`	`List`: the paints for the highlights. The highlightPaths and highlightPaints must have the same length and aligned in the same order. For example, the paint of the n-th of the highlightPaths should be stored at the n-th of highlightPaints. This value may be `null`.
`selectionPath`	`Path`: the selection or cursor path This value may be `null`.
`selectionPaint`	`Paint`: the paint for the selection or cursor. This value may be `null`.
`cursorOffsetVertical`	`int`: the amount to temporarily translate the canvas while rendering the highlight

See also:

drawBackground

Added in API level 34

public void drawBackground (Canvas canvas)

Draw background of this layout. Different from draw(android.graphics.Canvas, java.util.List, java.util.List, android.graphics.Path, android.graphics.Paint, int) API, this API only draws background, not drawing text, highlights or selections. The background here is drawn by LineBackgroundSpan attached to the text.

Parameters
`canvas`	`Canvas`: the canvas This value cannot be `null`.

See also:

drawText

Added in API level 34

public void drawText (Canvas canvas)

Draw text part of this layout. Different from draw(android.graphics.Canvas, java.util.List, java.util.List, android.graphics.Path, android.graphics.Paint, int) API, this API only draws text part, not drawing highlights, selections, or backgrounds.

Parameters
`canvas`	`Canvas`: the canvas This value cannot be `null`.

See also:

fillCharacterBounds

Added in API level 34

public void fillCharacterBounds (int start, 
                int end, 
                float[] bounds, 
                int boundsStart)

Return the characters' bounds in the given range. The bounds array will be filled starting from boundsStart (inclusive). The coordinates are in local text layout.

Parameters
`start`	`int`: the start index to compute the character bounds, inclusive. Value is 0 or greater
`end`	`int`: the end index to compute the character bounds, exclusive. Value is 0 or greater
`bounds`	`float`: the array to fill in the character bounds. The array is divided into segments of four where each index in that segment represents left, top, right and bottom of the character. This value cannot be `null`.
`boundsStart`	`int`: the inclusive start index in the array to start filling in the values from. Value is 0 or greater

Throws
`IndexOutOfBoundsException`	if the range defined by `start` and `end` exceeds the range of the text, or `bounds` doesn't have enough space to store the result.
`IllegalArgumentException`	if `bounds` is null.

getAlignment

Added in API level 1

public final Layout.Alignment getAlignment ()

Returns the alignment used for creating this layout in pixels.

Returns
`Layout.Alignment`	the alignment used for creating this layout. This value cannot be `null`.

See also:

StaticLayout.Builder.setAlignment(Alignment)

getBottomPadding

Added in API level 1

public abstract int getBottomPadding ()

Returns the number of extra pixels of descent padding in the bottom line of the Layout.

Returns
`int`

getBreakStrategy

Added in API level 35

public final int getBreakStrategy ()

Return the break strategy used for creating this layout.

Returns
`int`	the break strategy used for creating this layout. Value is `LineBreaker.BREAK_STRATEGY_SIMPLE`, `LineBreaker.BREAK_STRATEGY_HIGH_QUALITY`, or `LineBreaker.BREAK_STRATEGY_BALANCED`

See also:

getCursorPath

Added in API level 1

public void getCursorPath (int point, 
                Path dest, 
                CharSequence editingBuffer)

Fills in the specified Path with a representation of a cursor at the specified offset. This will often be a vertical line but can be multiple discontinuous lines in text with multiple directionalities.

Parameters
`point`	`int`
`dest`	`Path`
`editingBuffer`	`CharSequence`

getDesiredWidth

Added in API level 1

public static float getDesiredWidth (CharSequence source, 
                TextPaint paint)

Return how wide a layout must be in order to display the specified text with one line per paragraph.

As of O, Uses TextDirectionHeuristics#FIRSTSTRONG_LTR as the default text direction heuristics. In the earlier versions uses TextDirectionHeuristics#LTR as the default.

Parameters
`source`	`CharSequence`
`paint`	`TextPaint`

Returns
`float`

getDesiredWidth

Added in API level 1

public static float getDesiredWidth (CharSequence source, 
                int start, 
                int end, 
                TextPaint paint)

Return how wide a layout must be in order to display the specified text slice with one line per paragraph.

As of O, Uses TextDirectionHeuristics#FIRSTSTRONG_LTR as the default text direction heuristics. In the earlier versions uses TextDirectionHeuristics#LTR as the default.

Parameters
`source`	`CharSequence`
`start`	`int`
`end`	`int`
`paint`	`TextPaint`

Returns
`float`

getEllipsisCount

Added in API level 1

public abstract int getEllipsisCount (int line)

Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.

Parameters
`line`	`int`

Returns
`int`

getEllipsisStart

Added in API level 1

public abstract int getEllipsisStart (int line)

Return the offset of the first character to be ellipsized away, relative to the start of the line. (So 0 if the beginning of the line is ellipsized, not getLineStart().)

Parameters
`line`	`int`

Returns
`int`

getEllipsize

Added in API level 35

public final TextUtils.TruncateAt getEllipsize ()

Return the ellipsize option used for creating this layout. May return null if no ellipsize option was selected.

Returns
`TextUtils.TruncateAt`	The ellipsize option used for creating this layout, or null if no ellipsize option was selected.

See also:

getEllipsizedWidth

Added in API level 1

public int getEllipsizedWidth ()

Return the width to which this layout is ellipsized. If no ellipsize is applied, the same amount of getWidth() is returned.

Returns
`int`	the amount of ellipsized width in pixels. Value is 0 or greater

See also:

getHeight

Added in API level 1

public int getHeight ()

Return the total height of this layout.

Returns
`int`

getHyphenationFrequency

Added in API level 35

public final int getHyphenationFrequency ()

Return the hyphenation frequency used for creating this layout.

Returns
`int`	the hyphenation frequency used for creating this layout. Value is `HYPHENATION_FREQUENCY_NORMAL`, `HYPHENATION_FREQUENCY_NORMAL_FAST`, `HYPHENATION_FREQUENCY_FULL`, `HYPHENATION_FREQUENCY_FULL_FAST`, or `HYPHENATION_FREQUENCY_NONE`

See also:

getJustificationMode

Added in API level 35

public final int getJustificationMode ()

Return the justification mode used for creating this layout.

Returns
`int`	the justification mode used for creating this layout. Value is `LineBreaker.JUSTIFICATION_MODE_NONE`, `LineBreaker.JUSTIFICATION_MODE_INTER_WORD`, or `LineBreaker.JUSTIFICATION_MODE_INTER_CHARACTER`

See also:

getLeftIndents

Added in API level 35

public final int[] getLeftIndents ()

Return a copy of the left indents used for this layout. May return null if no left indentation is applied.

Returns
`int[]`	the array of left indents in pixels.

See also:

getLineAscent

Added in API level 1

public final int getLineAscent (int line)

Get the ascent of the text on the specified line. The return value is negative to match the Paint.ascent() convention.

Parameters
`line`	`int`

Returns
`int`

getLineBaseline

Added in API level 1

public final int getLineBaseline (int line)

Return the vertical position of the baseline of the specified line.

Parameters
`line`	`int`

Returns
`int`

getLineBottom

Added in API level 34

public int getLineBottom (int line, 
                boolean includeLineSpacing)

Return the vertical position of the bottom of the specified line.

Parameters
`line`	`int`: index of the line
`includeLineSpacing`	`boolean`: whether to include the line spacing

Returns
`int`

getLineBottom

Added in API level 1

public final int getLineBottom (int line)

Return the vertical position of the bottom of the specified line.

Parameters
`line`	`int`

Returns
`int`

getLineBounds

Added in API level 1

public int getLineBounds (int line, 
                Rect bounds)

Return the baseline for the specified line (0…getLineCount() - 1) If bounds is not null, return the top, left, right, bottom extents of the specified line in it.

Parameters
`line`	`int`: which line to examine (0..getLineCount() - 1)
`bounds`	`Rect`: Optional. If not null, it returns the extent of the line

Returns
`int`	the Y-coordinate of the baseline

getLineBreakConfig

Added in API level 35

public LineBreakConfig getLineBreakConfig ()

Gets the LineBreakConfig used for creating this layout. Do not modify the returned object.

Returns
`LineBreakConfig`	The line break config used for creating this layout. This value cannot be `null`.

getLineContainsTab

Added in API level 1

public abstract boolean getLineContainsTab (int line)

Returns whether the specified line contains one or more characters that need to be handled specially, like tabs.

Parameters
`line`	`int`

Returns
`boolean`

getLineCount

Added in API level 1

public abstract int getLineCount ()

Return the number of lines of text in this layout.

Returns
`int`

getLineDescent

Added in API level 1

public abstract int getLineDescent (int line)

Return the descent of the specified line(0…getLineCount() - 1).

Parameters
`line`	`int`

Returns
`int`

getLineDirections

Added in API level 1

public abstract Layout.Directions getLineDirections (int line)

Returns the directional run information for the specified line. The array alternates counts of characters in left-to-right and right-to-left segments of the line.

NOTE: this is inadequate to support bidirectional text, and will change.

Parameters
`line`	`int`

Returns
`Layout.Directions`

getLineEnd

Added in API level 1

public final int getLineEnd (int line)

Return the text offset after the last character on the specified line.

Parameters
`line`	`int`

Returns
`int`

getLineForOffset

Added in API level 1

public int getLineForOffset (int offset)

Get the line number on which the specified text offset appears. If you ask for a position before 0, you get 0; if you ask for a position beyond the end of the text, you get the last line.

Parameters
`offset`	`int`

Returns
`int`

getLineForVertical

Added in API level 1

public int getLineForVertical (int vertical)

Get the line number corresponding to the specified vertical position. If you ask for a position above 0, you get 0; if you ask for a position below the bottom of the text, you get the last line.

Parameters
`vertical`	`int`

Returns
`int`

getLineLeft

Added in API level 1

public float getLineLeft (int line)

Get the leftmost position that should be exposed for horizontal scrolling on the specified line.

Parameters
`line`	`int`

Returns
`float`

getLineLetterSpacingUnitCount

Added in API level 35

public int getLineLetterSpacingUnitCount (int line, 
                boolean includeTrailingWhitespace)

Returns the number of letter spacing unit in the line.

This API returns a number of letters that is a target of letter spacing. The letter spacing won't be added to the middle of the characters that are needed to be treated as a single, e.g., ligatured or conjunct form. Note that this value is different from the number of] grapheme clusters that is calculated by BreakIterator#getCharacterInstance(Locale). For example, if the "fi" is ligatured, the ligatured form is treated as single uni and letter spacing is not added, but it has two separate grapheme cluster.

This value is used for calculating the letter spacing amount for the justification because the letter spacing is applied between clusters. For example, if extra W pixels needed to be filled by letter spacing, the amount of letter spacing to be applied is W/(letter spacing unit count - 1) px.

Parameters
`line`	`int`: the index of the line Value is 0 or greater
`includeTrailingWhitespace`	`boolean`: whether to include trailing whitespace

Returns
`int`	the number of cluster count in the line. Value is 0 or greater

getLineMax

Added in API level 1

public float getLineMax (int line)

Gets the unsigned horizontal extent of the specified line, including leading margin indent, but excluding trailing whitespace.

Parameters
`line`	`int`

Returns
`float`

getLineRight

Added in API level 1

public float getLineRight (int line)

Get the rightmost position that should be exposed for horizontal scrolling on the specified line.

Parameters
`line`	`int`

Returns
`float`

getLineSpacingAmount

Added in API level 35

public final float getLineSpacingAmount ()

Returns the amount added to the line height.

Returns
`float`	the line height additional amount.

See also:

getLineSpacingMultiplier

Added in API level 35

public final float getLineSpacingMultiplier ()

Returns the multiplier applied to the line height.

Returns
`float`	the line height multiplier.

See also:

getLineStart

Added in API level 1

public abstract int getLineStart (int line)

Return the text offset of the beginning of the specified line ( 0…getLineCount()). If the specified line is equal to the line count, returns the length of the text.

Parameters
`line`	`int`

Returns
`int`

getLineTop

Added in API level 1

public abstract int getLineTop (int line)

Return the vertical position of the top of the specified line (0…getLineCount()). If the specified line is equal to the line count, returns the bottom of the last line.

Parameters
`line`	`int`

Returns
`int`

getLineVisibleEnd

Added in API level 1

public int getLineVisibleEnd (int line)

Return the text offset after the last visible character (so whitespace is not counted) on the specified line.

Parameters
`line`	`int`

Returns
`int`

getLineWidth

Added in API level 1

public float getLineWidth (int line)

Gets the unsigned horizontal extent of the specified line, including leading margin indent and trailing whitespace.

Parameters
`line`	`int`

Returns
`float`

getMaxLines

Added in API level 35

public final int getMaxLines ()

Return the maximum lines allowed used for creating this layout. Note that this is not an actual line count of this layout. Use getLineCount() for getting the actual line count of this layout.

Returns
`int`	the maximum lines allowed used for creating this layout. Value is 1 or greater

See also:

getMinimumFontMetrics

Added in API level 35

public Paint.FontMetrics getMinimumFontMetrics ()

Get the minimum font metrics used for line spacing.

Returns
`Paint.FontMetrics`	a minimum font metrics. `null` for using the value obtained by `Paint#getFontMetricsForLocale(Paint.FontMetrics)`

See also:

getOffsetForHorizontal

Added in API level 1

public int getOffsetForHorizontal (int line, 
                float horiz)

Get the character offset on the specified line whose position is closest to the specified horizontal position.

Parameters
`line`	`int`
`horiz`	`float`

Returns
`int`

getOffsetToLeftOf

Added in API level 1

public int getOffsetToLeftOf (int offset)

Parameters
`offset`	`int`

Returns
`int`

getOffsetToRightOf

Added in API level 1

public int getOffsetToRightOf (int offset)

Parameters
`offset`	`int`

Returns
`int`

getPaint

Added in API level 1

public final TextPaint getPaint ()

Return the paint used for creating this layout. Do not modify the returned paint object. This paint object will still be used for drawing/measuring text.

Returns
`TextPaint`	the paint used for creating this layout. This value cannot be `null`.

getParagraphAlignment

Added in API level 1

public final Layout.Alignment getParagraphAlignment (int line)

Get the alignment of the specified paragraph, taking into account markup attached to it.

Parameters
`line`	`int`

Returns
`Layout.Alignment`

getParagraphDirection

Added in API level 1

public abstract int getParagraphDirection (int line)

Returns the primary directionality of the paragraph containing the specified line, either 1 for left-to-right lines, or -1 for right-to-left lines (see DIR_LEFT_TO_RIGHT, DIR_RIGHT_TO_LEFT).

Parameters
`line`	`int`

Returns
`int`

getParagraphLeft

Added in API level 1

public final int getParagraphLeft (int line)

Get the left edge of the specified paragraph, inset by left margins.

Parameters
`line`	`int`

Returns
`int`

getParagraphRight

Added in API level 1

public final int getParagraphRight (int line)

Get the right edge of the specified paragraph, inset by right margins.

Parameters
`line`	`int`

Returns
`int`

getPrimaryHorizontal

Added in API level 1

public float getPrimaryHorizontal (int offset)

Get the primary horizontal position for the specified text offset. This is the location where a new character would be inserted in the paragraph's primary direction.

Parameters
`offset`	`int`

Returns
`float`

getRangeForRect

Added in API level 34

public int[] getRangeForRect (RectF area, 
                SegmentFinder segmentFinder, 
                Layout.TextInclusionStrategy inclusionStrategy)

Finds the range of text which is inside the specified rectangle area. The start of the range is the start of the first text segment inside the area, and the end of the range is the end of the last text segment inside the area.

A text segment is considered to be inside the area according to the provided TextInclusionStrategy. If a text segment spans multiple lines or multiple directional runs (e.g. a hyphenated word), the text segment is divided into pieces at the line and run breaks, then the text segment is considered to be inside the area if any of its pieces are inside the area.

The returned range may also include text segments which are not inside the specified area, if those text segments are in between text segments which are inside the area. For example, the returned range may be "segment1 segment2 segment3" if "segment1" and "segment3" are inside the area and "segment2" is not.

Parameters
`area`	`RectF`: area for which the text range will be found This value cannot be `null`.
`segmentFinder`	`SegmentFinder`: SegmentFinder for determining the ranges of text to be considered as a text segment This value cannot be `null`.
`inclusionStrategy`	`Layout.TextInclusionStrategy`: strategy for determining whether a text segment is inside the specified area This value cannot be `null`.

Returns
`int[]`	int array of size 2 containing the start (inclusive) and end (exclusive) character offsets of the text range, or null if there are no text segments inside the area

getRightIndents

Added in API level 35

public final int[] getRightIndents ()

Return a copy of the right indents used for this layout. May return null if no right indentation is applied.

Returns
`int[]`	the array of right indents in pixels.

See also:

getSecondaryHorizontal

Added in API level 1

public float getSecondaryHorizontal (int offset)

Get the secondary horizontal position for the specified text offset. This is the location where a new character would be inserted in the direction other than the paragraph's primary direction.

Parameters
`offset`	`int`

Returns
`float`

getSelectionPath

Added in API level 1

public void getSelectionPath (int start, 
                int end, 
                Path dest)

Fills in the specified Path with a representation of a highlight between the specified offsets. This will often be a rectangle or a potentially discontinuous set of rectangles. If the start and end are the same, the returned path is empty.

Parameters
`start`	`int`
`end`	`int`
`dest`	`Path`

getShiftDrawingOffsetForStartOverhang

Added in API level 35

public boolean getShiftDrawingOffsetForStartOverhang ()

Returns true if shifting drawing offset for start overhang.

Returns
`boolean`	True if shifting drawing offset for start overhang.

See also:

getSpacingAdd

Added in API level 1

public final float getSpacingAdd ()

Returns the amount added to the line height.

Returns
`float`	the line height additional amount.

See also:

StaticLayout.Builder.setLineSpacing(float, float)

getSpacingMultiplier

Added in API level 1

public final float getSpacingMultiplier ()

Returns the multiplier applied to the line height.

Returns
`float`	the line height multiplier.

See also:

StaticLayout.Builder.setLineSpacing(float, float)

getText

Added in API level 1

public final CharSequence getText ()

Return the text used for creating this layout.

Returns
`CharSequence`	the text used for creating this layout. This value cannot be `null`.

getTextDirectionHeuristic

Added in API level 35

public final TextDirectionHeuristic getTextDirectionHeuristic ()

Returns the text direction heuristic used for creating this layout.

Returns
`TextDirectionHeuristic`	the text direction heuristic used for creating this layout This value cannot be `null`.

See also:

getTopPadding

Added in API level 1

public abstract int getTopPadding ()

Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.

Returns
`int`

getUseBoundsForWidth

Added in API level 35

public boolean getUseBoundsForWidth ()

Returns true if using bounding box as a width, false for using advance as a width.

Returns
`boolean`	True if using bounding box for width, false if using advance for width.

See also:

getWidth

Added in API level 1

public final int getWidth ()

Return the width used for creating this layout in pixels.

Returns
`int`	the width used for creating this layout in pixels. Value is 0 or greater

increaseWidthTo

Added in API level 1

public final void increaseWidthTo (int wid)

Increase the width of this layout to the specified width. Be careful to use this only when you know it is appropriate— it does not cause the text to reflow to use the full new width.

Parameters
`wid`	`int`

isFallbackLineSpacingEnabled

Added in API level 33

public boolean isFallbackLineSpacingEnabled ()

Return true if the fallback line space is enabled in this Layout.

Returns
`boolean`	true if the fallback line space is enabled. Otherwise, returns false.

See also:

StaticLayout.Builder.setUseLineSpacingFromFallbacks(boolean)

isFontPaddingIncluded

Added in API level 35

public final boolean isFontPaddingIncluded ()

Returns true if this layout is created with increased line height.

Returns
`boolean`	true if the layout is created with increased line height.

See also:

isRtlCharAt

Added in API level 14

public boolean isRtlCharAt (int offset)

Returns true if the character at offset is right to left (RTL).

Parameters
`offset`	`int`: the offset

Returns
`boolean`	true if the character is RTL, false if it is LTR

Protected methods

isSpanned

Added in API level 1

protected final boolean isSpanned ()

Returns
`boolean`

Layout

Summary

Nested classes

Constants

Fields

Protected constructors

Public methods

Protected methods

Inherited methods

Constants

BREAK_STRATEGY_BALANCED

BREAK_STRATEGY_HIGH_QUALITY

BREAK_STRATEGY_SIMPLE

DEFAULT_LINESPACING_ADDITION

DEFAULT_LINESPACING_MULTIPLIER

DIR_LEFT_TO_RIGHT

DIR_RIGHT_TO_LEFT

HYPHENATION_FREQUENCY_FULL

HYPHENATION_FREQUENCY_FULL_FAST

HYPHENATION_FREQUENCY_NONE

HYPHENATION_FREQUENCY_NORMAL

HYPHENATION_FREQUENCY_NORMAL_FAST

JUSTIFICATION_MODE_INTER_CHARACTER

JUSTIFICATION_MODE_INTER_WORD

JUSTIFICATION_MODE_NONE

Fields

INCLUSION_STRATEGY_ANY_OVERLAP

INCLUSION_STRATEGY_CONTAINS_ALL

INCLUSION_STRATEGY_CONTAINS_CENTER

Protected constructors

Layout

Public methods

computeDrawingBoundingBox

draw

draw

draw

drawBackground

drawText

fillCharacterBounds

getAlignment

getBottomPadding

getBreakStrategy

getCursorPath

getDesiredWidth

getDesiredWidth

getEllipsisCount

getEllipsisStart

getEllipsize

getEllipsizedWidth

getHeight

getHyphenationFrequency

getJustificationMode

getLeftIndents

getLineAscent

getLineBaseline

getLineBottom

getLineBottom

getLineBounds

getLineBreakConfig

getLineContainsTab

getLineCount

getLineDescent

getLineDirections

getLineEnd

getLineForOffset

getLineForVertical

getLineLeft

getLineLetterSpacingUnitCount

getLineMax

getLineRight

getLineSpacingAmount

getLineSpacingMultiplier

getLineStart

getLineTop

getLineVisibleEnd

getLineWidth

getMaxLines

getMinimumFontMetrics

getOffsetForHorizontal

getOffsetToLeftOf