Skip to content

Most visited

Recently visited

navigation
Added in API level 1

TextView

public class TextView
extends View implements ViewTreeObserver.OnPreDrawListener

java.lang.Object
   ↳ android.view.View
     ↳ android.widget.TextView
Known Direct Subclasses
Known Indirect Subclasses


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.

To allow users to copy some or all of the TextView's value and paste it somewhere else, set the XML attribute android:textIsSelectable to "true" or call setTextIsSelectable(true). The textIsSelectable flag allows users to make selection gestures in the TextView, which in turn triggers the system's built-in copy/paste controls.

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

android:autoLink Controls whether links such as urls and email addresses are automatically found and converted to clickable links. 
android:autoText If set, specifies that this TextView has a textual input method and automatically corrects some common spelling errors. 
android:breakStrategy Break strategy (control over paragraph layout). 
android:bufferType Determines the minimum type that getText() will return. 
android:capitalize If set, specifies that this TextView has a textual input method and should automatically capitalize what the user types. 
android:cursorVisible Makes the cursor visible (the default) or invisible. 
android:digits 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 The drawable to be drawn below the text. 
android:drawableEnd The drawable to be drawn to the end of the text. 
android:drawableLeft The drawable to be drawn to the left of the text. 
android:drawablePadding The padding between the drawables and the text. 
android:drawableRight The drawable to be drawn to the right of the text. 
android:drawableStart The drawable to be drawn to the start of the text. 
android:drawableTint Tint to apply to the compound (left, top, etc.) drawables. 
android:drawableTintMode Blending mode used to apply the compound (left, top, etc.) drawables tint. 
android:drawableTop The drawable to be drawn above the text. 
android:editable If set, specifies that this TextView has an input method. 
android:editorExtras 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:elegantTextHeight Elegant text height, especially for less compacted complex script text. 
android:ellipsize If set, causes words that are longer than the view is wide to be ellipsized instead of broken in the middle. 
android:ems Makes the TextView be exactly this many ems wide. 
android:fontFamily Font family (named by string) for the text. 
android:fontFeatureSettings Font feature settings. 
android:freezesText 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 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 Makes the TextView be exactly this many pixels tall. 
android:hint Hint text to display when the text is empty. 
android:hyphenationFrequency Frequency of automatic hyphenation. 
android:imeActionId Supply a value for EditorInfo.actionId used when an input method is connected to the text view. 
android:imeActionLabel Supply a value for EditorInfo.actionLabel used when an input method is connected to the text view. 
android:imeOptions Additional features you can enable in an IME associated with an editor to improve the integration with your application. 
android:includeFontPadding Leave enough room for ascenders and descenders instead of using the font ascent and descent strictly. 
android:inputMethod If set, specifies that this TextView should use the specified input method (specified by fully-qualified class name). 
android:inputType 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:letterSpacing Text letter-spacing. 
android:lineSpacingExtra Extra spacing between lines of text. 
android:lineSpacingMultiplier Extra spacing between lines of text, as a multiplier. 
android:lines Makes the TextView be exactly this many lines tall. 
android:linksClickable 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 The number of times to repeat the marquee animation. 
android:maxEms Makes the TextView be at most this many ems wide. 
android:maxHeight Makes the TextView be at most this many pixels tall. 
android:maxLength Set an input filter to constrain the text length to the specified number. 
android:maxLines Makes the TextView be at most this many lines tall. 
android:maxWidth Makes the TextView be at most this many pixels wide. 
android:minEms Makes the TextView be at least this many ems wide. 
android:minHeight Makes the TextView be at least this many pixels tall. 
android:minLines Makes the TextView be at least this many lines tall. 
android:minWidth Makes the TextView be at least this many pixels wide. 
android:numeric If set, specifies that this TextView has a numeric input method. 
android:password Whether the characters of the field are displayed as password dots instead of themselves. 
android:phoneNumber If set, specifies that this TextView has a phone number input method. 
android:privateImeOptions 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 Whether the text is allowed to be wider than the view (and therefore can be scrolled horizontally). 
android:selectAllOnFocus If the text is selectable, select it all when the view takes focus. 
android:shadowColor Place a blurred shadow of text underneath the text, drawn with the specified color. 
android:shadowDx Horizontal offset of the text shadow. 
android:shadowDy Vertical offset of the text shadow. 
android:shadowRadius Blur radius of the text shadow. 
android:singleLine 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 Text to display. 
android:textAllCaps Present the text in ALL CAPS. 
android:textAppearance Base text color, typeface, size, and style. 
android:textColor Text color. 
android:textColorHighlight Color of the text selection highlight. 
android:textColorHint Color of the hint text. 
android:textColorLink Text color for links. 
android:textIsSelectable Indicates that the content of a non-editable text can be selected. 
android:textScaleX Sets the horizontal scaling factor for the text. 
android:textSize Size of the text. 
android:textStyle Style (bold, italic, bolditalic) for the text. 
android:typeface Typeface (normal, sans, serif, monospace) for the text. 
android:width Makes the TextView be exactly this many pixels wide. 

Inherited XML attributes

From class android.view.View

Inherited constants

From class android.view.View

Inherited fields

From class android.view.View

Public constructors

TextView(Context context)
TextView(Context context, AttributeSet attrs)
TextView(Context context, AttributeSet attrs, int defStyleAttr)
TextView(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes)

Public methods

void addTextChangedListener(TextWatcher watcher)

Adds a TextWatcher to the list of those whose methods are called whenever this TextView's text changes.

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 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.

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.

void drawableHotspotChanged(float x, float y)

This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view.

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.

void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags)

Finds the Views that contain given text.

CharSequence getAccessibilityClassName()

Return the class name of this object to be used for accessibility purposes.

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 getBreakStrategy()
int getCompoundDrawablePadding()

Returns the padding between the compound drawables and the text.

ColorStateList getCompoundDrawableTintList()
PorterDuff.Mode getCompoundDrawableTintMode()

Returns the blending mode used to apply the tint to the compound drawables, if specified.

Drawable[] getCompoundDrawables()

Returns drawables for the left, top, right, and bottom borders.

Drawable[] getCompoundDrawablesRelative()

Returns drawables for the start, top, end, and bottom borders.

int getCompoundPaddingBottom()

Returns the bottom padding of the view, plus space for the bottom Drawable if any.

int getCompoundPaddingEnd()

Returns the end padding of the view, plus space for the end 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 getCompoundPaddingStart()

Returns the start padding of the view, plus space for the start 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.

ActionMode.Callback getCustomInsertionActionModeCallback()

Retrieves the value set in setCustomInsertionActionModeCallback(ActionMode.Callback).

ActionMode.Callback getCustomSelectionActionModeCallback()

Retrieves the value set in setCustomSelectionActionModeCallback(ActionMode.Callback).

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.

String getFontFeatureSettings()

Returns the font feature settings.

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.

int getHighlightColor()
CharSequence getHint()

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

final ColorStateList getHintTextColors()
int getHyphenationFrequency()
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).

LocaleList getImeHintLocales()
int getImeOptions()

Get the type of the IME editor.

boolean getIncludeFontPadding()

Gets whether the TextView includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.

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 editable content.

final KeyListener getKeyListener()
final Layout getLayout()
float getLetterSpacing()
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()
float getLineSpacingExtra()

Gets the line spacing extra space

float getLineSpacingMultiplier()

Gets the line spacing multiplier

final ColorStateList getLinkTextColors()
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).

int getMarqueeRepeatLimit()

Gets the number of times the marquee animation is repeated.

int getMaxEms()
int getMaxHeight()
int getMaxLines()
int getMaxWidth()
int getMinEms()
int getMinHeight()
int getMinLines()
int getMinWidth()
final MovementMethod getMovementMethod()
int getOffsetForPosition(float x, float y)

Get the character offset closest to the specified absolute position.

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).

int getShadowColor()
float getShadowDx()
float getShadowDy()
float getShadowRadius()

Gets the radius of the shadow layer.

final boolean getShowSoftInputOnFocus()

Returns whether the soft input method will be made visible when this TextView gets focused.

CharSequence getText()

Return the text the TextView is displaying.

final ColorStateList getTextColors()

Gets the text colors for the different states (normal, selected, focused) of the TextView.

Locale getTextLocale()

Get the default primary Locale of the text in this TextView.

LocaleList getTextLocales()

Get the default LocaleList of the text in this TextView.

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 getTotalPaddingEnd()

Returns the total end padding of the view, including the end Drawable 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 getTotalPaddingStart()

Returns the total start padding of the view, including the start 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 hasOverlappingRendering()

Returns whether this View has content which overlaps.

boolean hasSelection()

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

void invalidateDrawable(Drawable drawable)

Invalidates the specified Drawable.

boolean isCursorVisible()
boolean isInputMethodTarget()

Returns whether this text view is a current input method target.

boolean isSuggestionsEnabled()

Return whether or not suggestions are enabled on this TextView.

boolean isTextSelectable()

Returns the state of the textIsSelectable flag (See setTextIsSelectable()).

void jumpDrawablesToCurrentState()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

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().

void onCommitCorrection(CorrectionInfo info)

Called by the framework in response to a text auto-correction (such as fixing a typo using a a dictionnary) from the current input method, provided by it calling commitCorrection(CorrectionInfo) InputConnection.commitCorrection()}.

InputConnection onCreateInputConnection(EditorInfo outAttrs)

Create a new InputConnection for an InputMethod to interact with the view.

boolean onDragEvent(DragEvent event)

Handles drag events sent by the system following a call to startDragAndDrop().

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().

boolean onGenericMotionEvent(MotionEvent event)

Implement this method to handle generic motion events.

boolean onKeyDown(int keyCode, KeyEvent event)

Default implementation of KeyEvent.Callback.onKeyDown(): 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 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 on the focused view when a key shortcut event is not handled.

boolean onKeyUp(int keyCode, KeyEvent event)

Default implementation of KeyEvent.Callback.onKeyUp(): perform clicking of the view when KEYCODE_DPAD_CENTER, KEYCODE_ENTER or KEYCODE_SPACE 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 onProvideStructure(ViewStructure structure)

Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData.

PointerIcon onResolvePointerIcon(MotionEvent event, int pointerIndex)

Returns the pointer icon for the motion event, or null if it doesn't specify the icon.

