Added in API level 1

Summary: Ctors | Methods | Inherited Methods

IconMarginSpan

Kotlin |Java

public class IconMarginSpan
extends Object implements LeadingMarginSpan, LineHeightSpan

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

Paragraph affecting span, that draws a bitmap at the beginning of a text. The span also allows setting a padding between the bitmap and the text. The default value of the padding is 0px. The span should be attached from the first character of the text.

For example, an IconMarginSpan with a bitmap and a padding of 30px can be set like this:

 SpannableString string = new SpannableString("Text with icon and padding");
 string.setSpan(new IconMarginSpan(bitmap, 30), 0, string.length(),
 Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);

Text with IconMarginSpan

See also:

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

Summary

Public constructors
`IconMarginSpan(Bitmap bitmap)` Creates an `IconMarginSpan` from a `Bitmap`.
`IconMarginSpan(Bitmap bitmap, int pad)` Creates an `IconMarginSpan` from a `Bitmap`.

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.
`Bitmap`	`getBitmap()` Returns the bitmap to be used at the beginning of the text
`int`	`getLeadingMargin(boolean first)` Returns the amount by which to adjust the leading margin.
`int`	`getPadding()` Returns the padding width between the bitmap and the text.
`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

IconMarginSpan

Added in API level 1

public IconMarginSpan (Bitmap bitmap)

Creates an IconMarginSpan from a Bitmap.

Parameters
`bitmap`	`Bitmap`: bitmap to be rendered at the beginning of the text This value cannot be `null`.

IconMarginSpan

Added in API level 1

public IconMarginSpan (Bitmap bitmap, 
                int pad)

Creates an IconMarginSpan from a Bitmap.

Parameters
`bitmap`	`Bitmap`: bitmap to be rendered at the beginning of the text This value cannot be `null`.
`pad`	`int`: padding width, in pixels, between the bitmap and the text Value is 0 or greater

Public methods

chooseHeight

Added in API level 1

public 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.

Parameters
`text`	`CharSequence`: the text
`start`	`int`: the start of the line
`end`	`int`: the end of the line
`istartv`	`int`: the start of the span
`v`	`int`: the line height
`fm`	`Paint.FontMetricsInt`: font metrics of the paint, in integers

drawLeadingMargin

Added in API level 1

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 getLeadingMargin(boolean).

Parameters
`c`	`Canvas`: the canvas
`p`	`Paint`: the paint. The this should be left unchanged on exit.
`x`	`int`: the current position of the margin
`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.
`top`	`int`: the top of the line
`baseline`	`int`: the baseline of the line
`bottom`	`int`: the bottom of the line
`text`	`CharSequence`: the text
`start`	`int`: the start of the line
`end`	`int`: the end of the line
`first`	`boolean`: true if this is the first line of its paragraph
`layout`	`Layout`: the layout containing this line

getBitmap

Added in API level 34

public Bitmap getBitmap ()

Returns the bitmap to be used at the beginning of the text

Returns
`Bitmap`	a bitmap This value cannot be `null`.

getLeadingMargin

Added in API level 1

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.

Parameters
`first`	`boolean`: true if the request is for the first line of a paragraph, false for subsequent lines

Returns
`int`	the offset for the margin.

getPadding

Added in API level 34

public int getPadding ()

Returns the padding width between the bitmap and the text.
This units of this value are pixels.

Returns
`int`	a padding width in pixels This units of this value are pixels. {}

toString

Added in API level 1

public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())

Returns
`String`	a string representation of the object.