Android
android.widget
public class

android.widget.TextView

java.lang.Object
android.view.View Drawable.Callback KeyEvent.Callback
android.widget.TextView ViewTreeObserver.OnPreDrawListener

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

XML attributes

See TextView Attributes, View Attributes

Nested Classes
TextView.BufferType  
TextView.SavedState User interface state that is stored by TextView for implementing onSaveInstanceState()
Known Direct Subclasses
Known Indirect Subclasses

Summary

XML Attributes

Attribute name Related methods  
android:autoLink setAutoLinkMask(int)
 
Controls whether links such as urls and email addresses are automatically found and converted to clickable links. 
android:autoText setKeyListener(KeyListener)
 
If set, specifies that this TextView has a textual input method and automatically corrects some common spelling errors. 
android:bufferType setText(CharSequence,TextView.BufferType)
 
Determines the minimum type that getText() will return. 
android:capitalize setKeyListener(KeyListener)
 
If set, specifies that this TextView has a textual input method and should automatically capitalize what the user types. 
android:cursorVisible setCursorVisible(boolean)
 
Makes the cursor visible (the default) or invisible

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

android:digits setKeyListener(KeyListener)
 
If set, specifies that this TextView has a numeric input method and that these specific characters are the ones that it will accept. 
android:drawableBottom setCompoundDrawablesWithIntrinsicBounds(Drawable,Drawable,Drawable,Drawable)
 
The drawable to be drawn below the text. 
android:drawableLeft setCompoundDrawablesWithIntrinsicBounds(Drawable,Drawable,Drawable,Drawable)
 
The drawable to be drawn to the left of the text. 
android:drawablePadding setCompoundDrawablePadding(int)
 
The padding between the drawables and the text. 
android:drawableRight setCompoundDrawablesWithIntrinsicBounds(Drawable,Drawable,Drawable,Drawable)
 
The drawable to be drawn to the right of the text. 
android:drawableTop setCompoundDrawablesWithIntrinsicBounds(Drawable,Drawable,Drawable,Drawable)
 
The drawable to be drawn above the text. 
android:editable   If set, specifies that this TextView has an input method. 
android:ellipsize setEllipsize(TextUtils.TruncateAt)
 
If set, causes words that are longer than the view is wide to be ellipsized instead of broken in the middle. 
android:ems setEms(int)
 
Makes the TextView be exactly this many ems wide

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

android:freezesText setFreezesText(boolean)
 
If set, the text view will include its current complete text inside of its frozen icicle in addition to meta-data such as the current cursor position. 
android:gravity setGravity(int)
 
Vertical gravity (top, center_vertical, bottom) when the text is smaller than the view. 
android:height setHeight(int)
 
Makes the TextView be exactly this many pixels tall. 
android:hint setHint(int)
 
Hint text to display when the text is empty. 
android:includeFontPadding setIncludeFontPadding(boolean)
 
Leave enough room for ascenders and descenders instead of using the font ascent and descent strictly. 
android:inputMethod setKeyListener(KeyListener)
 
If set, specifies that this TextView should use the specified input method (specified by fully-qualified class name). 
android:lineSpacingExtra setLineSpacing(float,float)
 
Extra spacing between lines of text. 
android:lineSpacingMultiplier setLineSpacing(float,float)
 
Extra spacing between lines of text, as a multiplier. 
android:lines setLines(int)
 
Makes the TextView be exactly this many lines tall

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

android:linksClickable setLinksClickable(boolean)
 
If set to false, keeps the movement method from being set to the link movement method even if autoLink causes links to be found. 
android:maxEms setMaxEms(int)
 
Makes the TextView be at most this many ems wide

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

android:maxHeight setMaxHeight(int)
 
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". 

android:maxLength setFilters(InputFilter)
 
Set an input filter to constrain the text length to the specified number. 
android:maxLines setMaxLines(int)
 
Makes the TextView be at most this many lines tall

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

android:maxWidth setMaxWidth(int)
 
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". 

android:minEms setMinEms(int)
 
Makes the TextView be at least this many ems wide

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

android:minHeight setMinHeight(int)
 
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". 

android:minLines setMinLines(int)
 
Makes the TextView be at least this many lines tall

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

android:minWidth setMinWidth(int)
 
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". 

