Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

public class

SpannableStringBuilder

extends Object
implements Editable GetChars Spannable Appendable CharSequence

java.lang.Object
↳	android.text.SpannableStringBuilder

Class Overview

This is the class for text whose content and markup can both be changed.

Summary

[Expand]

Inherited Constants

From interface android.text.Spanned

int	SPAN_COMPOSING	This flag is set on spans that are being used to apply temporary styling information on the composing text of an input method, so that they can be found and removed when the composing text is being replaced.
int	SPAN_EXCLUSIVE_EXCLUSIVE	Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point.
int	SPAN_EXCLUSIVE_INCLUSIVE	Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their ending point but not at their starting point.
int	SPAN_INCLUSIVE_EXCLUSIVE	Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their starting point but not at their ending point.
int	SPAN_INCLUSIVE_INCLUSIVE	Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.
int	SPAN_INTERMEDIATE	This flag will be set for intermediate span changes, meaning there is guaranteed to be another change following it.
int	SPAN_MARK_MARK	0-length spans with type SPAN_MARK_MARK behave like text marks: they remain at their original offset when text is inserted at that offset.
int	SPAN_MARK_POINT	SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.
int	SPAN_PARAGRAPH	SPAN_PARAGRAPH behaves like SPAN_INCLUSIVE_EXCLUSIVE (SPAN_MARK_MARK), except that if either end of the span is at the end of the buffer, that end behaves like _POINT instead (so SPAN_INCLUSIVE_INCLUSIVE if it starts in the middle and ends at the end, or SPAN_EXCLUSIVE_INCLUSIVE if it both starts and ends at the end).
int	SPAN_POINT_MARK	SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.
int	SPAN_POINT_MARK_MASK	Bitmask of bits that are relevent for controlling point/mark behavior of spans.
int	SPAN_POINT_POINT	0-length spans with type SPAN_POINT_POINT behave like cursors: they are pushed forward by the length of the insertion when text is inserted at their offset.
int	SPAN_PRIORITY	The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first.
int	SPAN_PRIORITY_SHIFT	The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first.
int	SPAN_USER	The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object.
int	SPAN_USER_SHIFT	The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object.

Public Constructors
	SpannableStringBuilder() Create a new SpannableStringBuilder with empty contents
	SpannableStringBuilder(CharSequence text) Create a new SpannableStringBuilder containing a copy of the specified text, including its spans if any.
	SpannableStringBuilder(CharSequence text, int start, int end) Create a new SpannableStringBuilder containing a copy of the specified slice of the specified text, including its spans if any.

Public Methods
SpannableStringBuilder	append(char text) Convenience for append(String.valueOf(text)).
SpannableStringBuilder	append(CharSequence text) Convenience for replace(length(), length(), text, 0, text.length())
SpannableStringBuilder	append(CharSequence text, int start, int end) Convenience for replace(length(), length(), text, start, end)
char	charAt(int where) Return the char at the specified offset within the buffer.
void	clear() Convenience for replace(0, length(), "", 0, 0)
void	clearSpans() Removes all spans from the Editable, as if by calling removeSpan(Object) on each of them.
SpannableStringBuilder	delete(int start, int end) Convenience for replace(st, en, "", 0, 0)
abstract void	drawText(Canvas c, int start, int end, float x, float y, Paint p) Just like drawText(char[], int, int, float, float, Paint).
void	getChars(int start, int end, char[] dest, int destoff) Copy the specified range of chars from this buffer into the specified array, beginning at the specified offset.
InputFilter[]	getFilters() Returns the array of input filters that are currently applied to changes to this Editable.
int	getSpanEnd(Object what) Return the buffer offset of the end of the specified markup object, or -1 if it is not attached to this buffer.
int	getSpanFlags(Object what) Return the flags of the end of the specified markup object, or 0 if it is not attached to this buffer.
int	getSpanStart(Object what) Return the buffer offset of the beginning of the specified markup object, or -1 if it is not attached to this buffer.
<T> T[]	getSpans(int queryStart, int queryEnd, Class<T> kind) Return an array of the spans of the specified type that overlap the specified range of the buffer.
abstract int	getTextWidths(int start, int end, float[] widths, Paint p) Just like getTextWidths(char[], int, int, float[]).
SpannableStringBuilder	insert(int where, CharSequence tb) Convenience for replace(where, where, text, 0, text.length());
SpannableStringBuilder	insert(int where, CharSequence tb, int start, int end) Convenience for replace(where, where, text, start, end)
int	length() Return the number of chars in the buffer.
abstract float	measureText(int start, int end, Paint p) Just like measureText(char[], int, int).
int	nextSpanTransition(int start, int limit, Class kind) Return the next offset after `start` but less than or equal to `limit` where a span of the specified type begins or ends.
void	removeSpan(Object what) Remove the specified markup object from the buffer.
SpannableStringBuilder	replace(int start, int end, CharSequence tb) Convenience for replace(st, en, text, 0, text.length())
SpannableStringBuilder	replace(int start, int end, CharSequence tb, int tbstart, int tbend) Replaces the specified range (`st…en`) of text in this Editable with a copy of the slice `start…end` from `source`.
void	setFilters(InputFilter[] filters) Sets the series of filters that will be called in succession whenever the text of this Editable is changed, each of which has the opportunity to limit or transform the text that is being inserted.
void	setSpan(Object what, int start, int end, int flags) Mark the specified range of text with the specified object.
CharSequence	subSequence(int start, int end) Return a new CharSequence containing a copy of the specified range of this buffer, including the overlapping spans.
String	toString() Return a String containing a copy of the chars in this buffer.
static SpannableStringBuilder	valueOf(CharSequence source)

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Is called before the object's memory is being reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of Class which represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.

