Added in API level 1

Summary: Inherited Constants | Ctors | Methods | Inherited Methods

LeadingMarginSpan.Standard

---

Kotlin |Java

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 int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Public constructors
Standard(Parcel src)
Standard(int every) Constructor taking an indent for all lines.
Standard(int first, int rest) Constructor taking separate indents for the first and subsequent lines.

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 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.ParcelableSpan abstract int getSpanTypeId() Return a special type identifier for this span class.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Public constructors

Standard

Added in API level 3

public Standard (Parcel src)

Parameters
src	Parcel

Standard

Added in API level 1

public Standard (int every)

Constructor taking an indent for all lines.

Parameters
every	int: the indent of each line

Standard

Added in API level 1

public 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

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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

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. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES