Skip to content

Most visited

Recently visited

navigation

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

From interface android.os.Parcelable

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

From class java.lang.Object
From interface android.text.style.LeadingMarginSpan
From interface android.text.ParcelableSpan
From interface android.os.Parcelable

Public constructors

LeadingMarginSpan.Standard

Added in API level 1
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
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
LeadingMarginSpan.Standard (Parcel src)

Parameters
src Parcel

Public methods

describeContents

Added in API level 3
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
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
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
int getSpanTypeId ()

Return a special type identifier for this span class.

Returns
int

writeToParcel

Added in API level 3
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_WRITE_RETURN_VALUE.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.