TextViewCompat

Added in 1.1.0

public final class TextViewCompat


Helper for accessing features in TextView.

Summary

Constants

static final int

The TextView does not auto-size text (default).

static final int

The TextView scales text size both horizontally and vertically to fit within the container.

Public methods

static int

name android:autoSizeMaxTextSize

static int

name android:autoSizeMinTextSize

static int

name android:autoSizeStepGranularity

static @NonNull int[]

name android:autoSizePresetSizes

static int

Returns the type of auto-size set for this widget.

static @Nullable ColorStateList

Return the tint applied to any compound drawables.

static @Nullable PorterDuff.Mode

Return the tint mode applied to any compound drawables.

static @NonNull Drawable[]

Returns drawables for the start, top, end, and bottom borders from the given text view.

static int

Returns the distance between the first text baseline and the top of this TextView.

static int

Returns the distance between the last text baseline and the bottom of this TextView.

static int

Returns the maximum number of lines displayed in the given TextView, or -1 if the maximum height was set in pixels instead.

static int

Returns the minimum number of lines displayed in the given TextView, or -1 if the minimum height was set in pixels instead.

static @NonNull PrecomputedTextCompat.Params

Gets the parameters for text layout precomputation, for use with PrecomputedTextCompat.

static void
setAutoSizeTextTypeUniformWithConfiguration(
    @NonNull TextView textView,
    int autoSizeMinTextSize,
    int autoSizeMaxTextSize,
    int autoSizeStepGranularity,
    int unit
)

Specify whether this widget should automatically scale the text to try to perfectly fit within the layout bounds.

static void
setAutoSizeTextTypeUniformWithPresetSizes(
    @NonNull TextView textView,
    @NonNull int[] presetSizes,
    int unit
)

Specify whether this widget should automatically scale the text to try to perfectly fit within the layout bounds.

static void
setAutoSizeTextTypeWithDefaults(
    @NonNull TextView textView,
    int autoSizeTextType
)

Specify whether this widget should automatically scale the text to try to perfectly fit within the layout bounds by using the default auto-size configuration.

static void

Applies a tint to any compound drawables.

static void

Applies a tint mode to any compound drawables.

static void
setCompoundDrawablesRelative(
    @NonNull TextView textView,
    @Nullable Drawable start,
    @Nullable Drawable top,
    @Nullable Drawable end,
    @Nullable Drawable bottom
)

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

static void
setCompoundDrawablesRelativeWithIntrinsicBounds(
    @NonNull TextView textView,
    @Nullable Drawable start,
    @Nullable Drawable top,
    @Nullable Drawable end,
    @Nullable Drawable bottom
)

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

static void
setCompoundDrawablesRelativeWithIntrinsicBounds(
    @NonNull TextView textView,
    @DrawableRes int start,
    @DrawableRes int top,
    @DrawableRes int end,
    @DrawableRes int bottom
)

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

static void

Sets a selection action mode callback on a TextView.

static void
setFirstBaselineToTopHeight(
    @NonNull TextView textView,
    @Px @IntRange(from = 0) int firstBaselineToTopHeight
)

Updates the top padding of the TextView so that firstBaselineToTopHeight is equal to the distance between the first text baseline and the top of this TextView.

static void
setLastBaselineToBottomHeight(
    @NonNull TextView textView,
    @Px @IntRange(from = 0) int lastBaselineToBottomHeight
)

Updates the bottom padding of the TextView so that lastBaselineToBottomHeight is equal to the distance between the last text baseline and the bottom of this TextView.

static void
setLineHeight(
    @NonNull TextView textView,
    @Px @IntRange(from = 0) int lineHeight
)

Sets an explicit line height for this TextView.

static void
setLineHeight(
    @NonNull TextView textView,
    int unit,
    @FloatRange(from = 0) float lineHeight
)

Sets an explicit line height to a given unit and value for the TextView.

static void
setPrecomputedText(
    @NonNull TextView textView,
    @NonNull PrecomputedTextCompat precomputed
)

Sets the PrecomputedTextCompat to the TextView If the given PrecomputeTextCompat is not compatible with textView, throws an IllegalArgumentException.

static void
setTextAppearance(@NonNull TextView textView, @StyleRes int resId)

Sets the text appearance from the specified style resource.

static void

Apply the text layout parameter.

Constants

AUTO_SIZE_TEXT_TYPE_NONE

Added in 1.1.0
public static final int AUTO_SIZE_TEXT_TYPE_NONE = 0

The TextView does not auto-size text (default).

AUTO_SIZE_TEXT_TYPE_UNIFORM

Added in 1.1.0
public static final int AUTO_SIZE_TEXT_TYPE_UNIFORM = 1

The TextView scales text size both horizontally and vertically to fit within the container.

