Android APIs
public interface

LeadingMarginSpan

implements ParagraphStyle
android.text.style.LeadingMarginSpan
Known Indirect Subclasses

Class Overview

A paragraph style affecting the leading margin. There can be multiple leading margin spans on a single paragraph; they will be rendered in order, each adding its margin to the ones before it. The leading margin is on the right for lines in a right-to-left paragraph.

LeadingMarginSpans should be attached from the first character to the last character of a single paragraph.

Summary

Nested Classes
interface LeadingMarginSpan.LeadingMarginSpan2 An extended version of LeadingMarginSpan, which allows the implementor to specify the number of lines of the paragraph to which this object is attached that the "first line of paragraph" margin width will be applied to. 
class LeadingMarginSpan.Standard The standard implementation of LeadingMarginSpan, which adjusts the margin but does not do any rendering. 
Public Methods
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.

Public Methods

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

Added in API level 1

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

public abstract int getLeadingMargin (boolean first)

Added in API level 1

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.