Added in API level 29

Summary: Inherited Constants | Ctors | Methods | Inherited Methods

LineBackgroundSpan.Standard

Kotlin |Java

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);

Text with LineBackgroundSpan

Summary

Inherited constants

From interface android.os.Parcelable

`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
`LineBackgroundSpan.Standard(int color)` Constructor taking a color integer.
`LineBackgroundSpan.Standard(Parcel src)` Creates a `LineBackgroundSpan.Standard` from a parcel

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

From class


        
          java.lang.Object

`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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.text.style.LineBackgroundSpan


      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.

From interface


        
          android.text.ParcelableSpan


      getSpanTypeId()

Return a special type identifier for this span class.

From interface


        
          android.os.Parcelable

`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

LineBackgroundSpan.Standard

Added in API level 29

public LineBackgroundSpan.Standard (int color)

Constructor taking a color integer.

Parameters
`color`	`int`: Color integer that defines the background color.

LineBackgroundSpan.Standard

Added in API level 29

public LineBackgroundSpan.Standard (Parcel src)

Creates a LineBackgroundSpan.Standard from a parcel

Parameters
`src`	`Parcel`: This value must never be `null`.

Public methods

describeContents

Added in API level 29

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

Added in API level 29

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 must never be `null`.
`paint`	`Paint`: This value must never be `null`.
`left`	`int`: This units of this value are pixels.
`right`	`int`: This units of this value are pixels.
`top`	`int`: This units of this value are pixels.
`baseline`	`int`: This units of this value are pixels.
`bottom`	`int`: This units of this value are pixels.
`text`	`CharSequence`: This value must never 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

Added in API level 29

public final int getColor ()

Returns
`int`	the color of this span.

See also:

ERROR(/android.text.style.LineBackgroundSpan.Standard#Standard(int))

getSpanTypeId

Added in API level 29

public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
`int`

writeToParcel

Added in API level 29

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value must never 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