Most visited

Recently visited

Results for

Summary: Nested Classes | Inherited Constants | Ctors | Methods | Inherited Methods

BoringLayout

public class BoringLayout
extends Layout implements TextUtils.EllipsizeCallback

java.lang.Object
↳	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(CharSequence, TextPaint) 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
`class`	`BoringLayout.Metrics`

Inherited constants

From class android.text.Layout

`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_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`	`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(CharSequence source, TextPaint paint, int outerwidth, Layout.Alignment align, float spacingMult, float spacingAdd, BoringLayout.Metrics metrics, boolean includePad)`
`BoringLayout(CharSequence source, TextPaint paint, int outerWidth, Layout.Alignment align, float spacingMult, float spacingAdd, BoringLayout.Metrics metrics, boolean includePad, TextUtils.TruncateAt ellipsize, int ellipsizedWidth)`

Public methods
`void`	`draw(Canvas c, Path highlight, Paint highlightpaint, int cursorOffset)` Draw this Layout on the specified canvas, with the highlight path drawn between the background and the text.
`void`	`ellipsized(int start, int end)` Callback for the ellipsizer to report what region it ellipsized.
`int`	`getBottomPadding()` Returns the number of extra pixels of descent padding in the bottom line of the Layout.
`int`	`getEllipsisCount(int line)` Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.
`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.
`boolean`	`getLineContainsTab(int line)` Returns whether the specified line contains one or more characters that need to be handled specially, like tabs.
`int`	`getLineCount()` Return the number of lines of text in this layout.
`int`	`getLineDescent(int line)` Return the descent of the specified line(0…getLineCount() - 1).
`final Layout.Directions`	`getLineDirections(int line)` Returns the directional run information for the specified line.
`float`	`getLineMax(int line)` Gets the unsigned horizontal extent of the specified line, including leading margin indent, but excluding trailing whitespace.
`int`	`getLineStart(int line)` Return the text offset of the beginning of the specified line ( 0…getLineCount()).
`int`	`getLineTop(int line)` Return the vertical position of the top of the specified line (0…getLineCount()).
`float`	`getLineWidth(int line)` Gets the unsigned horizontal extent of the specified line, including leading margin indent and trailing whitespace.
`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`	`getTopPadding()` Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
`static BoringLayout.Metrics`	`isBoring(CharSequence text, TextPaint paint)` Determine and compute metrics if given text can be handled by BoringLayout.
`static BoringLayout.Metrics`	`isBoring(CharSequence text, TextPaint paint, BoringLayout.Metrics metrics)` Determine and compute metrics if given text can be handled by BoringLayout.
`static BoringLayout`	`make(CharSequence source, TextPaint paint, int outerWidth, Layout.Alignment align, float spacingmult, float spacingadd, BoringLayout.Metrics metrics, boolean includePad, TextUtils.TruncateAt ellipsize, int ellipsizedWidth)` Utility function to construct a BoringLayout instance.
`static BoringLayout`	`make(CharSequence source, TextPaint paint, int outerWidth, Layout.Alignment align, float spacingMult, float spacingAdd, BoringLayout.Metrics metrics, boolean includePad)` Utility function to construct a BoringLayout instance.
`BoringLayout`	`replaceOrMake(CharSequence source, TextPaint paint, int outerWidth, Layout.Alignment align, float spacingMult, float spacingAdd, BoringLayout.Metrics metrics, boolean includePad, TextUtils.TruncateAt ellipsize, int ellipsizedWidth)` Returns a BoringLayout for the specified text, potentially reusing this one if it is already suitable.
`BoringLayout`	`replaceOrMake(CharSequence source, TextPaint paint, int outerwidth, Layout.Alignment align, float spacingMult, float spacingAdd, BoringLayout.Metrics metrics, boolean includePad)` Returns a BoringLayout for the specified text, potentially reusing this one if it is already suitable.

Inherited methods

From class


        
          android.text.Layout

`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.
`final 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, 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.
`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.
`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.
`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.
`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.
`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.
`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)`
`final TextPaint`	`getPaint()` Return the base Paint properties for 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.
`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.
`final float`	`getSpacingAdd()` Return the number of units of leading that are added to each line.
`final float`	`getSpacingMultiplier()` Return what the text height is multiplied by to get the line height.
`final CharSequence`	`getText()` Return the text that is displayed by this Layout.
`abstract int`	`getTopPadding()` Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
`final int`	`getWidth()` Return the width of this layout.
`final void`	`increaseWidthTo(int wid)` Increase the width of this layout to the specified width.
`boolean`	`isRtlCharAt(int offset)` Returns true if the character at offset is right to left (RTL).
`final boolean`	`isSpanned()`

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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.text.TextUtils.EllipsizeCallback


      ellipsized(int start, int end)

This method is called to report that the specified region of text was ellipsized away by a call to TextUtils.ellipsize(CharSequence, TextPaint, float, TextUtils.TruncateAt).

Public constructors

BoringLayout

public BoringLayout (CharSequence source, 
                TextPaint paint, 
                int outerwidth, 
                Layout.Alignment align, 
                float spacingMult, 
                float spacingAdd, 
                BoringLayout.Metrics metrics, 
                boolean includePad)

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

BoringLayout

public BoringLayout (CharSequence source, 
                TextPaint paint, 
                int outerWidth, 
                Layout.Alignment align, 
                float spacingMult, 
                float spacingAdd, 
                BoringLayout.Metrics metrics, 
                boolean includePad, 
                TextUtils.TruncateAt ellipsize, 
                int ellipsizedWidth)

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
`ellipsize`	`TextUtils.TruncateAt`: whether to ellipsize the text if width of the text is longer than the requested `outerwidth`
`ellipsizedWidth`	`int`: the width to which this Layout is ellipsizing. If `ellipsize` is `null`, or is `TextUtils.TruncateAt#MARQUEE` this value is not used, `outerwidth` is used instead