android:numeric setKeyListener(KeyListener)
 
If set, specifies that this TextView has a numeric input method. 
android:password setTransformationMethod(TransformationMethod)
 
Whether the characters of the field are displayed as password dots instead of themselves. 
android:phoneNumber setKeyListener(KeyListener)
 
If set, specifies that this TextView has a phone number input method. 
android:scrollHorizontally setHorizontallyScrolling(boolean)
 
Whether the text is allowed to be wider than the view (and therefore can be scrolled horizontally). 
android:selectAllOnFocus setSelectAllOnFocus(boolean)
 
If the text is selectable, select it all when the view takes focus instead of moving the cursor to the start or end. 
android:shadowColor setShadowLayer(float,float,float,int)
 
Place a shadow of the specified color behind the text. 
android:shadowDx setShadowLayer(float,float,float,int)
 
Horizontal offset of the shadow. 
android:shadowDy setShadowLayer(float,float,float,int)
 
Vertical offset of the shadow. 
android:shadowRadius setShadowLayer(float,float,float,int)
 
Radius of the shadow. 
android:singleLine setTransformationMethod(TransformationMethod)
 
Constrains the text to a single horizontally scrolling line instead of letting it wrap onto multiple lines, and advances focus instead of inserting a newline when you press the enter key. 
android:text setText(CharSequence)
 
Text to display. 
android:textColor setTextColor(ColorStateList)
 
Text color. 
android:textColorHighlight setHighlightColor(int)
 
Color of the text selection highlight. 
android:textColorHint setHintTextColor(int)
 
Color of the hint text. 
android:textColorLink setLinkTextColor(int)
 
Text color for links. 
android:textScaleX setTextScaleX(float)
 
Sets the horizontal scaling factor for the text

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

android:textSize setTextSize(float)
 
Size of the text. 
android:textStyle setTypeface(Typeface)
 
Style (bold, italic, bolditalic) for the text. 
android:typeface setTypeface(Typeface)
 
Typeface (normal, sans, serif, monospace) for the text. 
android:width setWidth(int)
 
Makes the TextView be exactly this many pixels wide. 
XML Attributes inherited from class android.view.View
Constants inherited from class android.view.View

Public Constructors

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

Public Methods

          void  addTextChangedListener(TextWatcher watcher)
Adds a TextWatcher to the list of those whose methods are called whenever this TextView's text changes.
    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  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.
    final      int  getAutoLinkMask()
Gets the autolink mask of the text.
          int  getBaseline()

Return the offset of the widget's text baseline from the widget's top boundary.

          int  getCompoundDrawablePadding()
Returns the padding between the compound drawables and the text.
          Drawable[]  getCompoundDrawables()
Returns drawables for the left, top, right, and bottom borders.
          int  getCompoundPaddingBottom()
Returns the bottom padding of the view, plus space for the bottom Drawable if any.
          int  getCompoundPaddingLeft()
Returns the left padding of the view, plus space for the left Drawable if any.
          int  getCompoundPaddingRight()
Returns the right padding of the view, plus space for the right Drawable if any.
          int  getCompoundPaddingTop()
Returns the top padding of the view, plus space for the top Drawable if any.
    final      int  getCurrentHintTextColor()

Return the current color selected to paint the hint text.

    final      int  getCurrentTextColor()

Return the current color selected for normal text.

          TextUtils.TruncateAt  getEllipsize()
Returns where, if anywhere, words that are longer than the view is wide should be ellipsized.
          CharSequence  getError()
Returns the error message that was set to be displayed with setError(CharSequence), or null if no error was set or if it the error was cleared by the widget after user input.
          int  getExtendedPaddingBottom()
Returns the extended bottom padding of the view, including both the bottom Drawable if any and any extra space to keep more than maxLines of text from showing.
          int  getExtendedPaddingTop()
Returns the extended top padding of the view, including both the top Drawable if any and any extra space to keep more than maxLines of text from showing.
          InputFilter[]  getFilters()
Returns the current list of input filters.
          void  getFocusedRect(Rect r)
When a view has focus and the user navigates away from it, the next view is searched for starting from the rectangle filled in by this method.
          boolean  getFreezesText()
Return whether this text view is including its entire text contents in frozen icicles.
          int  getGravity()
Returns the horizontal and vertical alignment of this TextView.
          CharSequence  getHint()
