EmphasisSpan

Kotlin |Java

class EmphasisSpan : ReplacementSpan

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	android.text.style.MetricAffectingSpan
		↳	android.text.style.ReplacementSpan
			↳	androidx.text.vertical.EmphasisSpan

A span that applies emphasis marks to text in a vertical layout.

This span is designed for use with VerticalTextLayout and will not have an effect in other contexts. It allows for the application of various emphasis styles, such as dots, circles, or triangles, above or next to characters in vertical text.

The EmphasisSpan takes a style, a boolean indicating whether the mark should be filled, and a scale factor for the size of the mark.

Summary

Constants
`const Boolean`	`DEFAULT_EMPHASIS_FILL = true` The default value for whether the emphasis mark should be filled.
`const Float`	`DEFAULT_SCALE = 0.5f` The default scale factor for emphasis marks.

Public companion properties
`EmphasisStyle`	`DEFAULT_EMPHASIS_STYLE` The default style used for emphasis marks, typically a dot.
`AnnotationPosition`	`DEFAULT_POSITION` The default position of the emphasis mark relative to the text.

Public constructors
`EmphasisSpan( style: EmphasisStyle, isFilled: Boolean, position: AnnotationPosition, scale: Float )`

Public functions
`open Unit`	`draw( canvas: Canvas, text: CharSequence?, start: Int, end: Int, x: Float, top: Int, y: Int, bottom: Int, paint: Paint )`
`open Int`	`getSize( paint: Paint, text: CharSequence?, start: Int, end: Int, fm: Paint.FontMetricsInt? )`

Public properties
`Boolean`	`isFilled` Whether the mark should be filled or outlined.
`AnnotationPosition`	`position` The position of the emphasis mark relative to the text.
`Float`	`scale` The scale factor for the size of the mark.
`EmphasisStyle`	`style` The style of the emphasis mark.

Inherited functions

From android.text.style.ReplacementSpan

`Unit`	`updateDrawState(ds: TextPaint)`
`Unit`	`updateMeasureState(p: TextPaint)`

Inherited properties

From android.text.style.MetricAffectingSpan

open MetricAffectingSpan

underlying

From android.text.style.ReplacementSpan

open CharSequence?

contentDescription

Constants

DEFAULT_EMPHASIS_FILL

const val DEFAULT_EMPHASIS_FILL = true: Boolean

The default value for whether the emphasis mark should be filled.

DEFAULT_SCALE

const val DEFAULT_SCALE = 0.5f: Float

The default scale factor for emphasis marks.

Public companion properties

DEFAULT_EMPHASIS_STYLE

val DEFAULT_EMPHASIS_STYLE: EmphasisStyle

The default style used for emphasis marks, typically a dot.

DEFAULT_POSITION

val DEFAULT_POSITION: AnnotationPosition

The default position of the emphasis mark relative to the text.

Public constructors

EmphasisSpan

Added in 1.0.0-beta02

EmphasisSpan(
    style: EmphasisStyle = DEFAULT_EMPHASIS_STYLE,
    isFilled: Boolean = DEFAULT_EMPHASIS_FILL,
    position: AnnotationPosition = AnnotationPosition.Before,
    scale: Float = DEFAULT_SCALE
)

Parameters
`style: EmphasisStyle = DEFAULT_EMPHASIS_STYLE`	The style of the emphasis mark.
`isFilled: Boolean = DEFAULT_EMPHASIS_FILL`	Whether the mark should be filled or outlined. When `true`, the emphasis mark will be drawn as a solid shape. When `false`, it will be drawn as an outline.
`position: AnnotationPosition = AnnotationPosition.Before`	The position of the emphasis mark relative to the text. `AnnotationPosition.Before` puts the mark on the right side in vertical writing mode and above the text in horizontal writing mode. `AnnotationPosition.After` puts it on the opposite side.
`scale: Float = DEFAULT_SCALE`	The scale factor for the size of the mark. This value determines the size of the emphasis mark relative to the font size. A scale of 0.5f means the emphasis mark will be half the size of the text.

Public functions

draw

Added in 1.0.0-beta02

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

getSize

Added in 1.0.0-beta02

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

Public properties

isFilled

Added in 1.0.0-beta02

val isFilled: Boolean

Whether the mark should be filled or outlined. When true, the emphasis mark will be drawn as a solid shape. When false, it will be drawn as an outline.

position

Added in 1.0.0-beta02

val position: AnnotationPosition

The position of the emphasis mark relative to the text. AnnotationPosition.Before puts the mark on the right side in vertical writing mode and above the text in horizontal writing mode. AnnotationPosition.After puts it on the opposite side.

scale

Added in 1.0.0-beta02

val scale: Float

The scale factor for the size of the mark. This value determines the size of the emphasis mark relative to the font size. A scale of 0.5f means the emphasis mark will be half the size of the text.

style

Added in 1.0.0-beta02

val style: EmphasisStyle

The style of the emphasis mark.