Added in API level 1

SpannedString


class SpannedString : CharSequence, GetChars, Spanned
kotlin.Any
   ↳ android.text.SpannedString

This is the class for text whose content and markup are immutable. For mutable markup, see SpannableString; for mutable text, see SpannableStringBuilder.

Summary

Inherited constants
Public constructors

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

Public methods
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)

Int
getSpanEnd(what: Any!)

Int
getSpanFlags(what: Any!)

Int
getSpanStart(what: Any!)

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

Int

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

CharSequence
subSequence(startIndex: Int, endIndex: Int)

String

static SpannedString!

Properties
Int

Public constructors

SpannedString

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

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

Parameters
source CharSequence!: source text

Public methods

equals

Added in API level 1
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.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

Added in API level 1
fun get(i: Int): Char
Parameters
index the index of the char value to be returned
Return
Char the specified char value
Exceptions
java.lang.IndexOutOfBoundsException if the index argument is negative or not less than length()

getChars

Added in API level 1
fun getChars(
    start: Int,
    end: Int,
    dest: CharArray!,
    off: Int
): Unit

getSpanEnd

Added in API level 1
fun getSpanEnd(what: Any!): Int

getSpanFlags

Added in API level 1
fun getSpanFlags(what: Any!): Int

getSpanStart

Added in API level 1
fun getSpanStart(what: Any!): Int

getSpans

Added in API level 1
fun <T : Any!> getSpans(
    queryStart: Int,
    queryEnd: Int,
    kind: Class<T>!
): Array<T>!

hashCode

Added in API level 1
fun hashCode(): Int
Return
Int a hash code value for this object.

nextSpanTransition

Added in API level 1
fun nextSpanTransition(
    start: Int,
    limit: Int,
    kind: Class<Any!>!
): Int

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

Added in API level 1
fun toString(): String
Return
String a string consisting of exactly this sequence of characters

valueOf

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

Properties

length

Added in API level 1
val length: Int
Return
Int the number of chars in this sequence