Added in API level 1

SpannableString

open class SpannableString : CharSequence, GetChars, Spannable
kotlin.Any
   ↳ android.text.SpannableString

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

Public constructors

For the backward compatibility reasons, this constructor copies all spans including .
Public methods
open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
Char
get(i: Int)
Unit
getChars(start: Int, end: Int, dest: CharArray!, off: Int)
open Int
getSpanEnd(what: Any!)
open Int
getSpanFlags(what: Any!)
open Int
getSpanStart(what: Any!)
open Array<T>!
getSpans(queryStart: Int, queryEnd: Int, kind: Class<T>!)
open Int

open Int
nextSpanTransition(start: Int, limit: Int, kind: Class<Any!>!)
open Unit
removeSpan(what: Any!)
open Unit
setSpan(what: Any!, start: Int, end: Int, flags: Int)
CharSequence
subSequence(startIndex: Int, endIndex: Int)
String

open static SpannableString!

Properties
Int

Public constructors

SpannableString

Added in API level 1
SpannableString(source: CharSequence!)

For the backward compatibility reasons, this constructor copies all spans including .

Parameters
source CharSequence!: source text

Public methods

equals

open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

get

fun get(i: Int): Char

getChars

fun getChars(
    start: Int, 
    end: Int, 
    dest: CharArray!, 
    off: Int
): Unit

getSpanEnd

open fun getSpanEnd(what: Any!): Int

getSpanFlags

open fun getSpanFlags(what: Any!): Int

getSpanStart

open fun getSpanStart(what: Any!): Int

getSpans

open fun <T : Any!> getSpans(
    queryStart: Int, 
    queryEnd: Int, 
    kind: Class<T>!
): Array<T>!

hashCode

open fun hashCode(): Int

nextSpanTransition

open fun nextSpanTransition(
    start: Int, 
    limit: Int, 
    kind: Class<Any!>!
): Int

removeSpan

Added in API level 1
open fun removeSpan(what: Any!): Unit

setSpan

Added in API level 1
open fun setSpan(
    what: Any!, 
    start: Int, 
    end: Int, 
    flags: Int
): Unit

subSequence

Added in API level 1
fun subSequence(
    startIndex: Int, 
    endIndex: Int
): CharSequence
Parameters
start the start index, inclusive
end the end index, exclusive
Return
CharSequence the specified subsequence
Exceptions
java.lang.IndexOutOfBoundsException if start or end are negative, if end is greater than length(), or if start is greater than end

toString

fun toString(): String

valueOf

Added in API level 1
open static fun valueOf(source: CharSequence!): SpannableString!

Properties

length

val length: Int