RelativeSizeSpan

public class RelativeSizeSpan
extends MetricAffectingSpan implements ParcelableSpan

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


Uniformly scales the size of the text to which it's attached by a certain proportion.

For example, a RelativeSizeSpan that increases the text size by 50% can be constructed like this:

SpannableString string = new SpannableString("Text with relative size span");
string.setSpan(new RelativeSizeSpan(1.5f), 10, 24, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
Text increased by 50% with RelativeSizeSpan.

Summary

Inherited constants

Public constructors

RelativeSizeSpan(float proportion)

Creates a RelativeSizeSpan based on a proportion.

RelativeSizeSpan(Parcel src)

Creates a RelativeSizeSpan from a parcel.

Public methods

int describeContents()

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

float getSizeChange()
int getSpanTypeId()

Return a special type identifier for this span class.

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

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

RelativeSizeSpan

added in API level 1
RelativeSizeSpan (float proportion)

Creates a RelativeSizeSpan based on a proportion.

Parameters
proportion float: the proportion with which the text is scaled.

Value is 0.0 or greater.

RelativeSizeSpan

added in API level 3
RelativeSizeSpan (Parcel src)

Creates a RelativeSizeSpan from a parcel.

Parameters
src Parcel

This value must never be null.

Public methods

describeContents

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

getSizeChange

added in API level 1
float getSizeChange ()

Returns
float the proportion with which the text size is changed.

getSpanTypeId

added in API level 3
int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

updateDrawState

added in API level 1
void updateDrawState (TextPaint ds)

Parameters
ds TextPaint

This value must never be null.

updateMeasureState

added in API level 1
void updateMeasureState (TextPaint ds)

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

This value must never be null.

writeToParcel

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