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

OudsAnnotatedHeadingText

class OudsAnnotatedHeadingText : OudsAnnotatedString<OudsAnnotatedHeadingText>

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

This class supports colored text formatting to highlight one or more important words in a heading.

Use buildOudsAnnotatedHeadingText to create instances:

OudsHeadingText(
    text = buildOudsAnnotatedHeadingText {
        append("This is ")
        withColor(OudsTheme.colorScheme.content.brandSecondary) {
            append("brand secondary text")
        }
)

Types

Builder

class Builder(capacity: Int = 16) : OudsAnnotatedString.Builder<OudsAnnotatedHeadingText> , OudsAnnotatedString.ColorBuilder

Properties

length

open override val length: Int

text

val text: String

The plain text content without any formatting annotations.

Functions

capitalize

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

Create capitalized OudsAnnotatedString.

decapitalize

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

Create decapitalized OudsAnnotatedString.

equals

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

get

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

hashCode

open override fun hashCode(): Int

plus

operator fun plus(other: OudsAnnotatedHeadingText): OudsAnnotatedHeadingText

Concatenates this annotated string with another annotated string.

subSequence

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

toLowerCase

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

Create lower case transformed OudsAnnotatedString.

toString

open override fun toString(): String

toUpperCase

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

Create upper case transformed OudsAnnotatedString.