Returns the hint that is displayed when the text of the TextView is empty.
    final      ColorStateList  getHintTextColors()

Return the color used to paint the hint text.

    final      KeyListener  getKeyListener()
    final      Layout  getLayout()
          int  getLineBounds(int line, Rect bounds)
Return the baseline for the specified line (0...getLineCount() - 1) If bounds is not null, return the top, left, right, bottom extents of the specified line in it.
          int  getLineCount()
Return the number of lines of text, or 0 if the internal Layout has not been built.
          int  getLineHeight()
    final      ColorStateList  getLinkTextColors()

Returns the color used to paint links in the text.

    final      boolean  getLinksClickable()
Returns whether the movement method will automatically be set to LinkMovementMethod if setAutoLinkMask(int) has been set to nonzero and links are detected in setText(char[], int, int).
    final      MovementMethod  getMovementMethod()
          TextPaint  getPaint()
          int  getPaintFlags()
          int  getSelectionEnd()
Convenience for getSelectionEnd(CharSequence).
          int  getSelectionStart()
Convenience for getSelectionStart(CharSequence).
          CharSequence  getText()
Return the text the TextView is displaying.
      static    int  getTextColor(Context context, TypedArray attrs, int def)
Returns the default color from the TextView_textColor attribute from the AttributeSet, if set, or the default color from the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.
    final      ColorStateList  getTextColors()
Return the set of text colors.
      static    ColorStateList  getTextColors(Context context, TypedArray attrs)
Returns the TextView_textColor attribute from the Resources.StyledAttributes, if set, or the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.
          float  getTextScaleX()
          float  getTextSize()
          int  getTotalPaddingBottom()
Returns the total bottom padding of the view, including the bottom Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.
          int  getTotalPaddingLeft()
Returns the total left padding of the view, including the left Drawable if any.
          int  getTotalPaddingRight()
Returns the total right padding of the view, including the right Drawable if any.
          int  getTotalPaddingTop()
Returns the total top padding of the view, including the top Drawable if any, the extra space to keep more than maxLines from showing, and the vertical offset for gravity, if any.
    final      TransformationMethod  getTransformationMethod()
          Typeface  getTypeface()
          URLSpan[]  getUrls()
Returns the list of URLSpans attached to the text (by Linkify or otherwise) if any.
          boolean  hasSelection()
Return true iff there is a selection inside this text view.
          int  length()