void onRestoreInstanceState(Parcelable state)

Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().

void onRtlPropertiesChanged(int layoutDirection)

Called when any RTL property (layout direction or text direction or text alignment) has been changed.

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 onScreenStateChanged(int screenState)

This method is called whenever the state of the screen this view is attached to changes.

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()

Calls 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.

void setAllCaps(boolean allCaps)

Sets the properties of this field to transform input to ALL CAPS display.

final void setAutoLinkMask(int mask)

Sets the autolink mask of the text.

void setBreakStrategy(int breakStrategy)

Sets the break strategy for breaking paragraphs into lines.

void setCompoundDrawablePadding(int pad)

Sets the size of the padding between the compound drawables and the text.

void setCompoundDrawableTintList(ColorStateList tint)

Applies a tint to the compound drawables.

void setCompoundDrawableTintMode(PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setCompoundDrawableTintList(ColorStateList) to the compound drawables.

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 setCompoundDrawablesRelative(Drawable start, Drawable top, Drawable end, Drawable bottom)

Sets the Drawables (if any) to appear to the start of, above, to the end of, and below the text.

void setCompoundDrawablesRelativeWithIntrinsicBounds(Drawable start, Drawable top, Drawable end, Drawable bottom)

Sets the Drawables (if any) to appear to the start of, above, to the end of, and below the text.

void setCompoundDrawablesRelativeWithIntrinsicBounds(int start, int top, int end, int bottom)

Sets the Drawables (if any) to appear to the start of, above, to the end 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.

void setCustomInsertionActionModeCallback(ActionMode.Callback actionModeCallback)

If provided, this ActionMode.Callback will be used to create the ActionMode when text insertion is initiated in this View.

void setCustomSelectionActionModeCallback(ActionMode.Callback actionModeCallback)

If provided, this ActionMode.Callback will be used to create the ActionMode when text selection is initiated in this View.

final void setEditableFactory(Editable.Factory factory)

Sets the Factory used to create new Editables.

void setElegantTextHeight(boolean elegant)

Set the TextView's elegant height metrics flag.

void setEllipsize(TextUtils.TruncateAt where)

Causes words in the text that are longer than the view's width to be ellipsized instead of broken in the middle.

void setEms(int ems)

Makes the TextView exactly this many ems wide

void setEnabled(boolean enabled)

Set the enabled state of this view.

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 setFontFeatureSettings(String fontFeatureSettings)

Sets font feature settings.

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(ColorStateList colors)

Sets the color of the hint text.

final void setHintTextColor(int color)

Sets the color of the hint text for all the states (disabled, focussed, selected...) of this TextView.

void setHorizontallyScrolling(boolean whether)

Sets whether the text should be allowed to be wider than the View is.

void setHyphenationFrequency(int hyphenationFrequency)

Sets the hyphenation frequency.

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 setImeHintLocales(LocaleList hintLocales)

Change "hint" locales associated with the text view, which will be reported to an IME with hintLocales 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 setLetterSpacing(float letterSpacing)

Sets text letter-spacing.

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 setPaddingRelative(int start, int top, int end, int bottom)

Sets the relative 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 blur radius and color, the specified distance from its drawn position.

final void setShowSoftInputOnFocus(boolean show)

Sets whether the soft input method will be made visible when this TextView gets focused.

void setSingleLine(boolean singleLine)

If true, sets the properties of this field (number of lines, horizontally scrolling, transformation method) to be for a single-line input; if false, restores these to the default conditions.

void setSingleLine()

Sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input.

final void setSpannableFactory(Spannable.Factory factory)

Sets the Factory used to create new Spannables.

final void setText(int resid)
final void setText(CharSequence text)

Sets the string value of the TextView.

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.

final void setText(int resid, TextView.BufferType type)
final void setText(char[] text, int start, int len)

Sets the TextView to display the specified slice of the specified char array.

void setTextAppearance(Context context, int resId)

This method was deprecated in API level 23. Use setTextAppearance(int) instead.

void setTextAppearance(int resId)

Sets the text appearance from the specified style 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.

void setTextIsSelectable(boolean selectable)

Sets whether the content of this view is selectable by the user.

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 setTextLocale(Locale locale)

Set the default LocaleList of the text in this TextView to a one-member list containing just the given value.

void setTextLocales(LocaleList locales)

Set the default LocaleList of the text in this TextView to the given value.

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)

Sets the typeface and style in which the text should be displayed.

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 setWidth(int pixels)

Makes the TextView exactly this many pixels wide.

boolean showContextMenu()

Shows the context menu for this view.

boolean showContextMenu(float x, float y)

Shows the context menu for this view anchored to the specified view-relative coordinate.

Protected methods

int computeHorizontalScrollRange()

Compute the horizontal range that the horizontal scrollbar represents.

int computeVerticalScrollExtent()

Compute the vertical extent of the vertical 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 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.

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 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 onScrollChanged(int horiz, int vert, int oldHoriz, int oldVert)

This is called in response to an internal scroll in this view (i.e., the view scrolled its own contents).

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 lengthBefore, int lengthAfter)

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 has 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.

Inherited methods

From class android.view.View
From class java.lang.Object
From interface android.graphics.drawable.Drawable.Callback
From interface android.view.KeyEvent.Callback
From interface android.view.accessibility.AccessibilityEventSource
From interface android.view.ViewTreeObserver.OnPreDrawListener

XML attributes

android:autoLink

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.

ConstantValueDescription
none0x00 Match no patterns (default).
web0x01 Match Web URLs.
email0x02 Match email addresses.
phone0x04 Match phone numbers.
map0x08 Match map addresses.
all0x0f Match all patterns (equivalent to web|email|phone|map).

This corresponds to the global attribute resource symbol autoLink.

Related methods:

android:autoText

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:

android:breakStrategy

Break strategy (control over paragraph layout).

Must be one of the following constant values.

ConstantValueDescription
simple0 Line breaking uses simple strategy.
high_quality1 Line breaking uses high-quality strategy, including hyphenation.
balanced2 Line breaking strategy balances line lengths.

This corresponds to the global attribute resource symbol breakStrategy.

Related methods:

android:bufferType

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.

ConstantValueDescription
normal0 Can return any CharSequence, possibly a Spanned one if the source text was Spanned.
spannable1 Can only return Spannable.
editable2 Can only return Spannable and Editable.

This corresponds to the global attribute resource symbol bufferType.

Related methods:

android:capitalize

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.

ConstantValueDescription
none0 Don't automatically capitalize anything.
sentences1 Capitalize the first word of each sentence.
words2 Capitalize the first letter of every word.
characters3 Capitalize every character.

This corresponds to the global attribute resource symbol capitalize.

Related methods:

android:cursorVisible

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:

android:digits

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:

android:drawableBottom

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:

android:drawableEnd

The drawable to be drawn to the end 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 drawableEnd.

Related methods:

android:drawableLeft

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:

android:drawablePadding

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:

android:drawableRight

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:

android:drawableStart

The drawable to be drawn to the start 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 drawableStart.

Related methods:

android:drawableTint

Tint to apply to the compound (left, top, etc.) drawables.

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 drawableTint.

Related methods:

android:drawableTintMode

Blending mode used to apply the compound (left, top, etc.) drawables tint.

Must be one of the following constant values.

ConstantValueDescription
src_over3 The tint is drawn on top of the drawable. [Sa + (1 - Sa)*Da, Rc = Sc + (1 - Sa)*Dc]
src_in5 The tint is masked by the alpha channel of the drawable. The drawable’s color channels are thrown out. [Sa * Da, Sc * Da]
src_atop9 The tint is drawn above the drawable, but with the drawable’s alpha channel masking the result. [Da, Sc * Da + (1 - Sa) * Dc]
multiply14 Multiplies the color and alpha channels of the drawable with those of the tint. [Sa * Da, Sc * Dc]
screen15 [Sa + Da - Sa * Da, Sc + Dc - Sc * Dc]
add16 Combines the tint and drawable color and alpha channels, clamping the result to valid color values. Saturate(S + D)

This corresponds to the global attribute resource symbol drawableTintMode.

Related methods:

android:drawableTop

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:

android:editable

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.

android:editorExtras

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:

android:elegantTextHeight

Elegant text height, especially for less compacted complex script text.

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 elegantTextHeight.

Related methods:

android:ellipsize

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.

ConstantValueDescription
none0
start1
middle2
end3
marquee4

This corresponds to the global attribute resource symbol ellipsize.

Related methods:

android:ems

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:

android:fontFamily

Font family (named by string) for the text.

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 fontFamily.

Related methods:

android:fontFeatureSettings

Font feature settings.

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 fontFeatureSettings.

Related methods:

android:freezesText

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. For EditText it is always enabled, regardless of the value of the attribute.

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:

android:gravity

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.

ConstantValueDescription
top0x30 Push object to the top of its container, not changing its size.
bottom0x50 Push object to the bottom of its container, not changing its size.
left0x03 Push object to the left of its container, not changing its size.
right0x05 Push object to the right of its container, not changing its size.
center_vertical0x10 Place object in the vertical center of its container, not changing its size.
fill_vertical0x70 Grow the vertical size of the object if needed so it completely fills its container.
center_horizontal0x01 Place object in the horizontal center of its container, not changing its size.
fill_horizontal0x07 Grow the horizontal size of the object if needed so it completely fills its container.
center0x11 Place the object in the center of its container in both the vertical and horizontal axis, not changing its size.
fill0x77 Grow the horizontal and vertical size of the object if needed so it completely fills its container.
clip_vertical0x80 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_horizontal0x08 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.
start0x00800003 Push object to the beginning of its container, not changing its size.
end0x00800005 Push object to the end of its container, not changing its size.

This corresponds to the global attribute resource symbol gravity.

Related methods:

android:height

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:

android:hint

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:

android:hyphenationFrequency

Frequency of automatic hyphenation.

Must be one of the following constant values.

ConstantValueDescription
none0 No hyphenation.
normal1 Less frequent hyphenation, useful for informal use cases, such as chat messages.
full2 Standard amount of hyphenation, useful for running text and for screens with limited space for text.

This corresponds to the global attribute resource symbol hyphenationFrequency.

Related methods:

android:imeActionId

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:

android:imeActionLabel

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:

android:imeOptions

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.

