SuperscriptSpan

Kotlin |Java

open class SuperscriptSpan : MetricAffectingSpan, ParcelableSpan

kotlin.Any
↳	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:

<code>SpannableString string = new SpannableString("1st example");
 string.setSpan(new SuperscriptSpan(), 1, 3, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);</code>

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

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

Public methods
open Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
open Int	`getSpanTypeId()` Return a special type identifier for this span class.
open String	`toString()` Returns a string representation of the object.
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)` Flatten this object in to a Parcel.

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

SuperscriptSpan

Added in API level 1

SuperscriptSpan()

Creates a SuperscriptSpan.

SuperscriptSpan

Added in API level 3

SuperscriptSpan(src: Parcel)

Creates a SuperscriptSpan from a parcel.

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

Public methods

describeContents

Added in API level 3

open fun describeContents(): Int

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), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

getSpanTypeId

Added in API level 3

open fun getSpanTypeId(): Int

Return a special type identifier for this span class.

toString

Added in API level 1

open fun toString(): String

Returns a string representation of the object.

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

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`