Since: API Level 1

public class

TextView

extends View
implements ViewTreeObserver.OnPreDrawListener

java.lang.Object
↳	android.view.View
	↳	android.widget.TextView

Known Direct Subclasses

Button, CheckedTextView, Chronometer, DigitalClock, EditText

Known Indirect Subclasses

AutoCompleteTextView, CheckBox, CompoundButton, ExtractEditText, MultiAutoCompleteTextView, RadioButton, ToggleButton

Class Overview

Displays text to the user and optionally allows them to edit it. A TextView is a complete text editor, however the basic class is configured to not allow editing; see EditText for a subclass that configures the text view for editing.

XML attributes

See TextView Attributes, View Attributes

Summary

Nested Classes
enum	TextView.BufferType
interface	TextView.OnEditorActionListener	Interface definition for a callback to be invoked when an action is performed on the editor.
class	TextView.SavedState	User interface state that is stored by TextView for implementing `onSaveInstanceState()`.

XML Attributes
Attribute Name	Related Method	Description
android:autoLink	setAutoLinkMask(int)	Controls whether links such as urls and email addresses are automatically found and converted to clickable links.
android:autoText	setKeyListener(KeyListener)	If set, specifies that this TextView has a textual input method and automatically corrects some common spelling errors.
android:bufferType	setText(CharSequence,TextView.BufferType)	Determines the minimum type that getText() will return.
android:capitalize	setKeyListener(KeyListener)	If set, specifies that this TextView has a textual input method and should automatically capitalize what the user types.
android:cursorVisible	setCursorVisible(boolean)	Makes the cursor visible (the default) or invisible.
android:digits	setKeyListener(KeyListener)	If set, specifies that this TextView has a numeric input method and that these specific characters are the ones that it will accept.
android:drawableBottom	setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)	The drawable to be drawn below the text.
android:drawableLeft	setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)	The drawable to be drawn to the left of the text.
android:drawablePadding	setCompoundDrawablePadding(int)	The padding between the drawables and the text.
android:drawableRight	setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)	The drawable to be drawn to the right of the text.
android:drawableTop	setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)	The drawable to be drawn above the text.
android:editable		If set, specifies that this TextView has an input method.
android:editorExtras	setInputExtras(int)	Reference to an `<input-extras>` XML resource containing additional data to supply to an input method, which is private to the implementation of the input method.
android:ellipsize	setEllipsize(TextUtils.TruncateAt)	If set, causes words that are longer than the view is wide to be ellipsized instead of broken in the middle.
android:ems	setEms(int)	Makes the TextView be exactly this many ems wide.
android:freezesText	setFreezesText(boolean)	If set, the text view will include its current complete text inside of its frozen icicle in addition to meta-data such as the current cursor position.
android:gravity	setGravity(int)	Specifies how to align the text by the view's x- and/or y-axis when the text is smaller than the view.
android:height	setHeight(int)	Makes the TextView be exactly this many pixels tall.
android:hint	setHint(int)	Hint text to display when the text is empty.
android:imeActionId	setImeActionLabel(CharSequence,int)	Supply a value for `EditorInfo.actionId` used when an input method is connected to the text view.
android:imeActionLabel	setImeActionLabel(CharSequence,int)	Supply a value for `EditorInfo.actionLabel` used when an input method is connected to the text view.
android:imeOptions	setImeOptions(int)	Additional features you can enable in an IME associated with an editor to improve the integration with your application.
android:includeFontPadding	setIncludeFontPadding(boolean)	Leave enough room for ascenders and descenders instead of using the font ascent and descent strictly.
android:inputMethod	setKeyListener(KeyListener)	If set, specifies that this TextView should use the specified input method (specified by fully-qualified class name).
android:inputType	setRawInputType(int)	The type of data being placed in a text field, used to help an input method decide how to let the user enter text.
android:lineSpacingExtra	setLineSpacing(float,float)	Extra spacing between lines of text.
android:lineSpacingMultiplier	setLineSpacing(float,float)	Extra spacing between lines of text, as a multiplier.
android:lines	setLines(int)	Makes the TextView be exactly this many lines tall.
android:linksClickable	setLinksClickable(boolean)	If set to false, keeps the movement method from being set to the link movement method even if autoLink causes links to be found.
android:marqueeRepeatLimit	setMarqueeRepeatLimit(int)	The number of times to repeat the marquee animation.
android:maxEms	setMaxEms(int)	Makes the TextView be at most this many ems wide.
android:maxHeight	setMaxHeight(int)	Makes the TextView be at most this many pixels tall.
android:maxLength	setFilters(InputFilter)	Set an input filter to constrain the text length to the specified number.
android:maxLines	setMaxLines(int)	Makes the TextView be at most this many lines tall.
android:maxWidth	setMaxWidth(int)	Makes the TextView be at most this many pixels wide.
android:minEms	setMinEms(int)	Makes the TextView be at least this many ems wide.
android:minHeight	setMinHeight(int)	Makes the TextView be at least this many pixels tall.
android:minLines	setMinLines(int)	Makes the TextView be at least this many lines tall.
android:minWidth	setMinWidth(int)	Makes the TextView be at least this many pixels wide.
android:numeric	setKeyListener(KeyListener)	If set, specifies that this TextView has a numeric input method.
android:password	setTransformationMethod(TransformationMethod)	Whether the characters of the field are displayed as password dots instead of themselves.
android:phoneNumber	setKeyListener(KeyListener)	If set, specifies that this TextView has a phone number input method.
android:privateImeOptions	setPrivateImeOptions(String)	An addition content type description to supply to the input method attached to the text view, which is private to the implementation of the input method.
android:scrollHorizontally	setHorizontallyScrolling(boolean)	Whether the text is allowed to be wider than the view (and therefore can be scrolled horizontally).
android:selectAllOnFocus	setSelectAllOnFocus(boolean)	If the text is selectable, select it all when the view takes focus instead of moving the cursor to the start or end.
android:shadowColor	setShadowLayer(float,float,float,int)	Place a shadow of the specified color behind the text.
android:shadowDx	setShadowLayer(float,float,float,int)	Horizontal offset of the shadow.
android:shadowDy	setShadowLayer(float,float,float,int)	Vertical offset of the shadow.
android:shadowRadius	setShadowLayer(float,float,float,int)	Radius of the shadow.
android:singleLine	setTransformationMethod(TransformationMethod)	Constrains the text to a single horizontally scrolling line instead of letting it wrap onto multiple lines, and advances focus instead of inserting a newline when you press the enter key.
android:text	setText(CharSequence,TextView.BufferType)	Text to display.
android:textAppearance		Base text color, typeface, size, and style.
android:textColor	setTextColor(ColorStateList)	Text color.
android:textColorHighlight	setHighlightColor(int)	Color of the text selection highlight.
android:textColorHint	setHintTextColor(ColorStateList)	Color of the hint text.
android:textColorLink	setLinkTextColor(int)	Text color for links.
android:textScaleX	setTextScaleX(float)	Sets the horizontal scaling factor for the text.
android:textSize	setTextSize(float)	Size of the text.
android:textStyle	setTypeface(Typeface)	Style (bold, italic, bolditalic) for the text.
android:typeface	setTypeface(Typeface)	Typeface (normal, sans, serif, monospace) for the text.
android:width	setWidth(int)	Makes the TextView be exactly this many pixels wide.

[Expand]

Inherited XML Attributes

From class android.view.View

[Expand]

Inherited Constants

From class android.view.View

Public Constructors
	TextView(Context context)
	TextView(Context context, AttributeSet attrs)
	TextView(Context context, AttributeSet attrs, int defStyle)

