IT. Expert System.

Android Reference

Layout

android.text

Class Layout

java.lang.Object
- android.text.Layout

Direct Known Subclasses:

BoringLayout, DynamicLayout, StaticLayout
```
public abstract class Layout
extends Object
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Layout.Alignment`
`static class`	`Layout.Directions` Stores information about bidirectional (left-to-right or right-to-left) text within the layout of a line.

Field Summary

Fields
Modifier and Type Field and Description

static int DIR_LEFT_TO_RIGHT

static int DIR_RIGHT_TO_LEFT

Fields
Modifier and Type	Field and Description
`static int`	`DIR_LEFT_TO_RIGHT`
`static int`	`DIR_RIGHT_TO_LEFT`

Constructor Summary

Constructors
Modifier	Constructor and Description
`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.
`protected`	`Layout(CharSequence text, TextPaint paint, int width, Layout.Alignment align, TextDirectionHeuristic textDir, float spacingMult, float spacingAdd)` Subclasses of Layout use this constructor to set the display text, width, and other standard properties.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`draw(Canvas c)` Draw this Layout on the specified Canvas.
`void`	`draw(Canvas canvas, Path highlight, Paint highlightPaint, int cursorOffsetVertical)` Draw this Layout on the specified canvas, with the highlight path drawn between the background and the text.
`void`	`drawBackground(Canvas canvas, Path highlight, Paint highlightPaint, int cursorOffsetVertical, int firstLine, int lastLine)`
`void`	`drawText(Canvas canvas, int firstLine, int lastLine)`
`Layout.Alignment`	`getAlignment()` Return the base alignment of this layout.
`abstract int`	`getBottomPadding()` Returns the number of extra pixels of descent padding in the bottom line of the 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, 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.
`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.
`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.
`int`	`getEllipsizedWidth()` Return the width to which this Layout is ellipsizing, or `getWidth()` if it is not doing anything special.
`int`	`getHeight()` Return the total height of this layout.
`int`	`getLineAscent(int line)` Get the ascent of the text on the specified line.
`int`	`getLineBaseline(int line)` Return the vertical position of the baseline of the specified line.
`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.
`abstract boolean`	`getLineContainsTab(int line)` Returns whether the specified line contains one or more characters that need to be handled specially, like tabs or emoji.
`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.
`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.
`float`	`getLineMax(int line)` Gets the unsigned horizontal extent of the specified line, including leading margin indent, but excluding trailing whitespace.
`long`	`getLineRangeForDraw(Canvas canvas)`
`float`	`getLineRight(int line)` Get the rightmost position that should be exposed for horizontal scrolling on the specified line.
`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.
`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)`
`TextPaint`	`getPaint()` Return the base Paint properties for this layout.
`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`).
`int`	`getParagraphLeft(int line)` Get the left edge of the specified paragraph, inset by left margins.
`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.
`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.
`float`	`getSpacingAdd()` Return the number of units of leading that are added to each line.
`float`	`getSpacingMultiplier()` Return what the text height is multiplied by to get the line height.
`CharSequence`	`getText()` Return the text that is displayed by this Layout.
`TextDirectionHeuristic`	`getTextDirectionHeuristic()` Return the heuristic used to determine paragraph text direction.
`abstract int`	`getTopPadding()` Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
`int`	`getWidth()` Return the width of this layout.
`void`	`increaseWidthTo(int wid)` Increase the width of this layout to the specified width.
`boolean`	`isLevelBoundary(int offset)` Returns true if the character at offset and the preceding character are at different run levels (and thus there's a split caret).
`boolean`	`isRtlCharAt(int offset)` Returns true if the character at offset is right to left (RTL).
`protected boolean`	`isSpanned()`

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

- Field Detail
  - DIR_LEFT_TO_RIGHT
```
public static final int DIR_LEFT_TO_RIGHT
```
    See Also:
    Constant Field Values
  - DIR_RIGHT_TO_LEFT
```
public static final int DIR_RIGHT_TO_LEFT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Layout
```
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 - the text to render
    paint - the default paint for the layout. Styles can override various attributes of the paint.
    width - the wrapping width for the text.
    align - whether to left, right, or center the text. Styles can override the alignment.
    spacingMult - factor by which to scale the font size to get the default line spacing
    spacingAdd - amount to add to the default line spacing
  - Layout
```
protected Layout(CharSequence text,
      TextPaint paint,
      int width,
      Layout.Alignment align,
      TextDirectionHeuristic textDir,
      float spacingMult,
      float spacingAdd)
