RubySpan.Builder

Kotlin |Java

class RubySpan.Builder

Builder class for creating RubySpan instances.

Summary

Public constructors
`Builder(text: CharSequence)`

Public functions
`RubySpan`	`build()` Builds and returns a new `RubySpan` instance.
`RubySpan.Builder`	`setOrientation(orientation: Int)` Sets the text orientation for the ruby text.
`RubySpan.Builder`	`setTextScale(textScale: Float)` Sets the text scale for the ruby text.

Builder(text: CharSequence)

Parameters
`text: CharSequence`	The ruby text to be displayed adjacent to the base text.

fun build(): RubySpan

Builds and returns a new RubySpan instance.

Returns
`RubySpan`	A new `RubySpan` instance.

fun setOrientation(orientation: Int): RubySpan.Builder

Sets the text orientation for the ruby text.

By default, TextOrientation.MIXED is used.

Parameters
`orientation: Int`	The text orientation to set.

Returns
`RubySpan.Builder`	This `Builder` instance for method chaining.

fun setTextScale(textScale: Float): RubySpan.Builder

Sets the text scale for the ruby text.

By default, 0.5f is used, meaning the ruby text will be half the size of the base text.

Parameters
`textScale: Float`	The text scale to set.

Returns
`RubySpan.Builder`	This `Builder` instance for method chaining.