Public Methods
void	addTextChangedListener(TextWatcher watcher) Adds a TextWatcher to the list of those whose methods are called whenever this TextView's text changes.
void	append(CharSequence text, int start, int end) Convenience method: Append the specified text slice to the TextView's display buffer, upgrading it to BufferType.EDITABLE if it was not already editable.
final void	append(CharSequence text) Convenience method: Append the specified text to the TextView's display buffer, upgrading it to BufferType.EDITABLE if it was not already editable.
void	beginBatchEdit()
boolean	bringPointIntoView(int offset) Move the point, specified by the offset, into the view if it is needed.
void	cancelLongPress() Cancels a pending long press.
void	clearComposingText() Use `BaseInputConnection.removeComposingSpans()` to remove any IME composing state from this text view.
void	computeScroll() Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.
void	debug(int depth) Prints information about this view in the log output, with the tag `VIEW_LOG_TAG`.
boolean	didTouchFocusSelect() Returns true, only while processing a touch gesture, if the initial touch down event caused focus to move to the text view and as a result its selection changed.
boolean	dispatchPopulateAccessibilityEvent(AccessibilityEvent event) Dispatches an `AccessibilityEvent` to the `View` children to be populated.
void	endBatchEdit()
boolean	extractText(ExtractedTextRequest request, ExtractedText outText) If this TextView contains editable content, extract a portion of it based on the information in `request` in to `outText`.
final int	getAutoLinkMask() Gets the autolink mask of the text.
int	getBaseline() Return the offset of the widget's text baseline from the widget's top boundary.
int	getCompoundDrawablePadding() Returns the padding between the compound drawables and the text.
Drawable[]	getCompoundDrawables() Returns drawables for the left, top, right, and bottom borders.
int	getCompoundPaddingBottom() Returns the bottom padding of the view, plus space for the bottom Drawable if any.
int	getCompoundPaddingLeft() Returns the left padding of the view, plus space for the left Drawable if any.
int	getCompoundPaddingRight() Returns the right padding of the view, plus space for the right Drawable if any.
int	getCompoundPaddingTop() Returns the top padding of the view, plus space for the top Drawable if any.
final int	getCurrentHintTextColor() Return the current color selected to paint the hint text.
final int	getCurrentTextColor() Return the current color selected for normal text.
Editable	getEditableText() Return the text the TextView is displaying as an Editable object.
TextUtils.TruncateAt	getEllipsize() Returns where, if anywhere, words that are longer than the view is wide should be ellipsized.
CharSequence	getError() Returns the error message that was set to be displayed with `setError(CharSequence)`, or `null` if no error was set or if it the error was cleared by the widget after user input.
int	getExtendedPaddingBottom() Returns the extended bottom padding of the view, including both the bottom Drawable if any and any extra space to keep more than maxLines of text from showing.
int	getExtendedPaddingTop() Returns the extended top padding of the view, including both the top Drawable if any and any extra space to keep more than maxLines of text from showing.
InputFilter[]	getFilters() Returns the current list of input filters.
void	getFocusedRect(Rect r) When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.
boolean	getFreezesText() Return whether this text view is including its entire text contents in frozen icicles.
int	getGravity() Returns the horizontal and vertical alignment of this TextView.
CharSequence	getHint() Returns the hint that is displayed when the text of the TextView is empty.
final ColorStateList	getHintTextColors() Return the color used to paint the hint text.
int	getImeActionId() Get the IME action ID previous set with `setImeActionLabel(CharSequence, int)`.
CharSequence	getImeActionLabel() Get the IME action label previous set with `setImeActionLabel(CharSequence, int)`.
int	getImeOptions() Get the type of the IME editor.
Bundle	getInputExtras(boolean create) Retrieve the input extras currently associated with the text view, which can be viewed as well as modified.
int	getInputType() Get the type of the content.
final KeyListener	getKeyListener()
final Layout	getLayout()
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.
int	getLineCount() Return the number of lines of text, or 0 if the internal Layout has not been built.
int	getLineHeight()
final ColorStateList	getLinkTextColors() Returns the color used to paint links in the text.
final boolean	getLinksClickable() Returns whether the movement method will automatically be set to `LinkMovementMethod` if `setAutoLinkMask(int)` has been set to nonzero and links are detected in `setText(char[], int, int)`.
final MovementMethod	getMovementMethod()
TextPaint	getPaint()
int	getPaintFlags()
String	getPrivateImeOptions() Get the private type of the content.
int	getSelectionEnd() Convenience for `getSelectionEnd(CharSequence)`.
int	getSelectionStart() Convenience for `getSelectionStart(CharSequence)`.
CharSequence	getText() Return the text the TextView is displaying.
static int	getTextColor(Context context, TypedArray attrs, int def) Returns the default color from the TextView_textColor attribute from the AttributeSet, if set, or the default color from the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.
final ColorStateList	getTextColors() Return the set of text colors.
static ColorStateList	getTextColors(Context context, TypedArray attrs) Returns the TextView_textColor attribute from the Resources.StyledAttributes, if set, or the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.
float	getTextScaleX()
float	getTextSize()
int	getTotalPaddingBottom() Returns the total bottom padding of the view, including the bottom Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.
int	getTotalPaddingLeft() Returns the total left padding of the view, including the left Drawable if any.
int	getTotalPaddingRight() Returns the total right padding of the view, including the right Drawable if any.
int	getTotalPaddingTop() Returns the total top padding of the view, including the top Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.
final TransformationMethod	getTransformationMethod()
Typeface	getTypeface()
URLSpan[]	getUrls() Returns the list of URLSpans attached to the text (by `Linkify` or otherwise) if any.
boolean	hasSelection() Return true iff there is a selection inside this text view.
void	invalidateDrawable(Drawable drawable) Invalidates the specified Drawable.
boolean	isInputMethodTarget() Returns whether this text view is a current input method target.
int	length() Returns the length, in characters, of the text managed by this TextView
boolean	moveCursorToVisibleOffset() Move the cursor, if needed, so that it is at an offset that is visible to the user.
void	onBeginBatchEdit() Called by the framework in response to a request to begin a batch of edit operations through a call to link `beginBatchEdit()`.
boolean	onCheckIsTextEditor() Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.
void	onCommitCompletion(CompletionInfo text) Called by the framework in response to a text completion from the current input method, provided by it calling `InputConnection.commitCompletion()`.
InputConnection	onCreateInputConnection(EditorInfo outAttrs) Create a new InputConnection for an InputMethod to interact with the view.
void	onEditorAction(int actionCode) Called when an attached input method calls `InputConnection.performEditorAction()` for this text view.
void	onEndBatchEdit() Called by the framework in response to a request to end a batch of edit operations through a call to link `endBatchEdit()`.
void	onFinishTemporaryDetach() Called after `onStartTemporaryDetach()` when the container is done changing the view.
boolean	onKeyDown(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: perform press of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released, if the view is enabled and clickable.
boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: always returns false (doesn't handle the event).
boolean	onKeyShortcut(int keyCode, KeyEvent event) Called when an unhandled key shortcut event occurs.
boolean	onKeyUp(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: perform clicking of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released.
boolean	onPreDraw() Callback method to be invoked when the view tree is about to be drawn.
boolean	onPrivateIMECommand(String action, Bundle data) Called by the framework in response to a private command from the current method, provided by it calling `InputConnection.performPrivateCommand()`.
void	onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()`.
Parcelable	onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	onStartTemporaryDetach() This is called when a container is going to temporarily detach a child, with `ViewGroup.detachViewFromParent`.
boolean	onTextContextMenuItem(int id) Called when a context menu option for the text view is selected.
boolean	onTouchEvent(MotionEvent event) Implement this method to handle touch screen motion events.
boolean	onTrackballEvent(MotionEvent event) Implement this method to handle trackball motion events.
void	onWindowFocusChanged(boolean hasWindowFocus) Called when the window containing this view gains or loses focus.
boolean	performLongClick() Call this view's OnLongClickListener, if it is defined.
void	removeTextChangedListener(TextWatcher watcher) Removes the specified TextWatcher from the list of those whose methods are called whenever this TextView's text changes.
final void	setAutoLinkMask(int mask) Sets the autolink mask of the text.
void	setCompoundDrawablePadding(int pad) Sets the size of the padding between the compound drawables and the text.
void	setCompoundDrawables(Drawable left, Drawable top, Drawable right, Drawable bottom) Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.
void	setCompoundDrawablesWithIntrinsicBounds(Drawable left, Drawable top, Drawable right, Drawable bottom) Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.
void	setCompoundDrawablesWithIntrinsicBounds(int left, int top, int right, int bottom) Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.
void	setCursorVisible(boolean visible) Set whether the cursor is visible.
final void	setEditableFactory(Editable.Factory factory) Sets the Factory used to create new Editables.
void	setEllipsize(TextUtils.TruncateAt where) Causes words in the text that are longer than the view is wide to be ellipsized instead of broken in the middle.
void	setEms(int ems) Makes the TextView exactly this many ems wide
void	setError(CharSequence error) Sets the right-hand compound drawable of the TextView to the "error" icon and sets an error message that will be displayed in a popup when the TextView has focus.
void	setError(CharSequence error, Drawable icon) Sets the right-hand compound drawable of the TextView to the specified icon and sets an error message that will be displayed in a popup when the TextView has focus.
void	setExtractedText(ExtractedText text) Apply to this text view the given extracted text, as previously returned by `extractText(ExtractedTextRequest, ExtractedText)`.
void	setFilters(InputFilter[] filters) Sets the list of input filters that will be used if the buffer is Editable.
void	setFreezesText(boolean freezesText) Control whether this text view saves its entire text contents when freezing to an icicle, in addition to dynamic state such as cursor position.
void	setGravity(int gravity) Sets the horizontal alignment of the text and the vertical gravity that will be used when there is extra space in the TextView beyond what is required for the text itself.
void	setHeight(int pixels) Makes the TextView exactly this many pixels tall.
void	setHighlightColor(int color) Sets the color used to display the selection highlight.
final void	setHint(CharSequence hint) Sets the text to be displayed when the text of the TextView is empty.
final void	setHint(int resid) Sets the text to be displayed when the text of the TextView is empty, from a resource.
final void	setHintTextColor(int color) Sets the color of the hint text.
final void	setHintTextColor(ColorStateList colors) Sets the color of the hint text.
void	setHorizontallyScrolling(boolean whether) Sets whether the text should be allowed to be wider than the View is.
void	setImeActionLabel(CharSequence label, int actionId) Change the custom IME action associated with the text view, which will be reported to an IME with `actionLabel` and `actionId` when it has focus.
void	setImeOptions(int imeOptions) Change the editor type integer associated with the text view, which will be reported to an IME with `imeOptions` when it has focus.
void	setIncludeFontPadding(boolean includepad) Set whether the TextView includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.
void	setInputExtras(int xmlResId) Set the extra input data of the text, which is the `TextBoxAttribute.extras` Bundle that will be filled in when creating an input connection.
void	setInputType(int type) Set the type of the content with a constant as defined for `inputType`.
void	setKeyListener(KeyListener input) Sets the key listener to be used with this TextView.
void	setLineSpacing(float add, float mult) Sets line spacing for this TextView.
void	setLines(int lines) Makes the TextView exactly this many lines tall
final void	setLinkTextColor(ColorStateList colors) Sets the color of links in the text.
final void	setLinkTextColor(int color) Sets the color of links in the text.
final void	setLinksClickable(boolean whether) Sets whether the movement method will automatically be set to `LinkMovementMethod` if `setAutoLinkMask(int)` has been set to nonzero and links are detected in `setText(char[], int, int)`.
void	setMarqueeRepeatLimit(int marqueeLimit) Sets how many times to repeat the marquee animation.
void	setMaxEms(int maxems) Makes the TextView at most this many ems wide
void	setMaxHeight(int maxHeight) Makes the TextView at most this many pixels tall
void	setMaxLines(int maxlines) Makes the TextView at most this many lines tall
void	setMaxWidth(int maxpixels) Makes the TextView at most this many pixels wide
void	setMinEms(int minems) Makes the TextView at least this many ems wide
void	setMinHeight(int minHeight) Makes the TextView at least this many pixels tall
void	setMinLines(int minlines) Makes the TextView at least this many lines tall
void	setMinWidth(int minpixels) Makes the TextView at least this many pixels wide
final void	setMovementMethod(MovementMethod movement) Sets the movement method (arrow key handler) to be used for this TextView.
void	setOnEditorActionListener(TextView.OnEditorActionListener l) Set a special listener to be called when an action is performed on the text view.
void	setPadding(int left, int top, int right, int bottom) Sets the padding.
void	setPaintFlags(int flags) Sets flags on the Paint being used to display the text and reflows the text if they are different from the old flags.
void	setPrivateImeOptions(String type) Set the private content type of the text, which is the `EditorInfo.privateImeOptions` field that will be filled in when creating an input connection.
void	setRawInputType(int type) Directly change the content type integer of the text view, without modifying any other state.
void	setScroller(Scroller s)
void	setSelectAllOnFocus(boolean selectAllOnFocus) Set the TextView so that when it takes focus, all the text is selected.
void	setSelected(boolean selected) Changes the selection state of this view.
void	setShadowLayer(float radius, float dx, float dy, int color) Gives the text a shadow of the specified radius and color, the specified distance from its normal position.
void	setSingleLine() Sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input.
void	setSingleLine(boolean singleLine) If true, sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input; if false, restores these to the default conditions.
final void	setSpannableFactory(Spannable.Factory factory) Sets the Factory used to create new Spannables.
final void	setText(int resid, TextView.BufferType type)
final void	setText(int resid)
final void	setText(CharSequence text) Sets the string value of the TextView.
final void	setText(char[] text, int start, int len) Sets the TextView to display the specified slice of the specified char array.
void	setText(CharSequence text, TextView.BufferType type) Sets the text that this TextView is to display (see `setText(CharSequence)`) and also sets whether it is stored in a styleable/spannable buffer and whether it is editable.
void	setTextAppearance(Context context, int resid) Sets the text color, size, style, hint color, and highlight color from the specified TextAppearance resource.
void	setTextColor(int color) Sets the text color for all the states (normal, selected, focused) to be this color.
void	setTextColor(ColorStateList colors) Sets the text color.
final void	setTextKeepState(CharSequence text) Like `setText(CharSequence)`, except that the cursor position (if any) is retained in the new text.
final void	setTextKeepState(CharSequence text, TextView.BufferType type) Like `setText(CharSequence, android.widget.TextView.BufferType)`, except that the cursor position (if any) is retained in the new text.
void	setTextScaleX(float size) Sets the extent by which text should be stretched horizontally.
void	setTextSize(int unit, float size) Set the default text size to a given unit and value.
void	setTextSize(float size) Set the default text size to the given value, interpreted as "scaled pixel" units.
final void	setTransformationMethod(TransformationMethod method) Sets the transformation that is applied to the text that this TextView is displaying.
void	setTypeface(Typeface tf, int style) Sets the typeface and style in which the text should be displayed, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
void	setTypeface(Typeface tf) Sets the typeface and style in which the text should be displayed.
void	setWidth(int pixels) Makes the TextView exactly this many pixels wide.

Protected Methods
int	computeHorizontalScrollRange() Compute the horizontal range that the horizontal scrollbar represents.
int	computeVerticalScrollExtent() Compute the vertical extent of the horizontal scrollbar's thumb within the vertical range.
int	computeVerticalScrollRange() Compute the vertical range that the vertical scrollbar represents.
void	drawableStateChanged() This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
int	getBottomPaddingOffset() Amount by which to extend the bottom fading region.
boolean	getDefaultEditable() Subclasses override this to specify that they have a KeyListener by default even if not specifically called for in the XML options.
MovementMethod	getDefaultMovementMethod() Subclasses override this to specify a default movement method.
float	getLeftFadingEdgeStrength() Returns the strength, or intensity, of the left faded edge.
int	getLeftPaddingOffset() Amount by which to extend the left fading region.
float	getRightFadingEdgeStrength() Returns the strength, or intensity, of the right faded edge.
int	getRightPaddingOffset() Amount by which to extend the right fading region.
int	getTopPaddingOffset() Amount by which to extend the top fading region.
boolean	isPaddingOffsetRequired() If the View draws content inside its padding and enables fading edges, it needs to support padding offsets.
void	onAttachedToWindow() This is called when the view is attached to a window.
void	onCreateContextMenu(ContextMenu menu) Views should implement this if the view itself is going to add items to the context menu.
void	onDetachedFromWindow() This is called when the view is detached from a window.
void	onDraw(Canvas canvas) Implement this to do your drawing.
void	onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes.
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
void	onSelectionChanged(int selStart, int selEnd) This method is called when the selection has changed, in case any subclasses would like to know.
void	onTextChanged(CharSequence text, int start, int before, int after) This method is called when the text is changed, in case any subclasses would like to know.
void	onVisibilityChanged(View changedView, int visibility) Called when the visibility of the view or an ancestor of the view is changed.
boolean	setFrame(int l, int t, int r, int b) Assign a size and position to this view.
boolean	verifyDrawable(Drawable who) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.

[Expand]

Inherited Methods

From class android.view.View

void	addFocusables(ArrayList<View> views, int direction) Add any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	addFocusables(ArrayList<View> views, int direction, int focusableMode) Adds any focusable views that are descendants of this view (possibly including this view if it is focusable itself) to views.
void	addTouchables(ArrayList<View> views) Add any touchable views that are descendants of this view (possibly including this view if it is touchable itself) to views.
boolean	awakenScrollBars(int startDelay) Trigger the scrollbars to draw.
boolean	awakenScrollBars(int startDelay, boolean invalidate) Trigger the scrollbars to draw.
boolean	awakenScrollBars() Trigger the scrollbars to draw.
void	bringToFront() Change the view's z order in the tree, so it's on top of other sibling views
void	buildDrawingCache(boolean autoScale) Forces the drawing cache to be built if the drawing cache is invalid.
void	buildDrawingCache() Calling this method is equivalent to calling `buildDrawingCache(false)`.
void	cancelLongPress() Cancels a pending long press.
boolean	checkInputConnectionProxy(View view) Called by the `InputMethodManager` when a view who is not the current input connection target is trying to make a call on the manager.
void	clearAnimation() Cancels any animations for this view.
void	clearFocus() Called when this view wants to give up focus.
int	computeHorizontalScrollExtent() Compute the horizontal extent of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollOffset() Compute the horizontal offset of the horizontal scrollbar's thumb within the horizontal range.
int	computeHorizontalScrollRange() Compute the horizontal range that the horizontal scrollbar represents.
void	computeScroll() Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary.
int	computeVerticalScrollExtent() Compute the vertical extent of the horizontal scrollbar's thumb within the vertical range.
int	computeVerticalScrollOffset() Compute the vertical offset of the vertical scrollbar's thumb within the horizontal range.
int	computeVerticalScrollRange() Compute the vertical range that the vertical scrollbar represents.
void	createContextMenu(ContextMenu menu) Show the context menu for this view.
void	destroyDrawingCache() Frees the resources used by the drawing cache.
void	dispatchConfigurationChanged(Configuration newConfig) Dispatch a notification about a resource configuration change down the view hierarchy.
void	dispatchDisplayHint(int hint) Dispatch a hint about whether this view is displayed.
void	dispatchDraw(Canvas canvas) Called by draw to draw the child views.
boolean	dispatchKeyEvent(KeyEvent event) Dispatch a key event to the next view on the focus path.
boolean	dispatchKeyEventPreIme(KeyEvent event) Dispatch a key event before it is processed by any input method associated with the view hierarchy.
boolean	dispatchKeyShortcutEvent(KeyEvent event) Dispatches a key shortcut event.
boolean	dispatchPopulateAccessibilityEvent(AccessibilityEvent event) Dispatches an `AccessibilityEvent` to the `View` children to be populated.
void	dispatchRestoreInstanceState(SparseArray<Parcelable> container) Called by `restoreHierarchyState(SparseArray)` to retrieve the state for this view and its children.
void	dispatchSaveInstanceState(SparseArray<Parcelable> container) Called by `saveHierarchyState(SparseArray)` to store the state for this view and its children.
void	dispatchSetPressed(boolean pressed) Dispatch setPressed to all of this View's children.
void	dispatchSetSelected(boolean selected) Dispatch setSelected to all of this View's children.
boolean	dispatchTouchEvent(MotionEvent event) Pass the touch screen motion event down to the target view, or this view if it is the target.
boolean	dispatchTrackballEvent(MotionEvent event) Pass a trackball motion event down to the focused view.
boolean	dispatchUnhandledMove(View focused, int direction) This method is the last chance for the focused view and its ancestors to respond to an arrow key.
void	dispatchVisibilityChanged(View changedView, int visibility) Dispatch a view visibility change down the view hierarchy.
void	dispatchWindowFocusChanged(boolean hasFocus) Called when the window containing this view gains or loses window focus.
void	dispatchWindowVisibilityChanged(int visibility) Dispatch a window visibility change down the view hierarchy.
void	draw(Canvas canvas) Manually render this view (and all of its children) to the given Canvas.
void	drawableStateChanged() This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.
View	findFocus() Find the view in the hierarchy rooted at this view that currently has focus.
final View	findViewById(int id) Look for a child view with the given id.
final View	findViewWithTag(Object tag) Look for a child view with the given tag.
boolean	fitSystemWindows(Rect insets) Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag is set
View	focusSearch(int direction) Find the nearest view in the specified direction that can take focus.
void	forceLayout() Forces this view to be laid out during the next layout pass.
Animation	getAnimation() Get the animation currently associated with this view.
IBinder	getApplicationWindowToken() Retrieve a unique token identifying the top-level "real" window of the window that this view is attached to.
Drawable	getBackground() Gets the background drawable
int	getBaseline() Return the offset of the widget's text baseline from the widget's top boundary.
final int	getBottom() Bottom position of this view relative to its parent.
float	getBottomFadingEdgeStrength() Returns the strength, or intensity, of the bottom faded edge.
int	getBottomPaddingOffset() Amount by which to extend the bottom fading region.
CharSequence	getContentDescription() Gets the `View` description.
final Context	getContext() Returns the context the view is running in, through which it can access the current theme, resources, etc.
ContextMenu.ContextMenuInfo	getContextMenuInfo() Views should implement this if they have extra information to associate with the context menu.
static int	getDefaultSize(int size, int measureSpec) Utility to return a default size.
final int[]	getDrawableState() Return an array of resource IDs of the drawable states representing the current state of the view.
Bitmap	getDrawingCache(boolean autoScale) Returns the bitmap in which this view drawing is cached.
Bitmap	getDrawingCache() Calling this method is equivalent to calling `getDrawingCache(false)`.
int	getDrawingCacheBackgroundColor()
int	getDrawingCacheQuality() Returns the quality of the drawing cache.
void	getDrawingRect(Rect outRect) Return the visible drawing bounds of your view.
long	getDrawingTime() Return the time at which the drawing of the view hierarchy started.
boolean	getFilterTouchesWhenObscured() Gets whether the framework should discard touches when the view's window is obscured by another visible window.
ArrayList<View>	getFocusables(int direction) Find and return all focusable views that are descendants of this view, possibly including this view if it is focusable itself.
void	getFocusedRect(Rect r) When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.
boolean	getGlobalVisibleRect(Rect r, Point globalOffset) If some part of this view is not clipped by any of its parents, then return that area in r in global (root) coordinates.
final boolean	getGlobalVisibleRect(Rect r)
Handler	getHandler()
final int	getHeight() Return the height of your view.
void	getHitRect(Rect outRect) Hit rectangle in parent's coordinates
int	getHorizontalFadingEdgeLength() Returns the size of the horizontal faded edges used to indicate that more content in this view is visible.
int	getHorizontalScrollbarHeight() Returns the height of the horizontal scrollbar.
int	getId() Returns this view's identifier.
boolean	getKeepScreenOn() Returns whether the screen should remain on, corresponding to the current value of `KEEP_SCREEN_ON`.
KeyEvent.DispatcherState	getKeyDispatcherState() Return the global `KeyEvent.DispatcherState` for this view's window.
ViewGroup.LayoutParams	getLayoutParams() Get the LayoutParams associated with this view.
final int	getLeft() Left position of this view relative to its parent.
float	getLeftFadingEdgeStrength() Returns the strength, or intensity, of the left faded edge.
int	getLeftPaddingOffset() Amount by which to extend the left fading region.
final boolean	getLocalVisibleRect(Rect r)
void	getLocationInWindow(int[] location) Computes the coordinates of this view in its window.
void	getLocationOnScreen(int[] location) Computes the coordinates of this view on the screen.
final int	getMeasuredHeight() The height of this view as measured in the most recent call to measure().
final int	getMeasuredWidth() The width of this view as measured in the most recent call to measure().
int	getNextFocusDownId()
int	getNextFocusLeftId()
int	getNextFocusRightId()
int	getNextFocusUpId()
View.OnFocusChangeListener	getOnFocusChangeListener() Returns the focus-change callback registered for this view.
int	getOverScrollMode() Returns the over-scroll mode for this view.
int	getPaddingBottom() Returns the bottom padding of this view.
int	getPaddingLeft() Returns the left padding of this view.
int	getPaddingRight() Returns the right padding of this view.
int	getPaddingTop() Returns the top padding of this view.
final ViewParent	getParent() Gets the parent of this view.
Resources	getResources() Returns the resources associated with this view.
final int	getRight() Right position of this view relative to its parent.
float	getRightFadingEdgeStrength() Returns the strength, or intensity, of the right faded edge.
int	getRightPaddingOffset() Amount by which to extend the right fading region.
View	getRootView() Finds the topmost view in the current view hierarchy.
int	getScrollBarStyle() Returns the current scrollbar style.
final int	getScrollX() Return the scrolled left position of this view.
final int	getScrollY() Return the scrolled top position of this view.
int	getSolidColor() Override this if your view is known to always be drawn on top of a solid color background, and needs to draw fading edges.
int	getSuggestedMinimumHeight() Returns the suggested minimum height that the view should use.
int	getSuggestedMinimumWidth() Returns the suggested minimum width that the view should use.
Object	getTag(int key) Returns the tag associated with this view and the specified key.
Object	getTag() Returns this view's tag.
final int	getTop() Top position of this view relative to its parent.
float	getTopFadingEdgeStrength() Returns the strength, or intensity, of the top faded edge.
int	getTopPaddingOffset() Amount by which to extend the top fading region.
TouchDelegate	getTouchDelegate() Gets the TouchDelegate for this View.
ArrayList<View>	getTouchables() Find and return all touchable views that are descendants of this view, possibly including this view if it is touchable itself.
int	getVerticalFadingEdgeLength() Returns the size of the vertical faded edges used to indicate that more content in this view is visible.
int	getVerticalScrollbarWidth() Returns the width of the vertical scrollbar.
ViewTreeObserver	getViewTreeObserver() Returns the ViewTreeObserver for this view's hierarchy.
int	getVisibility() Returns the visibility status for this view.
final int	getWidth() Return the width of the your view.
int	getWindowAttachCount()
IBinder	getWindowToken() Retrieve a unique token identifying the window this view is attached to.
int	getWindowVisibility() Returns the current visibility of the window this view is attached to (either `GONE`, `INVISIBLE`, or `VISIBLE`).
void	getWindowVisibleDisplayFrame(Rect outRect) Retrieve the overall visible display size in which the window this view is attached to has been positioned in.
boolean	hasFocus() Returns true if this view has focus iteself, or is the ancestor of the view that has focus.
boolean	hasFocusable() Returns true if this view is focusable or if it contains a reachable View for which `hasFocusable()` returns true.
boolean	hasWindowFocus() Returns true if this view is in a window that currently has window focus.
static View	inflate(Context context, int resource, ViewGroup root) Inflate a view from an XML resource.
void	initializeFadingEdge(TypedArray a) Initializes the fading edges from a given set of styled attributes.
void	initializeScrollbars(TypedArray a) Initializes the scrollbars from a given set of styled attributes.
void	invalidate(Rect dirty) Mark the the area defined by dirty as needing to be drawn.
void	invalidate(int l, int t, int r, int b) Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
void	invalidate() Invalidate the whole view.
void	invalidateDrawable(Drawable drawable) Invalidates the specified Drawable.
boolean	isClickable() Indicates whether this view reacts to click events or not.
boolean	isDrawingCacheEnabled() Indicates whether the drawing cache is enabled for this view.
boolean	isDuplicateParentStateEnabled() Indicates whether this duplicates its drawable state from its parent.
boolean	isEnabled() Returns the enabled status for this view.
final boolean	isFocusable() Returns whether this View is able to take focus.
final boolean	isFocusableInTouchMode() When a view is focusable, it may not want to take focus when in touch mode.
boolean	isFocused() Returns true if this view has focus
boolean	isHapticFeedbackEnabled()
boolean	isHorizontalFadingEdgeEnabled() Indicate whether the horizontal edges are faded when the view is scrolled horizontally.
boolean	isHorizontalScrollBarEnabled() Indicate whether the horizontal scrollbar should be drawn or not.
boolean	isInEditMode() Indicates whether this View is currently in edit mode.
boolean	isInTouchMode() Returns whether the device is currently in touch mode.
boolean	isLayoutRequested() Indicates whether or not this view's layout will be requested during the next hierarchy layout pass.
boolean	isLongClickable() Indicates whether this view reacts to long click events or not.
boolean	isOpaque() Indicates whether this View is opaque.
boolean	isPaddingOffsetRequired() If the View draws content inside its padding and enables fading edges, it needs to support padding offsets.
boolean	isPressed() Indicates whether the view is currently in pressed state.
boolean	isSaveEnabled() Indicates whether this view will save its state (that is, whether its `onSaveInstanceState()` method will be called).
boolean	isScrollbarFadingEnabled() Returns true if scrollbars will fade when this view is not scrolling
boolean	isSelected() Indicates the selection state of this view.
boolean	isShown() Returns the visibility of this view and all of its ancestors
boolean	isSoundEffectsEnabled()
boolean	isVerticalFadingEdgeEnabled() Indicate whether the vertical edges are faded when the view is scrolled horizontally.
boolean	isVerticalScrollBarEnabled() Indicate whether the vertical scrollbar should be drawn or not.
final void	layout(int l, int t, int r, int b) Assign a size and position to a view and all of its descendants This is the second phase of the layout mechanism.
final void	measure(int widthMeasureSpec, int heightMeasureSpec) This is called to find out how big a view should be.
static int[]	mergeDrawableStates(int[] baseState, int[] additionalState) Merge your own state values in `additionalState` into the base state values `baseState` that were returned by `onCreateDrawableState(int)`.
void	offsetLeftAndRight(int offset) Offset this view's horizontal location by the specified amount of pixels.
void	offsetTopAndBottom(int offset) Offset this view's vertical location by the specified number of pixels.
void	onAnimationEnd() Invoked by a parent ViewGroup to notify the end of the animation currently associated with this view.
void	onAnimationStart() Invoked by a parent ViewGroup to notify the start of the animation currently associated with this view.
void	onAttachedToWindow() This is called when the view is attached to a window.
boolean	onCheckIsTextEditor() Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it.
void	onConfigurationChanged(Configuration newConfig) Called when the current configuration of the resources being used by the application have changed.
void	onCreateContextMenu(ContextMenu menu) Views should implement this if the view itself is going to add items to the context menu.
int[]	onCreateDrawableState(int extraSpace) Generate the new `Drawable` state for this view.
InputConnection	onCreateInputConnection(EditorInfo outAttrs) Create a new InputConnection for an InputMethod to interact with the view.
void	onDetachedFromWindow() This is called when the view is detached from a window.
void	onDisplayHint(int hint) Gives this view a hint about whether is displayed or not.
void	onDraw(Canvas canvas) Implement this to do your drawing.
final void	onDrawScrollBars(Canvas canvas) Request the drawing of the horizontal and the vertical scrollbar.
boolean	onFilterTouchEventForSecurity(MotionEvent event) Filter the touch event to apply security policies.
void	onFinishInflate() Finalize inflating a view from XML.
void	onFinishTemporaryDetach() Called after `onStartTemporaryDetach()` when the container is done changing the view.
void	onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) Called by the view system when the focus state of this view changes.
boolean	onKeyDown(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: perform press of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released, if the view is enabled and clickable.
boolean	onKeyLongPress(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyLongPress()`: always returns false (doesn't handle the event).
boolean	onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: always returns false (doesn't handle the event).
boolean	onKeyPreIme(int keyCode, KeyEvent event) Handle a key event before it is processed by any input method associated with the view hierarchy.
boolean	onKeyShortcut(int keyCode, KeyEvent event) Called when an unhandled key shortcut event occurs.
boolean	onKeyUp(int keyCode, KeyEvent event) Default implementation of `KeyEvent.Callback.onKeyMultiple()`: perform clicking of the view when `KEYCODE_DPAD_CENTER` or `KEYCODE_ENTER` is released.
void	onLayout(boolean changed, int left, int top, int right, int bottom) Called from layout when this view should assign a size and position to each of its children.
void	onMeasure(int widthMeasureSpec, int heightMeasureSpec) Measure the view and its content to determine the measured width and the measured height.
void	onOverScrolled(int scrollX, int scrollY, boolean clampedX, boolean clampedY) Called by `overScrollBy(int, int, int, int, int, int, int, int, boolean)` to respond to the results of an over-scroll operation.
void	onRestoreInstanceState(Parcelable state) Hook allowing a view to re-apply a representation of its internal state that had previously been generated by `onSaveInstanceState()`.
Parcelable	onSaveInstanceState() Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
void	onScrollChanged(int l, int t, int oldl, int oldt) This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents).
boolean	onSetAlpha(int alpha) Invoked if there is a Transform that involves alpha.
void	onSizeChanged(int w, int h, int oldw, int oldh) This is called during layout when the size of this view has changed.
void	onStartTemporaryDetach() This is called when a container is going to temporarily detach a child, with `ViewGroup.detachViewFromParent`.
boolean	onTouchEvent(MotionEvent event) Implement this method to handle touch screen motion events.
boolean	onTrackballEvent(MotionEvent event) Implement this method to handle trackball motion events.
void	onVisibilityChanged(View changedView, int visibility) Called when the visibility of the view or an ancestor of the view is changed.
void	onWindowFocusChanged(boolean hasWindowFocus) Called when the window containing this view gains or loses focus.
void	onWindowVisibilityChanged(int visibility) Called when the window containing has change its visibility (between `GONE`, `INVISIBLE`, and `VISIBLE`).
boolean	overScrollBy(int deltaX, int deltaY, int scrollX, int scrollY, int scrollRangeX, int scrollRangeY, int maxOverScrollX, int maxOverScrollY, boolean isTouchEvent) Scroll the view with standard behavior for scrolling beyond the normal content boundaries.
boolean	performClick() Call this view's OnClickListener, if it is defined.
boolean	performHapticFeedback(int feedbackConstant, int flags) BZZZTT!!1! Like `performHapticFeedback(int)`, with additional options.
boolean	performHapticFeedback(int feedbackConstant) BZZZTT!!1! Provide haptic feedback to the user for this view.
boolean	performLongClick() Call this view's OnLongClickListener, if it is defined.
void	playSoundEffect(int soundConstant) Play a sound effect for this view.
boolean	post(Runnable action) Causes the Runnable to be added to the message queue.
boolean	postDelayed(Runnable action, long delayMillis) Causes the Runnable to be added to the message queue, to be run after the specified amount of time elapses.
void	postInvalidate(int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidate() Cause an invalidate to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed(long delayMilliseconds, int left, int top, int right, int bottom) Cause an invalidate of the specified area to happen on a subsequent cycle through the event loop.
void	postInvalidateDelayed(long delayMilliseconds) Cause an invalidate to happen on a subsequent cycle through the event loop.
void	refreshDrawableState() Call this to force a view to update its drawable state.
boolean	removeCallbacks(Runnable action) Removes the specified Runnable from the message queue.
boolean	requestFocus(int direction, Rect previouslyFocusedRect) Call this to try to give focus to a specific view or to one of its descendants and give it hints about the direction and a specific rectangle that the focus is coming from.
final boolean	requestFocus(int direction) Call this to try to give focus to a specific view or to one of its descendants and give it a hint about what direction focus is heading.
final boolean	requestFocus() Call this to try to give focus to a specific view or to one of its descendants.
final boolean	requestFocusFromTouch() Call this to try to give focus to a specific view or to one of its descendants.
void	requestLayout() Call this when something has changed which has invalidated the layout of this view.
boolean	requestRectangleOnScreen(Rect rectangle) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
boolean	requestRectangleOnScreen(Rect rectangle, boolean immediate) Request that a rectangle of this view be visible on the screen, scrolling if necessary just enough.
static int	resolveSize(int size, int measureSpec) Utility to reconcile a desired size with constraints imposed by a MeasureSpec.
void	restoreHierarchyState(SparseArray<Parcelable> container) Restore this view hierarchy's frozen state from the given container.
void	saveHierarchyState(SparseArray<Parcelable> container) Store this view hierarchy's frozen state into the given container.
void	scheduleDrawable(Drawable who, Runnable what, long when) Schedules an action on a drawable to occur at a specified time.
void	scrollBy(int x, int y) Move the scrolled position of your view.
void	scrollTo(int x, int y) Set the scrolled position of your view.
void	sendAccessibilityEvent(int eventType) Handles the request for sending an `AccessibilityEvent` given the event type.
void	sendAccessibilityEventUnchecked(AccessibilityEvent event) Handles the request for sending an `AccessibilityEvent`.
void	setAnimation(Animation animation) Sets the next animation to play for this view.
void	setBackgroundColor(int color) Sets the background color for this view.
void	setBackgroundDrawable(Drawable d) Set the background to a given Drawable, or remove the background.
void	setBackgroundResource(int resid) Set the background to a given resource.
void	setClickable(boolean clickable) Enables or disables click events for this view.
void	setContentDescription(CharSequence contentDescription) Sets the `View` description.
void	setDrawingCacheBackgroundColor(int color) Setting a solid background color for the drawing cache's bitmaps will improve perfromance and memory usage.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setDrawingCacheQuality(int quality) Set the drawing cache quality of this view.
void	setDuplicateParentStateEnabled(boolean enabled) Enables or disables the duplication of the parent's state into this view.
void	setEnabled(boolean enabled) Set the enabled state of this view.
void	setFadingEdgeLength(int length) Set the size of the faded edge used to indicate that more content in this view is available.
void	setFilterTouchesWhenObscured(boolean enabled) Sets whether the framework should discard touches when the view's window is obscured by another visible window.
void	setFocusable(boolean focusable) Set whether this view can receive the focus.
void	setFocusableInTouchMode(boolean focusableInTouchMode) Set whether this view can receive focus while in touch mode.
void	setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) Set whether this view should have haptic feedback for events such as long presses.
void	setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) Define whether the horizontal edges should be faded when this view is scrolled horizontally.
void	setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) Define whether the horizontal scrollbar should be drawn or not.
void	setId(int id) Sets the identifier for this view.
void	setKeepScreenOn(boolean keepScreenOn) Controls whether the screen should remain on, modifying the value of `KEEP_SCREEN_ON`.
void	setLayoutParams(ViewGroup.LayoutParams params) Set the layout parameters associated with this view.
void	setLongClickable(boolean longClickable) Enables or disables long click events for this view.
final void	setMeasuredDimension(int measuredWidth, int measuredHeight) This mehod must be called by `onMeasure(int, int)` to store the measured width and measured height.
void	setMinimumHeight(int minHeight) Sets the minimum height of the view.
void	setMinimumWidth(int minWidth) Sets the minimum width of the view.
void	setNextFocusDownId(int nextFocusDownId) Set the id of the view to use for the next focus
void	setNextFocusLeftId(int nextFocusLeftId) Set the id of the view to use for the next focus
void	setNextFocusRightId(int nextFocusRightId) Set the id of the view to use for the next focus
void	setNextFocusUpId(int nextFocusUpId) Set the id of the view to use for the next focus
void	setOnClickListener(View.OnClickListener l) Register a callback to be invoked when this view is clicked.
void	setOnCreateContextMenuListener(View.OnCreateContextMenuListener l) Register a callback to be invoked when the context menu for this view is being built.
void	setOnFocusChangeListener(View.OnFocusChangeListener l) Register a callback to be invoked when focus of this view changed.
void	setOnKeyListener(View.OnKeyListener l) Register a callback to be invoked when a key is pressed in this view.
void	setOnLongClickListener(View.OnLongClickListener l) Register a callback to be invoked when this view is clicked and held.
void	setOnTouchListener(View.OnTouchListener l) Register a callback to be invoked when a touch event is sent to this view.
void	setOverScrollMode(int overScrollMode) Set the over-scroll mode for this view.
void	setPadding(int left, int top, int right, int bottom) Sets the padding.
void	setPressed(boolean pressed) Sets the pressed that for this view.
void	setSaveEnabled(boolean enabled) Controls whether the saving of this view's state is enabled (that is, whether its `onSaveInstanceState()` method will be called).
void	setScrollBarStyle(int style) Specify the style of the scrollbars.
void	setScrollContainer(boolean isScrollContainer) Change whether this view is one of the set of scrollable containers in its window.
void	setScrollbarFadingEnabled(boolean fadeScrollbars) Define whether scrollbars will fade when the view is not scrolling.
void	setSelected(boolean selected) Changes the selection state of this view.
void	setSoundEffectsEnabled(boolean soundEffectsEnabled) Set whether this view should have sound effects enabled for events such as clicking and touching.
void	setTag(int key, Object tag) Sets a tag associated with this view and a key.
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchDelegate(TouchDelegate delegate) Sets the TouchDelegate for this View.
void	setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) Define whether the vertical edges should be faded when this view is scrolled vertically.
void	setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) Define whether the vertical scrollbar should be drawn or not.
void	setVisibility(int visibility) Set the enabled state of this view.
void	setWillNotCacheDrawing(boolean willNotCacheDrawing) When a View's drawing cache is enabled, drawing is redirected to an offscreen bitmap.
void	setWillNotDraw(boolean willNotDraw) If this view doesn't do any drawing on its own, set this flag to allow further optimizations.
boolean	showContextMenu() Bring up the context menu for this view.
void	startAnimation(Animation animation) Start the specified animation now.
void	unscheduleDrawable(Drawable who) Unschedule any events associated with the given Drawable.
void	unscheduleDrawable(Drawable who, Runnable what) Cancels a scheduled action on a drawable.
boolean	verifyDrawable(Drawable who) If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying.
boolean	willNotCacheDrawing() Returns whether or not this View can cache its drawing or not.
boolean	willNotDraw() Returns whether or not this View draws on its own.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Called before the object's memory is reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.graphics.drawable.Drawable.Callback

