Added in API level 1

AttributedString

open class AttributedString

kotlin.Any
↳	java.text.AttributedString

An AttributedString holds text and related attribute information. It may be used as the actual data storage in some cases where a text reader wants to access attributed text through the AttributedCharacterIterator interface.

An attribute is a key/value pair, identified by the key. No two attributes on a given character can have the same key.

The values for an attribute are immutable, or must not be mutated by clients or storage. They are always passed by reference, and not cloned.

Summary

Public constructors
`AttributedString(text: String!)` Constructs an AttributedString instance with the given text.
`AttributedString(text: String!, attributes: MutableMap<out AttributedCharacterIterator.Attribute!, *>!)` Constructs an AttributedString instance with the given text and attributes.
`AttributedString(text: AttributedCharacterIterator!)` Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator.
`AttributedString(text: AttributedCharacterIterator!, beginIndex: Int, endIndex: Int)` Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator.
`AttributedString(text: AttributedCharacterIterator!, beginIndex: Int, endIndex: Int, attributes: Array<AttributedCharacterIterator.Attribute!>!)` Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator.

Public methods
open Unit	`addAttribute(attribute: AttributedCharacterIterator.Attribute!, value: Any!)` Adds an attribute to the entire string.
open Unit	`addAttribute(attribute: AttributedCharacterIterator.Attribute!, value: Any!, beginIndex: Int, endIndex: Int)` Adds an attribute to a subrange of the string.
open Unit	`addAttributes(attributes: MutableMap<out AttributedCharacterIterator.Attribute!, *>!, beginIndex: Int, endIndex: Int)` Adds a set of attributes to a subrange of the string.
open AttributedCharacterIterator!	`getIterator()` Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.
open AttributedCharacterIterator!	`getIterator(attributes: Array<AttributedCharacterIterator.Attribute!>!)` Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.
open AttributedCharacterIterator!	`getIterator(attributes: Array<AttributedCharacterIterator.Attribute!>!, beginIndex: Int, endIndex: Int)` Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.

Public constructors

AttributedString

Added in API level 1

AttributedString(text: String!)

Constructs an AttributedString instance with the given text.

Parameters
`text`	String!: The text for this attributed string.

Exceptions
`java.lang.NullPointerException`	if `text` is null.

AttributedString

Added in API level 1

AttributedString(
    text: String!, 
    attributes: MutableMap<out AttributedCharacterIterator.Attribute!, *>!)

Constructs an AttributedString instance with the given text and attributes.

Parameters
`text`	String!: The text for this attributed string.
`attributes`	MutableMap<out AttributedCharacterIterator.Attribute!, *>!: The attributes that apply to the entire string.

Exceptions
`java.lang.NullPointerException`	if `text` or `attributes` is null.
`java.lang.IllegalArgumentException`	if the text has length 0 and the attributes parameter is not an empty Map (attributes cannot be applied to a 0-length range).

AttributedString

Added in API level 1

AttributedString(text: AttributedCharacterIterator!)

Constructs an AttributedString instance with the given attributed text represented by AttributedCharacterIterator.

Parameters
`text`	AttributedCharacterIterator!: The text for this attributed string.

Exceptions
`java.lang.NullPointerException`	if `text` is null.

AttributedString

Added in API level 1

AttributedString(
    text: AttributedCharacterIterator!, 
    beginIndex: Int, 
    endIndex: Int)

Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. If the given range produces an empty text, all attributes will be discarded. Note that any attributes wrapped by an Annotation object are discarded for a subrange of the original attribute range.

Parameters
`text`	AttributedCharacterIterator!: The text for this attributed string.
`beginIndex`	Int: Index of the first character of the range.
`endIndex`	Int: Index of the character following the last character of the range.

Exceptions
`java.lang.NullPointerException`	if `text` is null.
`java.lang.IllegalArgumentException`	if the subrange given by beginIndex and endIndex is out of the text range.

See Also

java.text.Annotation

AttributedString

Added in API level 1

AttributedString(
    text: AttributedCharacterIterator!, 
    beginIndex: Int, 
    endIndex: Int, 
    attributes: Array<AttributedCharacterIterator.Attribute!>!)

