Most visited

Recently visited

Added in API level 1

BulletSpan

public class BulletSpan
extends Object implements LeadingMarginSpan, ParcelableSpan

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


Summary

Constants

int STANDARD_GAP_WIDTH

Inherited constants

From interface android.os.Parcelable

Public constructors

BulletSpan()
BulletSpan(int gapWidth)
BulletSpan(int gapWidth, int color)
BulletSpan(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 l)

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

Constants

STANDARD_GAP_WIDTH

Added in API level 1
int STANDARD_GAP_WIDTH

Constant Value: 2 (0x00000002)

Public constructors

BulletSpan

Added in API level 1
BulletSpan ()

BulletSpan

Added in API level 1
BulletSpan (int gapWidth)

Parameters
gapWidth int

BulletSpan

Added in API level 1
BulletSpan (int gapWidth, 
                int color)

Parameters
gapWidth int
color int

BulletSpan

Added in API level 3
BulletSpan (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 l)

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

Hooray!