From interface android.view.KeyEvent.Callback

From interface android.view.ViewTreeObserver.OnPreDrawListener

From interface android.view.accessibility.AccessibilityEventSource

XML Attributes

android:autoLink

Since: API Level

Controls whether links such as urls and email addresses are automatically found and converted to clickable links. The default value is "none", disabling this feature.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`none`	0x00	Match no patterns (default).
`web`	0x01	Match Web URLs.
`email`	0x02	Match email addresses.
`phone`	0x04	Match phone numbers.
`map`	0x08	Match map addresses.
`all`	0x0f	Match all patterns (equivalent to web\|email\|phone\|map).

This corresponds to the global attribute resource symbol autoLink.

Related Methods

setAutoLinkMask(int)

android:autoText

Since: API Level

If set, specifies that this TextView has a textual input method and automatically corrects some common spelling errors. The default is "false".

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol autoText.

Related Methods

setKeyListener(KeyListener)

android:bufferType

Since: API Level

Determines the minimum type that getText() will return. The default is "normal". Note that EditText and LogTextBox always return Editable, even if you specify something less powerful here.

Must be one of the following constant values.

Constant	Value	Description
`normal`	0	Can return any CharSequence, possibly a Spanned one if the source text was Spanned.
`spannable`	1	Can only return Spannable.
`editable`	2	Can only return Spannable and Editable.