From interface android.text.Editable

abstract Editable	append(CharSequence text) Convenience for replace(length(), length(), text, 0, text.length())
abstract Editable	append(CharSequence text, int start, int end) Convenience for replace(length(), length(), text, start, end)
abstract Editable	append(char text) Convenience for append(String.valueOf(text)).
abstract void	clear() Convenience for replace(0, length(), "", 0, 0)
abstract void	clearSpans() Removes all spans from the Editable, as if by calling removeSpan(Object) on each of them.
abstract Editable	delete(int st, int en) Convenience for replace(st, en, "", 0, 0)
abstract InputFilter[]	getFilters() Returns the array of input filters that are currently applied to changes to this Editable.
abstract Editable	insert(int where, CharSequence text) Convenience for replace(where, where, text, 0, text.length());
abstract Editable	insert(int where, CharSequence text, int start, int end) Convenience for replace(where, where, text, start, end)
abstract Editable	replace(int st, int en, CharSequence text) Convenience for replace(st, en, text, 0, text.length())
abstract Editable	replace(int st, int en, CharSequence source, int start, int end) Replaces the specified range (`st…en`) of text in this Editable with a copy of the slice `start…end` from `source`.
abstract void	setFilters(InputFilter[] filters) Sets the series of filters that will be called in succession whenever the text of this Editable is changed, each of which has the opportunity to limit or transform the text that is being inserted.

From interface android.text.GetChars

From interface android.text.Spannable

From interface android.text.Spanned

From interface java.lang.Appendable

From interface java.lang.CharSequence

Public Constructors

public SpannableStringBuilder ()

Create a new SpannableStringBuilder with empty contents

public SpannableStringBuilder (CharSequence text)

Create a new SpannableStringBuilder containing a copy of the specified text, including its spans if any.

public SpannableStringBuilder (CharSequence text, int start, int end)

Create a new SpannableStringBuilder containing a copy of the specified slice of the specified text, including its spans if any.

Public Methods

public SpannableStringBuilder append (char text)

Convenience for append(String.valueOf(text)).

Parameters

text	the character to append.

Returns

this Appendable.

public SpannableStringBuilder append (CharSequence text)

Convenience for replace(length(), length(), text, 0, text.length())

Parameters

text	the character sequence to append.

Returns

this Appendable.

public SpannableStringBuilder append (CharSequence text, int start, int end)

Convenience for replace(length(), length(), text, start, end)

Parameters

text	the character sequence to append.
start	the first index of the subsequence of `csq` that is appended.
end	the last index of the subsequence of `csq` that is appended.

Returns

this Appendable.

public char charAt (int where)

Return the char at the specified offset within the buffer.

Parameters

where	the index of the character to return.

Returns

the requested character.

public void clear ()

Convenience for replace(0, length(), "", 0, 0)

public void clearSpans ()

Removes all spans from the Editable, as if by calling removeSpan(Object) on each of them.

public SpannableStringBuilder delete (int start, int end)

Convenience for replace(st, en, "", 0, 0)

public abstract void drawText (Canvas c, int start, int end, float x, float y, Paint p)

Just like drawText(char[], int, int, float, float, Paint).

public void getChars (int start, int end, char[] dest, int destoff)

Copy the specified range of chars from this buffer into the specified array, beginning at the specified offset.

public InputFilter[] getFilters ()

Returns the array of input filters that are currently applied to changes to this Editable.

public int getSpanEnd (Object what)

Return the buffer offset of the end of the specified markup object, or -1 if it is not attached to this buffer.

public int getSpanFlags (Object what)

