OffsetMapping

Kotlin |Java

interface OffsetMapping

androidx.compose.ui.text.input.OffsetMapping

Provides bidirectional offset mapping between original and transformed text.

Summary

Public methods
abstract Int	originalToTransformed(offset: Int) Convert offset in original text into the offset in transformed text.
abstract Int	transformedToOriginal(offset: Int) Convert offset in transformed text into the offset in original text.

Companion properties
OffsetMapping	Identity The offset map used for identity mapping.

Public methods

originalToTransformed

abstract fun originalToTransformed(offset: Int): Int

Convert offset in original text into the offset in transformed text.

This function must be a monotonically non-decreasing function. In other words, if a cursor advances in the original text, the cursor in the transformed text must advance or stay there.

Parameters
offset: Int	offset in original text.

Return
offset in transformed text

See Also

• VisualTransformation

transformedToOriginal

abstract fun transformedToOriginal(offset: Int): Int

Convert offset in transformed text into the offset in original text.

This function must be a monotonically non-decreasing function. In other words, if a cursor advances in the transformed text, the cusrsor in the original text must advance or stay there.

Parameters
offset: Int	offset in transformed text

Return
offset in original text

See Also

• VisualTransformation

Companion properties

Identity

val Identity: OffsetMapping

The offset map used for identity mapping.