Public methods

getAutoSizeMaxTextSize

Added in 1.1.0
public static int getAutoSizeMaxTextSize(@NonNull TextView textView)

name android:autoSizeMaxTextSize

Returns
int

the current auto-size maximum text size in pixels (the default is 112sp). Note that if auto-size has not been configured this function returns -1.

getAutoSizeMinTextSize

Added in 1.1.0
public static int getAutoSizeMinTextSize(@NonNull TextView textView)

name android:autoSizeMinTextSize

Returns
int

the current auto-size minimum text size in pixels (the default is 12sp). Note that if auto-size has not been configured this function returns -1.

getAutoSizeStepGranularity

Added in 1.1.0
public static int getAutoSizeStepGranularity(@NonNull TextView textView)

name android:autoSizeStepGranularity

Returns
int

the current auto-size step granularity in pixels.

getAutoSizeTextAvailableSizes

Added in 1.1.0
public static @NonNull int[] getAutoSizeTextAvailableSizes(@NonNull TextView textView)

name android:autoSizePresetSizes

Returns
@NonNull int[]

the current auto-size int sizes array (in pixels).

getAutoSizeTextType

Added in 1.1.0
public static int getAutoSizeTextType(@NonNull TextView textView)

Returns the type of auto-size set for this widget.

name android:autoSizeTextType

Returns
int

an int corresponding to one of the auto-size types: AUTO_SIZE_TEXT_TYPE_NONE or AUTO_SIZE_TEXT_TYPE_UNIFORM

getCompoundDrawableTintList

Added in 1.1.0
public static @Nullable ColorStateList getCompoundDrawableTintList(@NonNull TextView textView)

Return the tint applied to any compound drawables.

Only returns meaningful info when running on API v24 or newer, or if textView implements the TintableCompoundDrawablesView interface.

getCompoundDrawableTintMode

Added in 1.1.0
public static @Nullable PorterDuff.Mode getCompoundDrawableTintMode(@NonNull TextView textView)

Return the tint mode applied to any compound drawables.

Only returns meaningful info when running on API v24 or newer, or if textView implements the TintableCompoundDrawablesView interface.

getCompoundDrawablesRelative

Added in 1.1.0
public static @NonNull Drawable[] getCompoundDrawablesRelative(@NonNull TextView textView)

Returns drawables for the start, top, end, and bottom borders from the given text view.

getFirstBaselineToTopHeight

Added in 1.1.0
public static int getFirstBaselineToTopHeight(@NonNull TextView textView)

Returns the distance between the first text baseline and the top of this TextView.

name android:firstBaselineToTopHeight

getLastBaselineToBottomHeight

Added in 1.1.0
public static int getLastBaselineToBottomHeight(@NonNull TextView textView)

Returns the distance between the last text baseline and the bottom of this TextView.

name android:lastBaselineToBottomHeight

getMaxLines

Added in 1.1.0
public static int getMaxLines(@NonNull TextView textView)

Returns the maximum number of lines displayed in the given TextView, or -1 if the maximum height was set in pixels instead.

getMinLines

Added in 1.1.0
public static int getMinLines(@NonNull TextView textView)

Returns the minimum number of lines displayed in the given TextView, or -1 if the minimum height was set in pixels instead.

getTextMetricsParams

Added in 1.1.0
public static @NonNull PrecomputedTextCompat.Params getTextMetricsParams(@NonNull TextView textView)

Gets the parameters for text layout precomputation, for use with PrecomputedTextCompat.

setAutoSizeTextTypeUniformWithConfiguration

Added in 1.1.0
public static void setAutoSizeTextTypeUniformWithConfiguration(
    @NonNull TextView textView,
    int autoSizeMinTextSize,
    int autoSizeMaxTextSize,
    int autoSizeStepGranularity,
    int unit
)

Specify whether this widget should automatically scale the text to try to perfectly fit within the layout bounds. If all the configuration params are valid the type of auto-size is set to AUTO_SIZE_TEXT_TYPE_UNIFORM.

name android:autoSizeTextType

name android:autoSizeTextType

name android:autoSizeMinTextSize

name android:autoSizeMaxTextSize

name android:autoSizeStepGranularity

Parameters
@NonNull TextView textView

TextView for which to set the mode.

int autoSizeMinTextSize

the minimum text size available for auto-size

int autoSizeMaxTextSize

the maximum text size available for auto-size

int autoSizeStepGranularity

the auto-size step granularity. It is used in conjunction with the minimum and maximum text size in order to build the set of text sizes the system uses to choose from when auto-sizing

int unit

the desired dimension unit for all sizes above. See TypedValue for the possible dimension units

Throws
java.lang.IllegalArgumentException

if any of the configuration params are invalid.

