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/QuoteSpan#constants) \| [Inherited Constants](https://developer.android.com/reference/android/text/style/QuoteSpan#inhconstants) \| [Ctors](https://developer.android.com/reference/android/text/style/QuoteSpan#pubctors) \| [Methods](https://developer.android.com/reference/android/text/style/QuoteSpan#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/text/style/QuoteSpan#inhmethods)

# QuoteSpan

*** ** * ** ***

` public class QuoteSpan `   
` 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.QuoteSpan |

<br />

*** ** * ** ***

A span which styles paragraphs by adding a vertical stripe at the beginning of the text (respecting layout direction).

A `QuoteSpan` must be attached from the first character to the last character of a single paragraph, otherwise the span will not be displayed.

`QuoteSpans` allow configuring the following elements:

- **color** - the vertical stripe color. By default, the stripe color is 0xff0000ff
- **gap width** - the distance, in pixels, between the stripe and the paragraph. Default value is 2px.
- **stripe width** - the width, in pixels, of the stripe. Default value is 2px.

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

    SpannableString string = new SpannableString("Text with quote span on a long line");
    string.setSpan(new QuoteSpan(), 0, string.length(), Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

![](https://developer.android.com/static/reference/android/images/text/style/defaultquotespan.png) `QuoteSpan` constructed with default values.

<br />

To construct a `QuoteSpan` with a green stripe, of 20px in width and a gap width of 40px:

    SpannableString string = new SpannableString("Text with quote span on a long line");
    string.setSpan(new QuoteSpan(Color.GREEN, 20, 40), 0, string.length(),
    Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

![](https://developer.android.com/static/reference/android/images/text/style/customquotespan.png) Customized `QuoteSpan`.

<br />

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/text/style/QuoteSpan#STANDARD_COLOR` Default color for the quote stripe. |
| `int` | `https://developer.android.com/reference/android/text/style/QuoteSpan#STANDARD_GAP_WIDTH_PX` Default gap width in pixels. |
| `int` | `https://developer.android.com/reference/android/text/style/QuoteSpan#STANDARD_STRIPE_WIDTH_PX` Default stripe width in pixels. |

### 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/QuoteSpan#QuoteSpan()() ` Creates a `https://developer.android.com/reference/android/text/style/QuoteSpan` with the default values. |
| ` https://developer.android.com/reference/android/text/style/QuoteSpan#QuoteSpan(android.os.Parcel)(https://developer.android.com/reference/android/os/Parcel src) ` Create a `https://developer.android.com/reference/android/text/style/QuoteSpan` from a parcel. |
| ` https://developer.android.com/reference/android/text/style/QuoteSpan#QuoteSpan(int)(int color) ` Creates a `https://developer.android.com/reference/android/text/style/QuoteSpan` based on a color. |
| ` https://developer.android.com/reference/android/text/style/QuoteSpan#QuoteSpan(int,%20int,%20int)(int color, int stripeWidth, int gapWidth) ` Creates a `https://developer.android.com/reference/android/text/style/QuoteSpan` based on a color, a stripe width and the width of the gap between the stripe and the text. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` void` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#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. |
| ` int` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#getColor()() ` Get the color of the quote stripe. |
| ` int` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#getGapWidth()() ` Get the width of the gap between the stripe and the text. |
| ` int` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#getLeadingMargin(boolean)(boolean first) ` Returns the amount by which to adjust the leading margin. |
| ` int` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#getSpanTypeId()() ` Return a special type identifier for this span class. |
| ` int` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#getStripeWidth()() ` Get the width of the quote stripe. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/text/style/QuoteSpan#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_COLOR

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

```
public static final int STANDARD_COLOR
```

Default color for the quote stripe.

<br />

Constant Value: -16776961 (0xff0000ff)

### STANDARD_GAP_WIDTH_PX

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

```
public static final int STANDARD_GAP_WIDTH_PX
```

Default gap width in pixels.

<br />

Constant Value: 2 (0x00000002)

### STANDARD_STRIPE_WIDTH_PX

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

```
public static final int STANDARD_STRIPE_WIDTH_PX
```

Default stripe width in pixels.

<br />

Constant Value: 2 (0x00000002)

## Public constructors

### QuoteSpan

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

```
public QuoteSpan ()
```

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

<br />

### QuoteSpan

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

```
public QuoteSpan (Parcel src)
```

Create a `https://developer.android.com/reference/android/text/style/QuoteSpan` from a parcel.

<br />

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

### QuoteSpan

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

```
public QuoteSpan (int color)
```

Creates a `https://developer.android.com/reference/android/text/style/QuoteSpan` based on a color.

<br />

| Parameters ||
|---|---|
| `color` | `int`: the color of the quote stripe. <br /> |

### QuoteSpan

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

```
public QuoteSpan (int color, 
                int stripeWidth, 
                int gapWidth)
```

Creates a `https://developer.android.com/reference/android/text/style/QuoteSpan` based on a color, a stripe width and the width of the gap between the stripe and the text.

<br />

| Parameters ||
|---|---|
| `color` | `int`: the color of the quote stripe. <br /> |
| `stripeWidth` | `int`: the width of the stripe. Value is 0 or greater <br /> |
| `gapWidth` | `int`: the width of the gap between the stripe and the text. Value is 0 or greater <br /> |

## 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 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. 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 ||
|---|---|
| `c` | `Canvas`: This value cannot be `null`. <br /> |
| `p` | `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 cannot be `null`. <br /> |

### getColor

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

```
public int getColor ()
```

Get the color of the quote stripe.

<br />

| Returns ||
|---|---|
| `int` | the color of the quote stripe. <br /> |

### getGapWidth

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

```
public int getGapWidth ()
```

Get the width of the gap between the stripe and the text.

<br />

| Returns ||
|---|---|
| `int` | the width of the gap between the stripe and the text. <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 /> |

### getStripeWidth

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

```
public int getStripeWidth ()
```

Get the width of the quote stripe.

<br />

| Returns ||
|---|---|
| `int` | the width of the quote stripe. <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`: The Parcel in which the object should be written. 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` |