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

OudsAnnotatedBodyText

class OudsAnnotatedBodyText : OudsAnnotatedString<OudsAnnotatedBodyText>

An annotated string for com.orange.ouds.core.component.OudsBodyText text in OUDS components.

This class supports both colored text, strong (bold/emphasized) text and clickable links to create rich, interactive body texts.

Use buildOudsAnnotatedBodyText to create instances:

val highlightColor = OudsTheme.colorScheme.content.brandPrimary
OudsBodyText(
    text = buildOudsAnnotatedBodyText {
        withStrong {
            withColor(color = highlightColor) { append("Important update") }
        }
        append(", see details ")
        withLink(link = OudsLinkAnnotation.Url("https://example.com/details")) { append("here") }
        append(".")
    }
)

Types

class Builder(capacity: Int = 16) : OudsAnnotatedString.Builder<OudsAnnotatedBodyText> , OudsAnnotatedString.StrongBuilder, OudsAnnotatedString.LinkBuilder, OudsAnnotatedString.ColorBuilder

Properties

open override val length: Int

val text: String

The plain text content without any formatting annotations.

Functions

fun capitalize(localeList: LocaleList = LocaleList.current): OudsAnnotatedBodyText

Create capitalized OudsAnnotatedString.

fun decapitalize(localeList: LocaleList = LocaleList.current): OudsAnnotatedBodyText

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: OudsAnnotatedBodyText): OudsAnnotatedBodyText

Concatenates this annotated string with another annotated string.

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

fun toLowerCase(localeList: LocaleList = LocaleList.current): OudsAnnotatedBodyText

Create lower case transformed OudsAnnotatedString.

open override fun toString(): String

fun toUpperCase(localeList: LocaleList = LocaleList.current): OudsAnnotatedBodyText

Create upper case transformed OudsAnnotatedString.