DynamicDrawableSpan

Kotlin |Java

abstract class DynamicDrawableSpan : ReplacementSpan

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	android.text.style.MetricAffectingSpan
		↳	android.text.style.ReplacementSpan
			↳	android.text.style.DynamicDrawableSpan

Known Direct Subclasses

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.

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
static Int	`ALIGN_BASELINE` A constant indicating that the bottom of this span should be aligned with the baseline of the surrounding text.
static Int	`ALIGN_BOTTOM` A constant indicating that the bottom of this span should be aligned with the bottom of the surrounding text, i.
static Int	`ALIGN_CENTER` A constant indicating that this span should be vertically centered between the top and the lowest descender.

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

Protected constructors
`DynamicDrawableSpan(verticalAlignment: Int)` Creates a `DynamicDrawableSpan` based on a vertical alignment.

Public methods
open Unit	`draw(canvas: Canvas, text: CharSequence!, start: Int, end: Int, x: Float, top: Int, y: Int, bottom: Int, paint: Paint)` Draws the span into the canvas.
abstract Drawable!	`getDrawable()` Your subclass must implement this method to provide the bitmap to be drawn.
open Int	`getSize(paint: Paint, text: CharSequence!, start: Int, end: Int, fm: Paint.FontMetricsInt?)` Returns the width of the span.
open Int	`getVerticalAlignment()` Returns the vertical alignment of this span, one of `ALIGN_BOTTOM`, `ALIGN_BASELINE` or `ALIGN_CENTER`.
open String	`toString()`

Inherited functions

From class ReplacementSpan

`CharSequence?`	`getContentDescription()` Gets a brief description of this ReplacementSpan for use in accessibility support.
`Unit`	`setContentDescription(contentDescription: CharSequence?)` Sets the specific content description into ReplacementSpan. ReplacementSpans are shared with accessibility services, but only the content description is available from them.
`Unit`	`updateDrawState(ds: TextPaint!)` This method does nothing, since ReplacementSpans are drawn explicitly instead of affecting Paint properties.
`Unit`	`updateMeasureState(p: TextPaint)` This method does nothing, since ReplacementSpans are measured explicitly instead of affecting Paint properties.

From class MetricAffectingSpan

MetricAffectingSpan!

getUnderlying()

Returns "this" for most MetricAffectingSpans, but for MetricAffectingSpans that were generated by wrap, returns the underlying MetricAffectingSpan.

From class CharacterStyle

Unit

updateDrawState(tp: TextPaint!)

CharacterStyle!

wrap(cs: CharacterStyle!)

A given CharacterStyle can only applied to a single region of a given Spanned. If you need to attach the same CharacterStyle to multiple regions, you can use this method to wrap it with a new object that will have the same effect but be a distinct object so that it can also be attached without conflict.

Properties
Int	`mVerticalAlignment`

Constants

ALIGN_BASELINE

Added in API level 3

static val ALIGN_BASELINE: Int

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

Value: 1

ALIGN_BOTTOM

Added in API level 3

static val ALIGN_BOTTOM: Int

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.

Value: 0

ALIGN_CENTER

Added in API level 29

static val ALIGN_CENTER: Int

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

Value: 2

Public constructors