Stay organized with collections
Save and categorize content based on your preferences.
public final class RubySpan
A span used to specify ruby text for a portion of the text.
Ruby text cannot be nested (i.e., ruby text cannot contain further ruby text). Ruby spans also cannot overlap each other.
This span is designed for use with VerticalTextLayout.
Summary
Nested types |
|
Builder class for creating RubySpan instances.
|
Public methods |
final int |
The text orientation of the ruby text.
|
final @NonNull CharSequence |
The ruby text to be displayed adjacent to the base text.
|
final float |
The text scale ratio of the ruby text relative to the base text.
|
Public methods
public final float getTextScale()
The text scale ratio of the ruby text relative to the base text. Defaults to 0.5f.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-27 UTC."],[],[],null,["RubySpan \nArtifact: [androidx.text:text-vertical](/jetpack/androidx/releases/text) \n[View Source](https://cs.android.com/search?q=file:androidx/text/vertical/Ruby.kt+class:androidx.text.vertical.RubySpan) \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01)\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/androidx/text/vertical/RubySpan \"View this page in Kotlin\") \\|Java\n\n\n```\npublic final class RubySpan\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nA span used to specify ruby text for a portion of the text.\n\nRuby text cannot be nested (i.e., ruby text cannot contain further ruby text). Ruby spans also cannot overlap each other.\n\nThis span is designed for use with [VerticalTextLayout](/reference/androidx/text/vertical/VerticalTextLayout).\n\nSummary \n\n| Nested types |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `public final class `[RubySpan.Builder](/reference/androidx/text/vertical/RubySpan.Builder) Builder class for creating [RubySpan](/reference/androidx/text/vertical/RubySpan) instances. |\n\n| Public methods |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `final int` | [getOrientation](/reference/androidx/text/vertical/RubySpan#getOrientation())`()` The text orientation of the ruby text. |\n| `final @`[NonNull](/reference/androidx/annotation/NonNull)` `[CharSequence](https://developer.android.com/reference/java/lang/CharSequence.html) | [getText](/reference/androidx/text/vertical/RubySpan#getText())`()` The ruby text to be displayed adjacent to the base text. |\n| `final float` | [getTextScale](/reference/androidx/text/vertical/RubySpan#getTextScale())`()` The text scale ratio of the ruby text relative to the base text. |\n\nPublic methods \n\ngetOrientation \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\npublic final int getOrientation()\n```\n\nThe text orientation of the ruby text. Defaults to [TextOrientation.MIXED](/reference/androidx/text/vertical/TextOrientation#MIXED()). \n\ngetText \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\npublic final @NonNull CharSequence getText()\n```\n\nThe ruby text to be displayed adjacent to the base text. \n\ngetTextScale \nAdded in [1.0.0-alpha01](/jetpack/androidx/releases/text#1.0.0-alpha01) \n\n```\npublic final float getTextScale()\n```\n\nThe text scale ratio of the ruby text relative to the base text. Defaults to 0.5f."]]