Constructs an AttributedString instance with the subrange of the given attributed text represented by AttributedCharacterIterator. Only attributes that match the given attributes will be incorporated into the instance. If the given range produces an empty text, all attributes will be discarded. Note that any attributes wrapped by an Annotation object are discarded for a subrange of the original attribute range.

Parameters
`text`	AttributedCharacterIterator!: The text for this attributed string.
`beginIndex`	Int: Index of the first character of the range.
`endIndex`	Int: Index of the character following the last character of the range.
`attributes`	Array<AttributedCharacterIterator.Attribute!>!: Specifies attributes to be extracted from the text. If null is specified, all available attributes will be used.

Exceptions
`java.lang.NullPointerException`	if `text` is null.
`java.lang.IllegalArgumentException`	if the subrange given by beginIndex and endIndex is out of the text range.

See Also

java.text.Annotation

Public methods

addAttribute

Added in API level 1

open fun addAttribute(
    attribute: AttributedCharacterIterator.Attribute!, 
    value: Any!
): Unit

Adds an attribute to the entire string.

Parameters
`attribute`	AttributedCharacterIterator.Attribute!: the attribute key
`value`	Any!: the value of the attribute; may be null

Exceptions
`java.lang.NullPointerException`	if `attribute` is null.
`java.lang.IllegalArgumentException`	if the AttributedString has length 0 (attributes cannot be applied to a 0-length range).

addAttribute

Added in API level 1

open fun addAttribute(
    attribute: AttributedCharacterIterator.Attribute!, 
    value: Any!, 
    beginIndex: Int, 
    endIndex: Int
): Unit

Adds an attribute to a subrange of the string.

Parameters
`attribute`	AttributedCharacterIterator.Attribute!: the attribute key
`value`	Any!: The value of the attribute. May be null.
`beginIndex`	Int: Index of the first character of the range.
`endIndex`	Int: Index of the character following the last character of the range.

Exceptions
`java.lang.NullPointerException`	if `attribute` is null.
`java.lang.IllegalArgumentException`	if beginIndex is less than 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string.

addAttributes

Added in API level 1

open fun addAttributes(
    attributes: MutableMap<out AttributedCharacterIterator.Attribute!, *>!, 
    beginIndex: Int, 
    endIndex: Int
): Unit

Adds a set of attributes to a subrange of the string.

Parameters
`attributes`	MutableMap<out AttributedCharacterIterator.Attribute!, *>!: The attributes to be added to the string.
`beginIndex`	Int: Index of the first character of the range.
`endIndex`	Int: Index of the character following the last character of the range.

Exceptions
`java.lang.NullPointerException`	if `attributes` is null.
`java.lang.IllegalArgumentException`	if beginIndex is less than 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string and the attributes parameter is not an empty Map.

getIterator

Added in API level 1

open fun getIterator(): AttributedCharacterIterator!

Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.

Return
`AttributedCharacterIterator!`	An iterator providing access to the text and its attributes.

getIterator

Added in API level 1

open fun getIterator(attributes: Array<AttributedCharacterIterator.Attribute!>!): AttributedCharacterIterator!

Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. Information about attributes not listed in attributes that the implementor may have need not be made accessible through the iterator. If the list is null, all available attribute information should be made accessible.

Parameters
`attributes`	Array<AttributedCharacterIterator.Attribute!>!: a list of attributes that the client is interested in

Return
`AttributedCharacterIterator!`	an iterator providing access to the entire text and its selected attributes

getIterator

Added in API level 1

open fun getIterator(
    attributes: Array<AttributedCharacterIterator.Attribute!>!, 
    beginIndex: Int, 
    endIndex: Int
): AttributedCharacterIterator!

Parameters
`attributes`	Array<AttributedCharacterIterator.Attribute!>!: a list of attributes that the client is interested in
`beginIndex`	Int: the index of the first character
`endIndex`	Int: the index of the character following the last character

Return
`AttributedCharacterIterator!`	an iterator providing access to the text and its attributes

Exceptions
`java.lang.IllegalArgumentException`	if beginIndex is less than 0, endIndex is greater than the length of the string, or beginIndex is greater than endIndex.