RubySpan
public final class RubySpan extends ReplacementSpan
| java.lang.Object | ||||
| ↳ | android.text.style.CharacterStyle | |||
| ↳ | android.text.style.MetricAffectingSpan | |||
| ↳ | android.text.style.ReplacementSpan | |||
| ↳ | androidx.text.vertical.RubySpan | |||
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
Constants |
|
|---|---|
static final float |
DEFAULT_TEXT_SCALE = 0.5f |
Public fields |
|
|---|---|
static final @NonNull TextOrientation |
|
static final @NonNull AnnotationPosition |
Public constructors |
|---|
RubySpan( |
Public methods |
|
|---|---|
void |
|
final @NonNull TextOrientation |
The text orientation of the ruby text. |
final @NonNull AnnotationPosition |
The position of ruby text relative to the base text. |
int |
getSize( |
final @NonNull CharSequence |
getText()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. |
Inherited methods |
||||
|---|---|---|---|---|
|
||||
|
Constants
Public fields
Public constructors
RubySpan
public RubySpan(
@NonNull CharSequence text,
@NonNull AnnotationPosition position,
@NonNull TextOrientation orientation,
float textScale
)
Public methods
draw
public void draw(
@NonNull Canvas canvas,
CharSequence text,
int start,
int end,
float x,
int top,
int y,
int bottom,
@NonNull Paint paint
)
getOrientation
public final @NonNull TextOrientation getOrientation()
The text orientation of the ruby text. Defaults to TextOrientation.Mixed.
getPosition
public final @NonNull AnnotationPosition getPosition()
The position of ruby text relative to the base text. Defaults to AnnotationPosition.Before.
getSize
public int getSize(
@NonNull Paint paint,
CharSequence text,
int start,
int end,
Paint.FontMetricsInt fm
)
getText
public final @NonNull CharSequence getText()
The ruby text to be displayed adjacent to the base text.
getTextScale
public final float getTextScale()
The text scale ratio of the ruby text relative to the base text. Defaults to 0.5f.