Returns the length, in characters, of the text managed by this TextView
          boolean  onKeyDown(int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyMultiple(): perform press of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released, if the view is enabled and clickable.
          boolean  onKeyShortcut(int keyCode, KeyEvent event)
Called when an unhandled key shortcut event occurs.
          boolean  onKeyUp(int keyCode, KeyEvent event)
Default implementation of KeyEvent.Callback.onKeyMultiple(): perform clicking of the view when KEYCODE_DPAD_CENTER or KEYCODE_ENTER is released.
          boolean  onPreDraw()
Callback method to be invoked when the view tree is about to be drawn.
          void  onRestoreInstanceState(Parcelable state)
Hook allowing a view to re-apply a representation of its internal state that had previously been generated by onSaveInstanceState().
          Parcelable  onSaveInstanceState()
Hook allowing a view to generate a representation of its internal state that can later be used to create a new instance with that same state.
          boolean  onTouchEvent(MotionEvent event)
Implement this method to handle touch screen motion events.
          boolean  onTrackballEvent(MotionEvent event)
Implement this method to handle trackball motion events.
          void  onWindowFocusChanged(boolean hasWindowFocus)
Called when the window containing this view gains or loses focus.
          boolean  performLongClick()
Call this view's OnLongClickListener, if it is defined.
          void  removeTextChangedListener(TextWatcher watcher)
Removes the specified TextWatcher from the list of those whose methods are called whenever this TextView's text changes.
    final      void  setAutoLinkMask(int mask)
Sets the autolink mask of the text.
          void  setCompoundDrawablePadding(int pad)
Sets the size of the padding between the compound drawables and the text.
          void  setCompoundDrawables(Drawable left, Drawable top, Drawable right, Drawable bottom)
Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.
          void  setCompoundDrawablesWithIntrinsicBounds(Drawable left, Drawable top, Drawable right, Drawable bottom)
Sets the Drawables (if any) to appear to the left of, above, to the right of, and below the text.
          void  setCursorVisible(boolean visible)
Set whether the cursor is visible.
    final      void  setEditableFactory(Editable.Factory factory)
Sets the Factory used to create new Editables.
          void  setEllipsize(TextUtils.TruncateAt where)
Causes words in the text that are longer than the view is wide to be ellipsized instead of broken in the middle.
          void  setEms(int ems)
Makes the TextView exactly this many ems wide
          void  setError(CharSequence error)
Sets the right-hand compound drawable of the TextView to the "error" icon and sets an error message that will be displayed in a popup when the TextView has focus.
          void  setError(CharSequence error, Drawable icon)
Sets the right-hand compound drawable of the TextView to the specified icon and sets an error message that will be displayed in a popup when the TextView has focus.
          void  setFilters(InputFilter[] filters)
Sets the list of input filters that will be used if the buffer is Editable.
          void  setFreezesText(boolean freezesText)
Control whether this text view saves its entire text contents when freezing to an icicle, in addition to dynamic state such as cursor position.
          void  setGravity(int gravity)
Sets the horizontal alignment of the text and the vertical gravity that will be used when there is extra space in the TextView beyond what is required for the text itself.
          void  setHeight(int pixels)
Makes the TextView exactly this many pixels tall.
          void  setHighlightColor(int color)
Sets the color used to display the selection highlight.
    final      void  setHint(CharSequence hint)
Sets the text to be displayed when the text of the TextView is empty.
    final      void  setHint(int resid)
Sets the text to be displayed when the text of the TextView is empty, from a resource.
    final      void  setHintTextColor(ColorStateList colors)
Sets the color of the hint text.
    final      void  setHintTextColor(int color)
Sets the color of the hint text.
          void  setHorizontallyScrolling(boolean whether)
Sets whether the text should be allowed to be wider than the View is.
          void  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  setKeyListener(KeyListener input)
Sets the key listener to be used with this TextView.
          void  setLineSpacing(float add, float mult)
Sets line spacing for this TextView.
          void  setLines(int lines)
Makes the TextView exactly this many lines tall
    final      void  setLinkTextColor(ColorStateList colors)
Sets the color of links in the text.
    final      void  setLinkTextColor(int color)
Sets the color of links in the text.
    final      void  setLinksClickable(boolean whether)
Sets whether the movement method will automatically be set to LinkMovementMethod if setAutoLinkMask(int) has been set to nonzero and links are detected in setText(char[], int, int).
          void  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  setPadding(int left, int top, int right, int bottom)
Sets the padding.
          void  setPaintFlags(int flags)
Sets flags on the Paint being used to display the text and reflows the text if they are different from the old flags.
          void  setScroller(Scroller s)
          void  setSelectAllOnFocus(boolean selectAllOnFocus)
Set the TextView so that when it takes focus, all the text is selected.
          void  setShadowLayer(float radius, float dx, float dy, int color)
Gives the text a shadow of the specified radius and color, the specified distance from its normal position.
          void  setSingleLine()
Sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input.
          void  setSingleLine(boolean singleLine)
If true, sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input; if false, restores these to the default conditions.
    final      void  setSpannableFactory(Spannable.Factory factory)
Sets the Factory used to create new Spannables.
    final      void  setText(int resid)
    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  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(CharSequence text)
Sets the string value of the TextView.
          void  setTextAppearance(Context context, int resid)
Sets the text color, size, style, hint color, and highlight color from the specified TextAppearance resource.
          void  setTextColor(int color)
Sets the text color for all the states (normal, selected, focused) to be this color.
          void  setTextColor(ColorStateList colors)
Sets the text color.
    final      void  setTextKeepState(CharSequence text)
Like setText(CharSequence), except that the cursor position (if any) is retained in the new text.
    final      void  setTextKeepState(CharSequence text, TextView.BufferType type)
Like setText(CharSequence, android.widget.TextView.BufferType), except that the cursor position (if any) is retained in the new text.
          void  setTextScaleX(float size)
Sets the extent by which text should be stretched horizontally.
          void  setTextSize(int unit, float size)
Set the default text size to a given unit and value.
          void  setTextSize(float size)
Set the default text size to the given value, interpreted as "scaled pixel" units.
    final      void  setTransformationMethod(TransformationMethod method)
Sets the transformation that is applied to the text that this TextView is displaying.
          void  setTypeface(Typeface tf, int style)
Sets the typeface and style in which the text should be displayed, and turns on the fake bold and italic bits in the Paint if the Typeface that you provided does not have all the bits in the style that you specified.
          void  setTypeface(Typeface tf)
Sets the typeface and style in which the text should be displayed.
          void  setWidth(int pixels)
Makes the TextView exactly this many pixels wide.

Protected Methods

          int  computeHorizontalScrollRange()

Compute the horizontal range that the horizontal scrollbar represents.

          int  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.
          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.
          void  onCreateContextMenu(ContextMenu menu)
Views should implement this if the view itself is going to add items to the context menu.
          void  onDetachedFromWindow()
This is called when the view is detached from a window.
          void  onDraw(Canvas canvas)
Implement this to do your drawing.
          void  onFocusChanged(boolean focused, int direction, Rect previouslyFocusedRect)
Called by the view system when the focus state of this view changes.
          void  onMeasure(int widthMeasureSpec, int heightMeasureSpec)

Measure the view and its content to determine the measured width and the measured height.

          void  onTextChanged(CharSequence text, int start, int before, int after)
This method is called when the text is changed, in case any subclasses would like to know.
          boolean  setFrame(int l, int t, int r, int b)
Assign a size and position to this view.
Methods inherited from class android.view.View
Methods inherited from class java.lang.Object
Methods inherited from interface android.graphics.drawable.Drawable.Callback
Methods inherited from interface android.view.KeyEvent.Callback
Methods inherited from interface android.view.ViewTreeObserver.OnPreDrawListener

Details

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

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.

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.

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

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.

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.

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.

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

This corresponds to the global attribute resource symbol ellipsize.

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

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

Vertical gravity (top, center_vertical, bottom) 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.

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), db (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: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.

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: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), db (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: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), db (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

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

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), db (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.
signed0x003 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.

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

android:selectAllOnFocus

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

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

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

This corresponds to the global attribute resource symbol selectAllOnFocus.

android:shadowColor

Place a shadow of the specified color behind the text.

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

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

This corresponds to the global attribute resource symbol shadowColor.

android:shadowDx

Horizontal offset of the shadow.

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

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

This corresponds to the global attribute resource symbol shadowDx.

android:shadowDy

Vertical offset of the shadow.

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

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

This corresponds to the global attribute resource symbol shadowDy.

android:shadowRadius

Radius of the shadow.

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

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

This corresponds to the global attribute resource symbol shadowRadius.

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.

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.

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

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

Must be a dimension value, which is a floating point number appended with a unit such as "14.5sp". Available units are: px (pixels), db (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), db (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

public TextView(Context context)

public TextView(Context context, AttributeSet attrs)

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

Public Methods

public void addTextChangedListener(TextWatcher watcher)

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

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

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

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

public 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 the indentation level

public final int getAutoLinkMask()

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

Related XML Attributes

public 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

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

public int getCompoundDrawablePadding()

Returns the padding between the compound drawables and the text.

public Drawable[] getCompoundDrawables()

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

public int getCompoundPaddingBottom()

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

public int getCompoundPaddingLeft()

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

public int getCompoundPaddingRight()

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

public int getCompoundPaddingTop()

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

public final int getCurrentHintTextColor()

Return the current color selected to paint the hint text.

Returns

  • Returns the current hint text color.

public final int getCurrentTextColor()

Return the current color selected for normal text.

Returns

  • Returns the current text color.

public TextUtils.TruncateAt getEllipsize()

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

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

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

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

public InputFilter[] getFilters()

Returns the current list of input filters.

public 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 rectange is the getDrawingRect(Rect))of the view. However, if your view maintains some idea of internal selection, such as a cursor, or a selected row or column, you should override this method and fill in a more specific rectangle.

Parameters

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

public boolean getFreezesText()

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

Returns

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

public int getGravity()

Returns the horizontal and vertical alignment of this TextView.

Related XML Attributes

See Also

public CharSequence getHint()

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

Related XML Attributes

public final ColorStateList getHintTextColors()

Return the color used to paint the hint text.

Returns

  • Returns the list of hint text colors.

public final KeyListener getKeyListener()

Returns

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

public final Layout getLayout()

Returns

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

public int getLineBounds(int line, Rect bounds)

Return the baseline for the specified line (0...getLineCount() - 1) If bounds is not null, return the top, left, right, bottom extents of the specified line in it. If the internal Layout has not been built, return 0 and set bounds to (0, 0, 0, 0)

Parameters

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

Returns

  • the Y-coordinate of the baseline

public int getLineCount()

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

public int getLineHeight()

Returns

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

public final ColorStateList getLinkTextColors()

Returns the color used to paint links in the text.

Returns

  • Returns the list of link text colors.

public 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). The default is true.

