Android - An Open Handset Alliance Project

android.text
public class

android.text.TextPaint

java.lang.Object
	android.graphics.Paint
		android.text.TextPaint

TextPaint is an extension of Paint that leaves room for some extra data used during text measuring and drawing.

Summary

Constants inherited from class android.graphics.Paint

ANTI_ALIAS_FLAG, DEV_KERN_TEXT_FLAG, DITHER_FLAG, FAKE_BOLD_TEXT_FLAG, FILTER_BITMAP_FLAG, LINEAR_TEXT_FLAG, STRIKE_THRU_TEXT_FLAG, SUBPIXEL_TEXT_FLAG, UNDERLINE_TEXT_FLAG

			Value
int	ANTI_ALIAS_FLAG	bit mask for the flag enabling antialiasing	1	0x00000001
int	DEV_KERN_TEXT_FLAG	bit mask for the flag enabling device kerning for text	256	0x00000100
int	DITHER_FLAG	bit mask for the flag enabling dithering	4	0x00000004
int	FAKE_BOLD_TEXT_FLAG	bit mask for the flag enabling fake-bold text	32	0x00000020
int	FILTER_BITMAP_FLAG	bit mask for the flag enabling bitmap filtering	2	0x00000002
int	LINEAR_TEXT_FLAG	bit mask for the flag enabling linear-text (no gridding)	64	0x00000040
int	STRIKE_THRU_TEXT_FLAG	bit mask for the flag enabling strike-thru text	16	0x00000010
int	SUBPIXEL_TEXT_FLAG	bit mask for the flag enabling linear-text (no gridding)	128	0x00000080
int	UNDERLINE_TEXT_FLAG	bit mask for the flag enabling underline text	8	0x00000008

Fields

public			int	baselineShift
public			int	bgColor

Public Constructors

					TextPaint()
					TextPaint(int flags)
					TextPaint(Paint p)

Public Methods

				void	set(TextPaint tp)
					Copy the fields from tp into this TextPaint, including the fields inherited from Paint.

Methods inherited from class android.graphics.Paint

