TextInputLayout
public
class
TextInputLayout
extends LinearLayout
implements
ViewTreeObserver.OnGlobalLayoutListener
java.lang.Object | ||||
↳ | android.view.View | |||
↳ | android.view.ViewGroup | |||
↳ | android.widget.LinearLayout | |||
↳ | com.google.android.material.textfield.TextInputLayout |
Layout which wraps a TextInputEditText
, EditText
, or descendant to
show a floating label when the hint is hidden while the user inputs text.
Also supports:
- Showing an error via
setErrorEnabled(boolean)
andsetError(CharSequence)
, along with showing an error icon viasetErrorIconDrawable(Drawable)
- Showing helper text via
setHelperTextEnabled(boolean)
andsetHelperText(CharSequence)
- Showing placeholder text via
setPlaceholderText(CharSequence)
- Showing prefix text via
setPrefixText(CharSequence)
- Showing suffix text via
setSuffixText(CharSequence)
- Showing a character counter via
setCounterEnabled(boolean)
andsetCounterMaxLength(int)
- Password visibility toggling via
setEndIconMode(int)
API and related attribute. If set, a button is displayed to toggle between the password being displayed as plain-text or disguised, when your EditText is set to display a password. - Clearing text functionality via
setEndIconMode(int)
API and related attribute. If set, a button is displayed when text is present and clicking it clears the EditText field. - Showing a custom icon specified via
setEndIconMode(int)
API and related attribute. You should specify a drawable and content description for the icon. Optionally, you can also specify anView.OnClickListener
, anTextInputLayout.OnEditTextAttachedListener
and anTextInputLayout.OnEndIconChangedListener
.Note: When using an end icon, the 'end' compound drawable of the EditText will be overridden while the end icon view is visible. To ensure that any existing drawables are restored correctly, you should set those compound drawables relatively (start/end), as opposed to absolutely (left/right).
- Showing a start icon via
setStartIconDrawable(Drawable)
API and related attribute. You should specify a content description for the icon. Optionally, you can also specify anView.OnClickListener
for it.Note: Use the
setStartIconDrawable(Drawable)
API in place of setting a start/left compound drawable on the EditText. When using a start icon, the 'start/left' compound drawable of the EditText will be overridden. - Showing a button that when clicked displays a dropdown menu. The selected option is
displayed above the dropdown. You need to use an
AutoCompleteTextView
instead of aTextInputEditText
as the input text child, and a Widget.MaterialComponents.TextInputLayout.(...).ExposedDropdownMenu style.To disable user input you should set
on theandroid:editable="false"
AutoCompleteTextView
.
The TextInputEditText
class is provided to be used as the input text child of this
layout. Using TextInputEditText instead of an EditText provides accessibility support for the
text field and allows TextInputLayout greater control over the visual aspects of the text field.
This is an example usage:
<com.google.android.material.textfield.TextInputLayout android:layout_width="match_parent" android:layout_height="wrap_content" android:hint="@string/form_username"> <com.google.android.material.textfield.TextInputEditText android:layout_width="match_parent" android:layout_height="wrap_content"/> </com.google.android.material.textfield.TextInputLayout>
setHint(CharSequence)
and getHint()
on TextInputLayout,
instead of on EditText.
If you construct the TextInputEditText
child of a TextInputLayout
programmatically, you should use TextInputLayout
's context
to create the view.
This will allow TextInputLayout
to pass along the appropriate styling to the TextInputEditText
.
If the EditText
child is not a TextInputEditText
, make sure to set the EditText
's android:background
to null
when using an outlined or filled text
field. This allows TextInputLayout
to set the EditText
's background to an
outlined or filled box, respectively.
Note: The actual view hierarchy present under TextInputLayout is
NOT guaranteed to match the view hierarchy as written in XML. As a result, calls
to getParent()
on children of the TextInputLayout -- such as a TextInputEditText -- may
not return the TextInputLayout itself, but rather an intermediate View. If you need to access a
View directly, set an android:id
and use View.findViewById(int)
.
For more information, see the component developer guidance and design guidelines.
Summary
Nested classes | |
---|---|
class |
TextInputLayout.AccessibilityDelegate
An |
@interface |
TextInputLayout.BoxBackgroundMode
Values for box background mode. |
interface |
TextInputLayout.LengthCounter
Interface definition for a length counter. |
interface |
TextInputLayout.OnEditTextAttachedListener
Callback interface invoked when the view's |
interface |
TextInputLayout.OnEndIconChangedListener
Callback interface invoked when the view's end icon changes. |
XML attributes | |
---|---|
TextInputLayout_android_hint |
|
TextInputLayout_android_maxEms |
|
TextInputLayout_android_maxWidth |
|
TextInputLayout_android_minEms |
|
TextInputLayout_android_minWidth |
|
TextInputLayout_boxCollapsedPaddingTop |
|
TextInputLayout_boxStrokeErrorColor |
|
TextInputLayout_boxStrokeWidth |
|
TextInputLayout_boxStrokeWidthFocused |
|
TextInputLayout_counterEnabled |
|
TextInputLayout_counterMaxLength |
|
TextInputLayout_counterOverflowTextAppearance |
|
TextInputLayout_counterOverflowTextColor |
|
TextInputLayout_counterTextAppearance |
|
TextInputLayout_counterTextColor |
|
TextInputLayout_cursorColor |
|
TextInputLayout_cursorErrorColor |
|
TextInputLayout_endIconCheckable |
|
TextInputLayout_endIconContentDescription |
|
TextInputLayout_endIconDrawable |
|
TextInputLayout_endIconMode |
|
TextInputLayout_endIconTint |
|
TextInputLayout_endIconTintMode |
|
TextInputLayout_errorAccessibilityLiveRegion |
|
TextInputLayout_errorContentDescription |
|
TextInputLayout_errorEnabled |
|
TextInputLayout_errorIconDrawable |
|
TextInputLayout_errorIconTint |
|
TextInputLayout_errorIconTintMode |
|
TextInputLayout_errorTextAppearance |
|
TextInputLayout_helperTextEnabled |
|
TextInputLayout_helperTextTextAppearance |
|
TextInputLayout_hintAnimationEnabled |
|
TextInputLayout_hintEnabled |
|
TextInputLayout_hintTextAppearance |
|
TextInputLayout_hintTextColor |
|
TextInputLayout_passwordToggleContentDescription |
|
TextInputLayout_passwordToggleDrawable |
|
TextInputLayout_passwordToggleEnabled |
|
TextInputLayout_passwordToggleTint |
|
TextInputLayout_passwordToggleTintMode |
|
TextInputLayout_placeholderTextAppearance |
|
TextInputLayout_placeholderTextColor |
|
TextInputLayout_prefixTextAppearance |
|
TextInputLayout_prefixTextColor |
|
TextInputLayout_startIconCheckable |
|
TextInputLayout_startIconContentDescription |
|
TextInputLayout_startIconDrawable |
|
TextInputLayout_startIconTint |
|
TextInputLayout_startIconTintMode |
|
TextInputLayout_suffixTextAppearance |
|
TextInputLayout_suffixTextColor |
Constants | |
---|---|
int |
BOX_BACKGROUND_FILLED
|
int |
BOX_BACKGROUND_NONE
|
int |
BOX_BACKGROUND_OUTLINE
|
int |
END_ICON_CLEAR_TEXT
The TextInputLayout will show a clear text button while there is input in the EditText. |
int |
END_ICON_CUSTOM
The TextInputLayout will show a custom icon specified by the user. |
int |
END_ICON_DROPDOWN_MENU
The TextInputLayout will show a dropdown button if the EditText is an |
int |
END_ICON_NONE
Default for the TextInputLayout. |
int |
END_ICON_PASSWORD_TOGGLE
The TextInputLayout will show a password toggle button if its EditText displays a password. |
Inherited constants |
---|
Inherited fields |
---|
Public constructors | |
---|---|
TextInputLayout(Context context)
|
|
TextInputLayout(Context context, AttributeSet attrs)
|
|
TextInputLayout(Context context, AttributeSet attrs, int defStyleAttr)
|
Public methods | |
---|---|
void
|
addOnEditTextAttachedListener(TextInputLayout.OnEditTextAttachedListener listener)
Add a |
void
|
addOnEndIconChangedListener(TextInputLayout.OnEndIconChangedListener listener)
Add a |
void
|
addView(View child, int index, ViewGroup.LayoutParams params)
|
void
|
clearOnEditTextAttachedListeners()
Remove all previously added |
void
|
clearOnEndIconChangedListeners()
Remove all previously added |
void
|
dispatchProvideAutofillStructure(ViewStructure structure, int flags)
|
void
|
draw(Canvas canvas)
|
int
|
getBaseline()
|
int
|
getBoxBackgroundColor()
Returns the filled box's default background color. |
int
|
getBoxBackgroundMode()
Get the box background mode (filled, outline, or none). |
int
|
getBoxCollapsedPaddingTop()
Returns the EditText's collapsed top padding |
float
|
getBoxCornerRadiusBottomEnd()
Returns the box's bottom end corner radius. |
float
|
getBoxCornerRadiusBottomStart()
Returns the box's bottom start corner radius. |
float
|
getBoxCornerRadiusTopEnd()
Returns the box's top end corner radius. |
float
|
getBoxCornerRadiusTopStart()
Returns the box's top start corner radius. |
int
|
getBoxStrokeColor()
Returns the box's stroke focused color. |
ColorStateList
|
getBoxStrokeErrorColor()
Returns the box's stroke color when an error is being displayed. |
int
|
getBoxStrokeWidth()
Returns the box's stroke width. |
int
|
getBoxStrokeWidthFocused()
Returns the box's stroke focused width. |
int
|
getCounterMaxLength()
Returns the max length shown at the character counter. |
ColorStateList
|
getCounterOverflowTextColor()
Returns the text color used for the overflowed character counter, or null if one has not been set. |
ColorStateList
|
getCounterTextColor()
Returns the text color used for the character counter, or null if one has not been set. |
ColorStateList
|
getCursorColor()
Returns the cursor color. |
ColorStateList
|
getCursorErrorColor()
Returns the cursor error color. |
ColorStateList
|
getDefaultHintTextColor()
Returns the text color used by the hint in both the collapsed and expanded states, or null if no color has been set. |
EditText
|
getEditText()
Returns the |
CharSequence
|
getEndIconContentDescription()
Returns the currently configured content description for the end icon. |
Drawable
|
getEndIconDrawable()
Returns the drawable currently used for the end icon. |
int
|
getEndIconMinSize()
Returns the minimum size of the end icon. |
int
|
getEndIconMode()
Returns the current end icon mode. |
ImageView.ScaleType
|
getEndIconScaleType()
Returns the |
CharSequence
|
getError()
Returns the error message that was set to be displayed with |
int
|
getErrorAccessibilityLiveRegion()
Returns the accessibility live region of the error message. |
CharSequence
|
getErrorContentDescription()
Returns the content description of the error message, or null if not set. |
int
|
getErrorCurrentTextColors()
Returns the text color used by the error message in current state. |
Drawable
|
getErrorIconDrawable()
Returns the drawable currently used for the error icon. |
CharSequence
|
getHelperText()
Returns the helper message that was set to be displayed with |
int
|
getHelperTextCurrentTextColor()
Returns the text color used by the helper text in the current states. |
CharSequence
|
getHint()
Returns the hint which is displayed in the floating label, if enabled. |
ColorStateList
|
getHintTextColor()
Gets the collapsed hint text color. |
TextInputLayout.LengthCounter
|
getLengthCounter()
Returns the counting method used to count the length of the text. |
int
|
getMaxEms()
Returns the text field's maximum width in terms of ems, or -1 if no maximum width is set. |
int
|
getMaxWidth()
Returns the text field's maximum width, or -1 if no maximum width is set. |
int
|
getMinEms()
Returns the text field's minimum width in terms of ems, or -1 if no minimum width is set. |
int
|
getMinWidth()
Returns the text field's minimum width, or -1 if no minimum width is set. |
CharSequence
|
getPasswordVisibilityToggleContentDescription()
This method is deprecated.
Use |
Drawable
|
getPasswordVisibilityToggleDrawable()
This method is deprecated.
Use |
CharSequence
|
getPlaceholderText()
Returns the placeholder text that was set to be displayed with |
int
|
getPlaceholderTextAppearance()
Returns the TextAppearance resource used for the placeholder text color. |
ColorStateList
|
getPlaceholderTextColor()
Returns the ColorStateList used for the placeholder text. |
CharSequence
|
getPrefixText()
Returns the prefix text that was set to be displayed with |
ColorStateList
|
getPrefixTextColor()
Returns the ColorStateList used for the prefix text. |
TextView
|
getPrefixTextView()
Returns the prefix text view. |
ShapeAppearanceModel
|
getShapeAppearanceModel()
Returns the |
CharSequence
|
getStartIconContentDescription()
Returns the currently configured content description for the start icon. |
Drawable
|
getStartIconDrawable()
Returns the start icon. |
int
|
getStartIconMinSize()
Returns the size of the start icon. |
ImageView.ScaleType
|
getStartIconScaleType()
Returns the |
CharSequence
|
getSuffixText()
Returns the suffix text that was set to be displayed with |
ColorStateList
|
getSuffixTextColor()
Returns the ColorStateList used for the suffix text. |
TextView
|
getSuffixTextView()
Returns the suffix text view. |
Typeface
|
getTypeface()
Returns the typeface used for the hint and any label views (such as counter and error views). |
boolean
|
isCounterEnabled()
Returns whether the character counter functionality is enabled or not in this layout. |
boolean
|
isEndIconCheckable()
Returns whether the end icon is checkable. |
boolean
|
isEndIconVisible()
Returns whether the current end icon is visible. |
boolean
|
isErrorEnabled()
Returns whether the error functionality is enabled or not in this layout. |
boolean
|
isExpandedHintEnabled()
Returns whether the hint expands to occupy the input area when the text field is unpopulated and not focused. |
boolean
|
isHelperTextEnabled()
Returns whether the helper text functionality is enabled or not in this layout. |
boolean
|
isHintAnimationEnabled()
Returns whether any hint state changes, due to being focused or non-empty text, are animated. |
boolean
|
isHintEnabled()
Returns whether the floating label functionality is enabled or not in this layout. |
boolean
|
isPasswordVisibilityToggleEnabled()
This method is deprecated.
Use |
boolean
|
isStartIconCheckable()
Returns whether the start icon is checkable. |
boolean
|
isStartIconVisible()
Returns whether the current start icon is visible. |
void
|
onGlobalLayout()
|
void
|
onRtlPropertiesChanged(int layoutDirection)
|
Parcelable
|
onSaveInstanceState()
|
void
|
passwordVisibilityToggleRequested(boolean shouldSkipAnimations)
This method is deprecated.
The password toggle will show as checked or unchecked depending on whether the
|
void
|
refreshEndIconDrawableState()
This method should be called from within your icon's click listener if your icon's tint list has a color for a state that depends on a click (such as checked state). |
void
|
refreshErrorIconDrawableState()
This method should be called from within your icon's click listener if your icon's tint list has a color for a state that depends on a click (such as checked state). |
void
|
refreshStartIconDrawableState()
This method should be called from within your icon's click listener if your icon's tint list has a color for a state that depends on a click (such as checked state). |
void
|
removeOnEditTextAttachedListener(TextInputLayout.OnEditTextAttachedListener listener)
Remove the given |
void
|
removeOnEndIconChangedListener(TextInputLayout.OnEndIconChangedListener listener)
Remove the given |
void
|
setBoxBackgroundColor(int boxBackgroundColor)
Sets the filled box's default background color. |
void
|
setBoxBackgroundColorResource(int boxBackgroundColorId)
Set the resource used for the filled box's background color. |
void
|
setBoxBackgroundColorStateList(ColorStateList boxBackgroundColorStateList)
Sets the box's background color state list. |
void
|
setBoxBackgroundMode(int boxBackgroundMode)
Set the box background mode (filled, outline, or none). |
void
|
setBoxCollapsedPaddingTop(int boxCollapsedPaddingTop)
Set the value to use for the EditText's collapsed top padding in box mode. |
void
|
setBoxCornerFamily(int cornerFamily)
Sets the box's corner family for all corners of the text field. |
void
|
setBoxCornerRadii(float boxCornerRadiusTopStart, float boxCornerRadiusTopEnd, float boxCornerRadiusBottomStart, float boxCornerRadiusBottomEnd)
Set the box's corner radii. |
void
|
setBoxCornerRadiiResources(int boxCornerRadiusTopStartId, int boxCornerRadiusTopEndId, int boxCornerRadiusBottomEndId, int boxCornerRadiusBottomStartId)
Set the resources used for the box's corner radii. |
void
|
setBoxStrokeColor(int boxStrokeColor)
Set the outline box's stroke focused color. |
void
|
setBoxStrokeColorStateList(ColorStateList boxStrokeColorStateList)
Set the box's stroke color state list. |
void
|
setBoxStrokeErrorColor(ColorStateList strokeErrorColor)
Set the outline box's stroke color when an error is being displayed. |
void
|
setBoxStrokeWidth(int boxStrokeWidth)
Set the value to use for the box's stroke when in outline box mode, or for the underline stroke in filled mode. |
void
|
setBoxStrokeWidthFocused(int boxStrokeWidthFocused)
Set the value to use for the focused box's stroke when in outline box mode, or for the focused underline stroke in filled mode. |
void
|
setBoxStrokeWidthFocusedResource(int boxStrokeWidthFocusedResId)
Set the resource dimension to use for the focused box's stroke when in outline box mode, or for the focused underline stroke in filled mode. |
void
|
setBoxStrokeWidthResource(int boxStrokeWidthResId)
Set the resource dimension to use for the box's stroke when in outline box mode, or for the underline stroke in filled mode. |
void
|
setCounterEnabled(boolean enabled)
Whether the character counter functionality is enabled or not in this layout. |
void
|
setCounterMaxLength(int maxLength)
Sets the max length to display at the character counter. |
void
|
setCounterOverflowTextAppearance(int counterOverflowTextAppearance)
Sets the text color and size for the overflowed character counter using the specified TextAppearance resource. |
void
|
setCounterOverflowTextColor(ColorStateList counterOverflowTextColor)
Sets the text color for the overflowed character counter using a ColorStateList. |
void
|
setCounterTextAppearance(int counterTextAppearance)
Sets the text color and size for the character counter using the specified TextAppearance resource. |
void
|
setCounterTextColor(ColorStateList counterTextColor)
Sets the text color for the character counter using a ColorStateList. |
void
|
setCursorColor(ColorStateList cursorColor)
Sets the cursor color. |
void
|
setCursorErrorColor(ColorStateList cursorErrorColor)
Sets the cursor color when an error is being displayed. |
void
|
setDefaultHintTextColor(ColorStateList textColor)
Sets the text color used by the hint in both the collapsed and expanded states. |
void
|
setEnabled(boolean enabled)
|
void
|
setEndIconActivated(boolean endIconActivated)
Sets the current end icon's state to be activated or not. |
void
|
setEndIconCheckable(boolean endIconCheckable)
Sets the current end icon to be checkable or not. |
void
|
setEndIconContentDescription(int resId)
Set a content description for the end icon. |
void
|
setEndIconContentDescription(CharSequence endIconContentDescription)
Set a content description for the end icon. |
void
|
setEndIconDrawable(Drawable endIconDrawable)
Set the icon to use for the end icon. |
void
|
setEndIconDrawable(int resId)
Set the icon to use for the end icon. |
void
|
setEndIconMinSize(int iconSize)
Sets the width and height of the end icon. |
void
|
setEndIconMode(int endIconMode)
Set up the end icon mode. |
void
|
setEndIconOnClickListener(View.OnClickListener endIconOnClickListener)
Sets the end icon's functionality that is performed when the icon is clicked. |
void
|
setEndIconOnLongClickListener(View.OnLongClickListener endIconOnLongClickListener)
Sets the end icon's functionality that is performed when the end icon is long clicked. |
void
|
setEndIconScaleType(ImageView.ScaleType scaleType)
Sets |
void
|
setEndIconTintList(ColorStateList endIconTintList)
Applies a tint to the end icon drawable. |
void
|
setEndIconTintMode(PorterDuff.Mode endIconTintMode)
Specifies the blending mode used to apply the tint specified by |
void
|
setEndIconVisible(boolean visible)
Sets the current end icon to be VISIBLE or GONE. |
void
|
setError(CharSequence errorText)
Sets an error message that will be displayed below our |
void
|
setErrorAccessibilityLiveRegion(int errorAccessibilityLiveRegion)
Sets an accessibility live region for the error message. |
void
|
setErrorContentDescription(CharSequence errorContentDescription)
Sets a content description for the error message. |
void
|
setErrorEnabled(boolean enabled)
Whether the error functionality is enabled or not in this layout. |
void
|
setErrorIconDrawable(int resId)
Set the drawable to use for the error icon. |
void
|
setErrorIconDrawable(Drawable errorIconDrawable)
Set the drawable to use for the error icon. |
void
|
setErrorIconOnClickListener(View.OnClickListener errorIconOnClickListener)
Sets the error icon's functionality that is performed when the icon is clicked. |
void
|
setErrorIconOnLongClickListener(View.OnLongClickListener errorIconOnLongClickListener)
Sets the error icon's functionality that is performed when the end icon is long clicked. |
void
|
setErrorIconTintList(ColorStateList errorIconTintList)
Applies a tint to the error icon drawable. |
void
|
setErrorIconTintMode(PorterDuff.Mode errorIconTintMode)
Specifies the blending mode used to apply tint to the end icon drawable. |
void
|
setErrorTextAppearance(int errorTextAppearance)
Sets the text color and size for the error message from the specified TextAppearance resource. |
void
|
setErrorTextColor(ColorStateList errorTextColor)
Sets the text color used by the error message in all states. |
void
|
setExpandedHintEnabled(boolean enabled)
Sets whether the hint should expand to occupy the input area when the text field is unpopulated and not focused. |
void
|
setHelperText(CharSequence helperText)
Sets a helper message that will be displayed below the |
void
|
setHelperTextColor(ColorStateList helperTextColor)
Sets the text color used by the helper text in all states. |
void
|
setHelperTextEnabled(boolean enabled)
Whether the helper text functionality is enabled or not in this layout. |
void
|
setHelperTextTextAppearance(int helperTextTextAppearance)
Sets the text color and size for the helper text from the specified TextAppearance resource. |
void
|
setHint(CharSequence hint)
Set the hint to be displayed in the floating label, if enabled. |
void
|
setHint(int textHintId)
Set the hint to be displayed in the floating label, if enabled, using the given resource id. |
void
|
setHintAnimationEnabled(boolean enabled)
Set whether any hint state changes, due to being focused or non-empty text, are animated. |
void
|
setHintEnabled(boolean enabled)
Sets whether the floating label functionality is enabled or not in this layout. |
void
|
setHintTextAppearance(int resId)
Sets the collapsed hint text color, size, style from the specified TextAppearance resource. |
void
|
setHintTextColor(ColorStateList hintTextColor)
Sets the collapsed hint text color from the specified ColorStateList resource. |
void
|
setLengthCounter(TextInputLayout.LengthCounter lengthCounter)
Set the counting method used to count the length of a text. |
void
|
setMaxEms(int maxEms)
Sets the maximum width in terms of ems of the text field. |
void
|
setMaxWidth(int maxWidth)
Sets the maximum width of the text field. |
void
|
setMaxWidthResource(int maxWidthId)
Sets the maximum width of the text field. |
void
|
setMinEms(int minEms)
Sets the minimum width in terms of ems of the text field. |
void
|
setMinWidth(int minWidth)
Sets the minimum width of the text field. |
void
|
setMinWidthResource(int minWidthId)
Sets the minimum width of the text field. |
void
|
setPasswordVisibilityToggleContentDescription(CharSequence description)
This method is deprecated.
Use |
void
|
setPasswordVisibilityToggleContentDescription(int resId)
This method is deprecated.
Use |
void
|
setPasswordVisibilityToggleDrawable(Drawable icon)
This method is deprecated.
Use |
void
|
setPasswordVisibilityToggleDrawable(int resId)
This method is deprecated.
Use |
void
|
setPasswordVisibilityToggleEnabled(boolean enabled)
This method is deprecated.
Use |
void
|
setPasswordVisibilityToggleTintList(ColorStateList tintList)
This method is deprecated.
Use |
void
|
setPasswordVisibilityToggleTintMode(PorterDuff.Mode mode)
This method is deprecated.
Use |
void
|
setPlaceholderText(CharSequence placeholderText)
Sets placeholder text that will be displayed in the input area when the hint is collapsed before text is entered. |
void
|
setPlaceholderTextAppearance(int placeholderTextAppearance)
Sets the text color and size for the placeholder text from the specified TextAppearance resource. |
void
|
setPlaceholderTextColor(ColorStateList placeholderTextColor)
Sets the text color used by the placeholder text in all states. |
void
|
setPrefixText(CharSequence prefixText)
Sets prefix text that will be displayed in the input area when the hint is collapsed before text is entered. |
void
|
setPrefixTextAppearance(int prefixTextAppearance)
Sets the text color and size for the prefix text from the specified TextAppearance resource. |
void
|
setPrefixTextColor(ColorStateList prefixTextColor)
Sets the text color used by the prefix text in all states. |
void
|
setShapeAppearanceModel(ShapeAppearanceModel shapeAppearanceModel)
Sets the |
void
|
setStartIconCheckable(boolean startIconCheckable)
Sets the current start icon to be checkable or not. |
void
|
setStartIconContentDescription(CharSequence startIconContentDescription)
Set a content description for the start icon. |
void
|
setStartIconContentDescription(int resId)
Set a content description for the start icon. |
void
|
setStartIconDrawable(Drawable startIconDrawable)
Sets the start icon. |
void
|
setStartIconDrawable(int resId)
Sets the start icon. |
void
|
setStartIconMinSize(int iconSize)
Sets the width and height of the start icon. |
void
|
setStartIconOnClickListener(View.OnClickListener startIconOnClickListener)
Sets the start icon's functionality that is performed when the start icon is clicked. |
void
|
setStartIconOnLongClickListener(View.OnLongClickListener startIconOnLongClickListener)
Sets the start icon's functionality that is performed when the start icon is long clicked. |
void
|
setStartIconScaleType(ImageView.ScaleType scaleType)
Sets |
void
|
setStartIconTintList(ColorStateList startIconTintList)
Applies a tint to the start icon drawable. |
void
|
setStartIconTintMode(PorterDuff.Mode startIconTintMode)
Specifies the blending mode used to apply the tint specified by |
void
|
setStartIconVisible(boolean visible)
Sets the start icon to be VISIBLE or GONE. |
void
|
setSuffixText(CharSequence suffixText)
Sets suffix text that will be displayed in the input area when the hint is collapsed before text is entered. |
void
|
setSuffixTextAppearance(int suffixTextAppearance)
Sets the text color and size for the suffix text from the specified TextAppearance resource. |
void
|
setSuffixTextColor(ColorStateList suffixTextColor)
Sets the text color used by the suffix text in all states. |
void
|
setTextInputAccessibilityDelegate(TextInputLayout.AccessibilityDelegate delegate)
Sets an |
void
|
setTypeface(Typeface typeface)
Set the typeface to use for the hint and any label views (such as counter and error views). |
Protected methods | |
---|---|
void
|
dispatchRestoreInstanceState(SparseArray<Parcelable> container)
|
void
|
drawableStateChanged()
|
void
|
onConfigurationChanged(Configuration newConfig)
|
void
|
onLayout(boolean changed, int left, int top, int right, int bottom)
|
void
|
onMeasure(int widthMeasureSpec, int heightMeasureSpec)
|
void
|
onRestoreInstanceState(Parcelable state)
|
Inherited methods | |
---|---|
XML attributes
TextInputLayout_android_hint
Related methods:
TextInputLayout_android_maxEms
Related methods:
TextInputLayout_android_maxWidth
Related methods:
TextInputLayout_android_minEms
Related methods:
TextInputLayout_android_minWidth
Related methods:
TextInputLayout_boxCollapsedPaddingTop
Related methods:
TextInputLayout_boxStrokeErrorColor
Related methods:
TextInputLayout_boxStrokeWidth
Related methods:
TextInputLayout_boxStrokeWidthFocused
Related methods:
TextInputLayout_counterEnabled
Related methods:
TextInputLayout_counterMaxLength
Related methods:
TextInputLayout_counterOverflowTextAppearance
Related methods:
TextInputLayout_counterOverflowTextColor
Related methods:
TextInputLayout_counterTextAppearance
Related methods:
TextInputLayout_counterTextColor
Related methods:
TextInputLayout_cursorColor
Related methods:
TextInputLayout_cursorErrorColor
Related methods:
TextInputLayout_endIconCheckable
Related methods:
TextInputLayout_endIconContentDescription
Related methods:
TextInputLayout_endIconDrawable
Related methods:
TextInputLayout_endIconMode
Related methods:
TextInputLayout_endIconTint
Related methods:
TextInputLayout_endIconTintMode
Related methods:
TextInputLayout_errorAccessibilityLiveRegion
Related methods:
TextInputLayout_errorContentDescription
Related methods:
TextInputLayout_errorEnabled
Related methods:
TextInputLayout_errorIconDrawable
Related methods:
TextInputLayout_errorIconTint
Related methods:
TextInputLayout_errorIconTintMode
Related methods:
TextInputLayout_errorTextAppearance
Related methods:
TextInputLayout_helperTextEnabled
Related methods:
TextInputLayout_helperTextTextAppearance
Related methods:
TextInputLayout_hintAnimationEnabled
Related methods:
TextInputLayout_hintEnabled
Related methods:
TextInputLayout_hintTextAppearance
Related methods:
TextInputLayout_hintTextColor
Related methods:
TextInputLayout_passwordToggleContentDescription
Related methods:
TextInputLayout_passwordToggleDrawable
Related methods:
TextInputLayout_passwordToggleEnabled
Related methods:
TextInputLayout_passwordToggleTint
Related methods:
TextInputLayout_passwordToggleTintMode
Related methods:
TextInputLayout_placeholderTextAppearance
Related methods:
TextInputLayout_placeholderTextColor
Related methods:
TextInputLayout_prefixTextAppearance
Related methods:
TextInputLayout_prefixTextColor
Related methods:
TextInputLayout_startIconCheckable
Related methods:
TextInputLayout_startIconContentDescription
Related methods:
TextInputLayout_startIconDrawable
Related methods:
TextInputLayout_startIconTint
Related methods:
TextInputLayout_startIconTintMode
Related methods:
TextInputLayout_suffixTextAppearance
Related methods:
TextInputLayout_suffixTextColor
Related methods:
Constants
BOX_BACKGROUND_FILLED
public static final int BOX_BACKGROUND_FILLED
Constant Value: 1 (0x00000001)
BOX_BACKGROUND_NONE
public static final int BOX_BACKGROUND_NONE
Constant Value: 0 (0x00000000)
BOX_BACKGROUND_OUTLINE
public static final int BOX_BACKGROUND_OUTLINE
Constant Value: 2 (0x00000002)
END_ICON_CLEAR_TEXT
public static final int END_ICON_CLEAR_TEXT
The TextInputLayout will show a clear text button while there is input in the EditText. Clicking it will clear out the text and hide the icon.
See also:
Constant Value: 2 (0x00000002)
END_ICON_CUSTOM
public static final int END_ICON_CUSTOM
The TextInputLayout will show a custom icon specified by the user.
See also:
Constant Value: -1 (0xffffffff)
END_ICON_DROPDOWN_MENU
public static final int END_ICON_DROPDOWN_MENU
The TextInputLayout will show a dropdown button if the EditText is an AutoCompleteTextView
and a Widget.MaterialComponents.TextInputLayout.(...).ExposedDropdownMenu
style is being used.
Clicking the button will display a popup with a list of options. The current selected option is displayed on the EditText.
Constant Value: 3 (0x00000003)
END_ICON_NONE
public static final int END_ICON_NONE
Default for the TextInputLayout. It will not display an end icon.
See also:
Constant Value: 0 (0x00000000)
END_ICON_PASSWORD_TOGGLE
public static final int END_ICON_PASSWORD_TOGGLE
The TextInputLayout will show a password toggle button if its EditText displays a password. When this end icon is clicked, the password is shown as plain-text if it was disguised, or vice-versa.
See also:
Constant Value: 1 (0x00000001)
Public constructors
TextInputLayout
public TextInputLayout (Context context)
Parameters | |
---|---|
context |
Context |
TextInputLayout
public TextInputLayout (Context context, AttributeSet attrs)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
TextInputLayout
public TextInputLayout (Context context, AttributeSet attrs, int defStyleAttr)
Parameters | |
---|---|
context |
Context |
attrs |
AttributeSet |
defStyleAttr |
int |
Public methods
addOnEditTextAttachedListener
public void addOnEditTextAttachedListener (TextInputLayout.OnEditTextAttachedListener listener)
Add a TextInputLayout.OnEditTextAttachedListener
that will be invoked when the edit text is attached,
or from this method if the EditText is already present.
Components that add a listener should take care to remove it when finished via removeOnEditTextAttachedListener(OnEditTextAttachedListener)
.
Parameters | |
---|---|
listener |
TextInputLayout.OnEditTextAttachedListener : listener to add
|
addOnEndIconChangedListener
public void addOnEndIconChangedListener (TextInputLayout.OnEndIconChangedListener listener)
Add a TextInputLayout.OnEndIconChangedListener
that will be invoked when the end icon
gets changed.
Components that add a listener should take care to remove it when finished via removeOnEndIconChangedListener(OnEndIconChangedListener)
.
Parameters | |
---|---|
listener |
TextInputLayout.OnEndIconChangedListener : listener to add
|
addView
public void addView (View child, int index, ViewGroup.LayoutParams params)
Parameters | |
---|---|
child |
View |
index |
int |
params |
ViewGroup.LayoutParams |
clearOnEditTextAttachedListeners
public void clearOnEditTextAttachedListeners ()
Remove all previously added TextInputLayout.OnEditTextAttachedListener
s.
clearOnEndIconChangedListeners
public void clearOnEndIconChangedListeners ()
Remove all previously added TextInputLayout.OnEndIconChangedListener
s.
dispatchProvideAutofillStructure
public void dispatchProvideAutofillStructure (ViewStructure structure, int flags)
Parameters | |
---|---|
structure |
ViewStructure |
flags |
int |
draw
public void draw (Canvas canvas)
Parameters | |
---|---|
canvas |
Canvas |
getBaseline
public int getBaseline ()
Returns | |
---|---|
int |
getBoxBackgroundColor
public int getBoxBackgroundColor ()
Returns the filled box's default background color.
Returns | |
---|---|
int |
the color used for the filled box's background |
See also:
getBoxBackgroundMode
public int getBoxBackgroundMode ()
Get the box background mode (filled, outline, or none).
May be one of BOX_BACKGROUND_NONE
, BOX_BACKGROUND_FILLED
, or BOX_BACKGROUND_OUTLINE
.
Returns | |
---|---|
int |
getBoxCollapsedPaddingTop
public int getBoxCollapsedPaddingTop ()
Returns the EditText's collapsed top padding
Returns | |
---|---|
int |
the value used for the box's padding top when collapsed |
See also:
getBoxCornerRadiusBottomEnd
public float getBoxCornerRadiusBottomEnd ()
Returns the box's bottom end corner radius.
Returns | |
---|---|
float |
the value used for the box's bottom end corner radius |
getBoxCornerRadiusBottomStart
public float getBoxCornerRadiusBottomStart ()
Returns the box's bottom start corner radius.
Returns | |
---|---|
float |
the value used for the box's bottom start corner radius |
getBoxCornerRadiusTopEnd
public float getBoxCornerRadiusTopEnd ()
Returns the box's top end corner radius.
Returns | |
---|---|
float |
the value used for the box's top end corner radius |
getBoxCornerRadiusTopStart
public float getBoxCornerRadiusTopStart ()
Returns the box's top start corner radius.
Returns | |
---|---|
float |
the value used for the box's top start corner radius |
getBoxStrokeColor
public int getBoxStrokeColor ()
Returns the box's stroke focused color.
Returns | |
---|---|
int |
the color used for the box's stroke when focused |
See also:
getBoxStrokeErrorColor
public ColorStateList getBoxStrokeErrorColor ()
Returns the box's stroke color when an error is being displayed.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
See also:
getBoxStrokeWidth
public int getBoxStrokeWidth ()
Returns the box's stroke width.
Returns | |
---|---|
int |
the value used for the box's stroke width |
See also:
getBoxStrokeWidthFocused
public int getBoxStrokeWidthFocused ()
Returns the box's stroke focused width.
Returns | |
---|---|
int |
the value used for the box's stroke width when focused |
See also:
getCounterMaxLength
public int getCounterMaxLength ()
Returns the max length shown at the character counter.
Related XML Attributes:
Returns | |
---|---|
int |
getCounterOverflowTextColor
public ColorStateList getCounterOverflowTextColor ()
Returns the text color used for the overflowed character counter, or null if one has not been set.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
the text color used for the overflowed character counter |
See also:
getCounterTextColor
public ColorStateList getCounterTextColor ()
Returns the text color used for the character counter, or null if one has not been set.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
the text color used for the character counter |
See also:
getCursorColor
public ColorStateList getCursorColor ()
Returns the cursor color. It will return the value of app:cursorColor
if set, or
null
otherwise.
Note: This value only has effect on API levels 28+. On lower API levels
?attr/colorControlActivated
will be used for the cursor color.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
See also:
getCursorErrorColor
public ColorStateList getCursorErrorColor ()
Returns the cursor error color.
Note: This value only has effect on API levels 28+. On lower API levels
?attr/colorControlActivated
will be used for the cursor color.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
See also:
getDefaultHintTextColor
public ColorStateList getDefaultHintTextColor ()
Returns the text color used by the hint in both the collapsed and expanded states, or null if no color has been set.
Returns | |
---|---|
ColorStateList |
getEditText
public EditText getEditText ()
Returns the EditText
used for text input.
Returns | |
---|---|
EditText |
getEndIconContentDescription
public CharSequence getEndIconContentDescription ()
Returns the currently configured content description for the end icon.
This will be used to describe the navigation action to users through mechanisms such as screen readers.
Returns | |
---|---|
CharSequence |
getEndIconDrawable
public Drawable getEndIconDrawable ()
Returns the drawable currently used for the end icon.
Related XML Attributes:
Returns | |
---|---|
Drawable |
See also:
getEndIconMinSize
public int getEndIconMinSize ()
Returns the minimum size of the end icon.
Returns | |
---|---|
int |
Returns the size of the end icon in pixels. |
See also:
getEndIconMode
public int getEndIconMode ()
Returns the current end icon mode.
Related XML Attributes:
Returns | |
---|---|
int |
the end icon mode enum |
See also:
getEndIconScaleType
public ImageView.ScaleType getEndIconScaleType ()
Returns the ERROR(/ImageView.ScaleType)
for the end icon's ImageButton.
Returns | |
---|---|
ImageView.ScaleType |
Returns the ERROR(/ImageView.ScaleType) for the end icon's ImageButton. |
See also:
getError
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 error displaying is not enabled.
Returns | |
---|---|
CharSequence |
See also:
getErrorAccessibilityLiveRegion
public int getErrorAccessibilityLiveRegion ()
Returns the accessibility live region of the error message.
Returns | |
---|---|
int |
See also:
getErrorContentDescription
public CharSequence getErrorContentDescription ()
Returns the content description of the error message, or null if not set.
Returns | |
---|---|
CharSequence |
See also:
getErrorCurrentTextColors
public int getErrorCurrentTextColors ()
Returns the text color used by the error message in current state.
Returns | |
---|---|
int |
getErrorIconDrawable
public Drawable getErrorIconDrawable ()
Returns the drawable currently used for the error icon.
Related XML Attributes:
Returns | |
---|---|
Drawable |
See also:
getHelperText
public CharSequence getHelperText ()
Returns the helper message that was set to be displayed with setHelperText(CharSequence)
, or null
if no helper text was set or if helper text
functionality is not enabled.
Returns | |
---|---|
CharSequence |
See also:
getHelperTextCurrentTextColor
public int getHelperTextCurrentTextColor ()
Returns the text color used by the helper text in the current states.
Returns | |
---|---|
int |
getHint
public CharSequence getHint ()
Returns the hint which is displayed in the floating label, if enabled.
Related XML Attributes:
Returns | |
---|---|
CharSequence |
the hint, or null if there isn't one set, or the hint is not enabled. |
getHintTextColor
public ColorStateList getHintTextColor ()
Gets the collapsed hint text color.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
getLengthCounter
public TextInputLayout.LengthCounter getLengthCounter ()
Returns the counting method used to count the length of the text. The default counter will count the number of characters.
Returns | |
---|---|
TextInputLayout.LengthCounter |
getMaxEms
public int getMaxEms ()
Returns the text field's maximum width in terms of ems, or -1 if no maximum width is set.
Related XML Attributes:
Returns | |
---|---|
int |
See also:
getMaxWidth
public int getMaxWidth ()
Returns the text field's maximum width, or -1 if no maximum width is set.
Related XML Attributes:
Returns | |
---|---|
int |
See also:
getMinEms
public int getMinEms ()
Returns the text field's minimum width in terms of ems, or -1 if no minimum width is set.
Related XML Attributes:
Returns | |
---|---|
int |
See also:
getMinWidth
public int getMinWidth ()
Returns the text field's minimum width, or -1 if no minimum width is set.
Related XML Attributes:
Returns | |
---|---|
int |
See also:
getPasswordVisibilityToggleContentDescription
public CharSequence getPasswordVisibilityToggleContentDescription ()
This method is deprecated.
Use getEndIconContentDescription()
instead.
Returns the currently configured content description for the password visibility toggle button.
This will be used to describe the navigation action to users through mechanisms such as screen readers.
Returns | |
---|---|
CharSequence |
getPasswordVisibilityToggleDrawable
public Drawable getPasswordVisibilityToggleDrawable ()
This method is deprecated.
Use getEndIconDrawable()
instead.
Returns the icon currently used for the password visibility toggle button.
Related XML Attributes:
Returns | |
---|---|
Drawable |
getPlaceholderText
public CharSequence getPlaceholderText ()
Returns the placeholder text that was set to be displayed with setPlaceholderText(CharSequence)
, or null
if there is no placeholder text.
Returns | |
---|---|
CharSequence |
See also:
getPlaceholderTextAppearance
public int getPlaceholderTextAppearance ()
Returns the TextAppearance resource used for the placeholder text color.
Related XML Attributes:
Returns | |
---|---|
int |
getPlaceholderTextColor
public ColorStateList getPlaceholderTextColor ()
Returns the ColorStateList used for the placeholder text.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
getPrefixText
public CharSequence getPrefixText ()
Returns the prefix text that was set to be displayed with setPrefixText(CharSequence)
,
or null
if there is no prefix text.
Returns | |
---|---|
CharSequence |
See also:
getPrefixTextColor
public ColorStateList getPrefixTextColor ()
Returns the ColorStateList used for the prefix text.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
getPrefixTextView
public TextView getPrefixTextView ()
Returns the prefix text view.
Note: In order for the prefix to work correctly, text should always be set only via setPrefixText(CharSequence)
, instead of on the TextView
directly.
Returns | |
---|---|
TextView |
See also:
getShapeAppearanceModel
public ShapeAppearanceModel getShapeAppearanceModel ()
Returns the ShapeAppearanceModel
of the text field's box background.
Returns | |
---|---|
ShapeAppearanceModel |
getStartIconContentDescription
public CharSequence getStartIconContentDescription ()
Returns the currently configured content description for the start icon.
This will be used to describe the navigation action to users through mechanisms such as screen readers.
Returns | |
---|---|
CharSequence |
getStartIconDrawable
public Drawable getStartIconDrawable ()
Returns the start icon.
Related XML Attributes:
Returns | |
---|---|
Drawable |
the drawable used for the start icon |
See also:
getStartIconMinSize
public int getStartIconMinSize ()
Returns the size of the start icon.
Returns | |
---|---|
int |
Returns the size of the start icon in pixels. |
See also:
getStartIconScaleType
public ImageView.ScaleType getStartIconScaleType ()
Returns the ERROR(/ImageView.ScaleType)
for the start icon's ImageButton.
Returns | |
---|---|
ImageView.ScaleType |
Returns the ERROR(/ImageView.ScaleType) for the start icon's ImageButton. |
See also:
getSuffixText
public CharSequence getSuffixText ()
Returns the suffix text that was set to be displayed with setSuffixText(CharSequence)
,
or null
if there is no suffix text.
Returns | |
---|---|
CharSequence |
See also:
getSuffixTextColor
public ColorStateList getSuffixTextColor ()
Returns the ColorStateList used for the suffix text.
Related XML Attributes:
Returns | |
---|---|
ColorStateList |
getSuffixTextView
public TextView getSuffixTextView ()
Returns the suffix text view.
Note: In order for the suffix to work correctly, text should always be set only via setSuffixText(CharSequence)
, instead of on the TextView
directly.
Returns | |
---|---|
TextView |
See also:
getTypeface
public Typeface getTypeface ()
Returns the typeface used for the hint and any label views (such as counter and error views).
Returns | |
---|---|
Typeface |
isCounterEnabled
public boolean isCounterEnabled ()
Returns whether the character counter functionality is enabled or not in this layout.
Related XML Attributes:
Returns | |
---|---|
boolean |
See also:
isEndIconCheckable
public boolean isEndIconCheckable ()
Returns whether the end icon is checkable.
Returns | |
---|---|
boolean |
See also:
isEndIconVisible
public boolean isEndIconVisible ()
Returns whether the current end icon is visible.
Returns | |
---|---|
boolean |
See also:
isErrorEnabled
public boolean isErrorEnabled ()
Returns whether the error functionality is enabled or not in this layout.
Related XML Attributes:
Returns | |
---|---|
boolean |
See also:
isExpandedHintEnabled
public boolean isExpandedHintEnabled ()
Returns whether the hint expands to occupy the input area when the text field is unpopulated and not focused.
Returns | |
---|---|
boolean |
See also:
isHelperTextEnabled
public boolean isHelperTextEnabled ()
Returns whether the helper text functionality is enabled or not in this layout.
Related XML Attributes:
Returns | |
---|---|
boolean |
See also:
isHintAnimationEnabled
public boolean isHintAnimationEnabled ()
Returns whether any hint state changes, due to being focused or non-empty text, are animated.
Related XML Attributes:
Returns | |
---|---|
boolean |
See also:
isHintEnabled
public boolean isHintEnabled ()
Returns whether the floating label functionality is enabled or not in this layout.
Related XML Attributes:
Returns | |
---|---|
boolean |
See also:
isPasswordVisibilityToggleEnabled
public boolean isPasswordVisibilityToggleEnabled ()
This method is deprecated.
Use getEndIconMode()
instead.
Returns whether the password visibility toggle functionality is currently enabled.
Returns | |
---|---|
boolean |
isStartIconCheckable
public boolean isStartIconCheckable ()
Returns whether the start icon is checkable.
Returns | |
---|---|
boolean |
See also:
isStartIconVisible
public boolean isStartIconVisible ()
Returns whether the current start icon is visible.
Returns | |
---|---|
boolean |
See also:
onGlobalLayout
public void onGlobalLayout ()
onRtlPropertiesChanged
public void onRtlPropertiesChanged (int layoutDirection)
Parameters | |
---|---|
layoutDirection |
int |
onSaveInstanceState
public Parcelable onSaveInstanceState ()
Returns | |
---|---|
Parcelable |
passwordVisibilityToggleRequested
public void passwordVisibilityToggleRequested (boolean shouldSkipAnimations)
This method is deprecated.
The password toggle will show as checked or unchecked depending on whether the
EditText
's TransformationMethod
is of type PasswordTransformationMethod
Handles visibility for a password toggle icon when changing obfuscation in a password edit text. Public so that clients can override this method for custom UI changes when toggling the display of password text
Parameters | |
---|---|
shouldSkipAnimations |
boolean : true if the password toggle indicator icon should not animate
changes |
refreshEndIconDrawableState
public void refreshEndIconDrawableState ()
This method should be called from within your icon's click listener if your icon's tint list has a color for a state that depends on a click (such as checked state).
refreshErrorIconDrawableState
public void refreshErrorIconDrawableState ()
This method should be called from within your icon's click listener if your icon's tint list has a color for a state that depends on a click (such as checked state).
refreshStartIconDrawableState
public void refreshStartIconDrawableState ()
This method should be called from within your icon's click listener if your icon's tint list has a color for a state that depends on a click (such as checked state).
removeOnEditTextAttachedListener
public void removeOnEditTextAttachedListener (TextInputLayout.OnEditTextAttachedListener listener)
Remove the given TextInputLayout.OnEditTextAttachedListener
that was previously added via addOnEditTextAttachedListener(OnEditTextAttachedListener)
.
Parameters | |
---|---|
listener |
TextInputLayout.OnEditTextAttachedListener : listener to remove
|
removeOnEndIconChangedListener
public void removeOnEndIconChangedListener (TextInputLayout.OnEndIconChangedListener listener)
Remove the given TextInputLayout.OnEndIconChangedListener
that was previously added via
addOnEndIconChangedListener(OnEndIconChangedListener)
.
Parameters | |
---|---|
listener |
TextInputLayout.OnEndIconChangedListener : listener to remove
|
setBoxBackgroundColor
public void setBoxBackgroundColor (int boxBackgroundColor)
Sets the filled box's default background color. Calling this method will make the background color not be stateful, if it was before.
Note: The background color is only supported for filled boxes. When used with box variants
other than BOX_BACKGROUND_FILLED
, the box background color may not
work as intended.
Parameters | |
---|---|
boxBackgroundColor |
int : the color to use for the filled box's background |
See also:
setBoxBackgroundColorResource
public void setBoxBackgroundColorResource (int boxBackgroundColorId)
Set the resource used for the filled box's background color.
Note: The background color is only supported for filled boxes. When used with box variants
other than BOX_BACKGROUND_FILLED
, the box background color may not
work as intended.
Parameters | |
---|---|
boxBackgroundColorId |
int : the resource to use for the box's background color
|
setBoxBackgroundColorStateList
public void setBoxBackgroundColorStateList (ColorStateList boxBackgroundColorStateList)
Sets the box's background color state list.
Note: The background color is only supported for filled boxes. When used with box variants
other than BOX_BACKGROUND_FILLED
, the box background color may not
work as intended.
Parameters | |
---|---|
boxBackgroundColorStateList |
ColorStateList : the color state list to use for the box's background color
|
setBoxBackgroundMode
public void setBoxBackgroundMode (int boxBackgroundMode)
Set the box background mode (filled, outline, or none).
May be one of BOX_BACKGROUND_NONE
, BOX_BACKGROUND_FILLED
, or BOX_BACKGROUND_OUTLINE
.
Note: This method defines TextInputLayout's internal behavior (for example, it allows the
hint to be displayed inline with the stroke in a cutout), but doesn't set all attributes that
are set in the styles provided for the box background modes. To achieve the look of an outlined
or filled text field, supplement this method with other methods that modify the box, such as
setBoxStrokeColor(int)
and setBoxBackgroundColor(int)
.
Parameters | |
---|---|
boxBackgroundMode |
int : box's background mode |
Throws | |
---|---|
IllegalArgumentException |
if boxBackgroundMode is not a @BoxBackgroundMode constant |
setBoxCollapsedPaddingTop
public void setBoxCollapsedPaddingTop (int boxCollapsedPaddingTop)
Set the value to use for the EditText's collapsed top padding in box mode.
Customized boxCollapsedPaddingTop will be disabled if the font scale is larger than 1.3.
Related XML Attributes:
Parameters | |
---|---|
boxCollapsedPaddingTop |
int : the value to use for the EditText's collapsed top padding |
See also:
setBoxCornerFamily
public void setBoxCornerFamily (int cornerFamily)
Sets the box's corner family for all corners of the text field.
Parameters | |
---|---|
cornerFamily |
int : the CornerFamily to be used. May be one of CornerFamily.ROUNDED or CornerFamily.CUT .
|
setBoxCornerRadii
public void setBoxCornerRadii (float boxCornerRadiusTopStart, float boxCornerRadiusTopEnd, float boxCornerRadiusBottomStart, float boxCornerRadiusBottomEnd)
Set the box's corner radii.
Parameters | |
---|---|
boxCornerRadiusTopStart |
float : the value to use for the box's top start corner radius |
boxCornerRadiusTopEnd |
float : the value to use for the box's top end corner radius |
boxCornerRadiusBottomStart |
float : the value to use for the box's bottom start corner radius |
boxCornerRadiusBottomEnd |
float : the value to use for the box's bottom end corner radius |
setBoxCornerRadiiResources
public void setBoxCornerRadiiResources (int boxCornerRadiusTopStartId, int boxCornerRadiusTopEndId, int boxCornerRadiusBottomEndId, int boxCornerRadiusBottomStartId)
Set the resources used for the box's corner radii.
Parameters | |
---|---|
boxCornerRadiusTopStartId |
int : the resource to use for the box's top start corner radius |
boxCornerRadiusTopEndId |
int : the resource to use for the box's top end corner radius |
boxCornerRadiusBottomEndId |
int : the resource to use for the box's bottom end corner radius |
boxCornerRadiusBottomStartId |
int : the resource to use for the box's bottom start corner
radius
|
setBoxStrokeColor
public void setBoxStrokeColor (int boxStrokeColor)
Set the outline box's stroke focused color.
Calling this method when not in outline box mode will do nothing.
Parameters | |
---|---|
boxStrokeColor |
int : the color to use for the box's stroke when focused |
See also:
setBoxStrokeColorStateList
public void setBoxStrokeColorStateList (ColorStateList boxStrokeColorStateList)
Set the box's stroke color state list.
Parameters | |
---|---|
boxStrokeColorStateList |
ColorStateList : the color state list to use for the box's stroke
|
setBoxStrokeErrorColor
public void setBoxStrokeErrorColor (ColorStateList strokeErrorColor)
Set the outline box's stroke color when an error is being displayed.
Calling this method when not in outline box mode will do nothing.
Parameters | |
---|---|
strokeErrorColor |
ColorStateList : the error color to use for the box's stroke |
See also:
setBoxStrokeWidth
public void setBoxStrokeWidth (int boxStrokeWidth)
Set the value to use for the box's stroke when in outline box mode, or for the underline stroke in filled mode.
Related XML Attributes:
Parameters | |
---|---|
boxStrokeWidth |
int : the value to use for the box's stroke |
See also:
setBoxStrokeWidthFocused
public void setBoxStrokeWidthFocused (int boxStrokeWidthFocused)
Set the value to use for the focused box's stroke when in outline box mode, or for the focused underline stroke in filled mode.
Related XML Attributes:
Parameters | |
---|---|
boxStrokeWidthFocused |
int : the value to use for the box's stroke when focused |
See also:
setBoxStrokeWidthFocusedResource
public void setBoxStrokeWidthFocusedResource (int boxStrokeWidthFocusedResId)
Set the resource dimension to use for the focused box's stroke when in outline box mode, or for the focused underline stroke in filled mode.
Related XML Attributes:
Parameters | |
---|---|
boxStrokeWidthFocusedResId |
int : the resource dimension to use for the box's stroke width when
focused |
setBoxStrokeWidthResource
public void setBoxStrokeWidthResource (int boxStrokeWidthResId)
Set the resource dimension to use for the box's stroke when in outline box mode, or for the underline stroke in filled mode.
Related XML Attributes:
Parameters | |
---|---|
boxStrokeWidthResId |
int : the resource dimension to use for the box's stroke width |
setCounterEnabled
public void setCounterEnabled (boolean enabled)
Whether the character counter functionality is enabled or not in this layout.
Related XML Attributes:
Parameters | |
---|---|
enabled |
boolean |
setCounterMaxLength
public void setCounterMaxLength (int maxLength)
Sets the max length to display at the character counter.
Related XML Attributes:
Parameters | |
---|---|
maxLength |
int : maxLength to display. Any value less than or equal to 0 will not be shown. |
setCounterOverflowTextAppearance
public void setCounterOverflowTextAppearance (int counterOverflowTextAppearance)
Sets the text color and size for the overflowed character counter using the specified TextAppearance resource.
Related XML Attributes:
Parameters | |
---|---|
counterOverflowTextAppearance |
int |
setCounterOverflowTextColor
public void setCounterOverflowTextColor (ColorStateList counterOverflowTextColor)
Sets the text color for the overflowed character counter using a ColorStateList.
This text color takes precedence over a text color set in counterOverflowTextAppearance.
Related XML Attributes:
Parameters | |
---|---|
counterOverflowTextColor |
ColorStateList : the text color used for the overflowed character counter
|
See also:
setCounterTextAppearance
public void setCounterTextAppearance (int counterTextAppearance)
Sets the text color and size for the character counter using the specified TextAppearance resource.
Related XML Attributes:
Parameters | |
---|---|
counterTextAppearance |
int |
See also:
setCounterTextColor
public void setCounterTextColor (ColorStateList counterTextColor)
Sets the text color for the character counter using a ColorStateList.
This text color takes precedence over a text color set in counterTextAppearance.
Related XML Attributes:
Parameters | |
---|---|
counterTextColor |
ColorStateList : text color used for the character counter
|
setCursorColor
public void setCursorColor (ColorStateList cursorColor)
Sets the cursor color. Using this method will take precedence over using the
value of ?attr/colorControlActivated
.
Note: This method only has effect on API levels 28+. On lower API levels
?attr/colorControlActivated
will be used for the cursor color.
Related XML Attributes:
Parameters | |
---|---|
cursorColor |
ColorStateList : the cursor color to be set |
setCursorErrorColor
public void setCursorErrorColor (ColorStateList cursorErrorColor)
Sets the cursor color when an error is being displayed. If null, the cursor doesn't change its color when the text field is in an error state.
Note: This method only has effect on API levels 28+. On lower API levels
?attr/colorControlActivated
will be used for the cursor color.
Related XML Attributes:
Parameters | |
---|---|
cursorErrorColor |
ColorStateList : the error color to use for the cursor |
setDefaultHintTextColor
public void setDefaultHintTextColor (ColorStateList textColor)
Sets the text color used by the hint in both the collapsed and expanded states.
Parameters | |
---|---|
textColor |
ColorStateList |
setEnabled
public void setEnabled (boolean enabled)
Parameters | |
---|---|
enabled |
boolean |
setEndIconActivated
public void setEndIconActivated (boolean endIconActivated)
Sets the current end icon's state to be activated or not.
Parameters | |
---|---|
endIconActivated |
boolean : whether the icon should be activated
|
setEndIconCheckable
public void setEndIconCheckable (boolean endIconCheckable)
Sets the current end icon to be checkable or not.
If the icon works just as a button and the fact that it's checked or not doesn't affect its behavior, such as the clear text end icon, calling this method is encouraged so that screen readers will not announce the icon's checked state.
Related XML Attributes:
Parameters | |
---|---|
endIconCheckable |
boolean : whether the icon should be checkable |
setEndIconContentDescription
public void setEndIconContentDescription (int resId)
Set a content description for the end icon.
The content description will be read via screen readers or other accessibility systems to explain the action of the icon.
Related XML Attributes:
Parameters | |
---|---|
resId |
int : Resource ID of a content description string to set, or 0 to clear the description |
setEndIconContentDescription
public void setEndIconContentDescription (CharSequence endIconContentDescription)
Set a content description for the end icon.
The content description will be read via screen readers or other accessibility systems to explain the action of the icon.
Related XML Attributes:
Parameters | |
---|---|
endIconContentDescription |
CharSequence : Content description to set, or null to clear the content
description |
setEndIconDrawable
public void setEndIconDrawable (Drawable endIconDrawable)
Set the icon to use for the end icon. This method should be called after specifying an TextInputLayout.EndIconMode via setEndIconMode(int)
.
If you use an icon you should also set a description for its action using setEndIconContentDescription(CharSequence)
. This is used for accessibility.
Related XML Attributes:
Parameters | |
---|---|
endIconDrawable |
Drawable : Drawable to set, may be null to clear the icon |