Related XML Attributes

public final MovementMethod getMovementMethod()

Returns

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

public TextPaint getPaint()

Returns

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

public int getPaintFlags()

Returns

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

See Also

public int getSelectionEnd()

public int getSelectionStart()

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

public static int getTextColor(Context context, TypedArray attrs, int def)

Returns the default color from the TextView_textColor attribute from the AttributeSet, if set, or the default color from the TextAppearance_textColor from the TextView_textAppearance attribute, if TextView_textColor was not set directly.

public final ColorStateList getTextColors()

Return the set of text colors.

Returns

  • Returns the set of text colors.

public static ColorStateList getTextColors(Context context, TypedArray attrs)

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

public float getTextScaleX()

Returns

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

public float getTextSize()

Returns

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

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

public int getTotalPaddingLeft()

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

public int getTotalPaddingRight()

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

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

public final TransformationMethod getTransformationMethod()

Returns

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

public Typeface getTypeface()

Returns

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

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

public boolean hasSelection()

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

public int length()

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

public boolean onKeyDown(int keyCode, KeyEvent event)

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

Parameters

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

Returns

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

public boolean onKeyShortcut(int keyCode, KeyEvent event)

Called when an unhandled key shortcut event occurs.

Parameters

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

Returns

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

public boolean onKeyUp(int keyCode, KeyEvent event)

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

