SubscriptSpan

Kotlin |Java

open class SubscriptSpan : MetricAffectingSpan, ParcelableSpan

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	android.text.style.MetricAffectingSpan
		↳	android.text.style.SubscriptSpan

The span that moves the position of the text baseline lower.

The span can be used like this:

<code>SpannableString string = new SpannableString("☕- C8H10N4O2\n");
 string.setSpan(new SubscriptSpan(), 4, 5, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
 string.setSpan(new SubscriptSpan(), 6, 8, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
 string.setSpan(new SubscriptSpan(), 9, 10, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
 string.setSpan(new SubscriptSpan(), 11, 12, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);</code>

Text with SubscriptSpan. Note: Since the span affects the position of the text, if the text is on the last line of a TextView, it may appear cut.

Summary

Public constructors
`SubscriptSpan()` Creates a `SubscriptSpan`.
`SubscriptSpan(src: Parcel)` Creates a `SubscriptSpan` from a parcel.

Public methods
open Int	`describeContents()`
open Int	`getSpanTypeId()`
open String	`toString()`
open Unit	`updateDrawState(textPaint: TextPaint)`
open Unit	`updateMeasureState(textPaint: TextPaint)` Classes that extend MetricAffectingSpan implement this method to update the text formatting in a way that can change the width or height of characters.
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

Inherited functions

From class MetricAffectingSpan

MetricAffectingSpan!

getUnderlying()

Returns "this" for most MetricAffectingSpans, but for MetricAffectingSpans that were generated by wrap, returns the underlying MetricAffectingSpan.

From class CharacterStyle

Unit

updateDrawState(tp: TextPaint!)

CharacterStyle!

wrap(cs: CharacterStyle!)

A given CharacterStyle can only applied to a single region of a given Spanned. If you need to attach the same CharacterStyle to multiple regions, you can use this method to wrap it with a new object that will have the same effect but be a distinct object so that it can also be attached without conflict.

Public constructors

SubscriptSpan

Added in API level 1

SubscriptSpan()

Creates a SubscriptSpan.

SubscriptSpan

Added in API level 3

SubscriptSpan(src: Parcel)

Creates a SubscriptSpan from a parcel.

Parameters
`src`	Parcel: This value cannot be `null`.

Public methods

describeContents

Added in API level 3

open fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getSpanTypeId

Added in API level 3

open fun getSpanTypeId(): Int

toString

Added in API level 1

open fun toString(): String

Return
`String`	a string representation of the object.

updateDrawState

Added in API level 1

open fun updateDrawState(textPaint: TextPaint): Unit

Parameters
`textPaint`	TextPaint: This value cannot be `null`.

updateMeasureState

Added in API level 1

open fun updateMeasureState(textPaint: TextPaint): Unit

Classes that extend MetricAffectingSpan implement this method to update the text formatting in a way that can change the width or height of characters.

Parameters
`textPaint`	TextPaint: This value cannot be `null`.

writeToParcel

Added in API level 3

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES