Skip to content

Most visited

Recently visited

navigation

SuperscriptSpan

public class SuperscriptSpan
extends MetricAffectingSpan implements ParcelableSpan

java.lang.Object
   ↳ android.text.style.CharacterStyle
     ↳ android.text.style.MetricAffectingSpan
       ↳ android.text.style.SuperscriptSpan


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

The span can be used like this:

SpannableString string = new SpannableString("1st example");
string.setSpan(new SuperscriptSpan(), 1, 3, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
Text with SuperscriptSpan.
Note: Since the span affects the position of the text, if the text is on the first line of a TextView, it may appear cut. This can be avoided by decreasing the text size with an AbsoluteSizeSpan

Summary

Inherited constants

Public constructors

SuperscriptSpan()

Creates a SuperscriptSpan.

SuperscriptSpan(Parcel src)

Creates a SuperscriptSpan 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

SuperscriptSpan

added in API level 1
SuperscriptSpan ()

Creates a SuperscriptSpan.

SuperscriptSpan

added in API level 3
SuperscriptSpan (Parcel src)

Creates a SuperscriptSpan from a parcel.

Parameters
src Parcel

This value must never be null.

Public methods

describeContents

added in API level 3
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
int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

updateDrawState

added in API level 1
void updateDrawState (TextPaint textPaint)

Parameters
textPaint TextPaint

This value must never be null.

updateMeasureState

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

This value must never be null.

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

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (April 2018 — Developer Survey)