Android APIs
public class

SpannableString

extends Object
implements CharSequence GetChars Spannable
java.lang.Object
   ↳ android.text.SpannableString

Class Overview

This is the class for text whose content is immutable but to which markup objects can be attached and detached. For mutable text, see SpannableStringBuilder.

Summary

[Expand]
Inherited Constants
From interface android.text.Spanned
Public Constructors
SpannableString(CharSequence source)
Public Methods
final char charAt(int i)
Returns the character at index.
boolean equals(Object o)
Compares this instance with the specified object and indicates if they are equal.
final void getChars(int start, int end, char[] dest, int off)
Exactly like String.getChars(): copy chars start through end - 1 from this CharSequence into dest beginning at offset destoff.
int getSpanEnd(Object what)
Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
int getSpanFlags(Object what)
Return the flags that were specified when setSpan(Object, int, int, int) was used to attach the specified markup object, or 0 if the specified object has not been attached.
int getSpanStart(Object what)
Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
<T> T[] getSpans(int queryStart, int queryEnd, Class<T> kind)
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.
int hashCode()
Returns an integer hash code for this object.
final int length()
Returns the number of characters in this sequence.
int nextSpanTransition(int start, int limit, Class kind)
Return the first offset greater than start where a markup object of class type begins or ends, or limit if there are no starts or ends greater than start but less than limit.
void removeSpan(Object what)
void setSpan(Object what, int start, int end, int flags)
final CharSequence subSequence(int start, int end)
Returns a CharSequence from the start index (inclusive) to the end index (exclusive) of this sequence.
final String toString()
Returns a string containing a concise, human-readable description of this object.
static SpannableString valueOf(CharSequence source)
[Expand]
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.Spanned

Public Constructors

public SpannableString (CharSequence source)

Added in API level 1

Parameters
source CharSequence

Public Methods

public final char charAt (int i)

Added in API level 1

Returns the character at index.

Parameters
i int
Returns
char

public boolean equals (Object o)

Added in API level 1

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
o Object: the object to compare this instance with.
Returns
boolean true if the specified object is equal to this Object; false otherwise.

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

Added in API level 1

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

Parameters
start int
end int
dest char
off int

public int getSpanEnd (Object what)

Added in API level 1

Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached.

Parameters
what Object
Returns
int

public int getSpanFlags (Object what)

Added in API level 1

Return the flags that were specified when setSpan(Object, int, int, int) was used to attach the specified markup object, or 0 if the specified object has not been attached.

Parameters
what Object
Returns
int

public int getSpanStart (Object what)

Added in API level 1

Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.

Parameters
what Object
Returns
int

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

Added in API level 1

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. Specify Object.class for the type if you want all the objects regardless of type.

Parameters
queryStart int
queryEnd int
kind Class
Returns
T[]

public int hashCode ()

Added in API level 1

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
int this object's hash code.

public final int length ()

Added in API level 1

Returns the number of characters in this sequence.

Returns
int the number of characters.

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

Added in API level 1

Return the first offset greater than start where a markup object of class type begins or ends, or limit if there are no starts or ends greater than start but less than limit. Specify null or Object.class for the type if you want every transition regardless of type.

Parameters
start int
limit int
kind Class
Returns
int

public void removeSpan (Object what)

Added in API level 1

Parameters
what Object

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

Added in API level 1

Parameters
what Object
start int
end int
flags int

public final CharSequence subSequence (int start, int end)

Added in API level 1

Returns a CharSequence from the start index (inclusive) to the end index (exclusive) of this sequence.

Parameters
start int: 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 int: 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
CharSequence the requested sub-sequence.

public final String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
String a printable representation of this object.

public static SpannableString valueOf (CharSequence source)

Added in API level 1

Parameters
source CharSequence
Returns
SpannableString