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

OudsAnnotatedErrorMessage

class OudsAnnotatedErrorMessage : OudsAnnotatedString<OudsAnnotatedErrorMessage>

An annotated string for error messages in OUDS components.

This class supports strong (bold/emphasized) text formatting to highlight critical information in error messages. It is used by components like com.orange.ouds.core.component.OudsTextInput, com.orange.ouds.core.component.OudsTextArea, com.orange.ouds.core.component.OudsPasswordInput, com.orange.ouds.core.component.OudsPinCodeInput, com.orange.ouds.core.component.OudsCheckboxItem, com.orange.ouds.core.component.OudsRadioButtonItem, and com.orange.ouds.core.component.OudsSwitchItem through the com.orange.ouds.core.component.common.OudsError class.

Use buildOudsAnnotatedErrorMessage to create instances:

val errorMessage = buildOudsAnnotatedErrorMessage {
    append("This field ")
    withStrong { append("cannot") }
    append(" be empty")
}

OudsTextInput(
    textFieldState = rememberTextFieldState(),
    label = "Email",
    error = OudsError(annotatedMessage = errorMessage)
)

Types

class Builder(capacity: Int = 16) : OudsAnnotatedString.Builder<OudsAnnotatedErrorMessage> , OudsAnnotatedString.StrongBuilder

Builder for creating OudsAnnotatedErrorMessage with strong text formatting.

Properties

open override val length: Int

val text: String

The plain text content without any formatting annotations.

Functions

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

Create capitalized OudsAnnotatedString.

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

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

Concatenates this annotated string with another annotated string.

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

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

Create lower case transformed OudsAnnotatedString.

open override fun toString(): String

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

Create upper case transformed OudsAnnotatedString.