ConstantValueDescription
normal0x00000000 There are no special semantics associated with this editor.
actionUnspecified0x00000000 There is no specific action associated with this editor, let the editor come up with its own if it can. Corresponds to IME_NULL.
actionNone0x00000001 This editor has no action associated with it. Corresponds to IME_ACTION_NONE.
actionGo0x00000002 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.
actionSearch0x00000003 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.
actionSend0x00000004 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.
actionNext0x00000005 The action key performs a "next" operation, taking the user to the next field that will accept text. Corresponds to IME_ACTION_NEXT.
actionDone0x00000006 The action key performs a "done" operation, closing the soft input method. Corresponds to IME_ACTION_DONE.
actionPrevious0x00000007 The action key performs a "previous" operation, taking the user to the previous field that will accept text. Corresponds to IME_ACTION_PREVIOUS.
flagNoFullscreen0x2000000 Used to request that the IME never go into fullscreen mode. Applications need to be aware that the flag is not a guarantee, and not all IMEs will respect it.

Corresponds to IME_FLAG_NO_FULLSCREEN.

flagNavigatePrevious0x4000000 Like flagNavigateNext, but specifies there is something interesting that a backward navigation can focus on. If the user selects the IME's facility to backward navigate, this will show up in the application as an actionPrevious at InputConnection.performEditorAction(int).

Corresponds to IME_FLAG_NO_FULLSCREEN.

flagNavigateNext0x8000000 Used to specify that there is something interesting that a forward navigation can focus on. This is like using actionNext, except allows the IME to be multiline (with an enter key) as well as provide forward navigation. Note that some IMEs may not be able to do this, especially when running on a small screen where there is little space. In that case it does not need to present a UI for this option. Like actionNext, if the user selects the IME's facility to forward navigate, this will show up in the application at InputConnection.performEditorAction(int).

Corresponds to IME_FLAG_NAVIGATE_NEXT.

flagNoExtractUi0x10000000 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.

flagNoAccessoryAction0x20000000 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.

flagNoEnterAction0x40000000 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.

flagForceAscii0x80000000 Used to request that the IME should be capable of inputting ASCII characters. The intention of this flag is to ensure that the user can type Roman alphabet characters in a TextView used for, typically, account ID or password input. It is expected that IMEs normally are able to input ASCII even without being told so (such IMEs already respect this flag in a sense), but there could be some cases they aren't when, for instance, only non-ASCII input languagaes like Arabic, Greek, Hebrew, Russian are enabled in the IME. Applications need to be aware that the flag is not a guarantee, and not all IMEs will respect it. However, it is strongly recommended for IME authors to respect this flag especially when their IME could end up with a state that has only non-ASCII input languages enabled.

Corresponds to IME_FLAG_FORCE_ASCII.

This corresponds to the global attribute resource symbol imeOptions.

Related methods:

android:includeFontPadding

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:

android:inputMethod

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:

android:inputType

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.

ConstantValueDescription
none0x00000000 There is no content type. The text is not editable.
text0x00000001 Just plain old text. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_NORMAL.
textCapCharacters0x00001001 Can be combined with text and its variations to request capitalization of all characters. Corresponds to TYPE_TEXT_FLAG_CAP_CHARACTERS.
textCapWords0x00002001 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.
textCapSentences0x00004001 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.
textAutoCorrect0x00008001 Can be combined with text and its variations to request auto-correction of text being input. Corresponds to TYPE_TEXT_FLAG_AUTO_CORRECT.
textAutoComplete0x00010001 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.
textMultiLine0x00020001 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.
textImeMultiLine0x00040001 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.
textNoSuggestions0x00080001 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.
textUri0x00000011 Text that will be used as a URI. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_URI.
textEmailAddress0x00000021 Text that will be used as an e-mail address. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_EMAIL_ADDRESS.
textEmailSubject0x00000031 Text that is being supplied as the subject of an e-mail. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_EMAIL_SUBJECT.
textShortMessage0x00000041 Text that is the content of a short message. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_SHORT_MESSAGE.
textLongMessage0x00000051 Text that is the content of a long message. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_LONG_MESSAGE.
textPersonName0x00000061 Text that is the name of a person. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_PERSON_NAME.
textPostalAddress0x00000071 Text that is being supplied as a postal mailing address. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_POSTAL_ADDRESS.
textPassword0x00000081 Text that is a password. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_PASSWORD.
textVisiblePassword0x00000091 Text that is a password that should be visible. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_VISIBLE_PASSWORD.
textWebEditText0x000000a1 Text that is being supplied as text in a web form. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_WEB_EDIT_TEXT.
textFilter0x000000b1 Text that is filtering some other data. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_FILTER.
textPhonetic0x000000c1 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.
textWebEmailAddress0x000000d1 Text that will be used as an e-mail address on a web form. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_WEB_EMAIL_ADDRESS.
textWebPassword0x000000e1 Text that will be used as a password on a web form. Corresponds to TYPE_CLASS_TEXT | TYPE_TEXT_VARIATION_WEB_PASSWORD.
number0x00000002 A numeric only field. Corresponds to TYPE_CLASS_NUMBER | TYPE_NUMBER_VARIATION_NORMAL.
numberSigned0x00001002 Can be combined with number and its other options to allow a signed number. Corresponds to TYPE_CLASS_NUMBER | TYPE_NUMBER_FLAG_SIGNED.
numberDecimal0x00002002 Can be combined with number and its other options to allow a decimal (fractional) number. Corresponds to TYPE_CLASS_NUMBER | TYPE_NUMBER_FLAG_DECIMAL.
numberPassword0x00000012 A numeric password field. Corresponds to TYPE_CLASS_NUMBER | TYPE_NUMBER_VARIATION_PASSWORD.
phone0x00000003 For entering a phone number. Corresponds to TYPE_CLASS_PHONE.
datetime0x00000004 For entering a date and time. Corresponds to TYPE_CLASS_DATETIME | TYPE_DATETIME_VARIATION_NORMAL.
date0x00000014 For entering a date. Corresponds to TYPE_CLASS_DATETIME | TYPE_DATETIME_VARIATION_DATE.
time0x00000024 For entering a time. Corresponds to TYPE_CLASS_DATETIME | TYPE_DATETIME_VARIATION_TIME.

This corresponds to the global attribute resource symbol inputType.

Related methods:

android:letterSpacing

Text letter-spacing.

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 letterSpacing.

Related methods:

android:lineSpacingExtra

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:

android:lineSpacingMultiplier

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:

android:lines

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:

android:linksClickable

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:

android:marqueeRepeatLimit

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.

ConstantValueDescription
marquee_forever-1 Indicates that marquee should repeat indefinitely.

This corresponds to the global attribute resource symbol marqueeRepeatLimit.

Related methods:

android:maxEms

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:

android:maxHeight

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:

android:maxLength

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:

android:maxLines

Makes the TextView be at most this many lines tall. When used on an editable text, the inputType attribute's value must be combined with the textMultiLine flag for the maxLines attribute to apply.

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:

android:maxWidth

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:

android:minEms

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:

android:minHeight

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:

android:minLines

Makes the TextView be at least this many lines tall. When used on an editable text, the inputType attribute's value must be combined with the textMultiLine flag for the minLines attribute to apply.

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:

android:minWidth

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:

android:numeric

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.

ConstantValueDescription
integer0x01 Input is numeric.
signed0x03 Input is numeric, with sign allowed.
decimal0x05 Input is numeric, with decimals allowed.

This corresponds to the global attribute resource symbol numeric.

Related methods:

android:password

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:

android:phoneNumber

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:

android:privateImeOptions

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:

android:scrollHorizontally

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:

android:selectAllOnFocus

If the text is selectable, select it all when the view takes focus.

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:

android:shadowColor

Place a blurred shadow of text underneath the text, drawn with the specified color. The text shadow produced does not interact with properties on View that are responsible for real time shadows, elevation and translationZ.

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:

android:shadowDx

Horizontal offset of the text 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:

android:shadowDy

Vertical offset of the text 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:

android:shadowRadius

Blur radius of the text 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:

android:singleLine

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. The default value is false (multi-line wrapped text mode) for non-editable text, but if you specify any value for inputType, the default is true (single-line input field mode).

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:

android:text

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:

android:textAllCaps

Present the text in ALL CAPS. This may use a small-caps form when available.

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 textAllCaps.

Related methods:

android:textAppearance

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.

Related methods:

android:textColor

Text color.

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 textColor.

Related methods:

android:textColorHighlight

Color of the text selection highlight.

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 textColorHighlight.

Related methods:

android:textColorHint

Color of the hint 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 textColorHint.

Related methods:

android:textColorLink

Text color for links.

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 textColorLink.

Related methods:

android:textIsSelectable

Indicates that the content of a non-editable text can be selected.

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 textIsSelectable.

Related methods:

android:textScaleX

Sets the horizontal scaling factor for the text.

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 textScaleX.

Related methods:

android:textSize

Size of the text. Recommended dimension type for text is "sp" for scaled-pixels (example: 15sp).

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 textSize.

Related methods:

android:textStyle

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

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

ConstantValueDescription
normal0
bold1
italic2

This corresponds to the global attribute resource symbol textStyle.

Related methods:

android:typeface

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

Must be one of the following constant values.

ConstantValueDescription
normal0
sans1
serif2
monospace3

This corresponds to the global attribute resource symbol typeface.

Related methods:

android:width

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:

Public constructors

TextView

Added in API level 1
TextView (Context context)

Parameters
context Context

TextView

Added in API level 1
TextView (Context context, 
                AttributeSet attrs)

Parameters
context Context
attrs AttributeSet

TextView

Added in API level 1
TextView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr)

Parameters
context Context
attrs AttributeSet
defStyleAttr int

TextView

Added in API level 21
TextView (Context context, 
                AttributeSet attrs, 
                int defStyleAttr, 
                int defStyleRes)

Parameters
context Context
attrs AttributeSet
defStyleAttr int
defStyleRes int

Public methods

addTextChangedListener

Added in API level 1
void addTextChangedListener (TextWatcher watcher)

Adds a TextWatcher to the list of those whose methods are called whenever this TextView's text changes.

In 1.0, the afterTextChanged(Editable) method was erroneously not called after setText(char[], int, int) calls. Now, doing setText(char[], int, int) if there are any text changed listeners forces the buffer type to Editable if it would not otherwise be and does call this method.