setAutoSizeTextTypeUniformWithPresetSizes

Added in 1.1.0
public static void setAutoSizeTextTypeUniformWithPresetSizes(
    @NonNull TextView textView,
    @NonNull int[] presetSizes,
    int unit
)

Specify whether this widget should automatically scale the text to try to perfectly fit within the layout bounds. If at least one value from the presetSizes is valid then the type of auto-size is set to AUTO_SIZE_TEXT_TYPE_UNIFORM.

name android:autoSizeTextType

name android:autoSizePresetSizes

Parameters
@NonNull TextView textView

TextView for which to set the mode.

@NonNull int[] presetSizes

an int array of sizes in pixels

int unit

the desired dimension unit for the preset sizes above. See TypedValue for the possible dimension units

Throws
java.lang.IllegalArgumentException

if all of the presetSizes are invalid. _

setAutoSizeTextTypeWithDefaults

Added in 1.1.0
public static void setAutoSizeTextTypeWithDefaults(
    @NonNull TextView textView,
    int autoSizeTextType
)

Specify whether this widget should automatically scale the text to try to perfectly fit within the layout bounds by using the default auto-size configuration.

name android:autoSizeTextType

Parameters
@NonNull TextView textView

TextView for which to set the mode.

int autoSizeTextType

the type of auto-size. Must be one of AUTO_SIZE_TEXT_TYPE_NONE or AUTO_SIZE_TEXT_TYPE_UNIFORM

setCompoundDrawableTintList

Added in 1.1.0
public static void setCompoundDrawableTintList(
    @NonNull TextView textView,
    @Nullable ColorStateList tint
)

Applies a tint to any compound drawables.

This will always take effect when running on API v24 or newer. When running on platforms previous to API v24, it will only take effect if textView implements the TintableCompoundDrawablesView interface.

setCompoundDrawableTintMode

Added in 1.1.0
public static void setCompoundDrawableTintMode(
    @NonNull TextView textView,
    @Nullable PorterDuff.Mode tintMode
)

Applies a tint mode to any compound drawables.

This will always take effect when running on API v24 or newer. When running on platforms previous to API v24, it will only take effect if textView implements the TintableCompoundDrawablesView interface.

setCompoundDrawablesRelative

Added in 1.1.0
public static void setCompoundDrawablesRelative(
    @NonNull TextView textView,
    @Nullable Drawable start,
    @Nullable Drawable top,
    @Nullable Drawable end,
    @Nullable Drawable bottom
)

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

Calling this method will overwrite any Drawables previously set using setCompoundDrawables or related methods.

name android:drawableStart

name android:drawableTop

name android:drawableEnd

name android:drawableBottom

Parameters
@NonNull TextView textView

The TextView against which to invoke the method.

@Nullable Drawable start

position in pixels of the start bound

@Nullable Drawable top

position in pixels of the top bound

@Nullable Drawable end

position in pixels of the end bound

@Nullable Drawable bottom

position in pixels of the bottom bound

setCompoundDrawablesRelativeWithIntrinsicBounds

Added in 1.1.0
public static void setCompoundDrawablesRelativeWithIntrinsicBounds(
    @NonNull TextView textView,
    @Nullable Drawable start,
    @Nullable Drawable top,
    @Nullable Drawable end,
    @Nullable Drawable bottom
)

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

Calling this method will overwrite any Drawables previously set using setCompoundDrawables or related methods.

name android:drawableStart

name android:drawableTop

name android:drawableEnd

name android:drawableBottom

Parameters
@NonNull TextView textView

The TextView against which to invoke the method.

@Nullable Drawable start

drawable to use at start

@Nullable Drawable top

drawable to use at top

@Nullable Drawable end

drawable to use at end

@Nullable Drawable bottom

drawable to use at bottom

setCompoundDrawablesRelativeWithIntrinsicBounds

Added in 1.1.0
public static void setCompoundDrawablesRelativeWithIntrinsicBounds(
    @NonNull TextView textView,
    @DrawableRes int start,
    @DrawableRes int top,
    @DrawableRes int end,
    @DrawableRes int bottom
)

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

Calling this method will overwrite any Drawables previously set using setCompoundDrawables or related methods.

name android:drawableStart

name android:drawableTop

name android:drawableEnd

name android:drawableBottom

Parameters
@NonNull TextView textView

The TextView against which to invoke the method.

@DrawableRes int start

Resource identifier of the start Drawable.

@DrawableRes int top

Resource identifier of the top Drawable.

@DrawableRes int end

Resource identifier of the end Drawable.

@DrawableRes int bottom

Resource identifier of the bottom Drawable.

setCustomSelectionActionModeCallback

Added in 1.1.0
public static void setCustomSelectionActionModeCallback(
    @NonNull TextView textView,
    @NonNull ActionMode.Callback callback
)

