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.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
BoringLayout.Metrics |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.text.Layout
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Draw this Layout on the specified canvas, with the highlight path drawn
between the background and the text.
| |||||||||||
Callback for the ellipsizer to report what region it ellipsized.
| |||||||||||
Returns the number of extra pixels of descent padding in the
bottom line of the Layout.
| |||||||||||
Returns the number of characters to be ellipsized away, or 0 if
no ellipsis is to take place.
| |||||||||||
Return the offset of the first character to be ellipsized away,
relative to the start of the line.
| |||||||||||
Return the width to which this Layout is ellipsizing, or
getWidth() if it is not doing anything special. | |||||||||||
Return the total height of this layout.
| |||||||||||
Returns whether the specified line contains one or more
characters that need to be handled specially, like tabs
or emoji.
| |||||||||||
Return the number of lines of text in this layout.
| |||||||||||
Return the descent of the specified line(0…getLineCount() - 1).
| |||||||||||
Returns the directional run information for the specified line.
| |||||||||||
Gets the unsigned horizontal extent of the specified line, including
leading margin indent, but excluding trailing whitespace.
| |||||||||||
Return the text offset of the beginning of the specified line (
0…getLineCount()).
| |||||||||||
Return the vertical position of the top of the specified line
(0…getLineCount()).
| |||||||||||
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 ). | |||||||||||
Returns the (negative) number of extra pixels of ascent padding in the
top line of the Layout.
| |||||||||||
Returns null if not boring; the width, ascent, and descent in the
provided Metrics object (or a new one if the provided one was null)
if boring.
| |||||||||||
Returns null if not boring; the width, ascent, and descent if boring.
| |||||||||||
Returns a BoringLayout for the specified text, potentially reusing
this one if it is already suitable.
| |||||||||||
Returns a BoringLayout for the specified text, potentially reusing
this one if it is already suitable.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.text.Layout
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
android.text.TextUtils.EllipsizeCallback
|
Draw this Layout on the specified canvas, with the highlight path drawn between the background and the text.
c | the canvas |
---|---|
highlight | the path of the highlight or cursor; can be null |
highlightpaint | the paint for the highlight |
cursorOffset | the amount to temporarily translate the canvas while rendering the highlight |
Callback for the ellipsizer to report what region it ellipsized.
Returns the number of extra pixels of descent padding in the bottom line of the Layout.
Returns the number of characters to be ellipsized away, or 0 if no ellipsis is to take place.
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().)
Return the width to which this Layout is ellipsizing, or
getWidth()
if it is not doing anything special.
Returns whether the specified line contains one or more characters that need to be handled specially, like tabs or emoji.
Return the descent of the specified line(0…getLineCount() - 1).
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.
Gets the unsigned horizontal extent of the specified line, including leading margin indent, but excluding trailing whitespace.
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.
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.
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
).
Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
Returns null if not boring; the width, ascent, and descent in the provided Metrics object (or a new one if the provided one was null) if boring.
Returns null if not boring; the width, ascent, and descent if boring.
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.
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.