Parameters
watcher TextWatcher

append

Added in API level 1
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.

Parameters
text CharSequence

append

Added in API level 1
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.

Parameters
text CharSequence
start int
end int

beginBatchEdit

Added in API level 3
void beginBatchEdit ()

bringPointIntoView

Added in API level 3
boolean bringPointIntoView (int offset)

Move the point, specified by the offset, into the view if it is needed. This has to be called after layout. Returns true if anything changed.

Parameters
offset int
Returns
boolean

cancelLongPress

Added in API level 1
void cancelLongPress ()

Cancels a pending long press. Your subclass can use this if you want the context menu to come up if the user presses and holds at the same place, but you don't want it to come up if they press and then move around enough to cause scrolling.

clearComposingText

Added in API level 3
void clearComposingText ()

Use BaseInputConnection.removeComposingSpans() to remove any IME composing state from this text view.

computeScroll

Added in API level 1
void computeScroll ()

Called by a parent to request that a child update its values for mScrollX and mScrollY if necessary. This will typically be done if the child is animating a scroll using a Scroller object.

debug

Added in API level 1
void debug (int depth)

Prints information about this view in the log output, with the tag VIEW_LOG_TAG. Each line in the output is preceded with an indentation defined by the depth.

Parameters
depth int: the indentation level

didTouchFocusSelect

Added in API level 3
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. Only valid while processing the touch gesture of interest, in an editable text view.

Returns
boolean

drawableHotspotChanged

Added in API level 21
void drawableHotspotChanged (float x, 
                float y)

This function is called whenever the view hotspot changes and needs to be propagated to drawables or child views managed by the view.

Dispatching to child views is handled by dispatchDrawableHotspotChanged(float, float).

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

Parameters
x float: hotspot x coordinate
y float: hotspot y coordinate

endBatchEdit

Added in API level 3
void endBatchEdit ()

extractText

Added in API level 3
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.

Parameters
request ExtractedTextRequest
outText ExtractedText
Returns
boolean Returns true if the text was successfully extracted, else false.

findViewsWithText

Added in API level 14
void findViewsWithText (ArrayList<View> outViews, 
                CharSequence searched, 
                int flags)

Finds the Views that contain given text. The containment is case insensitive. The search is performed by either the text that the View renders or the content description that describes the view for accessibility purposes and the view does not render or both. Clients can specify how the search is to be performed via passing the FIND_VIEWS_WITH_TEXT and FIND_VIEWS_WITH_CONTENT_DESCRIPTION flags.

Parameters
outViews ArrayList: The output list of matching Views.
searched CharSequence: The text to match against.
flags int

getAccessibilityClassName

Added in API level 23
CharSequence getAccessibilityClassName ()

Return the class name of this object to be used for accessibility purposes. Subclasses should only override this if they are implementing something that should be seen as a completely new class of view when used by accessibility, unrelated to the class it is deriving from. This is used to fill in AccessibilityNodeInfo.setClassName.

Returns
CharSequence

getAutoLinkMask

Added in API level 1
int getAutoLinkMask ()

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

Related XML Attributes:

Returns
int

getBaseline

Added in API level 1
int getBaseline ()

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
int the offset of the baseline within the widget's bounds or -1 if baseline alignment is not supported

getBreakStrategy

Added in API level 23
int getBreakStrategy ()

Related XML Attributes:

Returns
int the currently set break strategy.

See also:

getCompoundDrawablePadding

Added in API level 1
int getCompoundDrawablePadding ()

Returns the padding between the compound drawables and the text.

Related XML Attributes:

Returns
int

getCompoundDrawableTintList

Added in API level 23
ColorStateList getCompoundDrawableTintList ()

Related XML Attributes:

Returns
ColorStateList the tint applied to the compound drawables

See also:

getCompoundDrawableTintMode

Added in API level 23
PorterDuff.Mode getCompoundDrawableTintMode ()

Returns the blending mode used to apply the tint to the compound drawables, if specified.

Related XML Attributes:

Returns
PorterDuff.Mode the blending mode used to apply the tint to the compound drawables

See also:

getCompoundDrawables

Added in API level 1
Drawable[] getCompoundDrawables ()

Returns drawables for the left, top, right, and bottom borders.

Related XML Attributes:

Returns
Drawable[]

getCompoundDrawablesRelative

Added in API level 17
Drawable[] getCompoundDrawablesRelative ()

Returns drawables for the start, top, end, and bottom borders.

Related XML Attributes:

Returns
Drawable[]

getCompoundPaddingBottom

Added in API level 1
int getCompoundPaddingBottom ()

Returns the bottom padding of the view, plus space for the bottom Drawable if any.

Returns
int

getCompoundPaddingEnd

Added in API level 17
int getCompoundPaddingEnd ()

Returns the end padding of the view, plus space for the end Drawable if any.

Returns
int

getCompoundPaddingLeft

Added in API level 1
int getCompoundPaddingLeft ()

Returns the left padding of the view, plus space for the left Drawable if any.

Returns
int

getCompoundPaddingRight

Added in API level 1
int getCompoundPaddingRight ()

Returns the right padding of the view, plus space for the right Drawable if any.

Returns
int

getCompoundPaddingStart

Added in API level 17
int getCompoundPaddingStart ()

Returns the start padding of the view, plus space for the start Drawable if any.

Returns
int

getCompoundPaddingTop

Added in API level 1
int getCompoundPaddingTop ()

Returns the top padding of the view, plus space for the top Drawable if any.

Returns
int

getCurrentHintTextColor

Added in API level 1
int getCurrentHintTextColor ()

Return the current color selected to paint the hint text.

Returns
int Returns the current hint text color.

getCurrentTextColor

Added in API level 1
int getCurrentTextColor ()

Return the current color selected for normal text.

Returns
int Returns the current text color.

getCustomInsertionActionModeCallback

Added in API level 23
ActionMode.Callback getCustomInsertionActionModeCallback ()

Retrieves the value set in setCustomInsertionActionModeCallback(ActionMode.Callback). Default is null.

Returns
ActionMode.Callback The current custom insertion callback.

getCustomSelectionActionModeCallback

Added in API level 11
ActionMode.Callback getCustomSelectionActionModeCallback ()

Retrieves the value set in setCustomSelectionActionModeCallback(ActionMode.Callback). Default is null.

Returns
ActionMode.Callback The current custom selection callback.

getEditableText

Added in API level 3
Editable getEditableText ()

Return the text the TextView is displaying as an Editable object. If the text is not editable, null is returned.

Returns
Editable

See also:

getEllipsize

Added in API level 1
TextUtils.TruncateAt getEllipsize ()

Returns where, if anywhere, words that are longer than the view is wide should be ellipsized.

Returns
TextUtils.TruncateAt

getError

Added in API level 1
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.

Returns
CharSequence

getExtendedPaddingBottom

Added in API level 1
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. It is only valid to call this after measuring.

Returns
int

getExtendedPaddingTop

Added in API level 1
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. It is only valid to call this after measuring.

Returns
int

getFilters

Added in API level 1
InputFilter[] getFilters ()

Returns the current list of input filters.

Related XML Attributes:

Returns
InputFilter[]

getFocusedRect

Added in API level 1
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. By default, the rectangle is the getDrawingRect(android.graphics.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 Rect: The rectangle to fill in, in this view's coordinates.

getFontFeatureSettings

Added in API level 21
String getFontFeatureSettings ()

Returns the font feature settings. The format is the same as the CSS font-feature-settings attribute: http://dev.w3.org/csswg/css-fonts/#propdef-font-feature-settings

Returns
String the currently set font feature settings. Default is null.

See also:

getFreezesText

Added in API level 1
boolean getFreezesText ()

Return whether this text view is including its entire text contents in frozen icicles. For EditText it always returns true.

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

See also:

getGravity

Added in API level 1
int getGravity ()

Returns the horizontal and vertical alignment of this TextView.

Related XML Attributes:

Returns
int

See also:

getHighlightColor

Added in API level 16
int getHighlightColor ()

Related XML Attributes:

Returns
int the color used to display the selection highlight

See also:

getHint

Added in API level 1
CharSequence getHint ()

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

Related XML Attributes:

Returns
CharSequence

getHintTextColors

Added in API level 1
ColorStateList getHintTextColors ()

Related XML Attributes:

Returns
ColorStateList the color of the hint text, for the different states of this TextView.

See also:

getHyphenationFrequency

Added in API level 23
int getHyphenationFrequency ()

Related XML Attributes:

Returns
int the currently set hyphenation frequency.

See also:

getImeActionId

Added in API level 3
int getImeActionId ()

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

Returns
int

See also:

getImeActionLabel

Added in API level 3
CharSequence getImeActionLabel ()

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

Returns
CharSequence

See also:

getImeHintLocales

Added in API level 24
LocaleList getImeHintLocales ()

Returns
LocaleList The current languages list "hint". null when no "hint" is available.

See also:

getImeOptions

Added in API level 3
int getImeOptions ()

Get the type of the IME editor.

Returns
int

See also:

getIncludeFontPadding

Added in API level 16
boolean getIncludeFontPadding ()

Gets whether the TextView includes extra top and bottom padding to make room for accents that go above the normal ascent and descent.

Related XML Attributes:

Returns
boolean

See also:

getInputExtras

Added in API level 3
Bundle getInputExtras (boolean create)

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

Related XML Attributes:

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

See also:

getInputType

Added in API level 3
int getInputType ()

Get the type of the editable content.

Returns
int

See also:

getKeyListener

Added in API level 1
KeyListener getKeyListener ()

Related XML Attributes:

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

getLayout

Added in API level 1
Layout getLayout ()

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

getLetterSpacing

Added in API level 21
float getLetterSpacing ()

Returns
float the extent by which text is currently being letter-spaced. This will normally be 0.

See also:

getLineBounds

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

Parameters
line int: which line to examine (0..getLineCount() - 1)
bounds Rect: Optional. If not null, it returns the extent of the line
Returns
int the Y-coordinate of the baseline

getLineCount

Added in API level 1
int getLineCount ()

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

Returns
int

getLineHeight

Added in API level 1
int getLineHeight ()

Returns
int 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.

getLineSpacingExtra

Added in API level 16
float getLineSpacingExtra ()

Gets the line spacing extra space

Related XML Attributes:

Returns
float the extra space that is added to the height of each lines of this TextView.

See also:

getLineSpacingMultiplier

Added in API level 16
float getLineSpacingMultiplier ()

Gets the line spacing multiplier

Related XML Attributes:

Returns
float the value by which each line's height is multiplied to get its actual height.

See also:

getLinkTextColors

Added in API level 1
ColorStateList getLinkTextColors ()

Related XML Attributes:

Returns
ColorStateList the list of colors used to paint the links in the text, for the different states of this TextView

See also:

getLinksClickable

Added in API level 1
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). The default is true.

