lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

LocaleSpan

public class LocaleSpan
extends MetricAffectingSpan implements ParcelableSpan

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


Changes the Locale of the text to which the span is attached.

Summary

Inherited constants

Public constructors

LocaleSpan(Locale locale)

Creates a LocaleSpan from a well-formed Locale.

LocaleSpan(LocaleList locales)

Creates a LocaleSpan from LocaleList.

LocaleSpan(Parcel source)

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Locale getLocale()
LocaleList getLocales()
int getSpanTypeId()

Return a special type identifier for this span class.

void updateDrawState(TextPaint ds)
void updateMeasureState(TextPaint paint)

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

LocaleSpan

added in API level 17
public LocaleSpan (Locale locale)

Creates a LocaleSpan from a well-formed Locale. Note that only Locale objects that can be created by Locale.forLanguageTag(String) are supported.

Caveat: Do not specify any Locale object that cannot be created by Locale.forLanguageTag(String). new Locale(" a ", " b c", " d") is an example of such a malformed Locale object.

Parameters
locale Locale: The Locale of the text to which the span is attached.

This value may be null.

LocaleSpan

added in API level 24
public LocaleSpan (LocaleList locales)

Creates a LocaleSpan from LocaleList.

Parameters
locales LocaleList: The LocaleList of the text to which the span is attached.

This value must never be null.

Throws
NullPointerException if locales is null

LocaleSpan

added in API level 17
public LocaleSpan (Parcel source)

Parameters
source Parcel

Public methods

describeContents

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

getLocale

added in API level 17
public Locale getLocale ()

Returns
Locale The Locale for this span. If multiple locales are associated with this span, only the first locale is returned. null if no Locale is specified.

getLocales

added in API level 24
public LocaleList getLocales ()

Returns
LocaleList The entire list of locales that are associated with this span.

This value will never be null.

getSpanTypeId

added in API level 17
public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

updateDrawState

added in API level 17
public void updateDrawState (TextPaint ds)

Parameters
ds TextPaint

updateMeasureState

added in API level 17
public void updateMeasureState (TextPaint paint)

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
paint TextPaint: the paint used for drawing the text

writeToParcel

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

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