This corresponds to the global attribute resource symbol bufferType.

Related Methods

setText(CharSequence,TextView.BufferType)

android:capitalize

Since: API Level

If set, specifies that this TextView has a textual input method and should automatically capitalize what the user types. The default is "none".

Must be one of the following constant values.

Constant	Value	Description
`none`	0	Don't automatically capitalize anything.
`sentences`	1	Capitalize the first word of each sentence.
`words`	2	Capitalize the first letter of every word.
`characters`	3	Capitalize every character.

This corresponds to the global attribute resource symbol capitalize.

Related Methods

setKeyListener(KeyListener)

android:cursorVisible

Since: API Level

Makes the cursor visible (the default) or invisible.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol cursorVisible.

Related Methods

setCursorVisible(boolean)

android:digits

Since: API Level

If set, specifies that this TextView has a numeric input method and that these specific characters are the ones that it will accept. If this is set, numeric is implied to be true. The default is false.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol digits.

Related Methods

setKeyListener(KeyListener)

android:drawableBottom

Since: API Level

The drawable to be drawn below the text.

May be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This corresponds to the global attribute resource symbol drawableBottom.

Related Methods

setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)

android:drawableLeft

Since: API Level

The drawable to be drawn to the left of the text.

May be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This corresponds to the global attribute resource symbol drawableLeft.

