core/com.orange.ouds.core.component.common.text/OudsAnnotatedBulletListLabel/Builder

Builder

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

Builder for creating OudsAnnotatedBulletListLabel with strong text and link formatting.

Supports both strong text and link annotations through addStrong, pushStrong, addLink, and pushLink methods, or more conveniently through the withStrong and withLink DSL helpers.

Parameters

capacity

Initial capacity for the underlying string builder. Defaults to 16.

Constructors

Builder

constructor(capacity: Int = 16)

constructor(text: String)

Creates a builder initialized with plain text.

constructor(text: OudsAnnotatedHelperText)

Creates a builder initialized with an existing annotated helper text.

Functions

addLink

open override fun addLink(clickable: OudsLinkAnnotation.Clickable, start: Int, end: Int)

Set a OudsLinkAnnotation.Clickable for the given range defined by start and end.

open override fun addLink(url: OudsLinkAnnotation.Url, start: Int, end: Int)

Set a OudsLinkAnnotation.Url for the given range defined by start and end.

addStrong

open override fun addStrong(start: Int, end: Int)

Adds strong (bold/emphasized) formatting to a specific range of text.

append

fun append(text: OudsAnnotatedBulletListLabel)

Appends an annotated string to this builder, preserving its formatting.

open override fun append(char: Char): OudsAnnotatedString.Builder<OudsAnnotatedBulletListLabel>

fun append(text: String)

Appends the given String to this Builder.

open override fun append(text: CharSequence?): OudsAnnotatedString.Builder<OudsAnnotatedBulletListLabel>

Appends text to this Builder if non-null, and returns this Builder.

fun append(text: OudsAnnotatedBulletListLabel, start: Int, end: Int)

Appends a portion of an annotated string to this builder, preserving its formatting.

open override fun append(text: CharSequence?, start: Int, end: Int): OudsAnnotatedString.Builder<OudsAnnotatedBulletListLabel>

Appends the range of text between start (inclusive) and end (exclusive) to this Builder if non-null, and returns this Builder.

pop

fun pop()

Ends the style or annotation that was added via a push operation before.

fun pop(index: Int)

Ends the styles or annotation up to and including the StrongBuilder.pushStrong or LinkBuilder.pushLink that returned the given index.

pushLink

open override fun pushLink(link: OudsLinkAnnotation): Int

Attach the given OudsLinkAnnotation to any appended text until a corresponding pop is called.

pushStrong

open override fun pushStrong(): Int

Applies strong (bold/emphasized) style to any appended text until a corresponding pop is called.

toAnnotatedString

open fun toAnnotatedString(): OudsAnnotatedBulletListLabel

Constructs an OudsAnnotatedString based on the configurations applied to the Builder.

withLink

inline fun <R : Any> OudsAnnotatedString.LinkBuilder.withLink(link: OudsLinkAnnotation, block: OudsAnnotatedString.LinkBuilder.() -> R): R

DSL helper for applying link formatting to a block of text.

withStrong

inline fun <R : Any> OudsAnnotatedString.StrongBuilder.withStrong(block: OudsAnnotatedString.StrongBuilder.() -> R): R

DSL helper for applying strong (bold/emphasized) formatting to a block of text.