Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/text/style/BulletSpan#constants) \| [Inherited Constants](https://developer.android.com/reference/android/text/style/BulletSpan#inhconstants) \| [Ctors](https://developer.android.com/reference/android/text/style/BulletSpan#pubctors) \| [Methods](https://developer.android.com/reference/android/text/style/BulletSpan#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/text/style/BulletSpan#inhmethods)

# BulletSpan

*** ** * ** ***


`
public


class
BulletSpan
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/text/style/LeadingMarginSpan,

https://developer.android.com/reference/android/text/ParcelableSpan


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.text.style.BulletSpan |

<br />

*** ** * ** ***

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

![](https://developer.android.com/static/reference/android/images/text/style/defaultbulletspan.png) 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);

![](https://developer.android.com/static/reference/android/images/text/style/custombulletspan.png) Customized BulletSpan.

<br />

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/text/style/BulletSpan#STANDARD_GAP_WIDTH` |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 ||
|---|---|
| ` https://developer.android.com/reference/android/text/style/BulletSpan#BulletSpan()() ` Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` with the default values. |
| ` https://developer.android.com/reference/android/text/style/BulletSpan#BulletSpan(android.os.Parcel)(https://developer.android.com/reference/android/os/Parcel src) ` Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` from a parcel. |
| ` https://developer.android.com/reference/android/text/style/BulletSpan#BulletSpan(int)(int gapWidth) ` Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` based on a gap width |
| ` https://developer.android.com/reference/android/text/style/BulletSpan#BulletSpan(int,%20int)(int gapWidth, int color) ` Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` based on a gap width and a color integer. |
| ` https://developer.android.com/reference/android/text/style/BulletSpan#BulletSpan(int,%20int,%20int)(int gapWidth, int color, int bulletRadius) ` Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` based on a gap width and a color integer. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/text/style/BulletSpan#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` void` | ` https://developer.android.com/reference/android/text/style/BulletSpan#drawLeadingMargin(android.graphics.Canvas,%20android.graphics.Paint,%20int,%20int,%20int,%20int,%20int,%20java.lang.CharSequence,%20int,%20int,%20boolean,%20android.text.Layout)(https://developer.android.com/reference/android/graphics/Canvas canvas, https://developer.android.com/reference/android/graphics/Paint paint, int x, int dir, int top, int baseline, int bottom, https://developer.android.com/reference/java/lang/CharSequence text, int start, int end, boolean first, https://developer.android.com/reference/android/text/Layout layout) ` Renders the leading margin. |
| ` int` | ` https://developer.android.com/reference/android/text/style/BulletSpan#getBulletRadius()() ` Get the radius, in pixels, of the bullet point. |
| ` int` | ` https://developer.android.com/reference/android/text/style/BulletSpan#getColor()() ` Get the bullet point color. |
| ` int` | ` https://developer.android.com/reference/android/text/style/BulletSpan#getGapWidth()() ` Get the distance, in pixels, between the bullet point and the paragraph. |
| ` int` | ` https://developer.android.com/reference/android/text/style/BulletSpan#getLeadingMargin(boolean)(boolean first) ` Returns the amount by which to adjust the leading margin. |
| ` int` | ` https://developer.android.com/reference/android/text/style/BulletSpan#getSpanTypeId()() ` Return a special type identifier for this span class. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/text/style/BulletSpan#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/text/style/BulletSpan#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/text/style/LeadingMarginSpan ` |---|---| | ` abstract void` | ` https://developer.android.com/reference/android/text/style/LeadingMarginSpan#drawLeadingMargin(android.graphics.Canvas,%20android.graphics.Paint,%20int,%20int,%20int,%20int,%20int,%20java.lang.CharSequence,%20int,%20int,%20boolean,%20android.text.Layout)(https://developer.android.com/reference/android/graphics/Canvas c, https://developer.android.com/reference/android/graphics/Paint p, int x, int dir, int top, int baseline, int bottom, https://developer.android.com/reference/java/lang/CharSequence text, int start, int end, boolean first, https://developer.android.com/reference/android/text/Layout layout) ` Renders the leading margin. | | ` abstract int` | ` https://developer.android.com/reference/android/text/style/LeadingMarginSpan#getLeadingMargin(boolean)(boolean first) ` Returns the amount by which to adjust the leading margin. | ||
| From interface ` https://developer.android.com/reference/android/text/ParcelableSpan ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/text/ParcelableSpan#getSpanTypeId()() ` Return a special type identifier for this span class. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### STANDARD_GAP_WIDTH

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STANDARD_GAP_WIDTH
```

<br />

<br />

Constant Value:

2
(0x00000002)


## Public constructors

### BulletSpan

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public BulletSpan ()
```

Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` with the default values.

<br />

### BulletSpan

Added in [API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public BulletSpan (Parcel src)
```

Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` from a parcel.

<br />

| Parameters ||
|---|---|
| `src` | `Parcel`: This value cannot be `null`. <br /> |

### BulletSpan

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public BulletSpan (int gapWidth)
```

Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` based on a gap width

<br />

| Parameters ||
|---|---|
| `gapWidth` | `int`: the distance, in pixels, between the bullet point and the paragraph. <br /> |

### BulletSpan

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` based on a gap width and a color integer.

<br />

| Parameters ||
|---|---|
| `gapWidth` | `int`: the distance, in pixels, between the bullet point and the paragraph. <br /> |
| `color` | `int`: the bullet point color, as a color integer <br /> |

**See also:**

- `https://developer.android.com/reference/android/content/res/Resources#getColor(int,%20android.content.res.Resources.Theme)`

### BulletSpan

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

Creates a `https://developer.android.com/reference/android/text/style/BulletSpan` based on a gap width and a color integer.

<br />

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

**See also:**

- `https://developer.android.com/reference/android/content/res/Resources#getColor(int,%20android.content.res.Resources.Theme)`

## Public methods

### describeContents

Added in [API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### drawLeadingMargin

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/text/style/LeadingMarginSpan#getLeadingMargin(boolean)`.

<br />

| Parameters ||
|---|---|
| `canvas` | `Canvas`: This value cannot be `null`. <br /> |
| `paint` | `Paint`: This value cannot be `null`. <br /> |
| `x` | `int`: the current position of the margin <br /> |
| `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. <br /> |
| `top` | `int`: the top of the line <br /> |
| `baseline` | `int`: the baseline of the line <br /> |
| `bottom` | `int`: the bottom of the line <br /> |
| `text` | `CharSequence`: This value cannot be `null`. <br /> |
| `start` | `int`: the start of the line <br /> |
| `end` | `int`: the end of the line <br /> |
| `first` | `boolean`: true if this is the first line of its paragraph <br /> |
| `layout` | `Layout`: This value may be `null`. <br /> |

### getBulletRadius

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getBulletRadius ()
```

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

<br />

| Returns ||
|---|---|
| `int` | the radius, in pixels, of the bullet point. <br /> |

### getColor

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getColor ()
```

Get the bullet point color.

<br />

| Returns ||
|---|---|
| `int` | the bullet point color <br /> |

### getGapWidth

Added in [API level 28](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getGapWidth ()
```

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

<br />

| Returns ||
|---|---|
| `int` | the distance, in pixels, between the bullet point and the paragraph. <br /> |

### getLeadingMargin

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `first` | `boolean`: true if the request is for the first line of a paragraph, false for subsequent lines <br /> |

| Returns ||
|---|---|
| `int` | the offset for the margin. <br /> |

### getSpanTypeId

Added in [API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getSpanTypeId ()
```

Return a special type identifier for this span class.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

### toString

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 3](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |