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
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
From interface android.text.Editable
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 ()

Since: API Level 1

Create a new SpannableStringBuilder with empty contents

public SpannableStringBuilder (CharSequence text)

Since: API Level 1

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

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

Since: API Level 1

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)

Since: API Level 1

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

Parameters
text the character to append.
Returns
  • this Appendable.

public SpannableStringBuilder append (CharSequence text)

Since: API Level 1

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)

Since: API Level 1

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)

Since: API Level 1

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 ()

Since: API Level 1

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

public void clearSpans ()

Since: API Level 1

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

public SpannableStringBuilder delete (int start, int end)

Since: API Level 1

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

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

Since: API Level

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

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

Since: API Level 1

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

public InputFilter[] getFilters ()

Since: API Level 1

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

public int getSpanEnd (Object what)

Since: API Level 1

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)

Since: API Level 1

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)

Since: API Level 1

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)

Since: API Level 1

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)

Since: API Level

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

public SpannableStringBuilder insert (int where, CharSequence tb)

Since: API Level 1

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

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

Since: API Level 1

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

public int length ()

Since: API Level 1

Return the number of chars in the buffer.

Returns
  • the number of characters.

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

Since: API Level

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

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

Since: API Level 1

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)

Since: API Level 1

Remove the specified markup object from the buffer.

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

Since: API Level 1

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

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

Since: API Level 1

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)

Since: API Level 1

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)

Since: API Level 1

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)

Since: API Level 1

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 ()

Since: API Level 1

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

Returns
  • a printable representation of this object.

public static SpannableStringBuilder valueOf (CharSequence source)

Since: API Level 1