BackgroundColorSpan
public
class
BackgroundColorSpan
extends CharacterStyle
implements
UpdateAppearance,
ParcelableSpan
java.lang.Object | ||
↳ | android.text.style.CharacterStyle | |
↳ | android.text.style.BackgroundColorSpan |
Changes the background color of the text to which the span is attached.
For example, to set a green background color for a text you would create a SpannableString
based on the text and set the span.
SpannableString string = new SpannableString("Text with a background color span");
string.setSpan(new BackgroundColorSpan(color), 12, 28, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
![](/https/developer.android.com/static/reference/android/images/text/style/backgroundcolorspan.png)
Summary
Inherited constants |
---|
Public constructors | |
---|---|
BackgroundColorSpan(int color)
Creates a |
|
BackgroundColorSpan(Parcel src)
Creates a |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
int
|
getBackgroundColor()
|
int
|
getSpanTypeId()
Return a special type identifier for this span class. |
String
|
toString()
Returns a string representation of the object. |
void
|
updateDrawState(TextPaint textPaint)
Updates the background color of the TextPaint. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Public constructors
BackgroundColorSpan
public BackgroundColorSpan (int color)
Creates a BackgroundColorSpan
from a color integer.
Parameters | |
---|---|
color |
int : color integer that defines the background color |
See also:
BackgroundColorSpan
public BackgroundColorSpan (Parcel src)
Creates a BackgroundColorSpan
from a parcel.
Parameters | |
---|---|
src |
Parcel : This value cannot be null . |
Public methods
describeContents
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 |
getBackgroundColor
public int getBackgroundColor ()
Returns | |
---|---|
int |
the background color of this span. |
See also:
getSpanTypeId
public int getSpanTypeId ()
Return a special type identifier for this span class.
Returns | |
---|---|
int |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
updateDrawState
public void updateDrawState (TextPaint textPaint)
Updates the background color of the TextPaint.
Parameters | |
---|---|
textPaint |
TextPaint : This value cannot be null . |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : 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 |