Parameters

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

Returns

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

public boolean onPreDraw()

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

Returns

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

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

public 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

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

public boolean onTouchEvent(MotionEvent event)

Implement this method to handle touch screen motion events.

Parameters

event The motion event.

Returns

  • True if the event was handled, false otherwise.

public boolean onTrackballEvent(MotionEvent event)

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

Parameters

event The motion event.

Returns

  • True if the event was handled, false otherwise.

public void onWindowFocusChanged(boolean hasWindowFocus)

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

Parameters

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

public boolean performLongClick()

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

Returns

  • True there was an assigned OnLongClickListener that was called, false otherwise is returned.

public void removeTextChangedListener(TextWatcher watcher)

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

public final void setAutoLinkMask(int mask)

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

Related XML Attributes

public void setCompoundDrawablePadding(int pad)

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

Related XML Attributes

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

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

public void setCursorVisible(boolean visible)

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

Related XML Attributes

public final void setEditableFactory(Editable.Factory factory)

Sets the Factory used to create new Editables.

public void setEllipsize(TextUtils.TruncateAt where)

Causes words in the text that are longer than the view is wide to be ellipsized instead of broken in the middle. You may also want to setSingleLine() or setHorizontallyScrolling(boolean) to constrain the text toa single line. Use null to turn off ellipsizing.

Related XML Attributes

public void setEms(int ems)

Makes the TextView exactly this many ems wide

Related XML Attributes

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

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

public 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

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

Related XML Attributes

Parameters

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

public void setGravity(int gravity)

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

See Also

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

Related XML Attributes

public void setHighlightColor(int color)

Sets the color used to display the selection highlight.

Related XML Attributes

public final 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

public final void setHint(int resid)

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

Related XML Attributes

public final void setHintTextColor(ColorStateList colors)

Sets the color of the hint text.

Related XML Attributes

public final void setHintTextColor(int color)

Sets the color of the hint text.

Related XML Attributes

public 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

public 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

public void setKeyListener(KeyListener input)

Sets the key listener to be used with this TextView. This can be null to disallow user input.

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

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

public void setLines(int lines)

Makes the TextView exactly this many lines tall

Related XML Attributes

public final void setLinkTextColor(ColorStateList colors)

Sets the color of links in the text.

