Added in API level 1

ImageSpan


open class ImageSpan : DynamicDrawableSpan
kotlin.Any
   ↳ android.text.style.CharacterStyle
   ↳ android.text.style.MetricAffectingSpan
   ↳ android.text.style.ReplacementSpan
   ↳ android.text.style.DynamicDrawableSpan
   ↳ android.text.style.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. The drawable can be constructed from varied sources:

The default value for the vertical alignment is DynamicDrawableSpan#ALIGN_BOTTOM

For example, an ImagedSpan can be used like this:

SpannableString string = new SpannableString("Bottom: span.\nBaseline: span.");
  // using the default alignment: ALIGN_BOTTOM
  string.setSpan(new ImageSpan(this, R.mipmap.ic_launcher), 7, 8, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
  string.setSpan(new ImageSpan(this, R.mipmap.ic_launcher, DynamicDrawableSpan.ALIGN_BASELINE),
  22, 23, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE);
  
Text with ImageSpans aligned bottom and baseline.

Summary

Inherited constants
Public constructors

ImageSpan(b: Bitmap, verticalAlignment: Int)

ImageSpan(context: Context, bitmap: Bitmap)

Constructs an ImageSpan from a Context and a Bitmap with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM

ImageSpan(context: Context, bitmap: Bitmap, verticalAlignment: Int)

Constructs an ImageSpan from a Context, a Bitmap and a vertical alignment.

ImageSpan(drawable: Drawable)

Constructs an ImageSpan from a drawable with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM.

ImageSpan(drawable: Drawable, verticalAlignment: Int)

Constructs an ImageSpan from a drawable and a vertical alignment.

ImageSpan(drawable: Drawable, source: String)

Constructs an ImageSpan from a drawable and a source with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM

ImageSpan(drawable: Drawable, source: String, verticalAlignment: Int)

Constructs an ImageSpan from a drawable, a source and a vertical alignment.

ImageSpan(context: Context, uri: Uri)

Constructs an ImageSpan from a Context and a Uri with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM.

ImageSpan(context: Context, uri: Uri, verticalAlignment: Int)

Constructs an ImageSpan from a Context, a Uri and a vertical alignment.

ImageSpan(context: Context, resourceId: Int)

Constructs an ImageSpan from a Context and a resource id with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM

ImageSpan(context: Context, resourceId: Int, verticalAlignment: Int)

Constructs an ImageSpan from a Context, a resource id and a vertical alignment.

Public methods
open Drawable!

open String?

Returns the source string that was saved during construction.

open String

Inherited functions
Inherited properties

Public constructors

ImageSpan

Added in API level 1
ImageSpan(b: Bitmap)

Deprecated: Use ImageSpan(android.content.Context,android.graphics.Bitmap) instead.

Parameters
b Bitmap: This value cannot be null.

ImageSpan

Added in API level 3
ImageSpan(
    b: Bitmap,
    verticalAlignment: Int)

Deprecated: Use ImageSpan(android.content.Context,android.graphics.Bitmap,int) instead.

Parameters
b Bitmap: This value cannot be null.

ImageSpan

Added in API level 4
ImageSpan(
    context: Context,
    bitmap: Bitmap)

Constructs an ImageSpan from a Context and a Bitmap with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM

Parameters
context Context: context used to create a drawable from {@param bitmap} based on the display metrics of the resources This value cannot be null.
bitmap Bitmap: bitmap to be rendered This value cannot be null.

ImageSpan

Added in API level 4
ImageSpan(
    context: Context,
    bitmap: Bitmap,
    verticalAlignment: Int)

Constructs an ImageSpan from a Context, a Bitmap and a vertical alignment.

Parameters
context Context: context used to create a drawable from {@param bitmap} based on the display metrics of the resources This value cannot be null.
bitmap Bitmap: bitmap to be rendered This value cannot be null.
verticalAlignment Int: one of DynamicDrawableSpan#ALIGN_BOTTOM or DynamicDrawableSpan#ALIGN_BASELINE

ImageSpan

Added in API level 1
ImageSpan(drawable: Drawable)

Constructs an ImageSpan from a drawable with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM.

Parameters
drawable Drawable: drawable to be rendered This value cannot be null.

ImageSpan

Added in API level 3
ImageSpan(
    drawable: Drawable,
    verticalAlignment: Int)

Constructs an ImageSpan from a drawable and a vertical alignment.

Parameters
drawable Drawable: drawable to be rendered This value cannot be null.
verticalAlignment Int: one of DynamicDrawableSpan#ALIGN_BOTTOM or DynamicDrawableSpan#ALIGN_BASELINE

ImageSpan

Added in API level 1
ImageSpan(
    drawable: Drawable,
    source: String)

Constructs an ImageSpan from a drawable and a source with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM

Parameters
drawable Drawable: drawable to be rendered This value cannot be null.
source String: drawable's Uri source This value cannot be null.

ImageSpan

Added in API level 3
ImageSpan(
    drawable: Drawable,
    source: String,
    verticalAlignment: Int)

Constructs an ImageSpan from a drawable, a source and a vertical alignment.

Parameters
drawable Drawable: drawable to be rendered This value cannot be null.
source String: drawable's uri source This value cannot be null.
verticalAlignment Int: one of DynamicDrawableSpan#ALIGN_BOTTOM or DynamicDrawableSpan#ALIGN_BASELINE

ImageSpan

Added in API level 1
ImageSpan(
    context: Context,
    uri: Uri)

Constructs an ImageSpan from a Context and a Uri with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM. The Uri source can be retrieved via getSource()

Parameters
context Context: context used to create a drawable from {@param bitmap} based on the display metrics of the resources This value cannot be null.
uri Uri: Uri used to construct the drawable that will be rendered This value cannot be null.

ImageSpan

Added in API level 3
ImageSpan(
    context: Context,
    uri: Uri,
    verticalAlignment: Int)

Constructs an ImageSpan from a Context, a Uri and a vertical alignment. The Uri source can be retrieved via getSource()

Parameters
context Context: context used to create a drawable from {@param bitmap} based on the display metrics of the resources This value cannot be null.
uri Uri: Uri used to construct the drawable that will be rendered. This value cannot be null.
verticalAlignment Int: one of DynamicDrawableSpan#ALIGN_BOTTOM or DynamicDrawableSpan#ALIGN_BASELINE

ImageSpan

Added in API level 1
ImageSpan(
    context: Context,
    resourceId: Int)

Constructs an ImageSpan from a Context and a resource id with the default alignment DynamicDrawableSpan#ALIGN_BOTTOM

Parameters
context Context: context used to retrieve the drawable from resources This value cannot be null.
resourceId Int: drawable resource id based on which the drawable is retrieved

ImageSpan

Added in API level 3
ImageSpan(
    context: Context,
    resourceId: Int,
    verticalAlignment: Int)

Constructs an ImageSpan from a Context, a resource id and a vertical alignment.

Parameters
context Context: context used to retrieve the drawable from resources This value cannot be null.
resourceId Int: drawable resource id based on which the drawable is retrieved.
verticalAlignment Int: one of DynamicDrawableSpan#ALIGN_BOTTOM or DynamicDrawableSpan#ALIGN_BASELINE

Public methods

getDrawable

Added in API level 1
open fun getDrawable(): Drawable!

getSource

Added in API level 1
open fun getSource(): String?

Returns the source string that was saved during construction.

Return
String? the source string that was saved during construction This value may be null.

toString

Added in API level 1
open fun toString(): String
Return
String a string representation of the object.