SpannableStringBuilder

public class SpannableStringBuilder extends Object
implements CharSequence GetChars Spannable Editable Appendable

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

Inherited Constant Summary

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_EXCLUSIVE_INCLUSIVE 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 Constructor Summary

	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 Method Summary

SpannableStringBuilder	append(char text) Convenience for append(String.valueOf(text)).
SpannableStringBuilder	append(CharSequence text, int start, int end) Convenience for replace(length(), length(), text, start, end)
SpannableStringBuilder	append(CharSequence text) Convenience for replace(length(), length(), text, 0, text.length())
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 Spannable.removeSpan(Object) on each of them.
SpannableStringBuilder	delete(int start, int end) Convenience for replace(st, en, "", 0, 0)
boolean	equals(Object o)
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.
int	hashCode()
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.
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, 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.
SpannableStringBuilder	replace(int start, int end, CharSequence tb) Convenience for replace(st, en, text, 0, text.length())
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)

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

From interface java.lang.CharSequence

abstract char	charAt(int arg0)
IntStream	chars()
IntStream	codePoints()
abstract int	length()
abstract CharSequence	subSequence(int arg0, int arg1)
abstract String	toString()

From interface android.text.GetChars

abstract void

getChars(int start, int end, char[] dest, int destoff) Exactly like String.getChars(): copy chars start through end - 1 from this CharSequence into dest beginning at offset destoff.

From interface android.text.Spannable

abstract void	removeSpan(Object what) Remove the specified object from the range of text to which it was attached, if any.
abstract void	setSpan(Object what, int start, int end, int flags) Attach the specified markup object to the range start…end of the text, or move the object to that range if it was already attached elsewhere.

From interface android.text.Editable

abstract Editable	append(char text) Convenience for append(String.valueOf(text)).
abstract Editable	append(CharSequence text, int start, int end) Convenience for replace(length(), length(), text, start, end)
abstract Editable	append(CharSequence text) Convenience for replace(length(), length(), text, 0, text.length())
abstract void	clear() Convenience for replace(0, length(), "", 0, 0)
abstract void	clearSpans() Removes all spans from the Editable, as if by calling Spannable.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 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 Editable	replace(int st, int en, CharSequence text) Convenience for replace(st, en, text, 0, text.length())
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 java.lang.Appendable

abstract Appendable	append(char arg0)
abstract Appendable	append(CharSequence arg0, int arg1, int arg2)
abstract Appendable	append(CharSequence arg0)

From interface android.text.Spanned

abstract int	getSpanEnd(Object tag) Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
abstract int	getSpanFlags(Object tag) Return the flags that were specified when Spannable.setSpan(Object, int, int, int) was used to attach the specified markup object, or 0 if the specified object has not been attached.
abstract int	getSpanStart(Object tag) Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
abstract <T> T[]	getSpans(int start, int end, Class<T> type) Return an array of the markup objects attached to the specified slice of this CharSequence and whose type is the specified type or a subclass of it.
abstract int	nextSpanTransition(int start, int limit, Class type) Return the first offset greater than or equal to start where a markup object of class type begins or ends, or limit if there are no starts or ends greater than or equal to start but less than limit.

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.

Parameters

text

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.

Parameters

text
start
end

Public Methods

public SpannableStringBuilder append (char text)

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

Parameters

text

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

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

Parameters

text
start
end

public SpannableStringBuilder append (CharSequence text)

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

Parameters

text

public char charAt (int where)

Return the char at the specified offset within the buffer.

Parameters

where

public void clear ()

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

public void clearSpans ()

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

public SpannableStringBuilder delete (int start, int end)

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

Parameters

start
end

public boolean equals (Object o)

Parameters

o

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.

Parameters

start
end
dest
destoff

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.

Parameters

what

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.

Parameters

what

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.

Parameters

what

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.

Parameters

queryStart
queryEnd
kind

public int hashCode ()

public SpannableStringBuilder insert (int where, CharSequence tb)

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

Parameters

where
tb

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

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

Parameters

where
tb
start
end

public int length ()

Return the number of chars in the buffer.

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.

Parameters

start
limit
kind

public void removeSpan (Object what)

Remove the specified markup object from the buffer.

Parameters

what

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.

Parameters

start
end
tb
tbstart
tbend

Returns

• a reference to this object.

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

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

Parameters

start
end
tb

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.

Parameters

filters

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.

Parameters

what
start
end
flags

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
end

public String toString ()

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

public static SpannableStringBuilder valueOf (CharSequence source)

Parameters

source