lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

SubscriptSpan

public class SubscriptSpan
extends MetricAffectingSpan implements ParcelableSpan

java.lang.Object
   ↳ 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:

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

Inherited constants

Public constructors

SubscriptSpan()

Creates a SubscriptSpan.

SubscriptSpan(Parcel src)

Creates a SubscriptSpan from a parcel.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

int getSpanTypeId()

Return a special type identifier for this span class.

void updateDrawState(TextPaint textPaint)
void 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.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Public constructors

SubscriptSpan

added in API level 1
public SubscriptSpan ()

Creates a SubscriptSpan.

SubscriptSpan

added in API level 3
public SubscriptSpan (Parcel src)

Creates a SubscriptSpan from a parcel.

Parameters
src Parcel

This value must never be null.

Public methods

describeContents

added in API level 3
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getSpanTypeId

added in API level 3
public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

updateDrawState

added in API level 1
public void updateDrawState (TextPaint textPaint)

Parameters
textPaint TextPaint

This value must never be null.

updateMeasureState

added in API level 1
public void 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.

Parameters
textPaint TextPaint: the paint used for drawing the text

This value must never be null.

writeToParcel

added in API level 3
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.