Android - An Open Handset Alliance Project

android.text
public class

android.text.BoringLayout

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, or need to call Canvas.drawText() directly.

Nested Classes

BoringLayout.Metrics

Summary

Constants inherited from class android.text.Layout

DIR_LEFT_TO_RIGHT, DIR_RIGHT_TO_LEFT

			Value
int	DIR_LEFT_TO_RIGHT		1	0x00000001
int	DIR_RIGHT_TO_LEFT		-1	0xffffffff

Public Constructors

BoringLayout(CharSequence source, TextPaint paint, int outerwidth, Alignment align, float spacingmult, float spacingadd, Metrics metrics, boolean includepad)

Public Methods

		int	getBottomPadding()
			Returns the number of extra pixels of descent padding in the bottom line of the Layout.
		int	getHeight()
			Return the total height of this layout.
		boolean	getLineContainsTab(int line)
			Returns whether the specified line contains one or more tabs.
		int	getLineCount()
			Return the number of lines of text in this layout.
		int	getLineDescent(int line)
			Return the descent of the specified line.
final		Directions	getLineDirections(int line)
			Returns an array of directionalities for the specified line.
		float	getLineMax(int line)
			Get the horizontal extent of the specified line.
		int	getLineStart(int line)
			Return the text offset of the beginning of the specified line.
		int	getLineTop(int line)
			Return the vertical position of the top of the specified line.
		int	getParagraphDirection(int line)
			Returns the primary directionality of the paragraph containing the specified line.
		int	getTopPadding()
			Returns the (negative) number of extra pixels of ascent padding in the top line of the Layout.
	static	Metrics	isBoring(CharSequence text, TextPaint paint)
			Returns null if not boring; the width, ascent, and descent if boring.
	static	BoringLayout	make(CharSequence source, TextPaint paint, int outerwidth, Alignment align, float spacingmult, float spacingadd, Metrics metrics, boolean includepad)

Methods inherited from class android.text.Layout

draw, draw, getAlignment, getBottomPadding, getCursorPath, getDesiredWidth, getDesiredWidth, getHeight, getLineAscent, getLineBaseline, getLineBottom, getLineBounds, getLineContainsTab, getLineCount, getLineDescent, getLineDirections, getLineEnd, getLineForOffset, getLineForVertical, getLineLeft, getLineMax, getLineRight, getLineStart, getLineTop, getLineVisibleEnd, getOffsetForHorizontal, getOffsetToLeftOf, getOffsetToRightOf, getPaint, getParagraphAlignment, getParagraphDirection, getParagraphLeft, getParagraphRight, getPrimaryHorizontal, getSecondaryHorizontal, getSelectionPath, getSpacingAdd, getSpacingMultiplier, getText, getTopPadding, getWidth, increaseWidthTo, isSpanned

			void	draw(Canvas c)
				Draw this Layout on the specified Canvas.
			void	draw(Canvas c, Path hilite, Paint hilitepaint)
				Draw the specified rectangle from this Layout on the specified Canvas, with the specified path drawn between the background and the text.
	final		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 would be necessary to display the specified text slice with one line per paragraph.
		static	float	getDesiredWidth(CharSequence source, TextPaint paint)
				Return how wide a layout would be necessary to display the specified text with one line per paragraph.
			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 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.
abstract			Directions	getLineDirections(int line)
				Returns an array of directionalities 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)
				Get the horizontal extent of the specified line.
			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.
abstract			int	getLineTop(int line)
				Return the vertical position of the top of the specified line.
			int	getLineVisibleEnd(int line)
				Return the text offset after the last visible character (so whitespace is not counted) on the specified line.
			int	getOffsetForHorizontal(int line, float horiz)
				Get the character offset on the specfied line whose position is closest to the specified horizontal position.
			int	getOffsetToLeftOf(int offset)
				Return the text offset that would be reached by moving left (possibly onto another line) from the specified offset.
			int	getOffsetToRightOf(int offset)
				Return the text offset that would be reached by moving right (possibly onto another line) from the specified offset.
	final		TextPaint	getPaint()
				Return the base Paint properties for this layout.
	final		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.
	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.
	final		boolean	isSpanned()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Details

Public Constructors

public BoringLayout(CharSequence source, TextPaint paint, int outerwidth, Alignment align, float spacingmult, float spacingadd, Metrics metrics, boolean includepad)

Public Methods

public int getBottomPadding()

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

public int getHeight()

Return the total height of this layout.

public boolean getLineContainsTab(int line)

Returns whether the specified line contains one or more tabs.

public int getLineCount()

Return the number of lines of text in this layout.

public int getLineDescent(int line)

Return the descent of the specified line.

public final Directions getLineDirections(int line)

Returns an array of directionalities for the specified line. The array alternates counts of characters in left-to-right and right-to-left segments of the line.

public float getLineMax(int line)

Get the horizontal extent of the specified line.

public int getLineStart(int line)

Return the text offset of the beginning of the specified line. If the specified line is one beyond the last line, returns the end of the last line.

public int getLineTop(int line)

Return the vertical position of the top of the specified line. If the specified line is one beyond the last line, returns the bottom of the last line.

public int getParagraphDirection(int line)

Returns the primary directionality of the paragraph containing the specified line.

public int getTopPadding()

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

public static Metrics isBoring(CharSequence text, TextPaint paint)

Returns null if not boring; the width, ascent, and descent if boring.

public static BoringLayout make(CharSequence source, TextPaint paint, int outerwidth, Alignment align, float spacingmult, float spacingadd, Metrics metrics, boolean includepad)

Android - An Open Handset Alliance Project

Documentation

Goodies

android.text.BoringLayout

Nested Classes

Summary

Constants inherited from class android.text.Layout

Public Constructors

Public Methods

Methods inherited from class android.text.Layout

Methods inherited from class java.lang.Object

Details

Public Constructors

public BoringLayout(CharSequence source, TextPaint paint, int outerwidth, Alignment align, float spacingmult, float spacingadd, Metrics metrics, boolean includepad)

Public Methods

public int getBottomPadding()

public int getHeight()

public boolean getLineContainsTab(int line)

public int getLineCount()

public int getLineDescent(int line)

public final Directions getLineDirections(int line)

public float getLineMax(int line)

public int getLineStart(int line)

public int getLineTop(int line)

public int getParagraphDirection(int line)

public int getTopPadding()

public static Metrics isBoring(CharSequence text, TextPaint paint)

public static BoringLayout make(CharSequence source, TextPaint paint, int outerwidth, Alignment align, float spacingmult, float spacingadd, Metrics metrics, boolean includepad)


e.g. "intent" or "activity"