Skip to content

Most visited

Recently visited

navigation

SpannableStringBuilder

public class SpannableStringBuilder
extends Object implements CharSequence, GetChars, Spannable, Editable, Appendable, CharSequence

java.lang.Object
   ↳ android.text.SpannableStringBuilder


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

Summary

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, Object what, int flags)

Appends the character sequence text and spans what over the appended part.

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)

Indicates whether some other object is "equal to" this one.

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 getTextRunCursor(int contextStart, int contextEnd, int dir, int offset, int cursorOpt, Paint p)

This method was deprecated in API level 12. This is an internal method, refrain from using it in your code

int getTextWatcherDepth()

Returns the depth of TextWatcher callbacks.

int hashCode()

Returns a hash code value for the object.

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 methods

From class java.lang.Object
From interface java.lang.CharSequence
From interface android.text.GetChars
From interface android.text.Spannable
From interface android.text.Editable
From interface java.lang.Appendable
From interface android.text.Spanned

Public constructors

SpannableStringBuilder

Added in API level 1
SpannableStringBuilder ()

Create a new SpannableStringBuilder with empty contents

SpannableStringBuilder

Added in API level 1
SpannableStringBuilder (CharSequence text)

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

Parameters
text CharSequence

SpannableStringBuilder

Added in API level 1
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 CharSequence
start int
end int

Public methods

append

Added in API level 1
SpannableStringBuilder append (char text)

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

Parameters
text char: The character to append
Returns
SpannableStringBuilder A reference to this Appendable

append

Added in API level 21
SpannableStringBuilder append (CharSequence text, 
                Object what, 
                int flags)

Appends the character sequence text and spans what over the appended part. See Spanned for an explanation of what the flags mean.

Parameters
text CharSequence: the character sequence to append.
what Object: the object to be spanned over the appended text.
flags int: see Spanned.
Returns
SpannableStringBuilder this SpannableStringBuilder.

append

Added in API level 1
SpannableStringBuilder append (CharSequence text, 
                int start, 
                int end)

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

Parameters
text CharSequence: 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 int: The index of the first character in the subsequence
end int: The index of the character following the last character in the subsequence
Returns
SpannableStringBuilder A reference to this Appendable

append

Added in API level 1
SpannableStringBuilder append (CharSequence text)

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

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

charAt

Added in API level 1
char charAt (int where)

Return the char at the specified offset within the buffer.

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

clear

Added in API level 1
void clear ()

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

clearSpans

Added in API level 1
void clearSpans ()

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

delete

Added in API level 1
SpannableStringBuilder delete (int start, 
                int end)

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

Parameters
start int
end int
Returns
SpannableStringBuilder

equals

Added in API level 1
boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

getChars

Added in API level 1
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 int
end int
dest char
destoff int

getFilters

Added in API level 1
InputFilter[] getFilters ()

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

Returns
InputFilter[]

getSpanEnd

Added in API level 1
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 Object
Returns
int

getSpanFlags

Added in API level 1
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 Object
Returns
int

getSpanStart

Added in API level 1
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 Object
Returns
int

getSpans

Added in API level 1
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 int
queryEnd int
kind Class
Returns
T[]

getTextRunCursor

Added in API level 11
int getTextRunCursor (int contextStart, 
                int contextEnd, 
                int dir, 
                int offset, 
                int cursorOpt, 
                Paint p)

This method was deprecated in API level 12.
This is an internal method, refrain from using it in your code

Returns the next cursor position in the run. This avoids placing the cursor between surrogates, between characters that form conjuncts, between base characters and combining marks, or within a reordering cluster.

The context is the shaping context for cursor movement, generally the bounds of the metric span enclosing the cursor in the direction of movement. contextStart, contextEnd and offset are relative to the start of the string.

If cursorOpt is CURSOR_AT and the offset is not a valid cursor position, this returns -1. Otherwise this will never return a value before contextStart or after contextEnd.

Parameters
contextStart int: the start index of the context
contextEnd int: the (non-inclusive) end index of the context
dir int: either DIRECTION_RTL or DIRECTION_LTR
offset int: the cursor position to move from
cursorOpt int: how to move the cursor, one of CURSOR_AFTER, CURSOR_AT_OR_AFTER, CURSOR_BEFORE, CURSOR_AT_OR_BEFORE, or CURSOR_AT
p Paint: the Paint object that is requesting this information
Returns
int the offset of the next position, or -1

getTextWatcherDepth

Added in API level 23
int getTextWatcherDepth ()

Returns the depth of TextWatcher callbacks. Returns 0 when the object is not handling TextWatchers. A return value greater than 1 implies that a TextWatcher caused a change that recursively triggered a TextWatcher.

Returns
int

hashCode

Added in API level 1
int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

insert

Added in API level 1
SpannableStringBuilder insert (int where, 
                CharSequence tb)

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

Parameters
where int
tb CharSequence
Returns
SpannableStringBuilder

insert

Added in API level 1
SpannableStringBuilder insert (int where, 
                CharSequence tb, 
                int start, 
                int end)

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

Parameters
where int
tb CharSequence
start int
end int
Returns
SpannableStringBuilder

length

Added in API level 1
int length ()

Return the number of chars in the buffer.

Returns
int the number of chars in this sequence

nextSpanTransition

Added in API level 1
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 int
limit int
kind Class
Returns
int

removeSpan

Added in API level 1
void removeSpan (Object what)

Remove the specified markup object from the buffer.

Parameters
what Object

replace

Added in API level 1
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. If the source contains a span with SPAN_PARAGRAPH flag, and it does not satisfy the paragraph boundary constraint, it is not retained. As a special case, the cursor position is preserved even when the entire range where it is located is replaced.

Parameters
start int
end int
tb CharSequence
tbstart int
tbend int
Returns
SpannableStringBuilder a reference to this object.

replace

Added in API level 1
SpannableStringBuilder replace (int start, 
                int end, 
                CharSequence tb)

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

Parameters
start int
end int
tb CharSequence
Returns
SpannableStringBuilder

setFilters

Added in API level 1
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 InputFilter

setSpan

Added in API level 1
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 Object
start int
end int
flags int

subSequence

Added in API level 1
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 int: the start index, inclusive
end int: the end index, exclusive
Returns
CharSequence the specified subsequence

toString

Added in API level 1
String toString ()

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

Returns
String a string representation of the object.

valueOf

Added in API level 1
SpannableStringBuilder valueOf (CharSequence source)

Parameters
source CharSequence
Returns
SpannableStringBuilder
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.