Related Methods

setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)

android:drawablePadding

Since: API Level

The padding between the drawables and the text.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol drawablePadding.

Related Methods

setCompoundDrawablePadding(int)

android:drawableRight

Since: API Level

The drawable to be drawn to the right of the text.

May be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This corresponds to the global attribute resource symbol drawableRight.

Related Methods

setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)

android:drawableTop

Since: API Level

The drawable to be drawn above the text.

May be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

May be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This corresponds to the global attribute resource symbol drawableTop.

Related Methods

setCompoundDrawablesWithIntrinsicBounds(int,int,int,int)

android:editable

Since: API Level

If set, specifies that this TextView has an input method. It will be a textual one unless it has otherwise been specified. For TextView, this is false by default. For EditText, it is true by default.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol editable.

Related Methods

android:editorExtras

Since: API Level

Reference to an <input-extras> XML resource containing additional data to supply to an input method, which is private to the implementation of the input method. This simply fills in the EditorInfo.extras field when the input method is connected.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol editorExtras.

Related Methods

setInputExtras(int)

android:ellipsize

Since: API Level

If set, causes words that are longer than the view is wide to be ellipsized instead of broken in the middle. You will often also want to set scrollHorizontally or singleLine as well so that the text as a whole is also constrained to a single line instead of still allowed to be broken onto multiple lines.

Must be one of the following constant values.

Constant	Value	Description
`none`	0
`start`	1
`middle`	2
`end`	3
`marquee`	4

This corresponds to the global attribute resource symbol ellipsize.

Related Methods

setEllipsize(TextUtils.TruncateAt)

android:ems

Since: API Level

Makes the TextView be exactly this many ems wide.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol ems.

Related Methods

setEms(int)

android:freezesText

Since: API Level

If set, the text view will include its current complete text inside of its frozen icicle in addition to meta-data such as the current cursor position. By default this is disabled; it can be useful when the contents of a text view is not stored in a persistent place such as a content provider.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol freezesText.

Related Methods

setFreezesText(boolean)

android:gravity

Since: API Level

Specifies how to align the text by the view's x- and/or y-axis when the text is smaller than the view.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`top`	0x30	Push object to the top of its container, not changing its size.
`bottom`	0x50	Push object to the bottom of its container, not changing its size.
`left`	0x03	Push object to the left of its container, not changing its size.
`right`	0x05	Push object to the right of its container, not changing its size.
`center_vertical`	0x10	Place object in the vertical center of its container, not changing its size.
`fill_vertical`	0x70	Grow the vertical size of the object if needed so it completely fills its container.
`center_horizontal`	0x01	Place object in the horizontal center of its container, not changing its size.
`fill_horizontal`	0x07	Grow the horizontal size of the object if needed so it completely fills its container.
`center`	0x11	Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
`fill`	0x77	Grow the horizontal and vertical size of the object if needed so it completely fills its container.
`clip_vertical`	0x80	Additional option that can be set to have the top and/or bottom edges of the child clipped to its container's bounds. The clip will be based on the vertical gravity: a top gravity will clip the bottom edge, a bottom gravity will clip the top edge, and neither will clip both edges.
`clip_horizontal`	0x08	Additional option that can be set to have the left and/or right edges of the child clipped to its container's bounds. The clip will be based on the horizontal gravity: a left gravity will clip the right edge, a right gravity will clip the left edge, and neither will clip both edges.

This corresponds to the global attribute resource symbol gravity.

Related Methods

setGravity(int)

android:height

Since: API Level

Makes the TextView be exactly this many pixels tall. You could get the same effect by specifying this number in the layout parameters.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol height.

Related Methods

setHeight(int)

android:hint

Since: API Level

Hint text to display when the text is empty.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol hint.

Related Methods

setHint(int)

android:imeActionId

Since: API Level

Supply a value for EditorInfo.actionId used when an input method is connected to the text view.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol imeActionId.

Related Methods

setImeActionLabel(CharSequence,int)

android:imeActionLabel

Since: API Level

Supply a value for EditorInfo.actionLabel used when an input method is connected to the text view.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol imeActionLabel.

Related Methods

setImeActionLabel(CharSequence,int)

android:imeOptions

Since: API Level

Additional features you can enable in an IME associated with an editor to improve the integration with your application. The constants here correspond to those defined by imeOptions.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`normal`	0x00000000	There are no special semantics associated with this editor.
`actionUnspecified`	0x00000000	There is no specific action associated with this editor, let the editor come up with its own if it can. Corresponds to `IME_NULL`.
`actionNone`	0x00000001	This editor has no action associated with it. Corresponds to `IME_ACTION_NONE`.
`actionGo`	0x00000002	The action key performs a "go" operation to take the user to the target of the text they typed. Typically used, for example, when entering a URL. Corresponds to `IME_ACTION_GO`.
`actionSearch`	0x00000003	The action key performs a "search" operation, taking the user to the results of searching for the text the have typed (in whatever context is appropriate). Corresponds to `IME_ACTION_SEARCH`.
`actionSend`	0x00000004	The action key performs a "send" operation, delivering the text to its target. This is typically used when composing a message. Corresponds to `IME_ACTION_SEND`.
`actionNext`	0x00000005	The action key performs a "next" operation, taking the user to the next field that will accept text. Corresponds to `IME_ACTION_NEXT`.
`actionDone`	0x00000006	The action key performs a "done" operation, closing the soft input method. Corresponds to `IME_ACTION_DONE`.
`flagNoExtractUi`	0x10000000	Used to specify that the IME does not need to show its extracted text UI. For input methods that may be fullscreen, often when in landscape mode, this allows them to be smaller and let part of the application be shown behind. Though there will likely be limited access to the application available from the user, it can make the experience of a (mostly) fullscreen IME less jarring. Note that when this flag is specified the IME may not be set up to be able to display text, so it should only be used in situations where this is not needed. Corresponds to `IME_FLAG_NO_EXTRACT_UI`.
`flagNoAccessoryAction`	0x20000000	Used in conjunction with a custom action, this indicates that the action should not be available as an accessory button when the input method is full-screen. Note that by setting this flag, there can be cases where the action is simply never available to the user. Setting this generally means that you think showing text being edited is more important than the action you have supplied. Corresponds to `IME_FLAG_NO_ACCESSORY_ACTION`.
`flagNoEnterAction`	0x40000000	Used in conjunction with a custom action, this indicates that the action should not be available in-line as a replacement for the "enter" key. Typically this is because the action has such a significant impact or is not recoverable enough that accidentally hitting it should be avoided, such as sending a message. Note that `TextView` will automatically set this flag for you on multi-line text views. Corresponds to `IME_FLAG_NO_ENTER_ACTION`.

This corresponds to the global attribute resource symbol imeOptions.

Related Methods

setImeOptions(int)

android:includeFontPadding

Since: API Level

Leave enough room for ascenders and descenders instead of using the font ascent and descent strictly. (Normally true).

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol includeFontPadding.

Related Methods

setIncludeFontPadding(boolean)

android:inputMethod

Since: API Level

If set, specifies that this TextView should use the specified input method (specified by fully-qualified class name).

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol inputMethod.

Related Methods

setKeyListener(KeyListener)

android:inputType

Since: API Level

The type of data being placed in a text field, used to help an input method decide how to let the user enter text. The constants here correspond to those defined by InputType. Generally you can select a single value, though some can be combined together as indicated. Setting this attribute to anything besides none also implies that the text is editable.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`none`	0x00000000	There is no content type. The text is not editable.
`text`	0x00000001	Just plain old text. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_NORMAL`.
`textCapCharacters`	0x00001001	Can be combined with `text` and its variations to request capitalization of all characters. Corresponds to `TYPE_TEXT_FLAG_CAP_CHARACTERS`.
`textCapWords`	0x00002001	Can be combined with `text` and its variations to request capitalization of the first character of every word. Corresponds to `TYPE_TEXT_FLAG_CAP_WORDS`.
`textCapSentences`	0x00004001	Can be combined with `text` and its variations to request capitalization of the first character of every sentence. Corresponds to `TYPE_TEXT_FLAG_CAP_SENTENCES`.
`textAutoCorrect`	0x00008001	Can be combined with `text` and its variations to request auto-correction of text being input. Corresponds to `TYPE_TEXT_FLAG_AUTO_CORRECT`.
`textAutoComplete`	0x00010001	Can be combined with `text` and its variations to specify that this field will be doing its own auto-completion and talking with the input method appropriately. Corresponds to `TYPE_TEXT_FLAG_AUTO_COMPLETE`.
`textMultiLine`	0x00020001	Can be combined with `text` and its variations to allow multiple lines of text in the field. If this flag is not set, the text field will be constrained to a single line. Corresponds to `TYPE_TEXT_FLAG_MULTI_LINE`.
`textImeMultiLine`	0x00040001	Can be combined with `text` and its variations to indicate that though the regular text view should not be multiple lines, the IME should provide multiple lines if it can. Corresponds to `TYPE_TEXT_FLAG_IME_MULTI_LINE`.
`textNoSuggestions`	0x00080001	Can be combined with `text` and its variations to indicate that the IME should not show any dictionary-based word suggestions. Corresponds to `TYPE_TEXT_FLAG_NO_SUGGESTIONS`.
`textUri`	0x00000011	Text that will be used as a URI. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_URI`.
`textEmailAddress`	0x00000021	Text that will be used as an e-mail address. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_EMAIL_ADDRESS`.
`textEmailSubject`	0x00000031	Text that is being supplied as the subject of an e-mail. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_EMAIL_SUBJECT`.
`textShortMessage`	0x00000041	Text that is the content of a short message. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_SHORT_MESSAGE`.
`textLongMessage`	0x00000051	Text that is the content of a long message. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_LONG_MESSAGE`.
`textPersonName`	0x00000061	Text that is the name of a person. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_PERSON_NAME`.
`textPostalAddress`	0x00000071	Text that is being supplied as a postal mailing address. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_POSTAL_ADDRESS`.
`textPassword`	0x00000081	Text that is a password. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_PASSWORD`.
`textVisiblePassword`	0x00000091	Text that is a password that should be visible. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_VISIBLE_PASSWORD`.
`textWebEditText`	0x000000a1	Text that is being supplied as text in a web form. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_WEB_EDIT_TEXT`.
`textFilter`	0x000000b1	Text that is filtering some other data. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_FILTER`.
`textPhonetic`	0x000000c1	Text that is for phonetic pronunciation, such as a phonetic name field in a contact entry. Corresponds to `TYPE_CLASS_TEXT` \| `TYPE_TEXT_VARIATION_PHONETIC`.
`number`	0x00000002	A numeric only field. Corresponds to `TYPE_CLASS_NUMBER`.
`numberSigned`	0x00001002	Can be combined with `number` and its other options to allow a signed number. Corresponds to `TYPE_CLASS_NUMBER` \| `TYPE_NUMBER_FLAG_SIGNED`.
`numberDecimal`	0x00002002	Can be combined with `number` and its other options to allow a decimal (fractional) number. Corresponds to `TYPE_CLASS_NUMBER` \| `TYPE_NUMBER_FLAG_DECIMAL`.
`phone`	0x00000003	For entering a phone number. Corresponds to `TYPE_CLASS_PHONE`.
`datetime`	0x00000004	For entering a date and time. Corresponds to `TYPE_CLASS_DATETIME` \| `TYPE_DATETIME_VARIATION_NORMAL`.
`date`	0x00000014	For entering a date. Corresponds to `TYPE_CLASS_DATETIME` \| `TYPE_DATETIME_VARIATION_DATE`.
`time`	0x00000024	For entering a time. Corresponds to `TYPE_CLASS_DATETIME` \| `TYPE_DATETIME_VARIATION_TIME`.