Sets a selection action mode callback on a TextView. Also this method can be used to fix a bug in framework SDK 26/27. On these affected devices, the bug causes the menu containing the options for handling ACTION_PROCESS_TEXT after text selection to miss a number of items. This method can be used to fix this wrong behaviour for a text view, by passing any custom callback implementation. If no custom callback is desired, a no-op implementation should be provided. Note that, by default, the bug will only be fixed when the default floating toolbar menu implementation is used. If a custom implementation of Menu is provided, this should provide the method Menu#removeItemAt(int) which removes a menu item by its position, as given by Menu#getItem(int). Also, the following post condition should hold: a call to removeItemAt(i), should not modify the results of getItem(j) for any j Menu interface. However, it is required, and going to be called by reflection, in order to display the correct process text items in the menu.

Parameters
@NonNull TextView textView

The TextView to set the action selection mode callback on.

@NonNull ActionMode.Callback callback

The action selection mode callback to set on textView.

setFirstBaselineToTopHeight

Added in 1.1.0
public static void setFirstBaselineToTopHeight(
    @NonNull TextView textView,
    @Px @IntRange(from = 0) int firstBaselineToTopHeight
)

Updates the top padding of the TextView so that firstBaselineToTopHeight is equal to the distance between the first text baseline and the top of this TextView. Note that if FontMetrics.top or FontMetrics.ascent was already greater than firstBaselineToTopHeight, the top padding is not updated.

name android:firstBaselineToTopHeight

Parameters
@NonNull TextView textView

TextView for which to set the padding.

@Px @IntRange(from = 0) int firstBaselineToTopHeight

distance between first baseline to top of the container in pixels

setLastBaselineToBottomHeight

Added in 1.1.0
public static void setLastBaselineToBottomHeight(
    @NonNull TextView textView,
    @Px @IntRange(from = 0) int lastBaselineToBottomHeight
)

Updates the bottom padding of the TextView so that lastBaselineToBottomHeight is equal to the distance between the last text baseline and the bottom of this TextView. Note that if FontMetrics.bottom or FontMetrics.descent was already greater than lastBaselineToBottomHeight, the bottom padding is not updated.

name android:lastBaselineToBottomHeight

Parameters
@NonNull TextView textView

TextView for which to set the padding.

@Px @IntRange(from = 0) int lastBaselineToBottomHeight

distance between last baseline to bottom of the container in pixels

setLineHeight

Added in 1.1.0
public static void setLineHeight(
    @NonNull TextView textView,
    @Px @IntRange(from = 0) int lineHeight
)

Sets an explicit line height for this TextView. This is equivalent to the vertical distance between subsequent baselines in the TextView.

name android:lineHeight

Parameters
@NonNull TextView textView

the TextView to modify

@Px @IntRange(from = 0) int lineHeight

the line height in pixels

setLineHeight

Added in 1.12.0
public static void setLineHeight(
    @NonNull TextView textView,
    int unit,
    @FloatRange(from = 0) float lineHeight
)

Sets an explicit line height to a given unit and value for the TextView. This is equivalent to the vertical distance between subsequent baselines in the TextView. See for the possible dimension units.

ref android.R.styleable#TextView_lineHeight

Parameters
@NonNull TextView textView

the TextView to modify

int unit

The desired dimension unit. SP units are strongly recommended so that line height stays proportional to the text size when fonts are scaled up for accessibility.

@FloatRange(from = 0) float lineHeight

The desired line height in the given units.

setPrecomputedText

Added in 1.1.0
public static void setPrecomputedText(
    @NonNull TextView textView,
    @NonNull PrecomputedTextCompat precomputed
)

Sets the PrecomputedTextCompat to the TextView If the given PrecomputeTextCompat is not compatible with textView, throws an IllegalArgumentException.

Parameters
@NonNull TextView textView

the TextView

@NonNull PrecomputedTextCompat precomputed

the precomputed text

Throws
java.lang.IllegalArgumentException

if precomputed text is not compatible with textView.

setTextAppearance

Added in 1.1.0
public static void setTextAppearance(@NonNull TextView textView, @StyleRes int resId)

Sets the text appearance from the specified style resource.

Use a framework-defined TextAppearance style like @android:style/TextAppearance.Material.Body1.

Parameters
@NonNull TextView textView

The TextView against which to invoke the method.

@StyleRes int resId

The resource identifier of the style to apply.

setTextMetricsParams

Added in 1.1.0
public static void setTextMetricsParams(
    @NonNull TextView textView,
    @NonNull PrecomputedTextCompat.Params params
)

Apply the text layout parameter. Update the TextView parameters to be compatible with PrecomputedTextCompat.Params.