RubySpan

class RubySpan : ReplacementSpan

A span used to specify ruby text for a portion of the text.

The text covered by this span is known as the "base text", and the ruby text is stored in text.

Ruby text cannot be nested (i.e., ruby text cannot contain further ruby text). Ruby spans also cannot overlap each other.

More information on ruby characters and span styling.

This span is designed for use with VerticalTextLayout, media3-ui library, and a bit more general use cases.

Summary

const val DEFAULT_TEXT_SCALE = 0.5f: Float

val DEFAULT_ORIENTATION: TextOrientation

val DEFAULT_POSITION: AnnotationPosition

RubySpan(
    text: CharSequence,
    position: AnnotationPosition = DEFAULT_POSITION,
    orientation: TextOrientation = DEFAULT_ORIENTATION,
    textScale: Float = DEFAULT_TEXT_SCALE
)

open fun draw(
    canvas: Canvas,
    text: CharSequence?,
    start: Int,
    end: Int,
    x: Float,
    top: Int,
    y: Int,
    bottom: Int,
    paint: Paint
): Unit

open fun getSize(
    paint: Paint,
    text: CharSequence?,
    start: Int,
    end: Int,
    fm: Paint.FontMetricsInt?
): Int

val orientation: TextOrientation

val position: AnnotationPosition

val text: CharSequence

val textScale: Float