LinkAnnotation.Clickable

Kotlin |Java

Cmn

class LinkAnnotation.Clickable : LinkAnnotation

kotlin.Any
↳	androidx.compose.ui.text.LinkAnnotation
	↳	androidx.compose.ui.text.LinkAnnotation.Clickable

An annotation that contains a clickable marked with tag. When clicking on the text to which this annotation is attached, the app will trigger a linkInteractionListener listener.

Summary

Public constructors
`Clickable( tag: String, style: SpanStyle?, focusedStyle: SpanStyle?, hoveredStyle: SpanStyle?, pressedStyle: SpanStyle?, linkInteractionListener: LinkInteractionListener? )`	Cmn

Public functions
`open operator Boolean`	`equals(other: Any?)`	Cmn
`open Int`	`hashCode()`	Cmn
`open String`	`toString()`	Cmn
`open LinkAnnotation.Clickable`	`withDefaultsFrom( defaultStyle: SpanStyle?, defaultFocusedStyle: SpanStyle?, defaultHoveredStyle: SpanStyle?, defaultPressedStyle: SpanStyle? )` Returns a new `LinkAnnotation` which styles are a combination of its original styles and the given default styles.	Cmn

Public properties
`open SpanStyle?`	`focusedStyle` Style configuration for this link applied on top of the `style` when the link is focused.	Cmn
`open SpanStyle?`	`hoveredStyle` Style configuration for this link applied on top of the `style` when the link is hovered.	Cmn
`open LinkInteractionListener?`	`linkInteractionListener` Interaction listener triggered when user interacts with this link.	Cmn
`open SpanStyle?`	`pressedStyle` Style configuration for this link applied on top of the `style` when the link is pressed.	Cmn
`open SpanStyle?`	`style` Style configuration for this link that is always applied	Cmn
`String`	`tag`	Cmn

Public constructors

Clickable

Cmn

Added in 1.7.0-beta01

Clickable(
    tag: String,
    style: SpanStyle? = null,
    focusedStyle: SpanStyle? = null,
    hoveredStyle: SpanStyle? = null,
    pressedStyle: SpanStyle? = null,
    linkInteractionListener: LinkInteractionListener?
)

Public functions

equals

Cmn

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

hashCode

Cmn

open fun hashCode(): Int

toString

Cmn

open fun toString(): String

withDefaultsFrom

Cmn

Added in 1.7.0-beta01

open fun withDefaultsFrom(
    defaultStyle: SpanStyle?,
    defaultFocusedStyle: SpanStyle?,
    defaultHoveredStyle: SpanStyle?,
    defaultPressedStyle: SpanStyle?
): LinkAnnotation.Clickable

Returns a new LinkAnnotation which styles are a combination of its original styles and the given default styles.

This link's style's null or inherit properties are replaced with the non-null properties of the corresponding default style. Another way to think of it is that the "missing" properties of the style are filled by the properties of the corresponding default style.

Public properties

focusedStyle

Cmn

Added in 1.7.0-beta01

open val focusedStyle: SpanStyle?

Style configuration for this link applied on top of the style when the link is focused.

The resulting style of the link is always a combination of all styles merged into one in the order style.merge(focusedStyle).merge(hoveredStyle).merge(pressedStyle)

hoveredStyle

Cmn

Added in 1.7.0-beta01

open val hoveredStyle: SpanStyle?

Style configuration for this link applied on top of the style when the link is hovered.

The resulting style of the link is always a combination of all styles merged into one in the order style.merge(focusedStyle).merge(hoveredStyle).merge(pressedStyle)

linkInteractionListener

Cmn

Added in 1.7.0-beta01

open val linkInteractionListener: LinkInteractionListener?

Interaction listener triggered when user interacts with this link.

pressedStyle

Cmn

Added in 1.7.0-beta01

open val pressedStyle: SpanStyle?

Style configuration for this link applied on top of the style when the link is pressed.

The resulting style of the link is always a combination of all styles merged into one in the order style.merge(focusedStyle).merge(hoveredStyle).merge(pressedStyle)

style

Cmn

Added in 1.7.0-beta01

open val style: SpanStyle?

Style configuration for this link that is always applied

tag

Cmn

Added in 1.7.0-beta01

val tag: String