Added in API level 1

Summary: Ctors | Methods | Inherited Methods

DrawableMarginSpan

Kotlin |Java

public class DrawableMarginSpan
extends Object implements LeadingMarginSpan, LineHeightSpan

java.lang.Object
↳	android.text.style.DrawableMarginSpan

A span which adds a drawable and a padding to the paragraph it's attached to.

If the height of the drawable is bigger than the height of the line it's attached to then the line height is increased to fit the drawable. DrawableMarginSpan allows setting a padding between the drawable and the text. The default value is 0. The span must be set from the beginning of the text, otherwise either the span won't be rendered or it will be rendered incorrectly.

For example, a drawable and a padding of 20px can be added like this:

SpannableString string = new SpannableString("Text with a drawable.");
 string.setSpan(new DrawableMarginSpan(drawable, 20), 0, string.length(),
 Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

Text with a drawable and a padding.

See also:

for working with a {@link android.graphics.Bitmap} instead of a {@link android.graphics.drawable.Drawable Drawable}.

Summary

Public constructors
`DrawableMarginSpan(Drawable drawable)` Creates a `DrawableMarginSpan` from a `Drawable`.
`DrawableMarginSpan(Drawable drawable, int pad)` Creates a `DrawableMarginSpan` from a `Drawable` and a padding, in pixels.

Public methods
`void`	`chooseHeight(CharSequence text, int start, int end, int istartv, int v, Paint.FontMetricsInt fm)` Classes that implement this should define how the height is being calculated.
`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.
`Drawable`	`getDrawable()` Returns the drawable used.
`int`	`getLeadingMargin(boolean first)` Returns the amount by which to adjust the leading margin.
`int`	`getPadding()` Returns a distance between the drawable and text in pixel.
`String`	`toString()` Returns a string representation of the object.

Inherited methods

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.

From interface


        
          android.text.style.LeadingMarginSpan

`abstract 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.
`abstract int`	`getLeadingMargin(boolean first)` Returns the amount by which to adjust the leading margin.

From interface


        
          android.text.style.LineHeightSpan


      chooseHeight(CharSequence text, int start, int end, int spanstartv, int lineHeight, Paint.FontMetricsInt fm)

Classes that implement this should define how the height is being calculated.

Public constructors