Placeholder

A placeholder is a rectangle box inserted into text, which tells the text processor to leave an empty space. It is typically used to insert inline image, custom emoji, etc into the text paragraph.

Throws
kotlin.IllegalArgumentException

if TextUnit.Unspecified is passed to width or height.

Summary

Public constructors
Placeholder(
    width: TextUnit,
    height: TextUnit,
    placeholderVerticalAlign: PlaceholderVerticalAlign
)
Cmn

Public functions
Placeholder
copy(
    width: TextUnit,
    height: TextUnit,
    placeholderVerticalAlign: PlaceholderVerticalAlign
)
Cmn
open operator Boolean
equals(other: Any?)
Cmn
open Int
Cmn
open String
Cmn

Public properties
TextUnit

the height of the placeholder, it must be specified in sp or em.
Cmn
PlaceholderVerticalAlign

the vertical alignment of the placeholder within the text line.
Cmn
TextUnit

the width of the placeholder, it must be specified in sp or em.
Cmn

Public constructors

Placeholder

Cmn 
Placeholder(
    width: TextUnit,
    height: TextUnit,
    placeholderVerticalAlign: PlaceholderVerticalAlign
)
Parameters
width: TextUnit

the width of the placeholder, it must be specified in sp or em. TextUnit.Unspecified is not allowed.
height: TextUnit

the height of the placeholder, it must be specified in sp or em. TextUnit.Unspecified is not allowed.
placeholderVerticalAlign: PlaceholderVerticalAlign

the vertical alignment of the placeholder within the text line. Check PlaceholderVerticalAlign for more information.

Public functions

copy

Cmn 
fun copy(
    width: TextUnit = this.width,
    height: TextUnit = this.height,
    placeholderVerticalAlign: PlaceholderVerticalAlign = this.placeholderVerticalAlign
): Placeholder

equals

Cmn
Added in 1.0.0
open operator fun equals(other: Any?): Boolean

hashCode

Cmn 
open fun hashCode(): Int

toString

Cmn 
open fun toString(): String

Public properties

height

Cmn
Added in 1.0.0
val height: TextUnit

the height of the placeholder, it must be specified in sp or em. TextUnit.Unspecified is not allowed.

placeholderVerticalAlign

Cmn
Added in 1.0.0
val placeholderVerticalAlign: PlaceholderVerticalAlign

the vertical alignment of the placeholder within the text line. Check PlaceholderVerticalAlign for more information.

width

Cmn
Added in 1.0.0
val width: TextUnit

the width of the placeholder, it must be specified in sp or em. TextUnit.Unspecified is not allowed.