```
    Subclasses of Layout use this constructor to set the display text, width, and other standard properties.
    
    Parameters:
    text - the text to render
    paint - the default paint for the layout. Styles can override various attributes of the paint.
    width - the wrapping width for the text.
    align - whether to left, right, or center the text. Styles can override the alignment.
    spacingMult - factor by which to scale the font size to get the default line spacing
    spacingAdd - amount to add to the default line spacing
- Method Detail
  - getDesiredWidth
```
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.
  - getDesiredWidth
```
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.
  - draw
```
public void draw(Canvas c)
```
    Draw this Layout on the specified Canvas.
  - draw
```
public void draw(Canvas canvas,
        Path highlight,
        Paint highlightPaint,
        int cursorOffsetVertical)
```
    Draw this Layout on the specified canvas, with the highlight path drawn between the background and the text.
    
    Parameters:
    canvas - the canvas
    highlight - the path of the highlight or cursor; can be null
    highlightPaint - the paint for the highlight
    cursorOffsetVertical - the amount to temporarily translate the canvas while rendering the highlight
  - drawText
```
public void drawText(Canvas canvas,
            int firstLine,
            int lastLine)
```
  - drawBackground
```
public void drawBackground(Canvas canvas,
                  Path highlight,
                  Paint highlightPaint,
                  int cursorOffsetVertical,
                  int firstLine,
                  int lastLine)
```
  - getLineRangeForDraw
```
public long getLineRangeForDraw(Canvas canvas)
```
    Parameters:
    canvas -
    
    Returns:
    The range of lines that need to be drawn, possibly empty.
  - getText
```
public final CharSequence getText()
```
    Return the text that is displayed by this Layout.
  - getPaint
```
public final TextPaint getPaint()
```
    Return the base Paint properties for this layout. Do NOT change the paint, which may result in funny drawing for this layout.
  - getWidth
```
public final int getWidth()
```
    Return the width of this layout.
  - getEllipsizedWidth
```
public int getEllipsizedWidth()
```
    Return the width to which this Layout is ellipsizing, or getWidth() if it is not doing anything special.
  - increaseWidthTo
```
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.
  - getHeight
```
public int getHeight()
```
    Return the total height of this layout.
  - getAlignment
```
public final Layout.Alignment getAlignment()
```
    Return the base alignment of this layout.
  - getSpacingMultiplier
```
public final float getSpacingMultiplier()
```
    Return what the text height is multiplied by to get the line height.
  - getSpacingAdd
```
public final float getSpacingAdd()
```
    Return the number of units of leading that are added to each line.
  - getTextDirectionHeuristic
```
public final TextDirectionHeuristic getTextDirectionHeuristic()
```
    Return the heuristic used to determine paragraph text direction.
  - getLineCount
```
public abstract int getLineCount()
```
    Return the number of lines of text in this layout.
  - getLineBounds
```
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 - which line to examine (0..getLineCount() - 1)
    bounds - Optional. If not null, it returns the extent of the line
    
    Returns:
    the Y-coordinate of the baseline
  - getLineTop
```
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.
  - getLineDescent
```
public abstract int getLineDescent(int line)
```
    Return the descent of the specified line(0…getLineCount() - 1).
  - getLineStart
```
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.
  - getParagraphDirection
```
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).
  - getLineContainsTab
```
public abstract boolean getLineContainsTab(int line)
```
    Returns whether the specified line contains one or more characters that need to be handled specially, like tabs or emoji.
  - getLineDirections
```
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.
  - getTopPadding
```
public abstract int getTopPadding()
```
    Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
  - getBottomPadding
```
public abstract int getBottomPadding()
```
    Returns the number of extra pixels of descent padding in the bottom line of the Layout.
  - isLevelBoundary
```
public boolean isLevelBoundary(int offset)
```
    Returns true if the character at offset and the preceding character are at different run levels (and thus there's a split caret).
    
    Parameters:
    offset - the offset
    
    Returns:
    true if at a level boundary
  - isRtlCharAt
```
public boolean isRtlCharAt(int offset)
```
    Returns true if the character at offset is right to left (RTL).
    
    Parameters:
    offset - the offset
    
    Returns:
    true if the character is RTL, false if it is LTR
  - getPrimaryHorizontal
```
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.
  - getSecondaryHorizontal
