SpannedString

Kotlin |Java

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

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 constructors
`SpannedString(source: CharSequence!)` For the backward compatibility reasons, this constructor copies all spans including `android.text.NoCopySpan`.

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	`hashCode()` Returns a hash code value for the object.
Int	`nextSpanTransition(start: Int, limit: Int, kind: Class<Any!>!)`
CharSequence	`subSequence(startIndex: Int, endIndex: Int)` Returns a `CharSequence` that is a subsequence of this sequence.
String	`toString()` Returns a string representation of the object.
static SpannedString!	`valueOf(source: CharSequence!)`

Properties
Int	`length`

Public constructors

SpannedString

Added in API level 1

SpannedString(source: CharSequence!)

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

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

Parameters
`srcBegin`	start copying at this offset.
`srcEnd`	stop copying at this offset.
`dst`	the array to copy the data into.
`dstBegin`	offset into `dst`.

Exceptions
`java.lang.IndexOutOfBoundsException`	if any of the following is true: `srcBegin` is negative `dstBegin` is negative the `srcBegin` argument is greater than the `srcEnd` argument. `srcEnd` is greater than `this.length()`. `dstBegin+srcEnd-srcBegin` is greater than `dst.length`
`java.lang.NullPointerException`	if `dst` is `null`

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

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

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

Returns a CharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

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

Returns a string representation of the object.

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 `char`s in this sequence

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

SpannedString

Summary

Public constructors

SpannedString

Public methods

equals

get

getChars

getSpanEnd

getSpanFlags

getSpanStart

getSpans

hashCode

nextSpanTransition

subSequence

toString

valueOf

Properties

length

More Android

Discover

Android Devices

Releases

Documentation and Downloads

Support