This corresponds to the global attribute resource symbol inputType.

Related Methods

setRawInputType(int)

android:lineSpacingExtra

Since: API Level

Extra spacing between lines of text.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol lineSpacingExtra.

Related Methods

setLineSpacing(float,float)

android:lineSpacingMultiplier

Since: API Level

Extra spacing between lines of text, as a multiplier.

Must be a floating point value, such as "1.2".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol lineSpacingMultiplier.

Related Methods

setLineSpacing(float,float)

android:lines

Since: API Level

Makes the TextView be exactly this many lines tall.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol lines.

Related Methods

setLines(int)

android:linksClickable

Since: API Level

If set to false, keeps the movement method from being set to the link movement method even if autoLink causes links to be found.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol linksClickable.

Related Methods

setLinksClickable(boolean)

android:marqueeRepeatLimit

Since: API Level

The number of times to repeat the marquee animation. Only applied if the TextView has marquee enabled.

May be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

May be one of the following constant values.

Constant	Value	Description
`marquee_forever`	-1	Indicates that marquee should repeat indefinitely.

This corresponds to the global attribute resource symbol marqueeRepeatLimit.

Related Methods

setMarqueeRepeatLimit(int)

android:maxEms

Since: API Level

Makes the TextView be at most this many ems wide.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol maxEms.

Related Methods

setMaxEms(int)

android:maxHeight

Since: API Level

Makes the TextView be at most this many pixels tall.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol maxHeight.

Related Methods

setMaxHeight(int)

android:maxLength

Since: API Level

Set an input filter to constrain the text length to the specified number.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol maxLength.

Related Methods

setFilters(InputFilter)

android:maxLines

Since: API Level

Makes the TextView be at most this many lines tall.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol maxLines.

Related Methods

setMaxLines(int)

android:maxWidth

Since: API Level

Makes the TextView be at most this many pixels wide.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol maxWidth.

Related Methods

setMaxWidth(int)

android:minEms

Since: API Level

Makes the TextView be at least this many ems wide.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol minEms.

Related Methods

setMinEms(int)

android:minHeight

Since: API Level

Makes the TextView be at least this many pixels tall.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol minHeight.

Related Methods

setMinHeight(int)

android:minLines

Since: API Level

Makes the TextView be at least this many lines tall.

Must be an integer value, such as "100".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol minLines.

Related Methods

setMinLines(int)

android:minWidth

Since: API Level

Makes the TextView be at least this many pixels wide.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol minWidth.

Related Methods

setMinWidth(int)

android:numeric

Since: API Level

If set, specifies that this TextView has a numeric input method. The default is false.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`integer`	0x01	Input is numeric.
`signed`	0x003	Input is numeric, with sign allowed.
`decimal`	0x05	Input is numeric, with decimals allowed.

This corresponds to the global attribute resource symbol numeric.

Related Methods

setKeyListener(KeyListener)

android:password

Since: API Level

Whether the characters of the field are displayed as password dots instead of themselves.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol password.

Related Methods

setTransformationMethod(TransformationMethod)

android:phoneNumber

Since: API Level

If set, specifies that this TextView has a phone number input method. The default is false.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol phoneNumber.

Related Methods

setKeyListener(KeyListener)

android:privateImeOptions

Since: API Level

An addition content type description to supply to the input method attached to the text view, which is private to the implementation of the input method. This simply fills in the EditorInfo.privateImeOptions field when the input method is connected.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol privateImeOptions.

Related Methods

setPrivateImeOptions(String)

android:scrollHorizontally

Since: API Level

Whether the text is allowed to be wider than the view (and therefore can be scrolled horizontally).

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol scrollHorizontally.

Related Methods

setHorizontallyScrolling(boolean)

android:selectAllOnFocus

Since: API Level

If the text is selectable, select it all when the view takes focus instead of moving the cursor to the start or end.

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol selectAllOnFocus.

Related Methods

setSelectAllOnFocus(boolean)

android:shadowColor

Since: API Level

Place a shadow of the specified color behind the text.

Must be a color value, in the form of "#rgb", "#argb", "#rrggbb", or "#aarrggbb".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol shadowColor.

Related Methods

setShadowLayer(float,float,float,int)

android:shadowDx

Since: API Level

Horizontal offset of the shadow.

Must be a floating point value, such as "1.2".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol shadowDx.

Related Methods

setShadowLayer(float,float,float,int)

android:shadowDy

Since: API Level

Vertical offset of the shadow.

Must be a floating point value, such as "1.2".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol shadowDy.

Related Methods

setShadowLayer(float,float,float,int)

android:shadowRadius

Since: API Level

Radius of the shadow.

Must be a floating point value, such as "1.2".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol shadowRadius.

Related Methods

setShadowLayer(float,float,float,int)

android:singleLine

Since: API Level

Constrains the text to a single horizontally scrolling line instead of letting it wrap onto multiple lines, and advances focus instead of inserting a newline when you press the enter key. Note: for editable text views, it is better to control this using the textMultiLine flag in the inputType attribute. (If both singleLine and inputType are supplied, the inputType flags will override the value of singleLine.)

Must be a boolean value, either "true" or "false".

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol singleLine.

Related Methods

setTransformationMethod(TransformationMethod)

android:text

Since: API Level

Text to display.

Must be a string value, using '\\;' to escape characters such as '\\n' or '\\uxxxx' for a unicode character.

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol text.

Related Methods

setText(CharSequence,TextView.BufferType)

android:textAppearance

Since: API Level

Base text color, typeface, size, and style.

Must be a reference to another resource, in the form "@[+][package:]type:name" or to a theme attribute in the form "?[package:][type:]name".

This corresponds to the global attribute resource symbol textAppearance.

setTextSize(float)

android:textStyle

Since: API Level

Style (bold, italic, bolditalic) for the text.

Must be one or more (separated by '|') of the following constant values.

Constant	Value	Description
`normal`	0
`bold`	1
`italic`	2

This corresponds to the global attribute resource symbol textStyle.

Related Methods

setTypeface(Typeface)

android:typeface

Since: API Level

Typeface (normal, sans, serif, monospace) for the text.

Must be one of the following constant values.

Constant	Value	Description
`normal`	0
`sans`	1
`serif`	2
`monospace`	3

This corresponds to the global attribute resource symbol typeface.

Related Methods

setTypeface(Typeface)

android:width

Since: API Level

Makes the TextView be exactly this many pixels wide. You could get the same effect by specifying this number in the layout parameters.

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), dp (density-independent pixels), sp (scaled pixels based on preferred font size), in (inches), mm (millimeters).

This may also be a reference to a resource (in the form "@[package:]type:name") or theme attribute (in the form "?[package:][type:]name") containing a value of this type.

This corresponds to the global attribute resource symbol width.

Related Methods

setWidth(int)

Public Constructors

public TextView (Context context)

Since: API Level 1

public TextView (Context context, AttributeSet attrs)

Since: API Level 1

public TextView (Context context, AttributeSet attrs, int defStyle)

depth	the indentation level

public boolean didTouchFocusSelect ()

Since: API Level 3

Returns true, only while processing a touch gesture, if the initial touch down event caused focus to move to the text view and as a result its selection changed. Only valid while processing the touch gesture of interest.

public boolean dispatchPopulateAccessibilityEvent (AccessibilityEvent event)

Since: API Level 4

Dispatches an AccessibilityEvent to the View children to be populated.

Parameters

event	The event.

Returns

True if the event population was completed.

public void endBatchEdit ()

Since: API Level 3

public boolean extractText (ExtractedTextRequest request, ExtractedText outText)

Since: API Level 3

If this TextView contains editable content, extract a portion of it based on the information in request in to outText.

Returns

Returns true if the text was successfully extracted, else false.

public final int getAutoLinkMask ()

Since: API Level 1

Gets the autolink mask of the text. See Linkify.ALL and peers for possible values.

Related XML Attributes

android:autoLink

public int getBaseline ()

Since: API Level 1

Return the offset of the widget's text baseline from the widget's top boundary. If this widget does not support baseline alignment, this method returns -1.

Returns

the offset of the baseline within the widget's bounds or -1 if baseline alignment is not supported

public final int getCurrentHintTextColor ()

Since: API Level 1

Return the current color selected to paint the hint text.

Returns

Returns the current hint text color.

public final int getCurrentTextColor ()

Since: API Level 1

Return the current color selected for normal text.

Returns

Returns the current text color.

public void getFocusedRect (Rect r)

Since: API Level 1

When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method. By default, the rectange is the getDrawingRect(Rect))of the view. However, if your view maintains some idea of internal selection, such as a cursor, or a selected row or column, you should override this method and fill in a more specific rectangle.

Parameters

r	The rectangle to fill in, in this view's coordinates.

public boolean getFreezesText ()

Since: API Level 1

Return whether this text view is including its entire text contents in frozen icicles.

Returns

Returns true if text is included, false if it isn't.

public int getGravity ()

Since: API Level 1

Returns the horizontal and vertical alignment of this TextView.

Related XML Attributes

android:gravity

public CharSequence getHint ()

Since: API Level 1

Returns the hint that is displayed when the text of the TextView is empty.

Related XML Attributes

android:hint

public final ColorStateList getHintTextColors ()

Since: API Level 1

Return the color used to paint the hint text.

Returns

Returns the list of hint text colors.

public int getImeActionId ()

Since: API Level 3

Get the IME action ID previous set with setImeActionLabel(CharSequence, int).

public CharSequence getImeActionLabel ()

Since: API Level 3

Get the IME action label previous set with setImeActionLabel(CharSequence, int).

public int getImeOptions ()

Since: API Level 3

Get the type of the IME editor.

public Bundle getInputExtras (boolean create)

Since: API Level 3

Retrieve the input extras currently associated with the text view, which can be viewed as well as modified.

Related XML Attributes

android:editorExtras

Parameters

create	If true, the extras will be created if they don't already exist. Otherwise, null will be returned if none have been created.

public int getInputType ()

Since: API Level 3

Get the type of the content.

public final KeyListener getKeyListener ()

Since: API Level 1

Returns

the current key listener for this TextView. This will frequently be null for non-EditText TextViews.

public final Layout getLayout ()

Since: API Level 1

Returns

the Layout that is currently being used to display the text. This can be null if the text or width has recently changes.

public int getLineBounds (int line, Rect bounds)

Since: API Level 1

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. If the internal Layout has not been built, return 0 and set bounds to (0, 0, 0, 0)

Parameters

line	which line to examine (0..getLineCount() - 1)
bounds	Optional. If not null, it returns the extent of the line

Returns

the Y-coordinate of the baseline

public int getLineCount ()

Since: API Level 1

Return the number of lines of text, or 0 if the internal Layout has not been built.

public int getLineHeight ()

Since: API Level 1

Returns

the height of one standard line in pixels. Note that markup within the text can cause individual lines to be taller or shorter than this height, and the layout may contain additional first- or last-line padding.

public final ColorStateList getLinkTextColors ()

Since: API Level 1

Returns the color used to paint links in the text.

Returns

Returns the list of link text colors.

public final boolean getLinksClickable ()

Since: API Level 1

Returns whether the movement method will automatically be set to LinkMovementMethod if setAutoLinkMask(int) has been set to nonzero and links are detected in setText(char[], int, int). The default is true.

Related XML Attributes

android:linksClickable

public final MovementMethod getMovementMethod ()

Since: API Level 1

Returns

the movement method being used for this TextView. This will frequently be null for non-EditText TextViews.

public TextPaint getPaint ()

Since: API Level 1

Returns

the base paint used for the text. Please use this only to consult the Paint's properties and not to change them.

public int getPaintFlags ()

