Editable

Kotlin |Java

interface Editable : CharSequence, GetChars, Spannable, Appendable

android.text.Editable

Known Direct Subclasses

SpannableStringBuilder

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

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
open	`Factory` Factory used by TextView to create new `Editables`.

Inherited constants

From class 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. They can never have a length of 0 and are automatically removed from the buffer if all the text they cover is removed.
`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. When 0-length, they behave like points.
`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. When 0-length, they behave like marks.
`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. Typically it is used for `Selection` which automatically uses this with the first offset it sets when updating the selection.
`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. Conceptually, the text is added after the mark.
`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). Its endpoints must be the start or end of the buffer or immediately after a \n character, and if the \n that anchors it is deleted, the endpoint is pulled to the next \n that follows in the buffer (or to the end of the buffer). If a span with SPAN_PARAGRAPH flag is pasted into another text and the paragraph boundary constraint is not satisfied, the span is discarded.
`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. MARK and POINT are conceptually located between two adjacent characters. A MARK is "attached" to the character before, while a POINT will stick to the character after. The insertion cursor is conceptually located between the MARK and the POINT. As a result, inserting a new character between a MARK and a POINT will leave the MARK unchanged, while the POINT will be shifted, now located after the inserted character and still glued to the same character after it. Depending on whether the insertion happens at the beginning or the end of a span, the span will hence be expanded to include the new character (when the span is using a MARK at its beginning or a POINT at its end) or it will be excluded. Note that before and after here refer to offsets in the String, which are independent from the visual representation of the text (left-to-right or right-to-left).
`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. The text is conceptually inserted before the point.
`Int`	`SPAN_PRIORITY` The bits specified by the SPAN_PRIORITY bitmap determine the order of change notifications -- higher numbers go first. You probably don't need to set this; it is used so that when text changes, the text layout gets the chance to update itself before any other callbacks can inquire about the layout of the text.
`Int`	`SPAN_PRIORITY_SHIFT` The bits numbered just above SPAN_PRIORITY_SHIFT determine the order of change notifications -- higher numbers go first. You probably don't need to set this; it is used so that when text changes, the text layout gets the chance to update itself before any other callbacks can inquire about the layout of the text.
`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 methods
abstract Editable	`append(text: CharSequence?)` Convenience for replace(length(), length(), text, 0, text.
abstract Editable	`append(text: CharSequence?, start: Int, end: Int)` Convenience for replace(length(), length(), text, start, end)
abstract Editable	`append(text: Char)` Convenience for append(String.valueOf(text)).
abstract Unit	`clear()` Convenience for replace(0, length(), "", 0, 0).
abstract Unit	`clearSpans()` Removes all spans from the Editable, as if by calling `removeSpan` on each of them.
abstract Editable!	`delete(st: Int, en: Int)` Convenience for replace(st, en, "", 0, 0)
abstract Array<InputFilter!>!	`getFilters()` Returns the array of input filters that are currently applied to changes to this Editable.
abstract Editable!	`insert(where: Int, text: CharSequence!, start: Int, end: Int)` Convenience for replace(where, where, text, start, end)
abstract Editable!	`insert(where: Int, text: CharSequence!)` Convenience for replace(where, where, text, 0, text.length());
abstract Editable!	`replace(st: Int, en: Int, source: CharSequence!, start: Int, end: Int)` Replaces the specified range (`st…en`) of text in this Editable with a copy of the slice `start…end` from `source`.
abstract Editable!	`replace(st: Int, en: Int, text: CharSequence!)` Convenience for replace(st, en, text, 0, text.length())
abstract Unit	`setFilters(filters: Array<InputFilter!>!)` 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.

Inherited functions

From class GetChars

Unit

getChars(start: Int, end: Int, dest: CharArray!, destoff: Int)

Exactly like String.getChars(): copy chars start through end - 1 from this CharSequence into dest beginning at offset destoff.

From class Spanned

`Int`	`getSpanEnd(tag: Any!)` 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(tag: Any!)` 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(tag: Any!)` Return the beginning of the range of text to which the specified markup object is attached, or -1 if the object is not attached.
`Array<T>!`	`getSpans(start: Int, end: Int, type: Class<T>!)` 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.
`Int`	`nextSpanTransition(start: Int, limit: Int, type: Class<Any!>!)` 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.

From class Spannable

Unit

removeSpan(what: Any!)

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.

Unit

setSpan(what: Any!, start: Int, end: Int, flags: Int)

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 android.text.style.CharacterStyle and android.text.style.ParagraphStyle, and android.text.TextWatcher and android.text.SpanWatcher.

Public methods

append

Added in API level 1

abstract fun append(text: CharSequence?): Editable

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

Parameters
`csq`	The character sequence to append. If `csq` is `null`, then the four characters `"null"` are appended to this Appendable.

Return
`Editable`	A reference to this `Appendable`

Exceptions
`java.io.IOException`	If an I/O error occurs

See Also

#replace(int, int, CharSequence, int, int)

append

Added in API level 1

abstract fun append(
    text: CharSequence?, 
    start: Int, 
    end: Int
): Editable

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

Parameters
`csq`	The character sequence from which a subsequence will be appended. If `csq` is `null`, then characters will be appended as if `csq` contained the four characters `"null"`.
`start`	Int: The index of the first character in the subsequence
`end`	Int: The index of the character following the last character in the subsequence

Return
`Editable`	A reference to this `Appendable`

Exceptions
`java.lang.IndexOutOfBoundsException`	If `start` or `end` are negative, `start` is greater than `end`, or `end` is greater than `csq.length()`
`java.io.IOException`	If an I/O error occurs

See Also

#replace(int, int, CharSequence, int, int)

append

Added in API level 1

abstract fun append(text: Char): Editable

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

Parameters
`c`	The character to append

Return
`Editable`	A reference to this `Appendable`

Exceptions
`java.io.IOException`	If an I/O error occurs

See Also

#replace(int, int, CharSequence, int, int)

clear

Added in API level 1

abstract fun clear(): Unit

Convenience for replace(0, length(), "", 0, 0). Note that this clears the text, not the spans; use clearSpans if you need that.

See Also

#replace(int, int, CharSequence, int, int)

clearSpans

Added in API level 1

abstract fun clearSpans(): Unit

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

delete

Added in API level 1

abstract fun delete(
    st: Int, 
    en: Int
): Editable!

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

See Also

#replace(int, int, CharSequence, int, int)

getFilters

Added in API level 1

abstract fun getFilters(): Array<InputFilter!>!

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

insert

Added in API level 1

abstract fun insert(
    where: Int, 
    text: CharSequence!, 
    start: Int, 
    end: Int
): Editable!

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

See Also

#replace(int, int, CharSequence, int, int)

insert

Added in API level 1

abstract fun insert(
    where: Int, 
    text: CharSequence!
): Editable!

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

See Also

#replace(int, int, CharSequence, int, int)

replace

Added in API level 1

abstract fun replace(
    st: Int, 
    en: Int, 
    source: CharSequence!, 
    start: Int, 
    end: Int
): Editable!

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 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. If the source contains a span with Spanned#SPAN_PARAGRAPH flag, and it does not satisfy the paragraph boundary constraint, it is not retained. As a special case, the cursor position is preserved even when the entire range where it is located is replaced.

Return
`Editable!`	a reference to this object.

See Also

android.text.Spanned#SPAN_PARAGRAPH

replace

Added in API level 1

abstract fun replace(
    st: Int, 
    en: Int, 
    text: CharSequence!
): Editable!

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

See Also

#replace(int, int, CharSequence, int, int)

setFilters

Added in API level 1

abstract fun setFilters(filters: Array<InputFilter!>!): Unit

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.