Stay organized with collections Save and categorize content based on your preferences.

SpannableStringBuilderKt

public final class SpannableStringBuilderKt


Summary

Public methods

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in a BackgroundColorSpan.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in a bold StyleSpan.

static final @NonNull SpannedString

Builds new string by populating a newly created SpannableStringBuilder using the provided builderAction and then converting it to SpannedString.

static final @NonNull SpannableStringBuilder
SpannableStringBuilderKt.color(
    @NonNull SpannableStringBuilder receiver,
    @ColorInt int color,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a ForegroundColorSpan.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in span.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in spans.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in an italic StyleSpan.

static final @NonNull SpannableStringBuilder
SpannableStringBuilderKt.scale(
    @NonNull SpannableStringBuilder receiver,
    float proportion,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a RelativeSizeSpan.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in a StrikethroughSpan.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in a SubscriptSpan.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in a SuperscriptSpan.

static final @NonNull SpannableStringBuilder

Wrap appended text in builderAction in an UnderlineSpan.

Public methods

SpannableStringBuilderKt.backgroundColor

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.backgroundColor(
    @NonNull SpannableStringBuilder receiver,
    @ColorInt int color,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a BackgroundColorSpan.

See also
inSpans

SpannableStringBuilderKt.bold

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.bold(
    @NonNull SpannableStringBuilder receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a bold StyleSpan.

See also
inSpans

buildSpannedString

public static final @NonNull SpannedString buildSpannedString(
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Builds new string by populating a newly created SpannableStringBuilder using the provided builderAction and then converting it to SpannedString.

SpannableStringBuilderKt.color

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.color(
    @NonNull SpannableStringBuilder receiver,
    @ColorInt int color,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a ForegroundColorSpan.

See also
inSpans

SpannableStringBuilderKt.inSpans

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.inSpans(
    @NonNull SpannableStringBuilder receiver,
    @NonNull Object span,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in span.

Note: the span will only have the correct position if the builderAction only appends or replaces text. Inserting, deleting, or clearing the text will cause the span to be placed at an incorrect position.

SpannableStringBuilderKt.inSpans

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.inSpans(
    @NonNull SpannableStringBuilder receiver,
    @NonNull Object spans,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in spans.

Note: the spans will only have the correct position if the builderAction only appends or replaces text. Inserting, deleting, or clearing the text will cause the span to be placed at an incorrect position.

SpannableStringBuilderKt.italic

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.italic(
    @NonNull SpannableStringBuilder receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in an italic StyleSpan.

See also
inSpans

SpannableStringBuilderKt.scale

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.scale(
    @NonNull SpannableStringBuilder receiver,
    float proportion,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a RelativeSizeSpan.

See also
inSpans

SpannableStringBuilderKt.strikeThrough

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.strikeThrough(
    @NonNull SpannableStringBuilder receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a StrikethroughSpan.

See also
inSpans

SpannableStringBuilderKt.subscript

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.subscript(
    @NonNull SpannableStringBuilder receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a SubscriptSpan.

See also
inSpans

SpannableStringBuilderKt.superscript

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.superscript(
    @NonNull SpannableStringBuilder receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in a SuperscriptSpan.

See also
inSpans

SpannableStringBuilderKt.underline

public static final @NonNull SpannableStringBuilder SpannableStringBuilderKt.underline(
    @NonNull SpannableStringBuilder receiver,
    @ExtensionFunctionType @NonNull Function1<@NonNull SpannableStringBuilderUnit> builderAction
)

Wrap appended text in builderAction in an UnderlineSpan.

See also
inSpans