Android - An Open Handset Alliance Project

android.text
public class

android.text.SpannableStringBuilder

java.lang.Object
	android.text.SpannableStringBuilder	Editable GetChars Spannable Appendable CharSequence

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

Summary

Constants inherited from interface android.text.Spanned

SPAN_EXCLUSIVE_EXCLUSIVE, SPAN_EXCLUSIVE_INCLUSIVE, SPAN_INCLUSIVE_EXCLUSIVE, SPAN_INCLUSIVE_INCLUSIVE, SPAN_MARK_MARK, SPAN_MARK_POINT, SPAN_PARAGRAPH, SPAN_POINT_MARK, SPAN_POINT_POINT, SPAN_USER, SPAN_USER_SHIFT

			Value
int	SPAN_EXCLUSIVE_EXCLUSIVE	Spans of type SPAN_EXCLUSIVE_EXCLUSIVE do not expand to include text inserted at either their starting or ending point.	33	0x00000021
int	SPAN_EXCLUSIVE_INCLUSIVE	Non-0-length spans of type SPAN_INCLUSIVE_EXCLUSIVE expand to include text inserted at their ending point but not at their starting point.	34	0x00000022
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.	17	0x00000011
int	SPAN_INCLUSIVE_INCLUSIVE	Spans of type SPAN_INCLUSIVE_INCLUSIVE expand to include text inserted at either their starting or ending point.	18	0x00000012
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.	17	0x00000011
int	SPAN_MARK_POINT	SPAN_MARK_POINT is a synonym for SPAN_INCLUSIVE_INCLUSIVE.	18	0x00000012
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).	51	0x00000033
int	SPAN_POINT_MARK	SPAN_POINT_MARK is a synonym for SPAN_EXCLUSIVE_EXCLUSIVE.	33	0x00000021
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.	34	0x00000022
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.	-16777216	0xff000000
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.	24	0x00000018

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

	Editable	append(char text)
		Convenience for append(String.valueOf(text)).
	Editable	append(CharSequence text)
		Convenience for replace(length(), length(), text, 0, text.length())
	Editable	append(CharSequence text, int start, int end)
		Convenience for replace(length(), length(), text, start, end)
	char	charAt(int where)
		Return the char at the specified offset within the buffer.
	void	clear()
		Convenience for replace(0, length(), "", 0, 0)
	void	delete(int start, int end)
		Convenience for replace(st, en, "", 0, 0)
	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[]	getSpans(int queryStart, int queryEnd, Class kind)
		Return an array of the spans of the specified type that overlap the specified range of the buffer.
	int	insert(int where, CharSequence tb, int start, int end)
		Convenience for replace(where, where, text, start, end)
	int	insert(int where, CharSequence tb)
		Convenience for replace(where, where, text, 0, text.length());
	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.
	int	replace(int start, int end, CharSequence tb)
		Convenience for replace(st, en, text, 0, text.length())
	int	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`.
	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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface java.lang.Appendable

append, append, append

Methods inherited from interface android.text.Editable

append, append, append, clear, delete, getFilters, insert, insert, replace, replace, setFilters

				Appendable	append(CharSequence text)
					Convenience for replace(length(), length(), text, 0, text.length())
				Appendable	append(CharSequence text, int start, int end)
					Convenience for replace(length(), length(), text, start, end)
				Appendable	append(char text)
					Convenience for append(String.valueOf(text)).
				void	clear()
					Convenience for replace(0, length(), "", 0, 0)
				void	delete(int st, int en)
					Convenience for replace(st, en, "", 0, 0)
				InputFilter[]	getFilters()
					Returns the array of input filters that are currently applied to changes to this Editable.
				int	insert(int where, CharSequence text)
					Convenience for replace(where, where, text, 0, text.length());
				int	insert(int where, CharSequence text, int start, int end)
					Convenience for replace(where, where, text, start, end)
				int	replace(int st, int en, CharSequence text)
					Convenience for replace(st, en, text, 0, text.length())
				int	replace(int st, int en, CharSequence source, int start, int end)
					Replaces the specified range (`st…en`) of text in this Editable with a copy of the slice `start…end` from `source`.
				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.

Details

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.

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.

Public Methods

public Editable append(char text)

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

public Editable append(CharSequence text)

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

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

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

public char charAt(int where)

Return the char at the specified offset within the buffer.

public void clear()

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

public void delete(int start, int end)

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

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.

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.

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.

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.

public T[] getSpans(int queryStart, int queryEnd, Class 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.

public int insert(int where, CharSequence tb, int start, int end)

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

public int insert(int where, CharSequence tb)

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

public int length()

Return the number of chars in the buffer.

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.

public void removeSpan(Object what)

Remove the specified markup object from the buffer.

public int replace(int start, int end, CharSequence tb)

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

public int 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.

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.

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.

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.

public String toString()

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

				Appendable	append(CharSequence csq)
					Append the given `CharSequence`.
				Appendable	append(CharSequence csq, int start, int end)
					Append part of the given `CharSequence`.
				Appendable	append(char c)
					Append the given character.

				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.
				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.
				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.
				T[]	getSpans(int start, int end, Class 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.
				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`.

				void	getChars(int start, int end, char[] dest, int destoff)
					Exactly like String.getChars(): copy chars `start` through `end - 1` from this CharSequence into `dest` beginning at offset `destoff`.

				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.

				char	charAt(int index)
					Answers the character at the specified index (0-based indexing).
				int	length()
					Answers the number of characters in the sequence.
				CharSequence	subSequence(int start, int end)
					Answers a CharSequence from the `start` index to the `end` index of this sequence.
				String	toString()
					Answers a String with the same characters and ordering of this CharSequence


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.text.SpannableStringBuilder

Summary

Constants inherited from interface android.text.Spanned

Public Constructors

Public Methods

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Appendable

Methods inherited from interface android.text.Editable

Methods inherited from interface android.text.GetChars

Methods inherited from interface android.text.Spanned

Methods inherited from interface android.text.Spannable

Methods inherited from interface java.lang.CharSequence

Details

Public Constructors

public SpannableStringBuilder()

public SpannableStringBuilder(CharSequence text)

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

Public Methods

public Editable append(char text)

public Editable append(CharSequence text)

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

public char charAt(int where)

public void clear()

public void delete(int start, int end)

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

public InputFilter[] getFilters()

public int getSpanEnd(Object what)

public int getSpanFlags(Object what)

public int getSpanStart(Object what)

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

public int insert(int where, CharSequence tb, int start, int end)

public int insert(int where, CharSequence tb)

public int length()

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

public void removeSpan(Object what)

public int replace(int start, int end, CharSequence tb)

public int replace(int start, int end, CharSequence tb, int tbstart, int tbend)

public void setFilters(InputFilter[] filters)

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

public CharSequence subSequence(int start, int end)

public String toString()

public static SpannableStringBuilder valueOf(CharSequence source)