Related XML Attributes:

Returns
boolean

getMarqueeRepeatLimit

Added in API level 16
int getMarqueeRepeatLimit ()

Gets the number of times the marquee animation is repeated. Only meaningful if the TextView has marquee enabled.

Related XML Attributes:

Returns
int the number of times the marquee animation is repeated. -1 if the animation repeats indefinitely

See also:

getMaxEms

Added in API level 16
int getMaxEms ()

Related XML Attributes:

Returns
int the maximum width of the TextView, expressed in ems or -1 if the maximum width was set in pixels instead (using setMaxWidth(int) or setWidth(int)).

See also:

getMaxHeight

Added in API level 16
int getMaxHeight ()

Related XML Attributes:

Returns
int the maximum height of this TextView expressed in pixels, or -1 if the maximum height was set in number of lines instead using or #setLines(int).

See also:

getMaxLines

Added in API level 16
int getMaxLines ()

Related XML Attributes:

Returns
int the maximum number of lines displayed in this TextView, or -1 if the maximum height was set in pixels instead using or #setHeight(int).

See also:

getMaxWidth

Added in API level 16
int getMaxWidth ()

Related XML Attributes:

Returns
int the maximum width of the TextView, in pixels or -1 if the maximum width was set in ems instead (using setMaxEms(int) or setEms(int)).

See also:

getMinEms

Added in API level 16
int getMinEms ()

Related XML Attributes:

Returns
int the minimum width of the TextView, expressed in ems or -1 if the minimum width was set in pixels instead (using setMinWidth(int) or setWidth(int)).

See also:

getMinHeight

Added in API level 16
int getMinHeight ()

Related XML Attributes:

Returns
int the minimum height of this TextView expressed in pixels, or -1 if the minimum height was set in number of lines instead using or #setLines(int).

See also:

getMinLines

Added in API level 16
int getMinLines ()

Related XML Attributes:

Returns
int the minimum number of lines displayed in this TextView, or -1 if the minimum height was set in pixels instead using or #setHeight(int).

See also:

getMinWidth

Added in API level 16
int getMinWidth ()

Related XML Attributes:

Returns
int the minimum width of the TextView, in pixels or -1 if the minimum width was set in ems instead (using setMinEms(int) or setEms(int)).

See also:

getMovementMethod

Added in API level 1
MovementMethod getMovementMethod ()

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

getOffsetForPosition

Added in API level 14
int getOffsetForPosition (float x, 
                float y)

Get the character offset closest to the specified absolute position. A typical use case is to pass the result of getX() and getY() to this method.

Parameters
x float: The horizontal absolute position of a point on screen
y float: The vertical absolute position of a point on screen
Returns
int the character offset for the character whose position is closest to the specified position. Returns -1 if there is no layout.

getPaint

Added in API level 1
TextPaint getPaint ()

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

getPaintFlags

Added in API level 1
int getPaintFlags ()

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

See also:

getPrivateImeOptions

Added in API level 3
String getPrivateImeOptions ()

Get the private type of the content.

Returns
String

See also:

getSelectionEnd

Added in API level 1
int getSelectionEnd ()

Convenience for getSelectionEnd(CharSequence).

Returns
int

getSelectionStart

Added in API level 1
int getSelectionStart ()

Convenience for getSelectionStart(CharSequence).

Returns
int

getShadowColor

Added in API level 16
int getShadowColor ()

Related XML Attributes:

Returns
int the color of the shadow layer

See also:

getShadowDx

Added in API level 16
float getShadowDx ()

Related XML Attributes:

Returns
float the horizontal offset of the shadow layer

See also:

getShadowDy

Added in API level 16
float getShadowDy ()

Related XML Attributes:

Returns
float the vertical offset of the shadow layer

See also:

getShadowRadius

Added in API level 16
float getShadowRadius ()

Gets the radius of the shadow layer.

Related XML Attributes:

Returns
float the radius of the shadow layer. If 0, the shadow layer is not visible

See also:

getShowSoftInputOnFocus

Added in API level 21
boolean getShowSoftInputOnFocus ()

Returns whether the soft input method will be made visible when this TextView gets focused. The default is true.

Returns
boolean

getText

Added in API level 1
CharSequence getText ()

Return the text the TextView is displaying. If setText() was called with an argument of BufferType.SPANNABLE or BufferType.EDITABLE, you can cast the return value from this method to Spannable or Editable, respectively. Note: The content of the return value should not be modified. If you want a modifiable one, you should make your own copy first.

Related XML Attributes:

Returns
CharSequence

getTextColors

Added in API level 1
ColorStateList getTextColors ()

Gets the text colors for the different states (normal, selected, focused) of the TextView.

Related XML Attributes:

Returns
ColorStateList

See also:

getTextLocale

Added in API level 17
Locale getTextLocale ()

Get the default primary Locale of the text in this TextView. This will always be the first member of getTextLocales().

Returns
Locale the default primary Locale of the text in this TextView.

getTextLocales

Added in API level 24
LocaleList getTextLocales ()

Get the default LocaleList of the text in this TextView.

Returns
LocaleList the default LocaleList of the text in this TextView.

getTextScaleX

Added in API level 1
float getTextScaleX ()

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

getTextSize

Added in API level 1
float getTextSize ()

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

getTotalPaddingBottom

Added in API level 1
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.

Returns
int

getTotalPaddingEnd

Added in API level 17
int getTotalPaddingEnd ()

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

Returns
int

getTotalPaddingLeft

Added in API level 1
int getTotalPaddingLeft ()

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

Returns
int

getTotalPaddingRight

Added in API level 1
int getTotalPaddingRight ()

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

Returns
int

getTotalPaddingStart

Added in API level 17
int getTotalPaddingStart ()

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

Returns
int

getTotalPaddingTop

Added in API level 1
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.

Returns
int

getTransformationMethod

Added in API level 1
TransformationMethod getTransformationMethod ()

Related XML Attributes:

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

getTypeface

Added in API level 1
Typeface getTypeface ()

Related XML Attributes:

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

See also:

getUrls

Added in API level 1
URLSpan[] getUrls ()

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.

Returns
URLSpan[]

hasOverlappingRendering

Added in API level 16
boolean hasOverlappingRendering ()

Returns whether this View has content which overlaps.

This function, intended to be overridden by specific View types, is an optimization when alpha is set on a view. If rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer and then composited into place, which can be expensive. If the view has no overlapping rendering, the view can draw each primitive with the appropriate alpha value directly. An example of overlapping rendering is a TextView with a background image, such as a Button. An example of non-overlapping rendering is a TextView with no background, or an ImageView with only the foreground image. The default implementation returns true; subclasses should override if they have cases which can be optimized.

The current implementation of the saveLayer and saveLayerAlpha methods in Canvas necessitates that a View return true if it uses the methods internally without passing the CLIP_TO_LAYER_SAVE_FLAG.

Note: The return value of this method is ignored if forceHasOverlappingRendering(boolean) has been called on this view.

Returns
boolean true if the content in this view might overlap, false otherwise.

hasSelection

Added in API level 1
boolean hasSelection ()

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

Returns
boolean

invalidateDrawable

Added in API level 1
void invalidateDrawable (Drawable drawable)

Invalidates the specified Drawable.

Parameters
drawable Drawable: the drawable to invalidate

isCursorVisible

Added in API level 16
boolean isCursorVisible ()

Related XML Attributes:

Returns
boolean whether or not the cursor is visible (assuming this TextView is editable)

See also:

isInputMethodTarget

Added in API level 3
boolean isInputMethodTarget ()

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

Returns
boolean

isSuggestionsEnabled

Added in API level 14
boolean isSuggestionsEnabled ()

Return whether or not suggestions are enabled on this TextView. The suggestions are generated by the IME or by the spell checker as the user types. This is done by adding SuggestionSpans to the text. When suggestions are enabled (default), this list of suggestions will be displayed when the user asks for them on these parts of the text. This value depends on the inputType of this TextView. The class of the input type must be TYPE_CLASS_TEXT. In addition, the type variation must be one of TYPE_TEXT_VARIATION_NORMAL, TYPE_TEXT_VARIATION_EMAIL_SUBJECT, TYPE_TEXT_VARIATION_LONG_MESSAGE, TYPE_TEXT_VARIATION_SHORT_MESSAGE or TYPE_TEXT_VARIATION_WEB_EDIT_TEXT. And finally, the TYPE_TEXT_FLAG_NO_SUGGESTIONS flag must not be set.

Returns
boolean true if the suggestions popup window is enabled, based on the inputType.

isTextSelectable

Added in API level 11
boolean isTextSelectable ()

Returns the state of the textIsSelectable flag (See setTextIsSelectable()). Although you have to set this flag to allow users to select and copy text in a non-editable TextView, the content of an EditText can always be selected, independently of the value of this flag.

Related XML Attributes:

Returns
boolean True if the text displayed in this TextView can be selected by the user.

jumpDrawablesToCurrentState

Added in API level 11
void jumpDrawablesToCurrentState ()

Call Drawable.jumpToCurrentState() on all Drawable objects associated with this view.

Also calls jumpToCurrentState() if there is a StateListAnimator attached to this view.

length

Added in API level 1
int length ()

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

Returns
int

moveCursorToVisibleOffset

Added in API level 3
boolean moveCursorToVisibleOffset ()

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
boolean True if the cursor was actually moved, false otherwise.

onBeginBatchEdit

Added in API level 3
void onBeginBatchEdit ()

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

onCheckIsTextEditor

Added in API level 3
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. 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
boolean Returns true if this view is a text editor, else false.

onCommitCompletion