Related XML Attributes

public final void setLinkTextColor(int color)

Sets the color of links in the text.

Related XML Attributes

public 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). The default is true.

Related XML Attributes

public void setMaxEms(int maxems)

Makes the TextView at most this many ems wide

Related XML Attributes

public void setMaxHeight(int maxHeight)

Makes the TextView at most this many pixels tall

Related XML Attributes

public void setMaxLines(int maxlines)

Makes the TextView at most this many lines tall

Related XML Attributes

public void setMaxWidth(int maxpixels)

Makes the TextView at most this many pixels wide

Related XML Attributes

public void setMinEms(int minems)

Makes the TextView at least this many ems wide

Related XML Attributes

public void setMinHeight(int minHeight)

Makes the TextView at least this many pixels tall

Related XML Attributes

public void setMinLines(int minlines)

Makes the TextView at least this many lines tall

Related XML Attributes

public void setMinWidth(int minpixels)

Makes the TextView at least this many pixels wide

Related XML Attributes

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

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

public void setPaintFlags(int flags)

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

See Also

public void setScroller(Scroller s)

public void setSelectAllOnFocus(boolean selectAllOnFocus)

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

Related XML Attributes

public void setShadowLayer(float radius, float dx, float dy, int color)

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

public void setSingleLine()

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

Related XML Attributes

public void setSingleLine(boolean singleLine)

If true, sets the properties of this field (lines, horizontally scrolling, transformation method) to be for a single-line input; if false, restores these to the default conditions. Note that calling this with false restores default conditions, not necessarily those that were in effect prior to calling it with true.

Related XML Attributes

public final void setSpannableFactory(Spannable.Factory factory)

Sets the Factory used to create new Spannables.

public final void setText(int resid)

public final void setText(int resid, TextView.BufferType type)

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

public 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

public final 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 String Resources for an example of setting formatted text in the XML resource file.

Related XML Attributes

public void setTextAppearance(Context context, int resid)

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

public void setTextColor(int color)

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

Related XML Attributes

public void setTextColor(ColorStateList colors)

Sets the text color.

Related XML Attributes

public final void setTextKeepState(CharSequence text)

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

Parameters

text The new text to place in the text view.

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

public void setTextScaleX(float size)

Sets the extent by which text should be stretched horizontally.

Related XML Attributes

public void setTextSize(int unit, float size)

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

Related XML Attributes

Parameters

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

public void setTextSize(float size)

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

Related XML Attributes

Parameters

size The scaled pixel size.

public final void setTransformationMethod(TransformationMethod method)

Sets the transformation that is applied to the text that this TextView is displaying.

Related XML Attributes

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

Related XML Attributes

public void setTypeface(Typeface tf)

Sets the typeface and style in which the text should be displayed. Note that not all Typeface families actually have bold and italic variants, so you may need to use setTypeface(Typeface, int) to get the appearance that you actually want.

Related XML Attributes

public void setWidth(int pixels)

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

Related XML Attributes

Protected Methods

protected int computeHorizontalScrollRange()

Compute the horizontal range that the horizontal scrollbar represents.

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

The default range is the drawing width of this view.

Returns

  • the total horizontal range represented by the horizontal scrollbar

protected int computeVerticalScrollRange()

Compute the vertical range that the vertical scrollbar represents.

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

Returns

  • the total vertical range represented by the vertical scrollbar

    The default range is the drawing height of this view.

protected void drawableStateChanged()

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

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

protected boolean getDefaultEditable()

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

protected MovementMethod getDefaultMovementMethod()

Subclasses override this to specify a default movement method.

protected void onCreateContextMenu(ContextMenu menu)

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

Parameters

menu the context menu to populate

protected void onDetachedFromWindow()

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

protected void onDraw(Canvas canvas)

Implement this to do your drawing.

Parameters

canvas the canvas on which the background will be drawn

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

Called by the view system when the focus state of this view changes. When the focus change event is caused by directional navigation, direction and previouslyFocusedRect provide insight into where the focus is coming from.

Parameters

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

protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec)

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

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

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

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

Parameters

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

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

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

Parameters

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

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

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

Parameters

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

Returns

  • true if the new size and position are different than the previous ones
Copyright 2007 Google Inc. Build 119366-119366 - 19 Nov 2008 16:04