core/com.orange.ouds.core.component.common.text/OudsAnnotatedString

OudsAnnotatedString

open class OudsAnnotatedString<T : OudsAnnotatedString<T>> : CharSequence

Base class for annotated strings with rich text formatting support in OUDS components.

This class wraps Compose's AnnotatedString to provide type-safe rich text formatting with support for strong (bold/emphasized) text and clickable links. It serves as the foundation for specialized annotated string types used throughout OUDS components.

This class implements CharSequence, making it compatible with standard string operations.

Inheritors

OudsAnnotatedAlertMessageBulletListLabel

OudsAnnotatedAlertMessageDescription

OudsAnnotatedBulletListLabel

OudsAnnotatedErrorMessage

OudsAnnotatedHelperText

Types

interface BaseBuilder

Base interface for all annotated string builders, providing stack management for annotations.

open class Builder<T : OudsAnnotatedString<T>> : Appendable

Builder class for annotated string. Enables construction of an OudsAnnotatedString using methods such as append.

interface LinkBuilder : OudsAnnotatedString.BaseBuilder

Interface for builders that support clickable link annotations.

interface StrongBuilder : OudsAnnotatedString.BaseBuilder

Interface for builders that support strong (bold/emphasized) text annotations.

Properties

open override val length: Int

val text: String

The plain text content without any formatting annotations.

Functions

fun capitalize(localeList: LocaleList = LocaleList.current): OudsAnnotatedString<T>

Create capitalized OudsAnnotatedString.

fun decapitalize(localeList: LocaleList = LocaleList.current): OudsAnnotatedString<T>

Create decapitalized OudsAnnotatedString.

open operator override fun equals(other: Any?): Boolean

open operator override fun get(index: Int): Char

open override fun hashCode(): Int

operator fun plus(other: OudsAnnotatedString<T>): OudsAnnotatedString<T>

Concatenates this annotated string with another annotated string.

open override fun subSequence(startIndex: Int, endIndex: Int): CharSequence

fun toLowerCase(localeList: LocaleList = LocaleList.current): OudsAnnotatedString<T>

Create lower case transformed OudsAnnotatedString.

open override fun toString(): String

fun toUpperCase(localeList: LocaleList = LocaleList.current): OudsAnnotatedString<T>

Create upper case transformed OudsAnnotatedString.