Public methods

draw

public void draw (Canvas c, 
                Path highlight, 
                Paint highlightpaint, 
                int cursorOffset)

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

Parameters
`c`	`Canvas`: the canvas
`highlight`	`Path`: the path of the highlight or cursor; can be null
`highlightpaint`	`Paint`: the paint for the highlight
`cursorOffset`	`int`: the amount to temporarily translate the canvas while rendering the highlight

ellipsized

public void ellipsized (int start, 
                int end)

Callback for the ellipsizer to report what region it ellipsized.

Parameters
`start`	`int`
`end`	`int`

getBottomPadding

public int getBottomPadding ()

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

Returns
`int`

getEllipsisCount

public 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

public 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`

getEllipsizedWidth

public int getEllipsizedWidth ()

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

Returns
`int`

getHeight

public int getHeight ()

Return the total height of this layout.

Returns
`int`

getLineContainsTab

public 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

public int getLineCount ()

Return the number of lines of text in this layout.

Returns
`int`

getLineDescent

public int getLineDescent (int line)

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

Parameters
`line`	`int`

Returns
`int`

getLineDirections

public final 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`

getLineMax

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`

getLineStart

public 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

public 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`

getLineWidth

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`

getParagraphDirection

public 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`

getTopPadding

public int getTopPadding ()

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

Returns
`int`

isBoring

public static BoringLayout.Metrics isBoring (CharSequence text, 
                TextPaint paint)

Determine and compute metrics if given text can be handled by BoringLayout.

Parameters
`text`	`CharSequence`: a text
`paint`	`TextPaint`: a paint

Returns
`BoringLayout.Metrics`	layout metric for the given text. null if given text is unable to be handled by BoringLayout.

isBoring

public static BoringLayout.Metrics isBoring (CharSequence text, 
                TextPaint paint, 
                BoringLayout.Metrics metrics)

Determine and compute metrics if given text can be handled by BoringLayout.

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.

Returns
`BoringLayout.Metrics`	layout metric for the given text. If metrics is not null, this method fills values to given metrics object instead of allocating new metrics object. null if given text is unable to be handled by BoringLayout.

make

public static BoringLayout make (CharSequence source, 
                TextPaint paint, 
                int outerWidth, 
                Layout.Alignment align, 
                float spacingmult, 
                float spacingadd, 
                BoringLayout.Metrics metrics, 
                boolean includePad, 
                TextUtils.TruncateAt ellipsize, 
                int ellipsizedWidth)

Utility function to construct a BoringLayout instance.

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
`ellipsize`	`TextUtils.TruncateAt`: whether to ellipsize the text if width of the text is longer than the requested width
`ellipsizedWidth`	`int`: the width to which this Layout is ellipsizing. If `ellipsize` is `null`, or is `TextUtils.TruncateAt#MARQUEE` this value is not used, `outerWidth` is used instead

Returns
`BoringLayout`

make

public static BoringLayout make (CharSequence source, 
                TextPaint paint, 
                int outerWidth, 
                Layout.Alignment align, 
                float spacingMult, 
                float spacingAdd, 
                BoringLayout.Metrics metrics, 
                boolean includePad)

Utility function to construct a BoringLayout instance.

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

Returns
`BoringLayout`

replaceOrMake

public BoringLayout replaceOrMake (CharSequence source, 
                TextPaint paint, 
                int outerWidth, 
                Layout.Alignment align, 
                float spacingMult, 
                float spacingAdd, 
                BoringLayout.Metrics metrics, 
                boolean includePad, 
                TextUtils.TruncateAt ellipsize, 
                int ellipsizedWidth)

Returns a BoringLayout for the specified text, potentially reusing this one if it is already suitable. The caller must make sure that no one is still using this Layout.

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
`ellipsize`	`TextUtils.TruncateAt`: whether to ellipsize the text if width of the text is longer than the requested width
`ellipsizedWidth`	`int`: the width to which this Layout is ellipsizing. If `ellipsize` is `null`, or is `TextUtils.TruncateAt#MARQUEE` this value is not used, `outerwidth` is used instead

Returns
`BoringLayout`

replaceOrMake

public BoringLayout replaceOrMake (CharSequence source, 
                TextPaint paint, 
                int outerwidth, 
                Layout.Alignment align, 
                float spacingMult, 
                float spacingAdd, 
                BoringLayout.Metrics metrics, 
                boolean includePad)

Returns a BoringLayout for the specified text, potentially reusing this one if it is already suitable. The caller must make sure that no one is still using this Layout.

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

Returns
`BoringLayout`

Interfaces

Classes

Enums

Most visited

Recently visited

Results for

BoringLayout

Summary

Nested classes

Inherited constants

Public constructors

Public methods

Inherited methods

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