# SuperscriptSpan
Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
Summary:[Inherited Constants](https://developer.android.com/reference/android/text/style/SuperscriptSpan#inhconstants)\|[Ctors](https://developer.android.com/reference/android/text/style/SuperscriptSpan#pubctors)\|[Methods](https://developer.android.com/reference/android/text/style/SuperscriptSpan#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/text/style/SuperscriptSpan#inhmethods)
# SuperscriptSpan
*** ** * ** ***
[Kotlin](https://developer.android.com/reference/kotlin/android/text/style/SuperscriptSpan "View this page in Kotlin")\|Java
`
public
class
SuperscriptSpan
`
`
``
``
extends `[MetricAffectingSpan](https://developer.android.com/reference/android/text/style/MetricAffectingSpan)`
``
implements
`[ParcelableSpan](https://developer.android.com/reference/android/text/ParcelableSpan)`
`
|---|---|---|------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||||
| ↳ | [android.text.style.CharacterStyle](https://developer.android.com/reference/android/text/style/CharacterStyle) |||
| | ↳ | [android.text.style.MetricAffectingSpan](https://developer.android.com/reference/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](https://developer.android.com/reference/android/text/style/AbsoluteSizeSpan)
## Summary
| ### Inherited constants |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`". | |
| ### Public constructors ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[SuperscriptSpan](https://developer.android.com/reference/android/text/style/SuperscriptSpan#SuperscriptSpan())`() ` Creates a[SuperscriptSpan](https://developer.android.com/reference/android/text/style/SuperscriptSpan). |
| ` `[SuperscriptSpan](https://developer.android.com/reference/android/text/style/SuperscriptSpan#SuperscriptSpan(android.os.Parcel))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` src) ` Creates a[SuperscriptSpan](https://developer.android.com/reference/android/text/style/SuperscriptSpan)from a parcel. |
| ### Public methods ||
|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int` | ` `[describeContents](https://developer.android.com/reference/android/text/style/SuperscriptSpan#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` int` | ` `[getSpanTypeId](https://developer.android.com/reference/android/text/style/SuperscriptSpan#getSpanTypeId())`() ` Return a special type identifier for this span class. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/text/style/SuperscriptSpan#toString())`() ` Returns a string representation of the object. |
| ` void` | ` `[updateDrawState](https://developer.android.com/reference/android/text/style/SuperscriptSpan#updateDrawState(android.text.TextPaint))`(`[TextPaint](https://developer.android.com/reference/android/text/TextPaint)` textPaint) `
|
| ` void` | ` `[updateMeasureState](https://developer.android.com/reference/android/text/style/SuperscriptSpan#updateMeasureState(android.text.TextPaint))`(`[TextPaint](https://developer.android.com/reference/android/text/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](https://developer.android.com/reference/android/text/style/SuperscriptSpan#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. |
| ### Inherited methods |
|-----------------------|---|
| From class` `[android.text.style.MetricAffectingSpan](https://developer.android.com/reference/android/text/style/MetricAffectingSpan)` ` |----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[MetricAffectingSpan](https://developer.android.com/reference/android/text/style/MetricAffectingSpan) | ` `[getUnderlying](https://developer.android.com/reference/android/text/style/MetricAffectingSpan#getUnderlying())`() ` Returns "this" for most MetricAffectingSpans, but for MetricAffectingSpans that were generated by[CharacterStyle.wrap(CharacterStyle)](https://developer.android.com/reference/android/text/style/CharacterStyle#wrap(android.text.style.CharacterStyle)), returns the underlying MetricAffectingSpan. | | ` abstract void` | ` `[updateMeasureState](https://developer.android.com/reference/android/text/style/MetricAffectingSpan#updateMeasureState(android.text.TextPaint))`(`[TextPaint](https://developer.android.com/reference/android/text/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. | ||
| From class` `[android.text.style.CharacterStyle](https://developer.android.com/reference/android/text/style/CharacterStyle)` ` |-------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[CharacterStyle](https://developer.android.com/reference/android/text/style/CharacterStyle) | ` `[getUnderlying](https://developer.android.com/reference/android/text/style/CharacterStyle#getUnderlying())`() ` Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by[wrap(CharacterStyle)](https://developer.android.com/reference/android/text/style/CharacterStyle#wrap(android.text.style.CharacterStyle)), returns the underlying CharacterStyle. | | ` abstract void` | ` `[updateDrawState](https://developer.android.com/reference/android/text/style/CharacterStyle#updateDrawState(android.text.TextPaint))`(`[TextPaint](https://developer.android.com/reference/android/text/TextPaint)` tp) ` | | ` static `[CharacterStyle](https://developer.android.com/reference/android/text/style/CharacterStyle) | ` `[wrap](https://developer.android.com/reference/android/text/style/CharacterStyle#wrap(android.text.style.CharacterStyle))`(`[CharacterStyle](https://developer.android.com/reference/android/text/style/CharacterStyle)` cs) ` A given CharacterStyle can only applied to a single region of a given Spanned. | ||
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object) | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`. | | ` int` | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*. | ||
| From interface` `[android.text.ParcelableSpan](https://developer.android.com/reference/android/text/ParcelableSpan)` ` |-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[getSpanTypeId](https://developer.android.com/reference/android/text/ParcelableSpan#getSpanTypeId())`() ` Return a special type identifier for this span class. | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int` | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||
## Public constructors
### SuperscriptSpan
Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public SuperscriptSpan ()
```
Creates a[SuperscriptSpan](https://developer.android.com/reference/android/text/style/SuperscriptSpan).
### SuperscriptSpan
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public SuperscriptSpan (Parcel src)
```
Creates a[SuperscriptSpan](https://developer.android.com/reference/android/text/style/SuperscriptSpan)from a parcel.
| Parameters ||
|-------|----------------------------------------------|
| `src` | `Parcel`: This value cannot be`null`.
|
## Public methods
### describeContents
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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(android.os.Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.
| Returns ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)
|
### getSpanTypeId
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public int getSpanTypeId ()
```
Return a special type identifier for this span class.
| Returns ||
|-------|--------|
| `int` |
|
### toString
Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public String toString ()
```
Returns a string representation of the object.
| Returns ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object.
|
### updateDrawState
Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void updateDrawState (TextPaint textPaint)
```
| Parameters ||
|-------------|-------------------------------------------------|
| `textPaint` | `TextPaint`: This value cannot be`null`.
|
### updateMeasureState
Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
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`: This value cannot be`null`.
|
### writeToParcel
Added in[API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)
```
public void writeToParcel (Parcel dest,
int flags)
```
Flatten this object in to a Parcel.
| Parameters ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest` | `Parcel`: This value cannot be`null`.
|
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
|