Join us on the livestream at Android Dev Summit on 7-8 November 2018, starting at 10AM PDT!

UnderlineSpan

public class UnderlineSpan
extends CharacterStyle implements UpdateAppearance, ParcelableSpan

java.lang.Object
   ↳ android.text.style.CharacterStyle
     ↳ android.text.style.UnderlineSpan


A span that underlines the text it's attached to.

The span can be used like this:

SpannableString string = new SpannableString("Text with underline span");
string.setSpan(new UnderlineSpan(), 10, 19, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
Underlined text.

Summary

Inherited constants

Public constructors

UnderlineSpan()

Creates an UnderlineSpan.

UnderlineSpan(Parcel src)

Creates an UnderlineSpan 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 ds)
void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Public constructors

UnderlineSpan

added in API level 1
public UnderlineSpan ()

Creates an UnderlineSpan.

UnderlineSpan

added in API level 3
public UnderlineSpan (Parcel src)

Creates an UnderlineSpan 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 ds)

Parameters
ds TextPaint

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.

This value must never be null.

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