core/com.orange.ouds.core.component.common.text/OudsAnnotatedString/LinkBuilder

LinkBuilder

interface LinkBuilder : OudsAnnotatedString.BaseBuilder

Interface for builders that support clickable link annotations.

Implementations can add links either by specifying ranges with addLink, or by using the push/pop pattern with pushLink and pop. For most use cases, prefer using the withLink DSL helper.

Inheritors

Builder

Functions

addLink

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

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

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

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

pop

abstract fun pop()

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

abstract 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

abstract fun pushLink(link: OudsLinkAnnotation): Int

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

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.