Added in API level 3
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(). The default implementation does nothing; text views that are supporting auto-completion should override this to do their desired behavior.

Parameters
text CompletionInfo: The auto complete text the user has selected.

onCommitCorrection

Added in API level 11
void onCommitCorrection (CorrectionInfo info)

Called by the framework in response to a text auto-correction (such as fixing a typo using a a dictionnary) from the current input method, provided by it calling commitCorrection(CorrectionInfo) InputConnection.commitCorrection()}. The default implementation flashes the background of the corrected word to provide feedback to the user.

Parameters
info CorrectionInfo: The auto correct info about the text that was corrected.

onCreateInputConnection

Added in API level 3
InputConnection onCreateInputConnection (EditorInfo outAttrs)

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.

Also, take good care to fill in the EditorInfo object correctly and in its entirety, so that the connected IME can rely on its values. For example, initialSelStart and initialSelEnd members must be filled in with the correct cursor position for IMEs to work correctly with your application.

Parameters
outAttrs EditorInfo: Fill in with attribute information about the connection.
Returns
InputConnection

onDragEvent

Added in API level 11
boolean onDragEvent (DragEvent event)

Handles drag events sent by the system following a call to startDragAndDrop().

When the system calls this method, it passes a DragEvent object. A call to getAction() returns one of the action type constants defined in DragEvent. The method uses these to determine what is happening in the drag and drop operation.

Parameters
event DragEvent: The DragEvent sent by the system. The getAction() method returns an action type constant defined in DragEvent, indicating the type of drag event represented by this object.
Returns
boolean true if the method was successful, otherwise false.

The method should return true in response to an action type of ACTION_DRAG_STARTED to receive drag events for the current operation.

The method should also return true in response to an action type of ACTION_DROP if it consumed the drop, or false if it didn't.

onEditorAction

Added in API level 3
void onEditorAction (int actionCode)

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, EditorInfo.IME_ACTION_PREVIOUS, 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 int: The code of the action being performed.

See also:

onEndBatchEdit

Added in API level 3
void onEndBatchEdit ()

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

onGenericMotionEvent

Added in API level 12
boolean onGenericMotionEvent (MotionEvent event)

Implement this method to handle generic motion events.

Generic motion events describe joystick movements, mouse hovers, track pad touches, scroll wheel movements and other input events. The source of the motion event specifies the class of input that was received. Implementations of this method must examine the bits in the source before processing the event. The following code example shows how this is done.

Generic motion events with source class SOURCE_CLASS_POINTER are delivered to the view under the pointer. All other generic motion events are delivered to the focused view.

 public boolean onGenericMotionEvent(MotionEvent event) {
     if (event.isFromSource(InputDevice.SOURCE_CLASS_JOYSTICK)) {
         if (event.getAction() == MotionEvent.ACTION_MOVE) {
             // process the joystick movement...
             return true;
         }
     }
     if (event.isFromSource(InputDevice.SOURCE_CLASS_POINTER)) {
         switch (event.getAction()) {
             case MotionEvent.ACTION_HOVER_MOVE:
                 // process the mouse hover movement...
                 return true;
             case MotionEvent.ACTION_SCROLL:
                 // process the scroll wheel movement...
                 return true;
         }
     }
     return super.onGenericMotionEvent(event);
 }

Parameters
event MotionEvent: The generic motion event being processed.
Returns
boolean True if the event was handled, false otherwise.

onKeyDown

Added in API level 1
boolean onKeyDown (int keyCode, 
                KeyEvent event)

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

Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.

Parameters
keyCode int: a key code that represents the button pressed, from KeyEvent
event KeyEvent: the KeyEvent object that defines the button action
Returns
boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyMultiple

Added in API level 1
boolean onKeyMultiple (int keyCode, 
                int repeatCount, 
                KeyEvent event)

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

Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.

Parameters
keyCode int: A key code that represents the button pressed, from KeyEvent.
repeatCount int: The number of times the action was made.
event KeyEvent: The KeyEvent object that defines the button action.
Returns
boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyPreIme

Added in API level 3
boolean onKeyPreIme (int keyCode, 
                KeyEvent event)

Handle a key event before it is processed by any input method associated with the view hierarchy. This can be used to intercept key events in special situations before the IME consumes them; a typical example would be handling the BACK key to update the application's UI instead of allowing the IME to see it and close itself.

Parameters
keyCode int: The value in event.getKeyCode().
event KeyEvent: Description of the key event.
Returns
boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyShortcut

Added in API level 1
boolean onKeyShortcut (int keyCode, 
                KeyEvent event)

Called on the focused view when a key shortcut event is not handled. Override this method to implement local key shortcuts for the View. Key shortcuts can also be implemented by setting the shortcut property of menu items.

Parameters
keyCode int: The value in event.getKeyCode().
event KeyEvent: Description of the key event.
Returns
boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onKeyUp

Added in API level 1
boolean onKeyUp (int keyCode, 
                KeyEvent event)

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

Key presses in software keyboards will generally NOT trigger this listener, although some may elect to do so in some situations. Do not rely on this to catch software key presses.

Parameters
keyCode int: A key code that represents the button pressed, from KeyEvent.
event KeyEvent: The KeyEvent object that defines the button action.
Returns
boolean If you handled the event, return true. If you want to allow the event to be handled by the next receiver, return false.

onPreDraw

Added in API level 1
boolean onPreDraw ()

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
boolean Return true to proceed with the current drawing pass, or false to cancel.

onPrivateIMECommand

Added in API level 3
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().

Parameters
action String: The action name of the command.
data Bundle: Any additional data for the command. This may be null.
Returns
boolean Return true if you handled the command, else false.

onProvideStructure

Added in API level 23
void onProvideStructure (ViewStructure structure)

Called when assist structure is being retrieved from a view as part of Activity.onProvideAssistData.

Parameters
structure ViewStructure: Fill in with structured view data. The default implementation fills in all data that can be inferred from the view itself.

onResolvePointerIcon

Added in API level 24
PointerIcon onResolvePointerIcon (MotionEvent event, 
                int pointerIndex)

Returns the pointer icon for the motion event, or null if it doesn't specify the icon. The default implementation does not care the location or event types, but some subclasses may use it (such as WebViews).

Parameters
event MotionEvent: The MotionEvent from a mouse
pointerIndex int: The index of the pointer for which to retrieve the PointerIcon. This will be between 0 and getPointerCount().
Returns
PointerIcon

onRestoreInstanceState

Added in API level 1
void onRestoreInstanceState (Parcelable state)

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 Parcelable: The frozen state that had previously been returned by onSaveInstanceState().

onRtlPropertiesChanged

Added in API level 17
void onRtlPropertiesChanged (int layoutDirection)

Called when any RTL property (layout direction or text direction or text alignment) has been changed. Subclasses need to override this method to take care of cached information that depends on the resolved layout direction, or to inform child views that inherit their layout direction. The default implementation does nothing.

Parameters
layoutDirection int: the direction of the layout

onSaveInstanceState

Added in API level 1
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. 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
Parcelable 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.

onScreenStateChanged

Added in API level 16
void onScreenStateChanged (int screenState)

This method is called whenever the state of the screen this view is attached to changes. A state change will usually occurs when the screen turns on or off (whether it happens automatically or the user does it manually.)

Parameters
screenState int: The new state of the screen. Can be either SCREEN_STATE_ON or SCREEN_STATE_OFF

onTextContextMenuItem

Added in API level 3
boolean onTextContextMenuItem (int id)

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

Parameters
id int
Returns
boolean true if the context menu item action was performed.

onTouchEvent

Added in API level 1
boolean onTouchEvent (MotionEvent event)

Implement this method to handle touch screen motion events.

If this method is used to detect click actions, it is recommended that the actions be performed by implementing and calling performClick(). This will ensure consistent system behavior, including:

  • obeying click sound preferences
  • dispatching OnClickListener calls
  • handling ACTION_CLICK when accessibility features are enabled

Parameters
event MotionEvent: The motion event.
Returns
boolean True if the event was handled, false otherwise.

onTrackballEvent

Added in API level 1
boolean onTrackballEvent (MotionEvent event)

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 MotionEvent: The motion event.
Returns
boolean True if the event was handled, false otherwise.

onWindowFocusChanged

Added in API level 1
void onWindowFocusChanged (boolean hasWindowFocus)

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 boolean: True if the window containing this view now has focus, false otherwise.

performLongClick

Added in API level 1
boolean performLongClick ()

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

Returns
boolean true if one of the above receivers consumed the event, false otherwise

removeTextChangedListener

Added in API level 1
void removeTextChangedListener (TextWatcher watcher)

Removes the specified TextWatcher from the list of those whose methods are called whenever this TextView's text changes.

Parameters
watcher TextWatcher

setAllCaps

Added in API level 14
void setAllCaps (boolean allCaps)

Sets the properties of this field to transform input to ALL CAPS display. This may use a "small caps" formatting if available. This setting will be ignored if this field is editable or selectable. This call replaces the current transformation method. Disabling this will not necessarily restore the previous behavior from before this was enabled.

Related XML Attributes:

Parameters
allCaps boolean

See also:

setAutoLinkMask

Added in API level 1
void setAutoLinkMask (int mask)

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

Related XML Attributes:

Parameters
mask int

setBreakStrategy

Added in API level 23
void setBreakStrategy (int breakStrategy)

Sets the break strategy for breaking paragraphs into lines. The default value for TextView is BREAK_STRATEGY_HIGH_QUALITY, and the default value for EditText is BREAK_STRATEGY_SIMPLE, the latter to avoid the text "dancing" when being edited.

Related XML Attributes:

Parameters
breakStrategy int

See also:

setCompoundDrawablePadding

Added in API level 1
void setCompoundDrawablePadding (int pad)

Sets the size of the padding between the compound drawables and the text.

Related XML Attributes:

Parameters
pad int

setCompoundDrawableTintList

Added in API level 23
void setCompoundDrawableTintList (ColorStateList tint)

Applies a tint to the compound drawables. Does not modify the current tint mode, which is SRC_IN by default.

Subsequent calls to setCompoundDrawables(Drawable, Drawable, Drawable, Drawable) and related methods will automatically mutate the drawables and apply the specified tint and tint mode using setTintList(ColorStateList).

Related XML Attributes:

