Android - An Open Handset Alliance Project

android.text
public interface

android.text.Editable

GetChars Spannable Appendable CharSequence

This is the interface for text whose content and markup can be changed (as opposed to immutable text like Strings). If you make a DynamicLayout of an Editable, the layout will be reflowed as the text is changed.

Known Indirect Subclasses

SpannableStringBuilder

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 Methods

				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 Methods

public Appendable append(CharSequence text)

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

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

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

public Appendable append(char text)

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

public void clear()

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

public void delete(int st, int en)

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

public InputFilter[] getFilters()

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

public int insert(int where, CharSequence text)

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

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

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

public int replace(int st, int en, CharSequence text)

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

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

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

Android - An Open Handset Alliance Project

Documentation

Goodies

android.text.Editable

Known Indirect Subclasses

Summary

Constants inherited from interface android.text.Spanned

Public Methods

Methods inherited from interface java.lang.Appendable

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 Methods

public Appendable append(CharSequence text)

See Also

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

See Also

public Appendable append(char text)

See Also

public void clear()

See Also

public void delete(int st, int en)

See Also

public InputFilter[] getFilters()

public int insert(int where, CharSequence text)

See Also

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

See Also

public int replace(int st, int en, CharSequence text)

See Also

public int replace(int st, int en, CharSequence source, int start, int end)

public void setFilters(InputFilter[] filters)

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


e.g. "intent" or "activity"