LineBackgroundSpan.Standard
public
static
class
LineBackgroundSpan.Standard
extends Object
implements
LineBackgroundSpan,
ParcelableSpan
java.lang.Object | |
↳ | android.text.style.LineBackgroundSpan.Standard |
Default implementation of the LineBackgroundSpan
, which changes the background
color of the lines to which the span is attached.
For example, an LineBackgroundSpan
can be used like this:
String text = "This is a multiline text. LineBackgroundSpan is applied here. This is a multiline text."; SpannableString string = new SpannableString(text); string.setSpan(new LineBackgroundSpan.Standard(Color.YELLOW), 26, 61, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
LineBackgroundSpan
Summary
Inherited constants |
---|
Public constructors | |
---|---|
Standard(int color)
Constructor taking a color integer. |
|
Standard(Parcel src)
Creates a |
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
void
|
drawBackground(Canvas canvas, Paint paint, int left, int right, int top, int baseline, int bottom, CharSequence text, int start, int end, int lineNumber)
Draw the background on the canvas. |
final
int
|
getColor()
|
int
|
getSpanTypeId()
Return a special type identifier for this span class. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Public constructors
Standard
public Standard (int color)
Constructor taking a color integer.
Parameters | |
---|---|
color |
int : Color integer that defines the background color. |
Standard
public Standard (Parcel src)
Creates a LineBackgroundSpan.Standard
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 |
drawBackground
public void drawBackground (Canvas canvas, Paint paint, int left, int right, int top, int baseline, int bottom, CharSequence text, int start, int end, int lineNumber)
Draw the background on the canvas.
Parameters | |
---|---|
canvas |
Canvas : This value cannot be null . |
paint |
Paint : This value cannot be null . |
left |
int : The units of this value are pixels. |
right |
int : The units of this value are pixels. |
top |
int : The units of this value are pixels. |
baseline |
int : The units of this value are pixels. |
bottom |
int : The units of this value are pixels. |
text |
CharSequence : This value cannot be null . |
start |
int : start character index of the line |
end |
int : end character index of the line |
lineNumber |
int : line number in the current text layout |
getColor
public final int getColor ()
Returns | |
---|---|
int |
the color of this span. |
See also:
getSpanTypeId
public int getSpanTypeId ()
Return a special type identifier for this span class.
Returns | |
---|---|
int |
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 |