Added in API level 1

Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods

BulletSpan

Kotlin |Java

public class BulletSpan
extends Object implements LeadingMarginSpan, ParcelableSpan

java.lang.Object
↳	android.text.style.BulletSpan

A span which styles paragraphs as bullet points (respecting layout direction).

BulletSpans must be attached from the first character to the last character of a single paragraph, otherwise the bullet point will not be displayed but the first paragraph encountered will have a leading margin.

BulletSpans allow configuring the following elements:

gap width - the distance, in pixels, between the bullet point and the paragraph. Default value is 2px.
color - the bullet point color. By default, the bullet point color is 0 - no color, so it uses the TextView's text color.
bullet radius - the radius, in pixels, of the bullet point. Default value is 4px.

For example, a BulletSpan using the default values can be constructed like this:

SpannableString string = new SpannableString("Text with\nBullet point");
string.setSpan(new BulletSpan(), 10, 22, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

BulletSpan constructed with default values.

To construct a BulletSpan with a gap width of 40px, green bullet point and bullet radius of 20px:

SpannableString string = new SpannableString("Text with\nBullet point");
string.setSpan(new BulletSpan(40, color, 20), 10, 22, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

Customized BulletSpan.

Summary

Constants
`int`	`STANDARD_GAP_WIDTH`

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
`BulletSpan()` Creates a `BulletSpan` with the default values.
`BulletSpan(int gapWidth)` Creates a `BulletSpan` based on a gap width
`BulletSpan(int gapWidth, int color)` Creates a `BulletSpan` based on a gap width and a color integer.
`BulletSpan(int gapWidth, int color, int bulletRadius)` Creates a `BulletSpan` based on a gap width and a color integer.
`BulletSpan(Parcel src)` Creates a `BulletSpan` from a parcel.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`void`	`drawLeadingMargin(Canvas canvas, Paint paint, int x, int dir, int top, int baseline, int bottom, CharSequence text, int start, int end, boolean first, Layout layout)` Renders the leading margin.
`int`	`getBulletRadius()` Get the radius, in pixels, of the bullet point.
`int`	`getColor()` Get the bullet point color.
`int`	`getGapWidth()` Get the distance, in pixels, between the bullet point and the paragraph.
`int`	`getLeadingMargin(boolean first)` Returns the amount by which to adjust the leading margin.
`int`	`getSpanTypeId()` Return a special type identifier for this span class.
`String`	`toString()` Returns a string representation of the object.
`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 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.

From interface


        
          android.text.style.LeadingMarginSpan

`abstract void`	`drawLeadingMargin(Canvas c, Paint p, int x, int dir, int top, int baseline, int bottom, CharSequence text, int start, int end, boolean first, Layout layout)` Renders the leading margin.
`abstract int`	`getLeadingMargin(boolean first)` Returns the amount by which to adjust the leading margin.

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.

Constants

STANDARD_GAP_WIDTH

Added in API level 1

public static final int STANDARD_GAP_WIDTH

Constant Value: 2 (0x00000002)

Public constructors

BulletSpan

Added in API level 1

public BulletSpan ()

Creates a BulletSpan with the default values.

BulletSpan

Added in API level 1

public BulletSpan (int gapWidth)

Creates a BulletSpan based on a gap width

Parameters
`gapWidth`	`int`: the distance, in pixels, between the bullet point and the paragraph.

BulletSpan

Added in API level 1

public BulletSpan (int gapWidth, 
                int color)

Creates a BulletSpan based on a gap width and a color integer.

Parameters
`gapWidth`	`int`: the distance, in pixels, between the bullet point and the paragraph.
`color`	`int`: the bullet point color, as a color integer

See also:

Resources.getColor(int, Resources.Theme)

BulletSpan

Added in API level 28

public BulletSpan (int gapWidth, 
                int color, 
                int bulletRadius)

Creates a BulletSpan based on a gap width and a color integer.

Parameters
`gapWidth`	`int`: the distance, in pixels, between the bullet point and the paragraph.
`color`	`int`: the bullet point color, as a color integer.
`bulletRadius`	`int`: the radius of the bullet point, in pixels. Value is 0 or greater

See also:

Resources.getColor(int, Resources.Theme)

BulletSpan

Added in API level 3

public BulletSpan (Parcel src)

Creates a BulletSpan from a parcel.

Parameters
`src`	`Parcel`: This value cannot be `null`.

Public methods

describeContents

Added in API level 3

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`

drawLeadingMargin

Added in API level 1

public void drawLeadingMargin (Canvas canvas, 
                Paint paint, 
                int x, 
                int dir, 
                int top, 
                int baseline, 
                int bottom, 
                CharSequence text, 
                int start, 
                int end, 
                boolean first, 
                Layout layout)

Renders the leading margin. This is called before the margin has been adjusted by the value returned by getLeadingMargin(boolean).

Parameters
`canvas`	`Canvas`: This value cannot be `null`.
`paint`	`Paint`: This value cannot be `null`.
`x`	`int`: the current position of the margin
`dir`	`int`: the base direction of the paragraph; if negative, the margin is to the right of the text, otherwise it is to the left.
`top`	`int`: the top of the line
`baseline`	`int`: the baseline of the line
`bottom`	`int`: the bottom of the line
`text`	`CharSequence`: This value cannot be `null`.
`start`	`int`: the start of the line
`end`	`int`: the end of the line
`first`	`boolean`: true if this is the first line of its paragraph
`layout`	`Layout`: This value may be `null`.

getBulletRadius

Added in API level 28

public int getBulletRadius ()

Get the radius, in pixels, of the bullet point.

Returns
`int`	the radius, in pixels, of the bullet point.

getColor

Added in API level 28

public int getColor ()

Get the bullet point color.

Returns
`int`	the bullet point color

getGapWidth

Added in API level 28

public int getGapWidth ()

Get the distance, in pixels, between the bullet point and the paragraph.

Returns
`int`	the distance, in pixels, between the bullet point and the paragraph.

getLeadingMargin

Added in API level 1

public int getLeadingMargin (boolean first)

Returns the amount by which to adjust the leading margin. Positive values move away from the leading edge of the paragraph, negative values move towards it.

Parameters
`first`	`boolean`: true if the request is for the first line of a paragraph, false for subsequent lines

Returns
`int`	the offset for the margin.

getSpanTypeId

Added in API level 3

public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
`int`

toString

Added in API level 1

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 3

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