BoringLayout

Kotlin |Java

open class BoringLayout : Layout, TextUtils.EllipsizeCallback

kotlin.Any
↳	android.text.Layout
	↳	android.text.BoringLayout

A BoringLayout is a very simple Layout implementation for text that fits on a single line and is all left-to-right characters. You will probably never want to make one of these yourself; if you do, be sure to call #isBoring first to make sure the text meets the criteria.

This class is used by widgets to control text layout. You should not need to use this class directly unless you are implementing your own widget or custom display object, in which case you are encouraged to use a Layout instead of calling Canvas.drawText() directly.

Summary

Nested classes
open	`Metrics`

Inherited constants

From class Layout

`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.
`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. 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.
`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. Useful for running text and where it's important to put the maximum amount of text in a screen with limited space.
`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.
`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.
`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.

Public constructors
`BoringLayout(source: CharSequence!, paint: TextPaint!, outerwidth: Int, align: Layout.Alignment!, spacingMult: Float, spacingAdd: Float, metrics: BoringLayout.Metrics!, includePad: Boolean)`
`BoringLayout(source: CharSequence!, paint: TextPaint!, outerWidth: Int, align: Layout.Alignment!, spacingMult: Float, spacingAdd: Float, metrics: BoringLayout.Metrics!, includePad: Boolean, ellipsize: TextUtils.TruncateAt!, ellipsizedWidth: Int)`

Public methods
open Unit	`draw(c: Canvas!, highlight: Path!, highlightpaint: Paint!, cursorOffset: Int)`
open Unit	`ellipsized(start: Int, end: Int)` Callback for the ellipsizer to report what region it ellipsized.
open Int	`getBottomPadding()`
open Int	`getEllipsisCount(line: Int)`
open Int	`getEllipsisStart(line: Int)`
open Int	`getEllipsizedWidth()`
open Int	`getHeight()`
open Boolean	`getLineContainsTab(line: Int)`
open Int	`getLineCount()`
open Int	`getLineDescent(line: Int)`
Layout.Directions!	`getLineDirections(line: Int)`
open Float	`getLineMax(line: Int)`
open Int	`getLineStart(line: Int)`
open Int	`getLineTop(line: Int)`
open Float	`getLineWidth(line: Int)`
open Int	`getParagraphDirection(line: Int)`
open Int	`getTopPadding()`
open static BoringLayout.Metrics!	`isBoring(text: CharSequence!, paint: TextPaint!)` Determine and compute metrics if given text can be handled by BoringLayout.
open static BoringLayout.Metrics!	`isBoring(text: CharSequence!, paint: TextPaint!, metrics: BoringLayout.Metrics!)` Determine and compute metrics if given text can be handled by BoringLayout.
open static BoringLayout!	`make(source: CharSequence!, paint: TextPaint!, outerWidth: Int, align: Layout.Alignment!, spacingMult: Float, spacingAdd: Float, metrics: BoringLayout.Metrics!, includePad: Boolean)` Utility function to construct a BoringLayout instance.
open static BoringLayout!	`make(source: CharSequence!, paint: TextPaint!, outerWidth: Int, align: Layout.Alignment!, spacingmult: Float, spacingadd: Float, metrics: BoringLayout.Metrics!, includePad: Boolean, ellipsize: TextUtils.TruncateAt!, ellipsizedWidth: Int)` Utility function to construct a BoringLayout instance.
open BoringLayout!	`replaceOrMake(source: CharSequence!, paint: TextPaint!, outerwidth: Int, align: Layout.Alignment!, spacingMult: Float, spacingAdd: Float, metrics: BoringLayout.Metrics!, includePad: Boolean)` Returns a BoringLayout for the specified text, potentially reusing this one if it is already suitable.
open BoringLayout!	`replaceOrMake(source: CharSequence!, paint: TextPaint!, outerWidth: Int, align: Layout.Alignment!, spacingMult: Float, spacingAdd: Float, metrics: BoringLayout.Metrics!, includePad: Boolean, ellipsize: TextUtils.TruncateAt!, ellipsizedWidth: Int)` Returns a BoringLayout for the specified text, potentially reusing this one if it is already suitable.