Since: API Level 1

Returns

the flags on the Paint being used to display the text.

Returns

Returns the set of text colors.

public static ColorStateList getTextColors (Context context, TypedArray attrs)

Since: API Level 1

Returns the TextView_textColor attribute from the Resources.StyledAttributes, if set, or the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.

public float getTextScaleX ()

Since: API Level 1

Returns

the extent by which text is currently being stretched horizontally. This will usually be 1.

public float getTextSize ()

Since: API Level 1

Returns

the size (in pixels) of the default text size in this TextView.

public int getTotalPaddingBottom ()

Since: API Level 1

Returns the total bottom padding of the view, including the bottom Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.

public int getTotalPaddingLeft ()

Since: API Level 1

Returns the total left padding of the view, including the left Drawable if any.

public int getTotalPaddingRight ()

Since: API Level 1

Returns the total right padding of the view, including the right Drawable if any.

public int getTotalPaddingTop ()

Since: API Level 1

Returns the total top padding of the view, including the top Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.

public final TransformationMethod getTransformationMethod ()

Since: API Level 1

Returns

the current transformation method for this TextView. This will frequently be null except for single-line and password fields.

public Typeface getTypeface ()

Since: API Level 1

Returns

the current typeface and style in which the text is being displayed.

public URLSpan[] getUrls ()

Since: API Level 1

Returns the list of URLSpans attached to the text (by Linkify or otherwise) if any. You can call getURL() on them to find where they link to or use getSpanStart(Object) and getSpanEnd(Object) to find the region of the text they are attached to.

public boolean hasSelection ()

Since: API Level 1

Return true iff there is a selection inside this text view.

public void invalidateDrawable (Drawable drawable)

Since: API Level 1

Invalidates the specified Drawable.

Parameters

drawable	the drawable to invalidate

public boolean isInputMethodTarget ()

Since: API Level 3

Returns whether this text view is a current input method target. The default implementation just checks with InputMethodManager.

public int length ()

Since: API Level 1

Returns the length, in characters, of the text managed by this TextView

public boolean moveCursorToVisibleOffset ()

Since: API Level 3

Move the cursor, if needed, so that it is at an offset that is visible to the user. This will not move the cursor if it represents more than one character (a selection range). This will only work if the TextView contains spannable text; otherwise it will do nothing.

Returns

True if the cursor was actually moved, false otherwise.

public void onBeginBatchEdit ()

Since: API Level 3

Called by the framework in response to a request to begin a batch of edit operations through a call to link beginBatchEdit().

public boolean onCheckIsTextEditor ()

Since: API Level 3

Check whether the called view is a text editor, in which case it would make sense to automatically display a soft input window for it. Subclasses should override this if they implement onCreateInputConnection(EditorInfo) to return true if a call on that method would return a non-null InputConnection, and they are really a first-class editor that the user would normally start typing on when the go into a window containing your view.

The default implementation always returns false. This does not mean that its onCreateInputConnection(EditorInfo) will not be called or the user can not otherwise perform edits on your view; it is just a hint to the system that this is not the primary purpose of this view.

Returns

Returns true if this view is a text editor, else false.

public void onCommitCompletion (CompletionInfo text)

Since: API Level 3

Called by the framework in response to a text completion from the current input method, provided by it calling InputConnection.commitCompletion(). The default implementation does nothing; text views that are supporting auto-completion should override this to do their desired behavior.

Parameters

text	The auto complete text the user has selected.

public InputConnection onCreateInputConnection (EditorInfo outAttrs)

Since: API Level 3

Create a new InputConnection for an InputMethod to interact with the view. The default implementation returns null, since it doesn't support input methods. You can override this to implement such support. This is only needed for views that take focus and text input.

When implementing this, you probably also want to implement onCheckIsTextEditor() to indicate you will return a non-null InputConnection.

Parameters

outAttrs	Fill in with attribute information about the connection.

public void onEditorAction (int actionCode)

Since: API Level 3

Called when an attached input method calls InputConnection.performEditorAction() for this text view. The default implementation will call your action listener supplied to setOnEditorActionListener(TextView.OnEditorActionListener), or perform a standard operation for EditorInfo.IME_ACTION_NEXT or EditorInfo.IME_ACTION_DONE.

For backwards compatibility, if no IME options have been set and the text view would not normally advance focus on enter, then the NEXT and DONE actions received here will be turned into an enter key down/up pair to go through the normal key handling.

Parameters

actionCode	The code of the action being performed.

public void onEndBatchEdit ()

Since: API Level 3

Called by the framework in response to a request to end a batch of edit operations through a call to link endBatchEdit().

public void onFinishTemporaryDetach ()

Since: API Level 3

Called after onStartTemporaryDetach() when the container is done changing the view.

public boolean onKeyDown (int keyCode, KeyEvent event)

Since: API Level 1

