Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

SpannableString

extends Object
implements GetChars Spannable CharSequence

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

int	SPAN_COMPOSING	This flag is set on spans that are being used to apply temporary styling information on the composing text of an input method, so that they can be found and removed when the composing text is being replaced.
int	SPAN_EXCLUSIVE_EXCLUSIVE	Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point.
int	SPAN_EXCLUSIVE_INCLUSIVE	Non-0-length spans of type SPAN_EXCLUSIVE_INCLUSIVE expand to include text inserted at their ending point but not at their starting point.
int	SPAN_INCLUSIVE_EXCLUSIVE	Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their starting point but not at their ending point.
int	SPAN_INCLUSIVE_INCLUSIVE	Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.
int	SPAN_INTERMEDIATE	This flag will be set for intermediate span changes, meaning there is guaranteed to be another change following it.
int	SPAN_MARK_MARK	0-length spans with type SPAN_MARK_MARK behave like text marks: they remain at their original offset when text is inserted at that offset.
int	SPAN_MARK_POINT	SPAN_MARK_POINT is a synonym for `SPAN_INCLUSIVE_INCLUSIVE` .
int	SPAN_PARAGRAPH	SPAN_PARAGRAPH behaves like SPAN_INCLUSIVE_EXCLUSIVE (SPAN_MARK_MARK), except that if either end of the span is at the end of the buffer, that end behaves like _POINT instead (so SPAN_INCLUSIVE_INCLUSIVE if it starts in the middle and ends at the end, or SPAN_EXCLUSIVE_INCLUSIVE if it both starts and ends at the end).
int	SPAN_POINT_MARK	SPAN_POINT_MARK is a synonym for `SPAN_EXCLUSIVE_EXCLUSIVE` .
int	SPAN_POINT_MARK_MASK	Bitmask of bits that are relevent for controlling point/mark behavior of spans.
int	SPAN_POINT_POINT	0-length spans with type SPAN_POINT_POINT behave like cursors: they are pushed forward by the length of the insertion when text is inserted at their offset.
int	SPAN_PRIORITY	The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first.
int	SPAN_PRIORITY_SHIFT	The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first.
int	SPAN_USER	The bits specified by the SPAN_USER bitfield are available for callers to use to store scalar data associated with their span object.
int	SPAN_USER_SHIFT	The bits numbered SPAN_USER_SHIFT and above are available for callers to use to store scalar data associated with their span object.

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 or equal to `start` where a markup object of class `type` begins or ends, or `limit` if there are no starts or ends greater than or equal to `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

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.text.GetChars

From interface android.text.Spannable

From interface android.text.Spanned

abstract int	getSpanEnd ( Object tag) Return the end of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
abstract int	getSpanFlags ( Object tag) 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.
abstract int	getSpanStart ( Object tag) Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
abstract <T> T[]	)">getSpans (int start, int end, Class <T> type) 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.
abstract int	nextSpanTransition (int start, int limit, Class type) Return the first offset greater than or equal to `start` where a markup object of class `type` begins or ends, or `limit` if there are no starts or ends greater than or equal to `start` but less than `limit` .

From interface java.lang.CharSequence

abstract char	charAt (int index) Returns the character at `index` .
abstract int	length () Returns the number of characters in this sequence.
abstract CharSequence	subSequence (int start, int end) Returns a `CharSequence` from the `start` index (inclusive) to the `end` index (exclusive) of this sequence.
abstract String	toString () Returns a string with the same characters in the same order as in this sequence.

Public Constructors

public SpannableString ( CharSequence source)

Added in API level 1

Public Methods

public final char charAt (int i)

Added in API level 1

Returns the character at index .

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	the object to compare this instance with.

Returns

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 .

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.

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.

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.

)">

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.

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

this object's hash code.

public final int length ()

Added in API level 1

Returns the number of characters in this sequence.

Returns

the number of characters.

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

Added in API level 1

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

public void removeSpan ( Object what)

Added in API level 1

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

Added in API level 1

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

a printable representation of this object.

public static SpannableString valueOf ( CharSequence source)

Added in API level 1

Results

Interfaces

Classes

Enums

SpannableString

Class Overview

Summary

Public Constructors

public SpannableString ( CharSequence source)

Public Methods

public final char charAt (int i)

public boolean equals ( Object o)

Parameters

Returns

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

public int getSpanEnd ( Object what)

public int getSpanFlags ( Object what)

public int getSpanStart ( Object what)

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

public int hashCode ()

Returns

public final int length ()

Returns

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

public void removeSpan ( Object what)

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

public final CharSequence subSequence (int start, int end)

Parameters

Returns

public final String toString ()

Returns

public static SpannableString valueOf ( CharSequence source)