SpannableString


public class SpannableString
extends Object implements CharSequence, GetChars, Spannable

java.lang.Object
   ↳ android.text.SpannableString


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

Inherited constants

Public constructors

SpannableString(CharSequence source)

For the backward compatibility reasons, this constructor copies all spans including NoCopySpan.

Public methods

final char charAt(int i)

Returns the char value at the specified index.

boolean equals(Object o)

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

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 Spannable#setSpan 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 a hash code value for the object.

final int length()

Returns the length of this character sequence.

int nextSpanTransition(int start, int limit, Class<T> 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)

Remove the specified object from the range of text to which it was attached, if any.

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.

final CharSequence subSequence(int start, int end)

Returns a CharSequence that is a subsequence of this sequence.

final String toString()

Returns a string representation of the object.

static SpannableString valueOf(CharSequence source)

Inherited methods

Public constructors

SpannableString

Added in API level 1
public SpannableString (CharSequence source)

For the backward compatibility reasons, this constructor copies all spans including NoCopySpan.

Parameters
source CharSequence: source text

Public methods

charAt

Added in API level 1
public final char charAt (int i)

Returns the char value at the specified index. An index ranges from zero to length() - 1. The first char value of the sequence is at index zero, the next at index one, and so on, as for array indexing.

If the char value specified by the index is a surrogate, the surrogate value is returned.

Parameters
i int: the index of the char value to be returned

Returns
char the specified char value

equals

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

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getChars

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

Parameters
start int

end int

dest char

off int

getSpanEnd

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

Parameters
what Object

Returns
int

getSpanFlags

Added in API level 1
public int getSpanFlags (Object what)

Return the flags that were specified when Spannable#setSpan was used to attach the specified markup object, or 0 if the specified object has not been attached.

Parameters
what Object

Returns
int

getSpanStart

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

Parameters
what Object

Returns
int

getSpans

Added in API level 1
public 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. Specify Object.class for the type if you want all the objects regardless of type.

Parameters
queryStart int

queryEnd int

kind Class

Returns
T[]

hashCode

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

Returns
int a hash code value for this object.

length

Added in API level 1
public final int length ()

Returns the length of this character sequence. The length is the number of 16-bit chars in the sequence.

Returns
int the number of chars in this sequence

nextSpanTransition

Added in API level 1
public int nextSpanTransition (int start, 
                int limit, 
                Class<T> 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. 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

removeSpan

Added in API level 1
public void removeSpan (Object what)

Remove the specified object from the range of text to which it was attached, if any. It is OK to remove an object that was never attached in the first place.

Parameters
what Object

setSpan

Added in API level 1
public 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. See Spanned for an explanation of what the flags mean. The object can be one that has meaning only within your application, or it can be one that the text system will use to affect text display or behavior. Some noteworthy ones are the subclasses of CharacterStyle and ParagraphStyle, and TextWatcher and SpanWatcher.

Parameters
what Object

start int

end int

flags int

subSequence

Added in API level 1
public final CharSequence subSequence (int start, 
                int end)

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Parameters
start int: the start index, inclusive

end int: the end index, exclusive

Returns
CharSequence the specified subsequence

toString

Added in API level 1
public final String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

valueOf

Added in API level 1
public static SpannableString valueOf (CharSequence source)

Parameters
source CharSequence

Returns
SpannableString