Parameters
tint ColorStateList: the tint to apply, may be null to clear tint

See also:

setCompoundDrawableTintMode

Added in API level 23
void setCompoundDrawableTintMode (PorterDuff.Mode tintMode)

Specifies the blending mode used to apply the tint specified by setCompoundDrawableTintList(ColorStateList) to the compound drawables. The default mode is SRC_IN.

Related XML Attributes:

Parameters
tintMode PorterDuff.Mode: the blending mode used to apply the tint, may be null to clear tint

See also:

setCompoundDrawables

Added in API level 1
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. Use null if you do not want a Drawable there. The Drawables must already have had setBounds(Rect) called.

Calling this method will overwrite any Drawables previously set using setCompoundDrawablesRelative(Drawable, Drawable, Drawable, Drawable) or related methods.

Related XML Attributes:

Parameters
left Drawable
top Drawable
right Drawable
bottom Drawable

setCompoundDrawablesRelative

Added in API level 17
void setCompoundDrawablesRelative (Drawable start, 
                Drawable top, 
                Drawable end, 
                Drawable bottom)

Sets the Drawables (if any) to appear to the start of, above, to the end of, and below the text. Use null if you do not want a Drawable there. The Drawables must already have had setBounds(Rect) called.

Calling this method will overwrite any Drawables previously set using setCompoundDrawables(Drawable, Drawable, Drawable, Drawable) or related methods.

Related XML Attributes:

Parameters
start Drawable
top Drawable
end Drawable
bottom Drawable

setCompoundDrawablesRelativeWithIntrinsicBounds

Added in API level 17
void setCompoundDrawablesRelativeWithIntrinsicBounds (Drawable start, 
                Drawable top, 
                Drawable end, 
                Drawable bottom)

Sets the Drawables (if any) to appear to the start of, above, to the end of, and below the text. Use null if you do not want a Drawable there. The Drawables' bounds will be set to their intrinsic bounds.

Calling this method will overwrite any Drawables previously set using setCompoundDrawables(Drawable, Drawable, Drawable, Drawable) or related methods.

Related XML Attributes:

Parameters
start Drawable
top Drawable
end Drawable
bottom Drawable

setCompoundDrawablesRelativeWithIntrinsicBounds

Added in API level 17
void setCompoundDrawablesRelativeWithIntrinsicBounds (int start, 
                int top, 
                int end, 
                int bottom)

Sets the Drawables (if any) to appear to the start of, above, to the end of, and below the text. Use 0 if you do not want a Drawable there. The Drawables' bounds will be set to their intrinsic bounds.

Calling this method will overwrite any Drawables previously set using setCompoundDrawables(Drawable, Drawable, Drawable, Drawable) or related methods.

Related XML Attributes:

Parameters
start int: Resource identifier of the start Drawable.
top int: Resource identifier of the top Drawable.
end int: Resource identifier of the end Drawable.
bottom int: Resource identifier of the bottom Drawable.

setCompoundDrawablesWithIntrinsicBounds

Added in API level 1
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. Use null if you do not want a Drawable there. The Drawables' bounds will be set to their intrinsic bounds.

Calling this method will overwrite any Drawables previously set using setCompoundDrawablesRelative(Drawable, Drawable, Drawable, Drawable) or related methods.

Related XML Attributes:

Parameters
left Drawable
top Drawable
right Drawable
bottom Drawable

setCompoundDrawablesWithIntrinsicBounds

Added in API level 3
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. Use 0 if you do not want a Drawable there. The Drawables' bounds will be set to their intrinsic bounds.

Calling this method will overwrite any Drawables previously set using setCompoundDrawablesRelative(Drawable, Drawable, Drawable, Drawable) or related methods.

Related XML Attributes:

Parameters
left int: Resource identifier of the left Drawable.
top int: Resource identifier of the top Drawable.
right int: Resource identifier of the right Drawable.
bottom int: Resource identifier of the bottom Drawable.

setCursorVisible

Added in API level 1
void setCursorVisible (boolean visible)

Set whether the cursor is visible. The default is true. Note that this property only makes sense for editable TextView.

Related XML Attributes:

Parameters
visible boolean

See also:

setCustomInsertionActionModeCallback

Added in API level 23
void setCustomInsertionActionModeCallback (ActionMode.Callback actionModeCallback)

If provided, this ActionMode.Callback will be used to create the ActionMode when text insertion is initiated in this View. The standard implementation populates the menu with a subset of Select All, Paste and Replace actions, depending on what this View supports.

A custom implementation can add new entries in the default menu in its onPrepareActionMode(android.view.ActionMode, android.view.Menu) method. The default actions can also be removed from the menu using removeItem(int) and passing selectAll, paste or replaceText ids as parameters.

Returning false from onCreateActionMode(android.view.ActionMode, android.view.Menu) will prevent the action mode from being started.

Action click events should be handled by the custom implementation of onActionItemClicked(android.view.ActionMode, android.view.MenuItem).

Note that text insertion mode is not started when a TextView receives focus and the selectAllOnFocus flag has been set.

Parameters
actionModeCallback ActionMode.Callback

setCustomSelectionActionModeCallback

Added in API level 11
void setCustomSelectionActionModeCallback (ActionMode.Callback actionModeCallback)

If provided, this ActionMode.Callback will be used to create the ActionMode when text selection is initiated in this View.

The standard implementation populates the menu with a subset of Select All, Cut, Copy, Paste, Replace and Share actions, depending on what this View supports.

A custom implementation can add new entries in the default menu in its onPrepareActionMode(ActionMode, android.view.Menu) method. The default actions can also be removed from the menu using removeItem(int) and passing selectAll, cut, copy, paste, replaceText or shareText ids as parameters.

Returning false from onCreateActionMode(ActionMode, android.view.Menu) will prevent the action mode from being started.

Action click events should be handled by the custom implementation of onActionItemClicked(ActionMode, android.view.MenuItem).

Note that text selection mode is not started when a TextView receives focus and the selectAllOnFocus flag has been set. The content is highlighted in that case, to allow for quick replacement.

Parameters
actionModeCallback ActionMode.Callback

setEditableFactory

Added in API level 1
void setEditableFactory (Editable.Factory factory)

Sets the Factory used to create new Editables.

Parameters
factory Editable.Factory

setElegantTextHeight

Added in API level 21
void setElegantTextHeight (boolean elegant)

Set the TextView's elegant height metrics flag. This setting selects font variants that have not been compacted to fit Latin-based vertical metrics, and also increases top and bottom bounds to provide more space.

Related XML Attributes:

Parameters
elegant boolean: set the paint's elegant metrics flag.

setEllipsize

Added in API level 1
void setEllipsize (TextUtils.TruncateAt where)

Causes words in the text that are longer than the view's width to be ellipsized instead of broken in the middle. You may also want to setSingleLine() or setHorizontallyScrolling(boolean) to constrain the text to a single line. Use null to turn off ellipsizing. If setMaxLines(int) has been used to set two or more lines, only END and MARQUEE are supported (other ellipsizing types will not do anything).

Related XML Attributes:

Parameters
where TextUtils.TruncateAt

setEms

Added in API level 1
void setEms (int ems)

Makes the TextView exactly this many ems wide

Related XML Attributes:

Parameters
ems int

See also:

setEnabled

Added in API level 1
void setEnabled (boolean enabled)

Set the enabled state of this view. The interpretation of the enabled state varies by subclass.

Parameters
enabled boolean: True if this view is enabled, false otherwise.

setError

Added in API level 1
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. The icon and error message will be reset to null when any key events cause changes to the TextView's text. If the error is null, the error message and icon will be cleared.

Parameters
error CharSequence

setError

Added in API level 1
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. 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).

Parameters
error CharSequence
icon Drawable

setExtractedText

Added in API level 3
void setExtractedText (ExtractedText text)

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

Parameters
text ExtractedText

setFilters

Added in API level 1
void setFilters (InputFilter[] filters)

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

Related XML Attributes:

Parameters
filters InputFilter

setFontFeatureSettings

Added in API level 21
void setFontFeatureSettings (String fontFeatureSettings)

Sets font feature settings. The format is the same as the CSS font-feature-settings attribute: http://dev.w3.org/csswg/css-fonts/#propdef-font-feature-settings

Related XML Attributes:

Parameters
fontFeatureSettings String: font feature settings represented as CSS compatible string

See also:

setFreezesText

Added in API level 1
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. 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. For EditText it is always enabled, regardless of the value of the attribute.

Related XML Attributes:

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

setGravity

Added in API level 1
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.

Related XML Attributes:

Parameters
gravity int

See also:

setHeight

Added in API level 1
void setHeight (int pixels)

Makes the TextView exactly this many pixels tall. You could do the same thing by specifying this number in the LayoutParams. Note that setting this value overrides any other (minimum / maximum) number of lines or height setting.

Related XML Attributes:

Parameters
pixels int

setHighlightColor

Added in API level 1
void setHighlightColor (int color)

Sets the color used to display the selection highlight.

Related XML Attributes:

Parameters
color int

setHint

Added in API level 1
void setHint (CharSequence hint)

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:

Parameters
hint CharSequence

setHint

Added in API level 1
void setHint (int resid)

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

Related XML Attributes:

Parameters
resid int

setHintTextColor

Added in API level 1
void setHintTextColor (ColorStateList colors)

Sets the color of the hint text.

Related XML Attributes:

Parameters
colors ColorStateList

See also:

setHintTextColor

Added in API level 1
void setHintTextColor (int color)

Sets the color of the hint text for all the states (disabled, focussed, selected...) of this TextView.

Related XML Attributes:

Parameters
color int

See also:

setHorizontallyScrolling

Added in API level 1
void setHorizontallyScrolling (boolean whether)

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:

Parameters
whether boolean

setHyphenationFrequency

Added in API level 23
void setHyphenationFrequency (int hyphenationFrequency)

Sets the hyphenation frequency. The default value for both TextView and EditText, which is set from the theme, is HYPHENATION_FREQUENCY_NORMAL.

Related XML Attributes:

Parameters
hyphenationFrequency int

See also:

setImeActionLabel

Added in API level 3
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.

Related XML Attributes:

Parameters
label CharSequence
actionId int

See also:

setImeHintLocales

Added in API level 24
void setImeHintLocales (LocaleList hintLocales)

