Layout

BREAK_STRATEGY_BALANCED

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

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

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)

DIR_LEFT_TO_RIGHT

int DIR_LEFT_TO_RIGHT

Constant Value: 1 (0x00000001)

DIR_RIGHT_TO_LEFT

int DIR_RIGHT_TO_LEFT

Constant Value: -1 (0xffffffff)

HYPHENATION_FREQUENCY_FULL

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_NONE

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

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)

Layout

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.

draw

void draw (Canvas c)

Draw this Layout on the specified Canvas.

draw

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.

getAlignment

Layout.Alignment getAlignment ()

Return the base alignment of this layout.

getBottomPadding

int getBottomPadding ()

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

getCursorPath

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.

getDesiredWidth

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

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.

getEllipsisCount

int getEllipsisCount (int line)

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

getEllipsisStart

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().)

getEllipsizedWidth

int getEllipsizedWidth ()

Return the width to which this Layout is ellipsizing, or getWidth() if it is not doing anything special.

getHeight

int getHeight ()

Return the total height of this layout.

getLineAscent

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.

getLineBaseline

int getLineBaseline (int line)

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

getLineBottom

int getLineBottom (int line)

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

getLineBounds

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.

getLineContainsTab

boolean getLineContainsTab (int line)

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

getLineCount

int getLineCount ()

Return the number of lines of text in this layout.

getLineDescent

int getLineDescent (int line)

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

getLineDirections

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.

getLineEnd

int getLineEnd (int line)

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

getLineForOffset

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.

getLineForVertical

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.

getLineLeft

float getLineLeft (int line)

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

getLineMax

float getLineMax (int line)

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

getLineRight

float getLineRight (int line)

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

getLineStart

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.

getLineTop

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.

getLineVisibleEnd

int getLineVisibleEnd (int line)

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

getLineWidth

float getLineWidth (int line)

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

getOffsetForHorizontal

int getOffsetForHorizontal (int line, 
                float horiz)

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

getOffsetToLeftOf

int getOffsetToLeftOf (int offset)

getOffsetToRightOf

int getOffsetToRightOf (int offset)

getPaint

TextPaint getPaint ()

Return the base Paint properties for this layout. Do NOT change the paint, which may result in funny drawing for this layout.

getParagraphAlignment

Layout.Alignment getParagraphAlignment (int line)

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

getParagraphDirection

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).

getParagraphLeft

int getParagraphLeft (int line)

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

getParagraphRight

int getParagraphRight (int line)

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

getPrimaryHorizontal

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

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.

getSelectionPath

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.

getSpacingAdd

float getSpacingAdd ()

Return the number of units of leading that are added to each line.

getSpacingMultiplier

float getSpacingMultiplier ()

Return what the text height is multiplied by to get the line height.

getText

CharSequence getText ()

Return the text that is displayed by this Layout.

getTopPadding

int getTopPadding ()

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

getWidth

int getWidth ()

Return the width of this layout.

increaseWidthTo

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.

isRtlCharAt

boolean isRtlCharAt (int offset)

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

isSpanned

boolean isSpanned ()