Return the flags of the end of the specified markup object, or 0 if it is not attached to this buffer.

public int getSpanStart (Object what)

Return the buffer offset of the beginning of the specified markup object, or -1 if it is not attached to this buffer.

public T[] getSpans (int queryStart, int queryEnd, Class<T> kind)

Return an array of the spans of the specified type that overlap the specified range of the buffer. The kind may be Object.class to get a list of all the spans regardless of type.

public abstract int getTextWidths (int start, int end, float[] widths, Paint p)

Just like getTextWidths(char[], int, int, float[]).

public SpannableStringBuilder insert (int where, CharSequence tb)

Convenience for replace(where, where, text, 0, text.length());

public SpannableStringBuilder insert (int where, CharSequence tb, int start, int end)

Convenience for replace(where, where, text, start, end)

public int length ()

Return the number of chars in the buffer.

Returns

the number of characters.

public abstract float measureText (int start, int end, Paint p)

Just like measureText(char[], int, int).

public int nextSpanTransition (int start, int limit, Class kind)

Return the next offset after start but less than or equal to limit where a span of the specified type begins or ends.

public void removeSpan (Object what)

Remove the specified markup object from the buffer.

public SpannableStringBuilder replace (int start, int end, CharSequence tb)

Convenience for replace(st, en, text, 0, text.length())

public SpannableStringBuilder replace (int start, int end, CharSequence tb, int tbstart, int tbend)

Replaces the specified range (st…en) of text in this Editable with a copy of the slice start…end from source. The destination slice may be empty, in which case the operation is an insertion, or the source slice may be empty, in which case the operation is a deletion.

Before the change is committed, each filter that was set with setFilters(InputFilter[]) is given the opportunity to modify the source text.

If source is Spanned, the spans from it are preserved into the Editable. Existing spans within the Editable that entirely cover the replaced range are retained, but any that were strictly within the range that was replaced are removed. As a special case, the cursor position is preserved even when the entire range where it is located is replaced.

Returns

a reference to this object.

public void setFilters (InputFilter[] filters)

Sets the series of filters that will be called in succession whenever the text of this Editable is changed, each of which has the opportunity to limit or transform the text that is being inserted.

public void setSpan (Object what, int start, int end, int flags)

Mark the specified range of text with the specified object. The flags determine how the span will behave when text is inserted at the start or end of the span's range.

public CharSequence subSequence (int start, int end)

Return a new CharSequence containing a copy of the specified range of this buffer, including the overlapping spans.

Parameters

start	the start offset of the sub-sequence. It is inclusive, that is, the index of the first character that is included in the sub-sequence.
end	the end offset of the sub-sequence. It is exclusive, that is, the index of the first character after those that are included in the sub-sequence

Returns

the requested sub-sequence.

public String toString ()

Return a String containing a copy of the chars in this buffer.

Returns

a printable representation of this object.

Interfaces

Classes

Enums

SpannableStringBuilder

Class Overview

Summary

Public Constructors

public SpannableStringBuilder ()

public SpannableStringBuilder (CharSequence text)

public SpannableStringBuilder (CharSequence text, int start, int end)

Public Methods

public SpannableStringBuilder append (char text)

Parameters

Returns

public SpannableStringBuilder append (CharSequence text)

Parameters

Returns

public SpannableStringBuilder append (CharSequence text, int start, int end)

Parameters

Returns

public char charAt (int where)

Parameters

Returns

public void clear ()

public void clearSpans ()

public SpannableStringBuilder delete (int start, int end)

public abstract void drawText (Canvas c, int start, int end, float x, float y, Paint p)

public void getChars (int start, int end, char[] dest, int destoff)

public InputFilter[] getFilters ()

public int getSpanEnd (Object what)

public int getSpanFlags (Object what)

public int getSpanStart (Object what)

public T[] getSpans (int queryStart, int queryEnd, Class<T> kind)

public abstract int getTextWidths (int start, int end, float[] widths, Paint p)

public SpannableStringBuilder insert (int where, CharSequence tb)

public SpannableStringBuilder insert (int where, CharSequence tb, int start, int end)

public int length ()

Returns

public abstract float measureText (int start, int end, Paint p)

public int nextSpanTransition (int start, int limit, Class kind)

public void removeSpan (Object what)

public SpannableStringBuilder replace (int start, int end, CharSequence tb)

public SpannableStringBuilder replace (int start, int end, CharSequence tb, int tbstart, int tbend)

Returns

public void setFilters (InputFilter[] filters)

public void setSpan (Object what, int start, int end, int flags)

public CharSequence subSequence (int start, int end)

Parameters

Returns

public String toString ()

Returns

public static SpannableStringBuilder valueOf (CharSequence source)