ascent, breakText, breakText, breakText, clearShadowLayer, descent, finalize, getAlpha, getColor, getColorFilter, getFillPath, getFlags, getFontMetrics, getFontMetrics, getFontMetricsInt, getFontMetricsInt, getFontSpacing, getMaskFilter, getPathEffect, getRasterizer, getShader, getStrokeCap, getStrokeJoin, getStrokeMiter, getStrokeWidth, getStyle, getTextAlign, getTextPath, getTextPath, getTextScaleX, getTextSize, getTextSkewX, getTextWidths, getTextWidths, getTextWidths, getTextWidths, getTypeface, getXfermode, isAntiAlias, isDither, isFakeBoldText, isFilterBitmap, isLinearText, isStrikeThruText, isSubpixelText, isUnderlineText, measureText, measureText, measureText, measureText, reset, set, setARGB, setAlpha, setAntiAlias, setColor, setColorFilter, setDither, setFakeBoldText, setFilterBitmap, setFlags, setLinearText, setMaskFilter, setPathEffect, setRasterizer, setShader, setShadowLayer, setStrikeThruText, setStrokeCap, setStrokeJoin, setStrokeMiter, setStrokeWidth, setStyle, setSubpixelText, setTextAlign, setTextScaleX, setTextSize, setTextSkewX, setTypeface, setUnderlineText, setXfermode

	float	ascent()
		Return the distance above (negative) the baseline (ascent) based on the current typeface and text size.
	int	breakText(CharSequence text, int start, int end, boolean measureForwards, float maxWidth, float[] measuredWidth)
		Measure the text, stopping early if the measured width exceeds maxWidth.
	int	breakText(char[] text, int index, int count, float maxWidth, float[] measuredWidth)
		Measure the text, stopping early if the measured width exceeds maxWidth.
	int	breakText(String text, boolean measureForwards, float maxWidth, float[] measuredWidth)
		Measure the text, stopping early if the measured width exceeds maxWidth.
	void	clearShadowLayer()
		Temporary API to clear the shadow layer.
	float	descent()
		Return the distance below (positive) the baseline (descent) based on the current typeface and text size.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
	int	getAlpha()
		Helper to getColor() that just returns the color's alpha value.
	int	getColor()
		Return the paint's color.
	ColorFilter	getColorFilter()
		Get the paint's colorfilter (maybe be null).
	boolean	getFillPath(Path src, Path dst)
		Applies any/all effects (patheffect, stroking) to src, returning the result in dst.
	int	getFlags()
		Return the paint's flags.
	float	getFontMetrics(FontMetrics metrics)
		Return the font's recommended interline spacing, given the Paint's settings for typeface, textSize, etc.
	FontMetrics	getFontMetrics()
		Allocates a new FontMetrics object, and then calls getFontMetrics(fm) with it, returning the object.
	FontMetricsInt	getFontMetricsInt()
	int	getFontMetricsInt(FontMetricsInt fmi)
		Return the font's interline spacing, given the Paint's settings for typeface, textSize, etc.
	float	getFontSpacing()
		Return the recommend line spacing based on the current typeface and text size.
	MaskFilter	getMaskFilter()
		Get the paint's maskfilter object.
	PathEffect	getPathEffect()
		Get the paint's patheffect object.
	Rasterizer	getRasterizer()
		Get the paint's rasterizer (or null).
	Shader	getShader()
		Get the paint's shader object.
	Cap	getStrokeCap()
		Return the paint's Cap, controlling how the start and end of stroked lines and paths are treated.
	Join	getStrokeJoin()
		Return the paint's stroke join type.
	float	getStrokeMiter()
		Return the paint's stroke miter value.
	float	getStrokeWidth()
		Return the width for stroking.
	Style	getStyle()
		Return the paint's style, used for controlling how primitives' geometries are interpreted (except for drawBitmap, which always assumes FILL_STYLE).
	Align	getTextAlign()
		Return the paint's Align value for drawing text.
	void	getTextPath(String text, int start, int end, float x, float y, Path path)
		Return the path (outline) for the specified text.
	void	getTextPath(char[] text, int index, int count, float x, float y, Path path)
		Return the path (outline) for the specified text.
	float	getTextScaleX()
		Return the paint's horizontal scale factor for text.
	float	getTextSize()
		Return the paint's text size.
	float	getTextSkewX()
		Return the paint's horizontal skew factor for text.
	int	getTextWidths(CharSequence text, int start, int end, float[] widths)
		Return the advance widths for the characters in the string.
	int	getTextWidths(char[] text, int index, int count, float[] widths)
		Return the advance widths for the characters in the string.
	int	getTextWidths(String text, int start, int end, float[] widths)
		Return the advance widths for the characters in the string.
	int	getTextWidths(String text, float[] widths)
		Return the advance widths for the characters in the string.
	Typeface	getTypeface()
		Get the paint's typeface object.
	Xfermode	getXfermode()
		Get the paint's xfermode object.
final	boolean	isAntiAlias()
		Helper for getFlags(), returning true if ANTI_ALIAS_FLAG bit is set
final	boolean	isDither()
		Helper for getFlags(), returning true if DITHER_FLAG bit is set
final	boolean	isFakeBoldText()
		Helper for getFlags(), returning true if FAKE_BOLD_TEXT_FLAG bit is set
final	boolean	isFilterBitmap()
		Whether or not the bitmap filter is activated.
final	boolean	isLinearText()
		Helper for getFlags(), returning true if LINEAR_TEXT_FLAG bit is set
final	boolean	isStrikeThruText()
		Helper for getFlags(), returning true if STRIKE_THRU_TEXT_FLAG bit is set
final	boolean	isSubpixelText()
		Helper for getFlags(), returning true if SUBPIXEL_TEXT_FLAG bit is set
