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

Builder

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

Constructors

Builder

constructor(capacity: Int = 16)

constructor(text: String)

Creates a builder initialized with plain text.

constructor(text: OudsAnnotatedBodyText)

Creates a builder initialized with an existing annotated body text.

constructor(text: AnnotatedString)

Creates a builder initialized with an existing annotated text.

Functions

addColor

open override fun addColor(color: Color, start: Int, end: Int)

Adds a color to a specific range of text.

addLink

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

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

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

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

addStrikethrough

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

Adds strikethrough formatting to a specific range of text.

addStrong

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

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

append

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

fun append(text: String)

Appends the given String to this Builder.

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

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

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

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.

pushColor

open override fun pushColor(color: Color): Int

Applies a color to any appended text until a corresponding pop is called.

pushLink

open override fun pushLink(link: OudsLinkAnnotation): Int

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

pushStrikethrough

open override fun pushStrikethrough(): Int

Applies strikethrough style 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(): OudsAnnotatedBodyText

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

withColor

inline fun <R : Any> OudsAnnotatedString.ColorBuilder.withColor(color: Color, block: OudsAnnotatedString.ColorBuilder.() -> R): R

DSL helper for applying color to a block of text.

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.

withStrikethrough

inline fun <R : Any> OudsAnnotatedString.StrikethroughBuilder.withStrikethrough(block: OudsAnnotatedString.StrikethroughBuilder.() -> R): R

DSL helper for applying strikethrough 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.