StyleSpan

Kotlin |Java

open class StyleSpan : MetricAffectingSpan, ParcelableSpan

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	android.text.style.MetricAffectingSpan
		↳	android.text.style.StyleSpan

Span that allows setting the style of the text it's attached to. Possible styles are: Typeface#NORMAL, Typeface#BOLD, Typeface#ITALIC and Typeface#BOLD_ITALIC.

Note that styles are cumulative -- if both bold and italic are set in separate spans, or if the base style is bold and a span calls for italic, you get bold italic. You can't turn off a style from the base style.

For example, the StyleSpan can be used like this:

SpannableString string = new SpannableString("Bold and italic text");
  string.setSpan(new StyleSpan(Typeface.BOLD), 0, 4, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
  string.setSpan(new StyleSpan(Typeface.ITALIC), 9, 15, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);

Text styled bold and italic with the StyleSpan.

Summary

Public constructors
`StyleSpan(style: Int)` Creates a `StyleSpan` from a style.
`StyleSpan(style: Int, fontWeightAdjustment: Int)` Creates a `StyleSpan` from a style and font weight adjustment.
`StyleSpan(src: Parcel)` Creates a `StyleSpan` from a parcel.

Public methods
open Int	`describeContents()`
open Int	`getFontWeightAdjustment()` Returns the font weight adjustment specified by this span.
open Int	`getSpanTypeId()`
open Int	`getStyle()` Returns the style constant defined in `Typeface`.
open String	`toString()`
open Unit	`updateDrawState(ds: TextPaint!)`
open Unit	`updateMeasureState(paint: TextPaint)`
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

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

StyleSpan

Added in API level 1

StyleSpan(style: Int)

Creates a StyleSpan from a style.

Parameters
`style`	Int: An integer constant describing the style for this span. Examples include bold, italic, and normal. Values are constants defined in `Typeface`.

StyleSpan

Added in API level 33

StyleSpan(
    style: Int, 
    fontWeightAdjustment: Int)

Creates a StyleSpan from a style and font weight adjustment.

Parameters
`style`	Int: An integer constant describing the style for this span. Examples include bold, italic, and normal. Values are constants defined in `Typeface`. Value is `android.graphics.Typeface#NORMAL`, `android.graphics.Typeface#BOLD`, `android.graphics.Typeface#ITALIC`, or `android.graphics.Typeface#BOLD_ITALIC`
`fontWeightAdjustment`	Int: An integer describing the adjustment to be made to the font weight. This is added to the value of the current weight returned by `Typeface#getWeight()`.

See Also

android.content.res.Configuration#fontWeightAdjustment

StyleSpan

Added in API level 3

StyleSpan(src: Parcel)

Creates a StyleSpan from a parcel.

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

Public methods

describeContents

Added in API level 3

open fun describeContents(): Int

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

getFontWeightAdjustment

Added in API level 33

open fun getFontWeightAdjustment(): Int

Returns the font weight adjustment specified by this span.

This can be Configuration#FONT_WEIGHT_ADJUSTMENT_UNDEFINED. This is added to the value of the current weight returned by Typeface#getWeight().

getSpanTypeId

Added in API level 3

open fun getSpanTypeId(): Int

getStyle

Added in API level 1

open fun getStyle(): Int

Returns the style constant defined in Typeface.

toString

Added in API level 1

open fun toString(): String

Return
`String`	a string representation of the object.

updateDrawState

Added in API level 1

open fun updateDrawState(ds: TextPaint!): Unit

updateMeasureState

Added in API level 1

open fun updateMeasureState(paint: TextPaint): Unit

Parameters
`textPaint`	the paint used for drawing the text This value cannot be `null`.

writeToParcel

Added in API level 3

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Parameters
`dest`	Parcel: The Parcel in which the object should be written. 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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES