to top
Android APIs
public interface

Editable

implements GetChars Spannable Appendable CharSequence
android.text.Editable
Known Indirect Subclasses

Class Overview

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.

Summary

Nested Classes
class Editable.Factory Factory used by TextView to create new Editables. 
[Expand]
Inherited Constants
From interface android.text.Spanned
Public Methods
abstract Editable append(CharSequence text)
Convenience for replace(length(), length(), text, 0, text.length())
abstract Editable append(CharSequence text, int start, int end)
Convenience for replace(length(), length(), text, start, end)
abstract Editable append(char text)
Convenience for append(String.valueOf(text)).
abstract void clear()
Convenience for replace(0, length(), "", 0, 0)
abstract void clearSpans()
Removes all spans from the Editable, as if by calling removeSpan(Object) on each of them.
abstract Editable delete(int st, int en)
Convenience for replace(st, en, "", 0, 0)
abstract InputFilter[] getFilters()
Returns the array of input filters that are currently applied to changes to this Editable.
abstract Editable insert(int where, CharSequence text, int start, int end)
Convenience for replace(where, where, text, start, end)
abstract Editable insert(int where, CharSequence text)
Convenience for replace(where, where, text, 0, text.length());
abstract Editable 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.
abstract Editable replace(int st, int en, CharSequence text)
Convenience for replace(st, en, text, 0, text.length())
abstract 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.
[Expand]
Inherited Methods
From interface android.text.GetChars
From interface android.text.Spannable
From interface android.text.Spanned
From interface java.lang.Appendable
From interface java.lang.CharSequence

Public Methods

public abstract Editable append (CharSequence text)

Added in API level 1

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

Parameters
text the character sequence to append.
Returns
  • this Appendable.

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

Added in API level 1

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

Parameters
text the character sequence to append.
start the first index of the subsequence of csq that is appended.
end the last index of the subsequence of csq that is appended.
Returns
  • this Appendable.

public abstract Editable append (char text)

Added in API level 1

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

Parameters
text the character to append.
Returns
  • this Appendable.

public abstract void clear ()

Added in API level 1

public abstract void clearSpans ()

Added in API level 1

Removes all spans from the Editable, as if by calling removeSpan(Object) on each of them.

public abstract Editable delete (int st, int en)

Added in API level 1

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

public abstract InputFilter[] getFilters ()

Added in API level 1

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

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

Added in API level 1

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

public abstract Editable insert (int where, CharSequence text)

Added in API level 1

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

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

Added in API level 1

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.

Returns
  • a reference to this object.

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

Added in API level 1

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

public abstract void setFilters (InputFilter[] filters)

Added in API level 1

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.