Inherited functions

From class Layout

`Unit`	`draw(c: Canvas!)` Draw this Layout on the specified Canvas.
`Layout.Alignment!`	`getAlignment()` Return the base alignment of this layout.
`Unit`	`getCursorPath(point: Int, dest: Path!, editingBuffer: CharSequence!)` 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.
`Float`	`getDesiredWidth(source: CharSequence!, paint: TextPaint!)` 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.
`Float`	`getDesiredWidth(source: CharSequence!, start: Int, end: Int, paint: TextPaint!)` 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.
`Int`	`getLineAscent(line: Int)` Get the ascent of the text on the specified line. The return value is negative to match the Paint.ascent() convention.
`Int`	`getLineBaseline(line: Int)` Return the vertical position of the baseline of the specified line.
`Int`	`getLineBottom(line: Int)` Return the vertical position of the bottom of the specified line.
`Int`	`getLineBounds(line: Int, bounds: Rect!)` 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.
`Int`	`getLineEnd(line: Int)` Return the text offset after the last character on the specified line.
`Int`	`getLineForOffset(offset: Int)` 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.
`Int`	`getLineForVertical(vertical: Int)` 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.
`Float`	`getLineLeft(line: Int)` Get the leftmost position that should be exposed for horizontal scrolling on the specified line.
`Float`	`getLineRight(line: Int)` Get the rightmost position that should be exposed for horizontal scrolling on the specified line.
`Int`	`getLineVisibleEnd(line: Int)` Return the text offset after the last visible character (so whitespace is not counted) on the specified line.
`Int`	`getOffsetForHorizontal(line: Int, horiz: Float)` Get the character offset on the specified line whose position is closest to the specified horizontal position.
`Int`	`getOffsetToLeftOf(offset: Int)`
`Int`	`getOffsetToRightOf(offset: Int)`
`TextPaint!`	`getPaint()` Return the base Paint properties for this layout. Do NOT change the paint, which may result in funny drawing for this layout.
`Layout.Alignment!`	`getParagraphAlignment(line: Int)` Get the alignment of the specified paragraph, taking into account markup attached to it.
`Int`	`getParagraphLeft(line: Int)` Get the left edge of the specified paragraph, inset by left margins.
`Int`	`getParagraphRight(line: Int)` Get the right edge of the specified paragraph, inset by right margins.
`Float`	`getPrimaryHorizontal(offset: Int)` 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.
`Float`	`getSecondaryHorizontal(offset: Int)` 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.
`Unit`	`getSelectionPath(start: Int, end: Int, dest: Path!)` 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.
`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.
`Int`	`getWidth()` Return the width of this layout.
`Unit`	`increaseWidthTo(wid: Int)` 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.
`Boolean`	`isRtlCharAt(offset: Int)` Returns true if the character at offset is right to left (RTL).
`Boolean`	`isSpanned()`

Parameters
`source`	CharSequence!: the text to render
`paint`	TextPaint!: the default paint for the layout
`outerwidth`	Int: the wrapping width for the text
`align`	Layout.Alignment!: whether to left, right, or center the text
`spacingMult`	Float: this value is no longer used by BoringLayout
`spacingAdd`	Float: this value is no longer used by BoringLayout
`metrics`	BoringLayout.Metrics!: `Metrics` instance that contains information about FontMetrics and line width
`includePad`	Boolean: set whether to include extra space beyond font ascent and descent which is needed to avoid clipping in some scripts

Parameters
`canvas`	the canvas
`highlight`	Path!: 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

Parameters
`text`	CharSequence!: a text
`paint`	TextPaint!: a paint
`metrics`	BoringLayout.Metrics!: a metrics object to be recycled. If null is passed, this function creat new object.

BoringLayout

Summary

Public constructors

BoringLayout

BoringLayout

Public methods

draw

ellipsized

getBottomPadding

getEllipsisCount

getEllipsisStart

getEllipsizedWidth

getHeight

getLineContainsTab

getLineCount

getLineDescent

getLineDirections

getLineMax

getLineStart

getLineTop

getLineWidth

getParagraphDirection

getTopPadding

isBoring

isBoring

make

make

replaceOrMake

replaceOrMake