```
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.
  - getLineLeft
```
public float getLineLeft(int line)
```
    Get the leftmost position that should be exposed for horizontal scrolling on the specified line.
  - getLineRight
```
public float getLineRight(int line)
```
    Get the rightmost position that should be exposed for horizontal scrolling on the specified line.
  - getLineMax
```
public float getLineMax(int line)
```
    Gets the unsigned horizontal extent of the specified line, including leading margin indent, but excluding trailing whitespace.
  - getLineWidth
```
public float getLineWidth(int line)
```
    Gets the unsigned horizontal extent of the specified line, including leading margin indent and trailing whitespace.
  - getLineForVertical
```
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.
  - getLineForOffset
```
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.
  - getOffsetForHorizontal
```
public int getOffsetForHorizontal(int line,
                         float horiz)
```
    Get the character offset on the specified line whose position is closest to the specified horizontal position.
  - getLineEnd
```
public final int getLineEnd(int line)
```
    Return the text offset after the last character on the specified line.
  - getLineVisibleEnd
```
public int getLineVisibleEnd(int line)
```
    Return the text offset after the last visible character (so whitespace is not counted) on the specified line.
  - getLineBottom
```
public final int getLineBottom(int line)
```
    Return the vertical position of the bottom of the specified line.
  - getLineBaseline
```
public final int getLineBaseline(int line)
```
    Return the vertical position of the baseline of the specified line.
  - getLineAscent
```
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.
  - getOffsetToLeftOf
```
public int getOffsetToLeftOf(int offset)
```
  - getOffsetToRightOf
```
public int getOffsetToRightOf(int offset)
```
  - getCursorPath
```
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.
  - getSelectionPath
```
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.
  - getParagraphAlignment
```
public final Layout.Alignment getParagraphAlignment(int line)
```
    Get the alignment of the specified paragraph, taking into account markup attached to it.
  - getParagraphLeft
```
public final int getParagraphLeft(int line)
```
    Get the left edge of the specified paragraph, inset by left margins.
  - getParagraphRight
```
public final int getParagraphRight(int line)
```
    Get the right edge of the specified paragraph, inset by right margins.
  - isSpanned
```
protected final boolean isSpanned()
```
  - getEllipsisStart
```
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().)
  - getEllipsisCount
```
public abstract int getEllipsisCount(int line)
```
    Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.

Content

Android Reference

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY

VBS

REGEX

C

C++

C#

Design patterns

RFC (standard status)

RFC (proposed standard status)

RFC (draft standard status)

RFC (informational status)

RFC (experimental status)

RFC (best current practice status)

RFC (historic status)

RFC (unknown status)

IT dictionary

License.

All information of this service is derived from the free sources and is provided solely in the form of quotations. This service provides information and interfaces solely for the familiarization (not ownership) and under the "as is" condition.

IT. Expert System.

Android Reference

Layout

Class Layout

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DIR_LEFT_TO_RIGHT

DIR_RIGHT_TO_LEFT

Constructor Detail

Layout

Layout

Method Detail

getDesiredWidth

getDesiredWidth

draw

draw

drawText

drawBackground

getLineRangeForDraw

getText

getPaint

getWidth

getEllipsizedWidth

increaseWidthTo

getHeight

getAlignment

getSpacingMultiplier

getSpacingAdd

getTextDirectionHeuristic

getLineCount

getLineBounds

getLineTop

getLineDescent

getLineStart

getParagraphDirection

getLineContainsTab

getLineDirections

getTopPadding

getBottomPadding

isLevelBoundary

isRtlCharAt

getPrimaryHorizontal

getSecondaryHorizontal

getLineLeft

getLineRight

getLineMax

getLineWidth

getLineForVertical

getLineForOffset

getOffsetForHorizontal

getLineEnd

getLineVisibleEnd

getLineBottom

getLineBaseline

getLineAscent

getOffsetToLeftOf

getOffsetToRightOf

getCursorPath

getSelectionPath

getParagraphAlignment

getParagraphLeft

getParagraphRight

isSpanned

getEllipsisStart

getEllipsisCount

Android Reference

Java basics

Java Enterprise Edition (EE)

Java Standard Edition (SE)

SQL

HTML

PHP

CSS

Java Script

MYSQL

JQUERY