Default implementation of KeyEvent.Callback.onKeyMultiple(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released, if the view is enabled and clickable.

Parameters

keyCode	A key code that represents the button pressed, from `KeyEvent`.
event	The KeyEvent object that defines the button action.

Returns

If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyMultiple (int keyCode, int repeatCount, KeyEvent event)

Since: API Level 1

Default implementation of KeyEvent.Callback.onKeyMultiple(): always returns false (doesn't handle the event).

Parameters

keyCode	A key code that represents the button pressed, from `KeyEvent`.
repeatCount	The number of times the action was made.
event	The KeyEvent object that defines the button action.

Returns

If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyShortcut (int keyCode, KeyEvent event)

Since: API Level 1

Called when an unhandled key shortcut event occurs.

Parameters

keyCode	The value in event.getKeyCode().
event	Description of the key event.

Returns

If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onKeyUp (int keyCode, KeyEvent event)

Since: API Level 1

Default implementation of KeyEvent.Callback.onKeyMultiple(): perform clicking of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released.

Parameters

keyCode	A key code that represents the button pressed, from `KeyEvent`.
event	The KeyEvent object that defines the button action.

Returns

If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

public boolean onPreDraw ()

Since: API Level 1

Callback method to be invoked when the view tree is about to be drawn. At this point, all views in the tree have been measured and given a frame. Clients can use this to adjust their scroll bounds or even to request a new layout before drawing occurs.

Returns

Return true to proceed with the current drawing pass, or false to cancel.

public boolean onPrivateIMECommand (String action, Bundle data)

Since: API Level 3

Called by the framework in response to a private command from the current method, provided by it calling InputConnection.performPrivateCommand().

Parameters

action	The action name of the command.
data	Any additional data for the command. This may be null.

Returns

Return true if you handled the command, else false.

public void onRestoreInstanceState (Parcelable state)

Since: API Level 1

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState(). This function will never be called with a null state.

Parameters

state	The frozen state that had previously been returned by `onSaveInstanceState()`.

public Parcelable onSaveInstanceState ()

Since: API Level 1

Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state. This state should only contain information that is not persistent or can not be reconstructed later. For example, you will never store your current position on screen because that will be computed again when a new instance of the view is placed in its view hierarchy.

Some examples of things you may store here: the current cursor position in a text view (but usually not the text itself since that is stored in a content provider or other persistent storage), the currently selected item in a list view.

Returns

Returns a Parcelable object containing the view's current dynamic state, or null if there is nothing interesting to save. The default implementation returns null.

public void onStartTemporaryDetach ()

Since: API Level 3

This is called when a container is going to temporarily detach a child, with ViewGroup.detachViewFromParent. It will either be followed by onFinishTemporaryDetach() or onDetachedFromWindow() when the container is done.

public boolean onTextContextMenuItem (int id)

Since: API Level 3

Called when a context menu option for the text view is selected. Currently this will be one of: selectAll, startSelectingText, cut, copy, paste, copyUrl, or switchInputMethod.

public boolean onTouchEvent (MotionEvent event)

Since: API Level 1

Implement this method to handle touch screen motion events.

Parameters

event	The motion event.

Returns

True if the event was handled, false otherwise.

public boolean onTrackballEvent (MotionEvent event)

Since: API Level 1

Implement this method to handle trackball motion events. The relative movement of the trackball since the last event can be retrieve with MotionEvent.getX() and MotionEvent.getY(). These are normalized so that a movement of 1 corresponds to the user pressing one DPAD key (so they will often be fractional values, representing the more fine-grained movement information available from a trackball).

Parameters

event	The motion event.

Returns

True if the event was handled, false otherwise.

public void onWindowFocusChanged (boolean hasWindowFocus)

Since: API Level 1

Called when the window containing this view gains or loses focus. Note that this is separate from view focus: to receive key events, both your view and its window must have focus. If a window is displayed on top of yours that takes input focus, then your own window will lose focus but the view focus will remain unchanged.

Parameters

hasWindowFocus	True if the window containing this view now has focus, false otherwise.

public boolean performLongClick ()

Since: API Level 1

Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the OnLongClickListener did not consume the event.

Returns

True if one of the above receivers consumed the event, false otherwise.

public void removeTextChangedListener (TextWatcher watcher)

Since: API Level 1

Parameters

left	Resource identifier of the left Drawable.
top	Resource identifier of the top Drawable.
right	Resource identifier of the right Drawable.
bottom	Resource identifier of the bottom Drawable.

public void setCursorVisible (boolean visible)

Since: API Level 1

Set whether the cursor is visible. The default is true.

Related XML Attributes

android:cursorVisible

public final void setEditableFactory (Editable.Factory factory)

Since: API Level 1

Since: API Level 1

Sets the right-hand compound drawable of the TextView to the specified icon and sets an error message that will be displayed in a popup when the TextView has focus. The icon and error message will be reset to null when any key events cause changes to the TextView's text. The drawable must already have had setBounds(Rect) set on it. If the error is null, the error message will be cleared (and you should provide a null icon as well).

public void setExtractedText (ExtractedText text)

Since: API Level 3

Apply to this text view the given extracted text, as previously returned by extractText(ExtractedTextRequest, ExtractedText).

public void setFilters (InputFilter[] filters)

Since: API Level 1

Sets the list of input filters that will be used if the buffer is Editable. Has no effect otherwise.

Related XML Attributes

android:maxLength

public void setFreezesText (boolean freezesText)

Since: API Level 1

Control whether this text view saves its entire text contents when freezing to an icicle, in addition to dynamic state such as cursor position. By default this is false, not saving the text. Set to true if the text in the text view is not being saved somewhere else in persistent storage (such as in a content provider) so that if the view is later thawed the user will not lose their data.

Related XML Attributes

android:freezesText

Parameters

freezesText	Controls whether a frozen icicle should include the entire text data: true to include it, false to not.

public void setGravity (int gravity)

Since: API Level 1

Sets the horizontal alignment of the text and the vertical gravity that will be used when there is extra space in the TextView beyond what is required for the text itself.

Related XML Attributes

android:gravity

public void setHeight (int pixels)

Since: API Level 1

Makes the TextView exactly this many pixels tall. You could do the same thing by specifying this number in the LayoutParams.

Related XML Attributes

android:height

public void setHighlightColor (int color)

Since: API Level 1

Sets the color used to display the selection highlight.

Related XML Attributes

android:textColorHighlight

public final void setHint (CharSequence hint)

Since: API Level 1

Sets the text to be displayed when the text of the TextView is empty. Null means to use the normal empty text. The hint does not currently participate in determining the size of the view.

Related XML Attributes

android:hint

public final void setHint (int resid)

Since: API Level 1

Sets the text to be displayed when the text of the TextView is empty, from a resource.

Related XML Attributes

android:hint

public final void setHintTextColor (int color)

Since: API Level 1

Sets the color of the hint text.

Related XML Attributes

android:textColorHint

public final void setHintTextColor (ColorStateList colors)

Since: API Level 1

Sets the color of the hint text.

Related XML Attributes

android:textColorHint

public void setHorizontallyScrolling (boolean whether)

Since: API Level 1

Sets whether the text should be allowed to be wider than the View is. If false, it will be wrapped to the width of the View.

Related XML Attributes

android:scrollHorizontally

public void setImeActionLabel (CharSequence label, int actionId)

Since: API Level 3

Change the custom IME action associated with the text view, which will be reported to an IME with actionLabel and actionId when it has focus.

android:editorExtras

Throws

XmlPullParserException
IOException

public void setInputType (int type)

Since: API Level 3

Set the type of the content with a constant as defined for inputType. This will take care of changing the key listener, by calling setKeyListener(KeyListener), to match the given content type. If the given content type is TYPE_NULL then a soft keyboard will not be displayed for this text view.

Related XML Attributes

android:inputType

public void setKeyListener (KeyListener input)

Since: API Level 1

Sets the key listener to be used with this TextView. This can be null to disallow user input. Note that this method has significant and subtle interactions with soft keyboards and other input method: see KeyListener.getContentType() for important details. Calling this method will replace the current content type of the text view with the content type returned by the key listener.

Be warned that if you want a TextView with a key listener or movement method not to be focusable, or if you want a TextView without a key listener or movement method to be focusable, you must call setFocusable(boolean) again after calling this to get the focusability back the way you want it.

Related XML Attributes

public void setLineSpacing (float add, float mult)

Since: API Level 1

Sets line spacing for this TextView. Each line will have its height multiplied by mult and have add added to it.

android:minWidth

public final void setMovementMethod (MovementMethod movement)

Since: API Level 1

Sets the movement method (arrow key handler) to be used for this TextView. This can be null to disallow using the arrow keys to move the cursor or scroll the view.

Be warned that if you want a TextView with a key listener or movement method not to be focusable, or if you want a TextView without a key listener or movement method to be focusable, you must call setFocusable(boolean) again after calling this to get the focusability back the way you want it.

public void setOnEditorActionListener (TextView.OnEditorActionListener l)

Since: API Level 3

Set a special listener to be called when an action is performed on the text view. This will be called when the enter key is pressed, or when an action supplied to the IME is selected by the user. Setting this means that the normal hard key event will not insert a newline into the text view, even if it is multi-line; holding down the ALT modifier will, however, allow the user to insert a newline character.

public void setPadding (int left, int top, int right, int bottom)

Since: API Level 1

Sets the padding. The view may add on the space required to display the scrollbars, depending on the style and visibility of the scrollbars. So the values returned from getPaddingLeft(), getPaddingTop(), getPaddingRight() and getPaddingBottom() may be different from the values set in this call.

Parameters

left	the left padding in pixels
top	the top padding in pixels
right	the right padding in pixels
bottom	the bottom padding in pixels

public void setPaintFlags (int flags)

Since: API Level 1

Sets flags on the Paint being used to display the text and reflows the text if they are different from the old flags.

public void setPrivateImeOptions (String type)

Since: API Level 3

Set the private content type of the text, which is the EditorInfo.privateImeOptions field that will be filled in when creating an input connection.

Related XML Attributes

android:privateImeOptions

public void setRawInputType (int type)

Since: API Level 3

Directly change the content type integer of the text view, without modifying any other state.

Related XML Attributes

android:inputType

Since: API Level 1

public final void setText (int resid)

Since: API Level 1

public final void setText (CharSequence text)

Since: API Level 1

Sets the string value of the TextView. TextView does not accept HTML-like formatting, which you can do with text strings in XML resource files. To style your strings, attach android.text.style.* objects to a SpannableString, or see the Available Resource Types documentation for an example of setting formatted text in the XML resource file.

Related XML Attributes

android:text

public final void setText (char[] text, int start, int len)

Since: API Level 1

Sets the TextView to display the specified slice of the specified char array. You must promise that you will not change the contents of the array except for right before another call to setText(), since the TextView has no way to know that the text has changed and that it needs to invalidate and re-layout.

public void setText (CharSequence text, TextView.BufferType type)

Since: API Level 1

Sets the text that this TextView is to display (see setText(CharSequence)) and also sets whether it is stored in a styleable/spannable buffer and whether it is editable.

Related XML Attributes

public void setTextAppearance (Context context, int resid)

Since: API Level 1

Since: API Level 1

Sets the extent by which text should be stretched horizontally.

Related XML Attributes

android:textScaleX

public void setTextSize (int unit, float size)

Since: API Level 1

Set the default text size to a given unit and value. See TypedValue for the possible dimension units.

Related XML Attributes

android:textSize

Parameters

unit	The desired dimension unit.
size	The desired size in the given units.

public void setTextSize (float size)

Since: API Level 1

Set the default text size to the given value, interpreted as "scaled pixel" units. This size is adjusted based on the current density and user font size preference.

Related XML Attributes

android:textSize

Parameters

size	The scaled pixel size.

android:width

Protected Methods

protected int computeHorizontalScrollRange ()

Since: API Level 1

Compute the horizontal range that the horizontal scrollbar represents.

The range is expressed in arbitrary units that must be the same as the units used by computeHorizontalScrollExtent() and computeHorizontalScrollOffset().

The default range is the drawing width of this view.

Returns

the total horizontal range represented by the horizontal scrollbar

protected int computeVerticalScrollExtent ()

Since: API Level 1

Compute the vertical extent of the horizontal scrollbar's thumb within the vertical range. This value is used to compute the length of the thumb within the scrollbar's track.

The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollRange() and computeVerticalScrollOffset().

The default extent is the drawing height of this view.

Returns

the vertical extent of the scrollbar's thumb

protected int computeVerticalScrollRange ()

Since: API Level 1

Compute the vertical range that the vertical scrollbar represents.

The range is expressed in arbitrary units that must be the same as the units used by computeVerticalScrollExtent() and computeVerticalScrollOffset().

Returns

the total vertical range represented by the vertical scrollbar
The default range is the drawing height of this view.

protected void drawableStateChanged ()

Since: API Level 1

This function is called whenever the state of the view changes in such a way that it impacts the state of drawables being shown.

Be sure to call through to the superclass when overriding this function.

protected int getBottomPaddingOffset ()

Since: API Level 2

Amount by which to extend the bottom fading region. Called only when isPaddingOffsetRequired() returns true.

Returns

The bottom padding offset in pixels.

protected boolean getDefaultEditable ()

Since: API Level 1

Subclasses override this to specify that they have a KeyListener by default even if not specifically called for in the XML options.

protected MovementMethod getDefaultMovementMethod ()

Since: API Level 1

Subclasses override this to specify a default movement method.

protected float getLeftFadingEdgeStrength ()

Since: API Level 1

Returns the strength, or intensity, of the left faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs.

Returns

the intensity of the left fade as a float between 0.0f and 1.0f

protected int getLeftPaddingOffset ()

Since: API Level 2

Amount by which to extend the left fading region. Called only when isPaddingOffsetRequired() returns true.

Returns

The left padding offset in pixels.

protected float getRightFadingEdgeStrength ()

Since: API Level 1

Returns the strength, or intensity, of the right faded edge. The strength is a value between 0.0 (no fade) and 1.0 (full fade). The default implementation returns 0.0 or 1.0 but no value in between. Subclasses should override this method to provide a smoother fade transition when scrolling occurs.

Returns

the intensity of the right fade as a float between 0.0f and 1.0f

protected int getRightPaddingOffset ()

Since: API Level 2

Amount by which to extend the right fading region. Called only when isPaddingOffsetRequired() returns true.

Returns

The right padding offset in pixels.

protected int getTopPaddingOffset ()

Since: API Level 2

Amount by which to extend the top fading region. Called only when isPaddingOffsetRequired() returns true.

Returns

The top padding offset in pixels.

protected boolean isPaddingOffsetRequired ()

Since: API Level 2

If the View draws content inside its padding and enables fading edges, it needs to support padding offsets. Padding offsets are added to the fading edges to extend the length of the fade so that it covers pixels drawn inside the padding. Subclasses of this class should override this method if they need to draw content inside the padding.

Returns

True if padding offset must be applied, false otherwise.

protected void onAttachedToWindow ()

Since: API Level 1

This is called when the view is attached to a window. At this point it has a Surface and will start drawing. Note that this function is guaranteed to be called before onDraw(Canvas), however it may be called any time before the first onDraw -- including before or after onMeasure(int, int).

protected void onCreateContextMenu (ContextMenu menu)

Since: API Level 1

Views should implement this if the view itself is going to add items to the context menu.

Parameters

menu	the context menu to populate

protected void onDetachedFromWindow ()

Since: API Level 1

This is called when the view is detached from a window. At this point it no longer has a surface for drawing.

protected void onDraw (Canvas canvas)

Since: API Level 1

Implement this to do your drawing.

Parameters

canvas	the canvas on which the background will be drawn

protected void onFocusChanged (boolean focused, int direction, Rect previouslyFocusedRect)

Since: API Level 1

Called by the view system when the focus state of this view changes. When the focus change event is caused by directional navigation, direction and previouslyFocusedRect provide insight into where the focus is coming from. When overriding, be sure to call up through to the super class so that the standard focus handling will occur.

Parameters

focused	True if the View has focus; false otherwise.
direction	The direction focus has moved when requestFocus() is called to give this view focus. Values are `FOCUS_UP`, `FOCUS_DOWN`, `FOCUS_LEFT` or `FOCUS_RIGHT`. It may not always apply, in which case use the default.
previouslyFocusedRect	The rectangle, in this view's coordinate system, of the previously focused view. If applicable, this will be passed in as finer grained information about where the focus is coming from (in addition to direction). Will be `null` otherwise.

protected void onMeasure (int widthMeasureSpec, int heightMeasureSpec)

Since: API Level 1

Measure the view and its content to determine the measured width and the measured height. This method is invoked by measure(int, int) and should be overriden by subclasses to provide accurate and efficient measurement of their contents.

CONTRACT: When overriding this method, you must call setMeasuredDimension(int, int) to store the measured width and height of this view. Failure to do so will trigger an IllegalStateException, thrown by measure(int, int). Calling the superclass' onMeasure(int, int) is a valid use.

The base class implementation of measure defaults to the background size, unless a larger size is allowed by the MeasureSpec. Subclasses should override onMeasure(int, int) to provide better measurements of their content.

If this method is overridden, it is the subclass's responsibility to make sure the measured height and width are at least the view's minimum height and width (getSuggestedMinimumHeight() and getSuggestedMinimumWidth()).

Parameters

widthMeasureSpec	horizontal space requirements as imposed by the parent. The requirements are encoded with `View.MeasureSpec`.
heightMeasureSpec	vertical space requirements as imposed by the parent. The requirements are encoded with `View.MeasureSpec`.

protected void onSelectionChanged (int selStart, int selEnd)

Since: API Level 3

This method is called when the selection has changed, in case any subclasses would like to know.

Parameters

selStart	The new selection start location.
selEnd	The new selection end location.

protected void onTextChanged (CharSequence text, int start, int before, int after)

Since: API Level 1

This method is called when the text is changed, in case any subclasses would like to know.

Parameters

text	The text the TextView is displaying.
start	The offset of the start of the range of the text that was modified.
before	The offset of the former end of the range of the text that was modified. If text was simply inserted, this will be the same as `start`. If text was replaced with new text or deleted, the length of the old text was `before-start`.
after	The offset of the end of the range of the text that was modified. If text was simply deleted, this will be the same as `start`. If text was replaced with new text or inserted, the length of the new text is `after-start`.

protected void onVisibilityChanged (View changedView, int visibility)

Since: API Level 8

Called when the visibility of the view or an ancestor of the view is changed.

Parameters

changedView	The view whose visibility changed. Could be 'this' or an ancestor view.
visibility	The new visibility of changedView: `VISIBLE`, `INVISIBLE` or `GONE`.

protected boolean setFrame (int l, int t, int r, int b)

Since: API Level 1

Assign a size and position to this view. This is called from layout.

Parameters

l	Left position, relative to parent
t	Top position, relative to parent
r	Right position, relative to parent
b	Bottom position, relative to parent

Returns

true if the new size and position are different than the previous ones

protected boolean verifyDrawable (Drawable who)

Since: API Level 1

If your view subclass is displaying its own Drawable objects, it should override this function and return true for any Drawable it is displaying. This allows animations for those drawables to be scheduled.

Be sure to call through to the super class when overriding this function.

Parameters

who	The Drawable to verify. Return true if it is one you are displaying, else return the result of calling through to the super class.

Returns

boolean If true than the Drawable is being displayed in the view; else false and it is not allowed to animate.

Interfaces

Classes

Enums

Exceptions

TextView

Class Overview

Summary

XML Attributes

android:autoLink

Related Methods

android:autoText

Related Methods

android:bufferType

Related Methods

android:capitalize

Related Methods

android:cursorVisible

Related Methods

android:digits

Related Methods

android:drawableBottom

Related Methods

android:drawableLeft

Related Methods

android:drawablePadding

Related Methods

android:drawableRight

Related Methods

android:drawableTop

Related Methods

android:editable

Related Methods

android:editorExtras

Related Methods

android:ellipsize

Related Methods

android:ems

Related Methods

android:freezesText

Related Methods

android:gravity

Related Methods

android:height

Related Methods

android:hint

Related Methods

android:imeActionId

Related Methods

android:imeActionLabel

Related Methods

android:imeOptions

Related Methods

android:includeFontPadding

Related Methods

android:inputMethod

Related Methods

android:inputType

Related Methods

android:lineSpacingExtra

Related Methods

android:lineSpacingMultiplier

Related Methods

android:lines

Related Methods

android:linksClickable

Related Methods

android:marqueeRepeatLimit

Related Methods

android:maxEms

Related Methods

android:maxHeight

Related Methods

android:maxLength

Related Methods

android:maxLines

Related Methods

android:maxWidth

Related Methods

android:minEms

Related Methods