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

int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel(Parcel, int): 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

LocaleSpan(LocaleList locales)

Creates a LocaleSpan from LocaleList.

LocaleSpan(Parcel source)
LocaleSpan(Locale locale)

Creates a LocaleSpan from a well-formed Locale.

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.

String toString()

Returns a string representation of the object.

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

MetricAffectingSpan getUnderlying()

Returns "this" for most MetricAffectingSpans, but for MetricAffectingSpans that were generated by CharacterStyle.wrap(CharacterStyle), returns the underlying MetricAffectingSpan.

abstract 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.

CharacterStyle getUnderlying()

Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by wrap(CharacterStyle), returns the underlying CharacterStyle.

abstract void updateDrawState(TextPaint tp)
static CharacterStyle wrap(CharacterStyle cs)

A given CharacterStyle can only applied to a single region of a given Spanned.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(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(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()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int getSpanTypeId()

Return a special type identifier for this span class.

abstract int describeContents()

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

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Public constructors

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 cannot be null.

Throws
NullPointerException if locales is null

LocaleSpan

Added in API level 17
public LocaleSpan (Parcel source)

Parameters
source Parcel

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.

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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

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 cannot be null.

getSpanTypeId

Added in API level 17
public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

toString

Added in API level 17
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

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 This value cannot be null.

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. 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. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES