Added in API level 1

DynamicDrawableSpan

Kotlin |Java

public abstract class DynamicDrawableSpan
extends ReplacementSpan

java.lang.Object
↳	android.text.style.CharacterStyle
	↳	android.text.style.MetricAffectingSpan
		↳	android.text.style.ReplacementSpan
			↳	android.text.style.DynamicDrawableSpan

Known direct subclasses

ImageSpan

ImageSpan Span that replaces the text it's attached to with a Drawable that can be aligned with the bottom or with the baseline of the surrounding text.

Span that replaces the text it's attached to with a Drawable that can be aligned with the bottom or with the baseline of the surrounding text.

For an implementation that constructs the drawable from various sources (Bitmap, Drawable, resource id or Uri) use ImageSpan.

A simple implementation of DynamicDrawableSpan that uses drawables from resources looks like this:

 class MyDynamicDrawableSpan extends DynamicDrawableSpan {

 private final Context mContext;
 private final int mResourceId;

 public MyDynamicDrawableSpan(Context context, @DrawableRes int resourceId) {
     mContext = context;
     mResourceId = resourceId;
 }

 @Override
 public Drawable getDrawable() {
      Drawable drawable = mContext.getDrawable(mResourceId);
      drawable.setBounds(0, 0, drawable.getIntrinsicWidth(), drawable.getIntrinsicHeight());
      return drawable;
 }
 }

The class can be used like this:

 SpannableString string = new SpannableString("Text with a drawable span");
 string.setSpan(new MyDynamicDrawableSpan(context, R.mipmap.ic_launcher), 12, 20, Spanned
 .SPAN_EXCLUSIVE_EXCLUSIVE);

Replacing text with a drawable.

Summary

Constants
`int`	`ALIGN_BASELINE` A constant indicating that the bottom of this span should be aligned with the baseline of the surrounding text.
`int`	`ALIGN_BOTTOM` A constant indicating that the bottom of this span should be aligned with the bottom of the surrounding text, i.e., at the same level as the lowest descender in the text.
`int`	`ALIGN_CENTER` A constant indicating that this span should be vertically centered between the top and the lowest descender.

Fields
`protected final int`	`mVerticalAlignment`

Public constructors
`DynamicDrawableSpan()` Creates a `DynamicDrawableSpan`.

Protected constructors
`DynamicDrawableSpan(int verticalAlignment)` Creates a `DynamicDrawableSpan` based on a vertical alignment.\

Public methods
`void`	`draw(Canvas canvas, CharSequence text, int start, int end, float x, int top, int y, int bottom, Paint paint)` Draws the span into the canvas.
`abstract Drawable`	`getDrawable()` Your subclass must implement this method to provide the bitmap to be drawn.
`int`	`getSize(Paint paint, CharSequence text, int start, int end, Paint.FontMetricsInt fm)` Returns the width of the span.
`int`	`getVerticalAlignment()` Returns the vertical alignment of this span, one of `ALIGN_BOTTOM`, `ALIGN_BASELINE` or `ALIGN_CENTER`.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

From class


        
          android.text.style.ReplacementSpan

`abstract void`	`draw(Canvas canvas, CharSequence text, int start, int end, float x, int top, int y, int bottom, Paint paint)` Draws the span into the canvas.
`CharSequence`	`getContentDescription()` Gets a brief description of this ReplacementSpan for use in accessibility support.
`abstract int`	`getSize(Paint paint, CharSequence text, int start, int end, Paint.FontMetricsInt fm)` Returns the width of the span.
`void`	`setContentDescription(CharSequence contentDescription)` Sets the specific content description into ReplacementSpan.
`void`	`updateDrawState(TextPaint ds)` This method does nothing, since ReplacementSpans are drawn explicitly instead of affecting Paint properties.
`void`	`updateMeasureState(TextPaint p)` This method does nothing, since ReplacementSpans are measured explicitly instead of affecting Paint properties.

From class


        
          android.text.style.MetricAffectingSpan

`MetricAffectingSpan`	`getUnderlying()` Returns "this" for most MetricAffectingSpans, but for MetricAffectingSpans that were generated by `CharacterStyle.wrap(CharacterStyle)`, returns the underlying MetricAffectingSpan.
`abstract void`	`updateMeasureState(TextPaint textPaint)` Classes that extend MetricAffectingSpan implement this method to update the text formatting in a way that can change the width or height of characters.

From class


        
          android.text.style.CharacterStyle

`CharacterStyle`	`getUnderlying()` Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by `wrap(CharacterStyle)`, returns the underlying CharacterStyle.
`abstract void`	`updateDrawState(TextPaint tp)`
`static CharacterStyle`	`wrap(CharacterStyle cs)` A given CharacterStyle can only applied to a single region of a given Spanned.

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.

Constants

ALIGN_BASELINE

Added in API level 3

public static final int ALIGN_BASELINE

A constant indicating that the bottom of this span should be aligned with the baseline of the surrounding text.

Constant Value: 1 (0x00000001)

ALIGN_BOTTOM

Added in API level 3

public static final int ALIGN_BOTTOM

A constant indicating that the bottom of this span should be aligned with the bottom of the surrounding text, i.e., at the same level as the lowest descender in the text.

Constant Value: 0 (0x00000000)

ALIGN_CENTER

Added in API level 29

public static final int ALIGN_CENTER

A constant indicating that this span should be vertically centered between the top and the lowest descender.

Constant Value: 2 (0x00000002)

Fields

mVerticalAlignment

Added in API level 3

protected final int mVerticalAlignment

Public constructors