lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

LeadingMarginSpan.Standard

public static class LeadingMarginSpan.Standard
extends Object implements LeadingMarginSpan, ParcelableSpan

java.lang.Object
   ↳ android.text.style.LeadingMarginSpan.Standard


The standard implementation of LeadingMarginSpan, which adjusts the margin but does not do any rendering.

Summary

Inherited constants

Public constructors

LeadingMarginSpan.Standard(int first, int rest)

Constructor taking separate indents for the first and subsequent lines.

LeadingMarginSpan.Standard(int every)

Constructor taking an indent for all lines.

LeadingMarginSpan.Standard(Parcel src)

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

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.

int getLeadingMargin(boolean first)

Returns the amount by which to adjust the leading margin.

int getSpanTypeId()

Return a special type identifier for this span class.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Public constructors

LeadingMarginSpan.Standard

added in API level 1
public LeadingMarginSpan.Standard (int first, 
                int rest)

Constructor taking separate indents for the first and subsequent lines.

Parameters
first int: the indent for the first line of the paragraph

rest int: the indent for the remaining lines of the paragraph

LeadingMarginSpan.Standard

added in API level 1
public LeadingMarginSpan.Standard (int every)

Constructor taking an indent for all lines.

Parameters
every int: the indent of each line

LeadingMarginSpan.Standard

added in API level 3
public LeadingMarginSpan.Standard (Parcel src)

Parameters
src Parcel

Public methods

describeContents

added in API level 3
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

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

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.

getSpanTypeId

added in API level 3
public int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

writeToParcel

added in API level 3
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.