final	boolean	isUnderlineText()
		Helper for getFlags(), returning true if UNDERLINE_TEXT_FLAG bit is set
	float	measureText(char[] text, int index, int count)
		Return the width of the text.
	float	measureText(String text, int start, int end)
		Return the width of the text.
	float	measureText(CharSequence text, int start, int end)
		Return the width of the text.
	float	measureText(String text)
		Return the width of the text.
	void	reset()
		Restores the paint to its default settings.
	void	set(Paint src)
		Copy the fields from src into this paint.
	void	setARGB(int a, int r, int g, int b)
		Helper to setColor(), that takes a,r,g,b and constructs the color int
	void	setAlpha(int a)
		Helper to setColor(), that only assigns the color's alpha value, leaving its r,g,b values unchanged.
	void	setAntiAlias(boolean aa)
		Helper for setFlags(), setting or clearing the ANTI_ALIAS_FLAG bit
	void	setColor(int color)
		Set the paint's color.
	ColorFilter	setColorFilter(ColorFilter filter)
		Set or clear the paint's colorfilter, returning the parameter.
	void	setDither(boolean dither)
		Helper for setFlags(), setting or clearing the DITHER_FLAG bit
	void	setFakeBoldText(boolean fakeBoldText)
		Helper for setFlags(), setting or clearing the STRIKE_THRU_TEXT_FLAG bit
	void	setFilterBitmap(boolean filter)
		Helper for setFlags(), setting or clearing the FILTER_BITMAP_FLAG bit.
	void	setFlags(int flags)
		Set the paint's flags.
	void	setLinearText(boolean linearText)
		Helper for setFlags(), setting or clearing the LINEAR_TEXT_FLAG bit
	MaskFilter	setMaskFilter(MaskFilter maskfilter)
		Set or clear the maskfilter object.
	PathEffect	setPathEffect(PathEffect effect)
		Set or clear the patheffect object.
	Rasterizer	setRasterizer(Rasterizer rasterizer)
		Set or clear the rasterizer object.
	Shader	setShader(Shader shader)
		Set or clear the shader object.
	void	setShadowLayer(float radius, float dx, float dy, int color)
		Temporary API to expose layer drawing.
	void	setStrikeThruText(boolean strikeThruText)
		Helper for setFlags(), setting or clearing the STRIKE_THRU_TEXT_FLAG bit
	void	setStrokeCap(Cap cap)
		Set the paint's Cap.
	void	setStrokeJoin(Join join)
		Set the paint's Join.
	void	setStrokeMiter(float miter)
		Set the paint's stroke miter value.
	void	setStrokeWidth(float width)
		Set the width for stroking.
	void	setStyle(Style style)
		Set the paint's style, used for controlling how primitives' geometries are interpreted (except for drawBitmap, which always assumes Fill).
	void	setSubpixelText(boolean subpixelText)
		Helper for setFlags(), setting or clearing the SUBPIXEL_TEXT_FLAG bit
	void	setTextAlign(Align align)
		Set the paint's text alignment.
	void	setTextScaleX(float scaleX)
		Set the paint's horizontal scale factor for text.
	void	setTextSize(float textSize)
		Set the paint's text size.
	void	setTextSkewX(float skewX)
		Set the paint's horizontal skew factor for text.
	Typeface	setTypeface(Typeface typeface)
		Set or clear the typeface object.
	void	setUnderlineText(boolean underlineText)
		Helper for setFlags(), setting or clearing the UNDERLINE_TEXT_FLAG bit
	Xfermode	setXfermode(Xfermode xfermode)
		Set or clear the xfermode object.

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

Fields

public int baselineShift

public int bgColor

Public Constructors

public TextPaint()

public TextPaint(int flags)

public TextPaint(Paint p)

Public Methods

public void set(TextPaint tp)

Copy the fields from tp into this TextPaint, including the fields inherited from Paint.

Android - An Open Handset Alliance Project

Documentation

Goodies

android.text.TextPaint

Summary

Constants inherited from class android.graphics.Paint

Fields

Public Constructors

Public Methods

Methods inherited from class android.graphics.Paint

Methods inherited from class java.lang.Object

Details

Fields

public int baselineShift

public int bgColor

Public Constructors

public TextPaint()

public TextPaint(int flags)

public TextPaint(Paint p)

Public Methods

public void set(TextPaint tp)


e.g. "intent" or "activity"