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

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

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 The character to append
Returns
  • A reference to this Appendable

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

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

Parameters
text The character sequence from which a subsequence will be appended. If csq is null, then characters will be appended as if csq contained the four characters "null".
start The index of the first character in the subsequence
end The index of the character following the last character in the subsequence
Returns
  • A reference to this Appendable

public SpannableStringBuilder append (CharSequence text)

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

Parameters
text The character sequence to append. If csq is null, then the four characters "null" are appended to this Appendable.
Returns
  • A reference to this Appendable

public char charAt (int where)

Return the char at the specified offset within the buffer.

Parameters
where the index of the char value to be returned
Returns
  • the specified char value

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)

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.

Returns
  • the number of chars in this sequence

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 the start index, inclusive
end the end index, exclusive
Returns
  • the specified subsequence

public String toString ()

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

public static SpannableStringBuilder valueOf (CharSequence source)

Parameters
source