Change "hint" locales associated with the text view, which will be reported to an IME with hintLocales when it has focus.

Note: If you want new "hint" to take effect immediately you need to call restartInput(View).

Parameters
hintLocales LocaleList: List of the languages that the user is supposed to switch to no matter what input method subtype is currently used. Set null to clear the current "hint".

See also:

setImeOptions

Added in API level 3
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.

Related XML Attributes:

Parameters
imeOptions int

See also:

setIncludeFontPadding

Added in API level 1
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. The default is true.

Related XML Attributes:

Parameters
includepad boolean

See also:

setInputExtras

Added in API level 3
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. The given integer is the resource ID of an XML resource holding an <input-extras> XML tree.

Related XML Attributes:

Parameters
xmlResId int
Throws
XmlPullParserException
IOException

See also:

setInputType

Added in API level 3
void setInputType (int type)

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. Note that the maximum number of displayed lines (see setMaxLines(int)) will be modified if you change the TYPE_TEXT_FLAG_MULTI_LINE flag of the input type.

Related XML Attributes:

Parameters
type int

See also:

setKeyListener

Added in API level 1
void setKeyListener (KeyListener input)

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:

Parameters
input KeyListener

setLetterSpacing

Added in API level 21
void setLetterSpacing (float letterSpacing)

Sets text letter-spacing. The value is in 'EM' units. Typical values for slight expansion will be around 0.05. Negative values tighten text.

Related XML Attributes:

Parameters
letterSpacing float

See also:

setLineSpacing

Added in API level 1
void setLineSpacing (float add, 
                float mult)

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

Related XML Attributes:

Parameters
add float
mult float

setLines

Added in API level 1
void setLines (int lines)

Makes the TextView exactly this many lines tall. Note that setting this value overrides any other (minimum / maximum) number of lines or height setting. A single line TextView will set this value to 1.

Related XML Attributes:

Parameters
lines int

setLinkTextColor

Added in API level 1
void setLinkTextColor (ColorStateList colors)

Sets the color of links in the text.

Related XML Attributes:

Parameters
colors ColorStateList

See also:

setLinkTextColor

Added in API level 1
void setLinkTextColor (int color)

Sets the color of links in the text.

Related XML Attributes:

Parameters
color int

See also:

setLinksClickable

Added in API level 1
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). The default is true.

Related XML Attributes:

Parameters
whether boolean

setMarqueeRepeatLimit

Added in API level 2
void setMarqueeRepeatLimit (int marqueeLimit)

Sets how many times to repeat the marquee animation. Only applied if the TextView has marquee enabled. Set to -1 to repeat indefinitely.

Related XML Attributes:

Parameters
marqueeLimit int

See also:

setMaxEms

Added in API level 1
void setMaxEms (int maxems)

Makes the TextView at most this many ems wide

Related XML Attributes:

Parameters
maxems int

setMaxHeight

Added in API level 1
void setMaxHeight (int maxHeight)

Makes the TextView at most this many pixels tall. This option is mutually exclusive with the setMaxLines(int) method. Setting this value overrides any other (maximum) number of lines setting.

Related XML Attributes:

Parameters
maxHeight int

setMaxLines

Added in API level 1
void setMaxLines (int maxlines)

Makes the TextView at most this many lines tall. Setting this value overrides any other (maximum) height setting.

Related XML Attributes:

Parameters
maxlines int

setMaxWidth

Added in API level 1
void setMaxWidth (int maxpixels)

Makes the TextView at most this many pixels wide

Related XML Attributes:

Parameters
maxpixels int

setMinEms

Added in API level 1
void setMinEms (int minems)

Makes the TextView at least this many ems wide

Related XML Attributes:

Parameters
minems int

setMinHeight

Added in API level 1
void setMinHeight (int minHeight)

Makes the TextView at least this many pixels tall. Setting this value overrides any other (minimum) number of lines setting.

Related XML Attributes:

Parameters
minHeight int

setMinLines

Added in API level 1
void setMinLines (int minlines)

Makes the TextView at least this many lines tall. Setting this value overrides any other (minimum) height setting. A single line TextView will set this value to 1.

Related XML Attributes:

Parameters
minlines int

See also:

setMinWidth

Added in API level 1
void setMinWidth (int minpixels)

Makes the TextView at least this many pixels wide

Related XML Attributes:

Parameters
minpixels int

setMovementMethod

Added in API level 1
void setMovementMethod (MovementMethod movement)

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.

Parameters
movement MovementMethod

setOnEditorActionListener

Added in API level 3
void setOnEditorActionListener (TextView.OnEditorActionListener l)

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.

Parameters
l TextView.OnEditorActionListener

setPadding

Added in API level 1
void setPadding (int left, 
                int top, 
                int right, 
                int bottom)

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 int: the left padding in pixels
top int: the top padding in pixels
right int: the right padding in pixels
bottom int: the bottom padding in pixels

setPaddingRelative

Added in API level 16
void setPaddingRelative (int start, 
                int top, 
                int end, 
                int bottom)

Sets the relative 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 getPaddingStart(), getPaddingTop(), getPaddingEnd() and getPaddingBottom() may be different from the values set in this call.

Parameters
start int: the start padding in pixels
top int: the top padding in pixels
end int: the end padding in pixels
bottom int: the bottom padding in pixels

setPaintFlags

Added in API level 1
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.

Parameters
flags int

See also:

setPrivateImeOptions

Added in API level 3
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.

Related XML Attributes:

Parameters
type String

See also:

setRawInputType

Added in API level 3
void setRawInputType (int type)

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

Related XML Attributes:

Parameters
type int

See also:

setScroller

Added in API level 1
void setScroller (Scroller s)

Parameters
s Scroller

setSelectAllOnFocus

Added in API level 1
void setSelectAllOnFocus (boolean selectAllOnFocus)

Set the TextView so that when it takes focus, all the text is selected.

Related XML Attributes:

Parameters
selectAllOnFocus boolean

setSelected

Added in API level 1
void setSelected (boolean selected)

Changes the selection state of this view. A view can be selected or not. Note that selection is not the same as focus. Views are typically selected in the context of an AdapterView like ListView or GridView; the selected view is the view that is highlighted.

Parameters
selected boolean: true if the view must be selected, false otherwise

setShadowLayer

Added in API level 1
void setShadowLayer (float radius, 
                float dx, 
                float dy, 
                int color)

Gives the text a shadow of the specified blur radius and color, the specified distance from its drawn position.

The text shadow produced does not interact with the properties on view that are responsible for real time shadows, elevation and translationZ.

Related XML Attributes:

Parameters
radius float
dx float
dy float
color int

See also:

setShowSoftInputOnFocus

Added in API level 21
void setShowSoftInputOnFocus (boolean show)

Sets whether the soft input method will be made visible when this TextView gets focused. The default is true.

Parameters
show boolean

setSingleLine

Added in API level 1
void setSingleLine (boolean singleLine)

If true, sets the properties of this field (number of lines, horizontally scrolling, transformation method) to be for a single-line input; if false, restores these to the default conditions. Note that the default conditions are not necessarily those that were in effect prior this method, and you may want to reset these properties to your custom values.

Related XML Attributes:

Parameters
singleLine boolean

setSingleLine

Added in API level 1
void setSingleLine ()

Sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input.

Related XML Attributes:

setSpannableFactory

Added in API level 1
void setSpannableFactory (Spannable.Factory factory)

Sets the Factory used to create new Spannables.

Parameters
factory Spannable.Factory

setText

Added in API level 1
void setText (int resid)

Parameters
resid int

setText

Added in API level 1
void setText (CharSequence text)

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:

Parameters
text CharSequence

setText

Added in API level 1
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.

Related XML Attributes:

Parameters
text CharSequence
type TextView.BufferType

setText

Added in API level 1
void setText (int resid, 
                TextView.BufferType type)

Parameters
resid int
type TextView.BufferType

setText

Added in API level 1
void setText (char[] text, 
                int start, 
                int len)

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.

Parameters
text char
start int
len int

setTextAppearance

Added in API level 1
void setTextAppearance (Context context, 
                int resId)

This method was deprecated in API level 23.
Use setTextAppearance(int) instead.

Sets the text color, size, style, hint color, and highlight color from the specified TextAppearance resource.

Parameters
context Context
resId int

setTextAppearance

Added in API level 23
void setTextAppearance (int resId)

Sets the text appearance from the specified style resource.

Use a framework-defined TextAppearance style like @android:style/TextAppearance.Material.Body1 or see TextAppearance for the set of attributes that can be used in a custom style.

Related XML Attributes:

Parameters
resId int: the resource identifier of the style to apply

setTextColor

Added in API level 1
void setTextColor (int color)

Sets the text color for all the states (normal, selected, focused) to be this color.

Related XML Attributes:

Parameters
color int

See also:

setTextColor

Added in API level 1
void setTextColor (ColorStateList colors)

Sets the text color.

Related XML Attributes:

Parameters
colors ColorStateList

See also:

setTextIsSelectable

Added in API level 11
void setTextIsSelectable (boolean selectable)

Sets whether the content of this view is selectable by the user. The default is false, meaning that the content is not selectable.

When you use a TextView to display a useful piece of information to the user (such as a contact's address), make it selectable, so that the user can select and copy its content. You can also use set the XML attribute TextView_textIsSelectable to "true".

When you call this method to set the value of textIsSelectable, it sets the flags focusable, focusableInTouchMode, clickable, and longClickable to the same value. These flags correspond to the attributes android:focusable, android:focusableInTouchMode, android:clickable, and android:longClickable. To restore any of these flags to a state you had set previously, call one or more of the following methods: setFocusable(), setFocusableInTouchMode(), setClickable() or setLongClickable().

Parameters
selectable boolean: Whether the content of this TextView should be selectable.

setTextKeepState

Added in API level 1
void setTextKeepState (CharSequence text)

Like setText(CharSequence), except that the cursor position (if any) is retained in the new text.

Parameters
text CharSequence: The new text to place in the text view.

See also:

setTextKeepState

Added in API level 1
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.

Parameters
text CharSequence
type TextView.BufferType

See also:

setTextLocale

Added in API level 17
void setTextLocale (Locale locale)

Set the default LocaleList of the text in this TextView to a one-member list containing just the given value.

Parameters
locale Locale